# Get Invoice Data

This endpoint gets the invoice data for given invoice numbers

Endpoint: POST /v2/invoicing/invoice-data
Version: v2
Security: Bearer

## Request fields (application/json):

  - `invoiceIds` (array)
    One or more Invoice IDs being requested
    Example: ["15c94ac1-f540-4916-9243-306a75fbd8a9"]

  - `tmcId` (string)
    TMC for which invoice is being requested. Deprecated in favor of invoiceIds.
    Example: "15c94ac1-f540-4916-9243-306a75fbd8a9"

  - `invoiceNumbers` (array)
    One or more invoice numbers being requested. Deprecated in favor of invoiceIds.

## Response 200 fields (application/json):

  - `invoices` (array, required)
    List of invoices which were requested.

  - `invoices.invoiceNumber` (string, required)
    The invoice number
    Example: "SPOT-0001232"

  - `invoices.invoiceId` (string, required)
    The invoice ID
    Example: "d694cf94-534e-410e-b66b-11ef970622bc"

  - `invoices.data` (object, required)
    The invoice content

  - `invoices.data.issuedDate` (object, required)
    Date of invoice issue

  - `invoices.data.issuedDate.iso8601` (string, required)
    Example: "2017-07-21"

  - `invoices.data.seller` (object, required)
    Entity that sold the items mentioned in the invoice.

  - `invoices.data.seller.name` (string, required)
    Name of seller, usually a TMC Legal Entity.
    Example: "Spotnana India Pvt. Ltd."

  - `invoices.data.seller.address` (string, required)
    Address of seller.
    Example: "115 Broadway Suite 04-101,\nNew York, NY 10006"

  - `invoices.data.seller.idInfo` (array)
    The seller ID information.

  - `invoices.data.seller.idInfo.idType` (string, required)
    The type of Id.
    Enum: "TAX_ID", "VAT_ID", "VAT_REG_NO", "GST_NO", "ABN", "GSTIN", "SIRET", "BUSINESS_REG_NO", "UID", "CVR_NO", "EIN"

  - `invoices.data.seller.idInfo.value` (string, required)
    Value of the Id.
    Example: "TXG239023092"

  - `invoices.data.seller.taxId` (string)
    Tax number for the seller, for ex GSTN in India
    Example: "TXG239023092"

  - `invoices.data.buyer` (object, required)
    Buyer of items mentioned in the invoice.

  - `invoices.data.buyer.name` (string, required)
    Name of buyer, usually a traveler.
    Example: "John Doe"

  - `invoices.data.buyer.address` (string, required)
    Address of buyer. Could be office, legal entity or org address.
    Example: "115 Broadway Suite 04-101,\nNew York, NY 10006"

  - `invoices.data.items` (array, required)
    Items being invoiced.

  - `invoices.data.items.name` (string, required)
    Name of the item.
    Example: "Air Ticket SFO-EWR"

  - `invoices.data.items.identifier` (string, required)
    Number identifying the item, for ex, the ticket number for air ticket.
    Example: "00129383829"

  - `invoices.data.items.purchaseType` (string, required)
    Type of item, indicates what type of item is being sold
    Enum: "TRIP_FEE", "FLIGHT", "ANCILLARY", "HOTEL", "CAR", "RAIL", "MERCHANT_FEE", "LIMO", "MISC"

  - `invoices.data.items.type` (string, required)
    Type of item, indicates if the item was purchased vs refunded.
    Enum: "PURCHASE", "REFUND"

  - `invoices.data.items.amount` (object, required)
    Amount of money.

  - `invoices.data.items.amount.base` (object, required)
    Base fare amount.

  - `invoices.data.items.amount.base.amount` (number, required)
    The numeric value for the amount of money.
    Example: 510

  - `invoices.data.items.amount.base.currencyCode` (string, required)
    The 3-letter currency code for the money amount (defined using ISO 4217 standard).
    Example: "GBP"

  - `invoices.data.items.amount.base.convertedAmount` (number)
    The converted currency and amount that has been converted (if a currency conversion has been requested).
