The Invoice model

The invoice object

Attribute	Type	Description
serial_numberRequired	string	A globally unique identifier for this invoice.
profile_idOptional	string	The globally unique identifier for the invoice profile.
profile_nameOptional	string	The name of the invoice profile.
billing_informationRequired	object	The legal information of the customer which the invoice is issued to. See Billing Information
modeOptional	string	A description of the type of legal document that this object represents. `reseller` `intermediary` `gross` `credit-reseller` `credit-intermediary` `credit-gross` `passthrough` See Billing mode for more information
statusRequired	string	Indicates the current status of the invoice in its lifecycle. -`paid` -`unpaid` Check table below for more information.
issuing_dateOptional	string	Date indicating when the invoice is closed. ISO date format.
billing_periodOptional	string	Indicates the billing cycle configured. `instant` `weekly` `biweekly` `monthly`
from_dateOptional	string	The first day of the billing period. ISO date format. Equal to `issuing_date` when the invoice is instant.
to_dateOptional	string	The last day of the billing period. ISO date format. Equal to `issuing_date` when the invoice is instant.
due_dateOptional	string	The date by which the invoice must be fully paid. ISO date format.
currencyOptional	string	Billing currency used. ISO 4217 code.
totalOptional	string	Total amount due for this invoice, including tax. `decimal`
credit_used_for_customer_paymentOptional	string	The total amount of TK credit used in this invoice. TK credit refers to any way in which a customer can accumulate funds within Perk. The sole purpose of those funds is to use them later for booking trips through the TravelPerk platform. `decimal`
linesOptional	object	The line items included in this invoice. See Invoice line list for more information.
taxes_summaryOptional	array[object]	A list of items describing the total base and tax amounts for each tax regime. Check table below for more information.
referenceOptional	string	Additional (text) reference about the invoice. In case of instant invoices, it includes a reference to the invoiced trip (format example: `Trip: #12345`). In case of periodic invoices, the field is empty.
travelperk_bank_accountOptional	object	Applies only to invoices paid by wire transfer. This attribute contains details of the bank account of Perk. Null, otherwise. Check table below for more information.
pdfOptional	string	An URL to this invoice rendered as a .pdf file

Invoice line list

The invoice line list only appears when retrieving an individual invoice, not when listing all invoices.

Attribute	Type	Description
total	int	The total number of lines on this invoice.
data	array[InvoiceLine]	(Up to) The first 10 lines on this invoice, ordered by most recent expense date.
next	string	The relative path where you can retrieve the next page of lines for this invoice.

Billing information object

Attribute	Type	Description
legal_name	string	The name of the legal entity where the invoice is issued to.
vat_number	string	The tax id or VAT number of the legal entity.
address_line_1	string	The first line of the address of the legal entity.
address_line_2	string	The second line of the address of the legal entity.
city	string	The city of the legal entity.
postal_code	string	The postal code of the legal entity.
country_name	string	The country name of the legal entity.

Billing statuses

Status	Description
`paid`	The invoice is issued and fully paid.
`unpaid`	The invoice is issued but not yet fully paid.

Billing mode types

Mode	Description
`reseller`	An invoice issued by Perk for regular retail operations.
`intermediary`	An invoice issued by Perk on behalf of the underlying service suppliers (ie airline).
`gross`	Not an invoice*. Represents a request for payment. Applies to the cases in which Perk is only doing the prepayment of the service, but not the merchant of records. It applies mainly to some hotels per request of the customer, where the real invoice is collected on checkout.
`credit-reseller`	A credit note applied to regular retail operations.
`credit-intermediary`	A credit note applied to an invoice under the intermediation model.
`credit-intermediary`	A credit note applied to a request for payment (gross) document.
`Mixed`	The invoice has invoice lines that have different billing modes.
`passthrough`	Not an invoice. A Transaction Summary document. Created when the customer directly pays the supplier of a service instead of Perk

Taxes summary array object

The tax summary provides a summary of the tax information for the invoice items. The tax summary groups invoice items by either tax regime or by tax percent. A single summary is provided for each group, and includes the total tax and base amounts for all items in that group

If Perk is acting as a reseller for all items in the invoice, then the invoice mode will be reseller and the tax summary will group by tax_regime. The tax_regime is a code that describes how VAT is applied to each invoice item

For all other invoice modes, the tax summary will instead be grouped by tax_percentage. The tax_regime will be null

Attribute	Type	Description
tax_regime	string or null	The code representing the tax regime. The tax regime will only be provided if the invoice `mode` is `reseller`. Examples include: `STAR`: Special Travel Agency Regime (TOMS) `G-VAT-R`: General Regime `GROSS`: All lines belonging to a gross mode document
subtotal	string	The total base amount (without taxes).
tax_percentage	string	The percentage of tax applied by the regime.
tax_amount	string	The tax amount.
total	string	The total amount after taxes.

Perk bank account object

Attribute	Type	Description
bank_name	string	The name of the bank.
account_number	string	Unique identifier of the bank account.
bic	string	BIC or SWIFT code of the bank.
reference	string	The reference code requested by Perk in the wire transfer.

{
   "serial_number": "INV-01-987654",
   "profile_id": "edb6322b-8e11-48e9-8d6f-6402e445e50d",
   "profile_name": "My Company Ltd",
   "billing_information": {
      "legal_name": "My Company Ltd",
      "vat_number": "GB123456789",
      "address_line_1": "199 Bishopsgate",
      "address_line_2": "Spitalfields",
      "city": "London",
      "postal_code": "EC2M 3TY",
      "country_name": "United Kingdom"
   },
   "mode": "reseller",
   "status": "paid",
   "issuing_date": "2020-03-31",
   "billing_period": "monthly",
   "from_date":  "2020-03-01",
   "to_date": "2020-03-31",
   "due_date": "2020-04-15",
   "currency": "EUR",
   "total": "13579.24",
   "taxes_summary": [
      {
         "tax_regime": "STAR",
         "subtotal": "6543.21",
         "tax_percentage": "0.00",
         "tax_amount": "0.00",
         "total": "6543.21",
      },
      {
         "tax_regime": "G-VAT-R",
         "subtotal": "5912.63",
         "tax_percentage": "19.00",
         "tax_amount": "1123.40",
         "total": "7036.03",
      }
   ],
   "reference": "",
   "travelperk_bank_account": {
      "bank_name": "La Caixa",
      "account_number": "ES01 2345 6789 1098 7654 3210",
      "bic": "CAIX ES BB XXX",
      "reference": "INV-01-987654"
   },
   "pdf": "https://api.travelperk.com/invoices/INV-01-987654/pdf"
}