--- title: "Get Invoice Data" method: POST path: "/v2/invoicing/invoice-data" tags: ["Invoicing"] --- # Get Invoice Data `POST /v2/invoicing/invoice-data` This endpoint gets the invoice data for given invoice numbers ## Request body - InvoiceDataRequest — Invoice Data Request - `tmcId` string — TMC for which invoice is being requested. Deprecated in favor of invoiceIds. - `invoiceNumbers` string[] — One or more invoice numbers being requested. Deprecated in favor of invoiceIds. - `invoiceIds` string[] — One or more Invoice IDs being requested ## Response `200` OK - InvoiceDataResponse — Invoice Data List - `invoices` Invoice[], required — List of invoices which were requested. - `invoiceNumber` string, required — The invoice number - `invoiceId` string, required — The invoice ID - `data` InvoiceData, required — Actual Data - `issuedDate` DateModel, required — Date in ISO 8601 standard. - `iso8601` string, required - `seller` SellerInfo, required — Entity that sold the items mentioned in the invoice. - `name` string, required — Name of seller, usually a TMC Legal Entity. - `address` string, required — Address of seller. - `taxId` string — Tax number for the seller, for ex GSTN in India - `idInfo` IdInfo[] — The seller ID information. - `idType` 'TAX_ID' | 'VAT_ID' | 'VAT_REG_NO' | 'GST_NO' | 'ABN' | 'GSTIN' | 'SIRET' | 'BUSINESS_REG_NO' | 'UID' | 'CVR_NO' | 'EIN', required — The type of Id. - `value` string, required — Value of the Id. - `buyer` BuyerInfo, required — Buyer of items mentioned in the invoice. - `name` string, required — Name of buyer, usually a traveler. - `address` string, required — Address of buyer. Could be office, legal entity or org address. - `taxId` string — Tax number for the seller, for ex GSTN in India - `idInfo` IdInfo[] — The seller ID information. - `idType` 'TAX_ID' | 'VAT_ID' | 'VAT_REG_NO' | 'GST_NO' | 'ABN' | 'GSTIN' | 'SIRET' | 'BUSINESS_REG_NO' | 'UID' | 'CVR_NO' | 'EIN', required — The type of Id. - `value` string, required — Value of the Id. - `items` Item[], required — Items being invoiced. - `name` string, required — Name of the item. - `identifier` string, required — Number identifying the item, for ex, the ticket number for air ticket. - `purchaseType` 'TRIP_FEE' | 'FLIGHT' | 'ANCILLARY' | 'HOTEL' | 'CAR' | 'RAIL' | 'MERCHANT_FEE' | 'LIMO' | 'MISC', required — Type of item, indicates what type of item is being sold - `type` 'PURCHASE' | 'REFUND', required — Type of item, indicates if the item was purchased vs refunded. - `amount` FareAmount, required — Fare amount including base fare and tax. - `base` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - … - `tax` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - … - `taxBreakdown` Tax[] - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - … - `taxCode` string — Tax code - `percentage` number, double — Tax amount to total amount - `description` string — Tax name or Tax Description - `travelerName` string, required — Name of the traveler. - `taxBreakdown` Tax[] - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - … - `taxCode` string — Tax code - `percentage` number, double — Tax amount to total amount - `description` string — Tax name or Tax Description - `itemNameMetadata` union — Metadata for the ticket. - AirItemNameMetadata — AirItemNameMetadata information. - `pnrType` string, required - `ticketStatus` 'UNKNOWN' | 'ISSUED' | 'VOIDED' | 'REFUNDED_EXCHANGED' | 'EXCHANGED' — Status of the ticket. - `airNameInvoiceMetadata` AirNameInvoiceMetadata[] — Air invoice metadata. - … - `defaultItemName` string — Default item name. - HotelItemNameMetadata — HotelItemNameMetadata information. - `pnrType` string, required - `hotelName` string — Name of the hotel. - `hotelCity` string — City of the hotel. - `checkInDate` DateModel — Date in ISO 8601 standard. - … - `nights` string — Number of nights. - RailItemNameMetadata — RailItemNameMetadata information. - `railNameInvoiceMetadata` RailNameInvoiceMetadata[] — RailNameInvoiceMetadata information. - … - `pnrType` string, required - `payments` PaymentInformation[], required — Information on how the items have been paid for. - `id` string — Payment reference ID. - `transactionTime` DateTimeOffset — ISO8601 UTC Date Time - `iso8601` string, required - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - `coinageCode` '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' | 'NO_PREPAYMENT' — Payment method - `amount` number, double - `conversionRate` number, double — 1 coin in this system equals to how many currency value - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata. - … - `paymentMode` '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' | 'NO_PREPAYMENT', required — Mode of Payment shown on invoice. - `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. - `actualPayment` ActualPayment — Payment done via supported Spotnana payment types. - `paymentSourceType` 'CARD' | 'VIRTUAL_CARD' | 'REWARDS_PROGRAM' | 'DELAYED_INVOICING' | 'CUSTOM_PAYMENT_METHOD' | 'VENDOR_PROGRAM_PAYMENT' | 'UNUSED_CREDIT' | 'CASH', required — Type of Payment Source - `paymentMetadata` union, required — Metadata corresponding to the payment source. - object — Wrapper for CardMetadata - … - object — Wrapper for VirtualCardMetadata - … - object — Wrapper for RewardsProgramMetadata - … - object — Wrapper for CustomPaymentMethodMetadata - … - object — Wrapper for VendorProgramPaymentDescriptor - … - `exchangePayment` ExchangePayment — In case of exchange, payment accounted to the original ticket. - `originalTicketNumber` string, required — Ticket number which was exchanged to pay for current ticket. - `productId` string, required — ID of the product being invoiced - `productType` 'PNR' | 'SERVICE_FEE', required — Type of product being invoiced - `invoiceAmount` FareAmount, required — Fare amount including base fare and tax. - `base` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - `coinageCode` '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' | 'NO_PREPAYMENT' — Payment method - `amount` number, double - `conversionRate` number, double — 1 coin in this system equals to how many currency value - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata. - … - `tax` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - `coinageCode` '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' | 'NO_PREPAYMENT' — Payment method - `amount` number, double - `conversionRate` number, double — 1 coin in this system equals to how many currency value - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata. - … - `taxBreakdown` Tax[] - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - … - `taxCode` string — Tax code - `percentage` number, double — Tax amount to total amount - `description` string — Tax name or Tax Description - `taxBreakdown` Tax[] - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount. - `amount` number, double, required — The numeric value for the amount of money. - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard). - `convertedAmount` number, double — 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). - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard). - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - `coinageCode` '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' | 'NO_PREPAYMENT' — Payment method - `amount` number, double - `conversionRate` number, double — 1 coin in this system equals to how many currency value - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata. - … - `taxCode` string — Tax code - `percentage` number, double — Tax amount to total amount - `description` string — Tax name or Tax Description - `referenceIds` ReferenceId[], required — Reference Numbers to be shown on the invoice, for ex, Trip ID, PNR ID etc. - `label` 'TRIP_ID' | 'PNR_ID' | 'AGENCY_REFERENCE', required — Label for the reference ID on invoice. - `value` string, required — The reference ID. - `regionCode` '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' — The region code for which the following invoicing information is applicable. - `documentType` 'INVOICE' | 'RECEIPT' | 'NONE' — Type of document - `footerText` string — Text shown at bottom of the PDF document. Nothing is shown if not set. - `supplierType` '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' | 'ENTERPRISE' | 'HYATT' | 'EUROSTAR' | 'NATIONAL' | 'ALAMO' | 'AVIS' | 'BUDGET' | 'HERTZ' | 'DOLLAR' | 'THRIFTY' | 'FIREFLY' ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — The specified resource was not found. --- [API](https://skmtc.net/spotnana/apis/trip-api.md) · [All operations](https://skmtc.net/spotnana/apis/trip-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/trip-api/revisions/ccddd94cdc01/schema)