For example, if the call requests that money be sent in a specified currency (because the frontend requested
the backend to send money in the user's preferred currency).
    Example: 715.42

  - `invoices.data.items.amount.base.convertedCurrency` (string)
    The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
    Example: "USD"

  - `invoices.data.items.amount.base.otherCoinage` (array)
    List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.

  - `invoices.data.items.amount.base.otherCoinage.coinageCode` (string)
    Payment method
    Enum: "PAYMENT_METHOD_UNKNOWN", "CREDIT_CARD", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "DELAYED_INVOICING", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "CUSTOM_VIRTUAL_PAYMENT", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER"

  - `invoices.data.items.amount.base.otherCoinage.amount` (number)
    Example: 1000

  - `invoices.data.items.amount.base.otherCoinage.conversionRate` (number)
    1 coin in this system equals to how many currency value
    Example: 0.01

  - `invoices.data.items.amount.base.otherCoinage.preferredCurrencyConversionRate` (number)
    1 coin in this system equals to how many currency value
    Example: 0.01

  - `invoices.data.items.amount.tax` (object, required)
    Tax amount.

  - `invoices.data.items.amount.taxBreakdown` (array)
    Breakdown of tax amounts.

  - `invoices.data.items.amount.taxBreakdown.amount` (object, required)
    Tax amount

  - `invoices.data.items.amount.taxBreakdown.taxCode` (string)
    Tax code
    Example: "VAT"

  - `invoices.data.items.amount.taxBreakdown.percentage` (number)
    Tax amount to total amount
    Example: 9

  - `invoices.data.items.travelerName` (string, required)
    Name of the traveler.
    Example: "John Doe"

  - `invoices.data.items.taxBreakdown` (array)
    Tax breakdown for the invoice, this will be present for UK invoices with VAT

  - `invoices.data.items.itemNameMetadata` (any)

  - `invoices.data.payments` (array, required)
    Information on how the items have been paid for.

  - `invoices.data.payments.id` (string)
    Payment reference ID.
    Example: "sdkljhafisudlls"

  - `invoices.data.payments.transactionTime` (object)
    Transaction timestamp.

  - `invoices.data.payments.amount` (object, required)
    Amount paid.

  - `invoices.data.payments.paymentMode` (string, required)
    Mode of Payment shown on invoice.
    Enum: "CREDIT_CARD", "ON_ACCOUNT", "DIRECT", "EXCHANGE", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "AMADEUS_CHECKOUT", "PREVIOUS_BOOKING_VALUE", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER"

  - `invoices.data.payments.paymentInstrumentIdentifier` (string, required)
    An identifier for the payment instrument used. For example, last four credit card number digits in case a credit card was used.
    Example: "**2343"

  - `invoices.data.payments.actualPayment` (object)
    Details of how payment was done

  - `invoices.data.payments.actualPayment.paymentSourceType` (string, required)
    Type of payment source.
    Enum: "CARD", "VIRTUAL_CARD", "REWARDS_PROGRAM", "DELAYED_INVOICING", "CUSTOM_PAYMENT_METHOD", "VENDOR_PROGRAM_PAYMENT", "UNUSED_CREDIT", "CASH"

  - `invoices.data.payments.actualPayment.paymentMetadata` (any, required)

  - `invoices.data.payments.exchangePayment` (object)
    Details of how payment was done

  - `invoices.data.payments.exchangePayment.originalTicketNumber` (string, required)
    Ticket number which was exchanged to pay for current ticket.
    Example: "00129332929"

  - `invoices.data.productId` (string, required)
    ID of the product being invoiced
    Example: "123243223"

  - `invoices.data.productType` (string, required)
    Type of product for which invoice is generated.
    Enum: "PNR", "SERVICE_FEE"

  - `invoices.data.invoiceAmount` (object, required)
    Total invoice amount.

  - `invoices.data.referenceIds` (array, required)
    Reference Numbers to be shown on the invoice, for ex, Trip ID, PNR ID etc.

  - `invoices.data.referenceIds.label` (string, required)
    Label for the reference ID on invoice.
    Enum: "TRIP_ID", "PNR_ID", "AGENCY_REFERENCE"

  - `invoices.data.referenceIds.value` (string, required)
    The reference ID.
    Example: "122332432"

  - `invoices.data.regionCode` (string)
    The region code for which the invoice is generated.
    Enum: "US", "UK", "NL", "SG", "CA", "MX", "DO", "AR", "BR", "CO", "GT", "PE", "CR", "IL", "NOR", "AE", "SE", "TR", "PL", "SA", "ZA", "AU", "CN", "HK", "IN", "ID", "JP", "KR", "MY", "NZ", "PH", "TH", "VN", "FR", "DK", "CZ", "HU", "AL", "BY", "BA", "BG", "IS", "AD", "AT", "BE", "CY", "EE", "FI", "DE", "GR", "IE", "IT", "XK", "LV", "LT", "LU", "MC", "ME", "MT", "PT", "SM", "SK", "SI", "ES", "VA", "HR", "LI", "MD", "MK", "RO", "RU", "RS", "CH", "UA", "GB", "TW"

  - `invoices.data.documentType` (string)
    Type of document
    Enum: "INVOICE", "RECEIPT", "NONE"

  - `invoices.data.footerText` (string)
    Text shown at bottom of the PDF document. Nothing is shown if not set.
    Example: "This document is proof of payment. If you require a tax invoice, please request one from the travel provider."

  - `invoices.data.supplierType` (string)
    SupplierType for PNR, for eg. NDC, Sabre etc.
    Enum: "UNKNOWN_SOURCE", "SABRE", "TRAVEL_FUSION", "AVIA", "NDC", "TRAINLINE", "ATPCO_NDC", "FARELOGIX_NDC", "OFFLINE", "CONNEXUS", "ROUTEHAPPY", "AMADEUS", "GIATA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE"

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.