The InvoiceProfile model

An invoice profile represents the legal entity a trip is invoiced to, all Invoices will be Issued on an InvoiceProfile.

The InvoiceProfile object

AttributeTypeDescription
idstringUnique identifier of the invoice profile.
namestringThe name of the invoice profile.
payment_method_typestring

The chosen payment method.

Can hold values such as:
credit_card,
instant_direct_debit,
manual_direct_debit,
bank_transfer,
sepa,

You should expect that new payment methods may be added over time.

billing_periodstringThe billing period used in this specific invoice profile.
instant
weekly
biweekly
monthly
currencystringThe 3 character currency code used.
EUR, AUD, CAD, CHF, GBP, SGD, USD
billing_informationobjectThe billing address information. See Billing Information Object.

Billing information object

AttributeTypeDescription
legal_namestringThe name of the legal entity where the invoice is issued to.
vat_numberstringThe tax id or VAT number of the legal entity.
address_line_1stringThe first line of the address of the legal entity.
address_line_2stringThe second line of the address of the legal entity.
citystringThe city of the legal entity.
postal_codestringThe postal code of the legal entity.
country_namestringThe country name of the legal entity.
{
   "id": "edb6322b-8e11-48e9-8d6f-6402e445e50d",
   "name": "MyCompany Ltd",
   "payment_method_type": "credit_card",
   "billing_period": "weekly",
   "currency": "GBP",
   "billing_information": {
      "legal_name": "MyCompany Ltd",
      "vat_number": "GB123456789",
      "address_line_1": "199 Bishopsgate",
      "address_line_2": "Spitalfields", 
      "city": "London",
      "postal_code": "EC2M 3TY",
      "country_name": "United Kingdom"
   }
}