v1

latestOpenAPI 3.1.02026-07-2420077.8 KB

List all Invoices

Get list of invoices, filters may be added as query parameters

get/invoices

Query parameters

profile_idstring[]

Filter, only fetch invoices that match any of the provided invoice profile ids

serial_numberstring[]

Filter, only fetch invoices that exactly match one of the provided invoice serial numbers

serial_number_containsstring

Filter, only fetch invoices that partially match a serial_number

billing_periodstring

Filter, only fetch invoices that match a billing_period (instant, weekly, biweekly, monthly)

travelperk_bank_account_numberstring

Filter, only fetch invoices that match the number of the tk_bank_account in the invoice

customer_country_namestring

Filter, only fetch invoices that match the country name of the customer's billing address in the invoice

statusstring

Filter, only fetch invoices that match invoice's status. Available values : paid, unpaid

issuing_date_gtestring date

Filter, only fetch invoices where invoice.issuing_date is greater than or equal to this date. Dates should be in format YYYY-MM-DD.

issuing_date_ltestring date

Filter, only fetch invoices where invoice.issuing_date is less than or equal to this date. Dates should be in format YYYY-MM-DD.

due_date_gtestring date

Filter, only fetch invoices where invoice.due_date is greater than or equal to this date. Dates should be in format YYYY-MM-DD.

due_date_ltestring date

Filter, only fetch invoices where invoice.due_date is less than or equal to this date. Dates should be in format YYYY-MM-DD.

limitinteger

Maximum number of elements to return per page. See more info in Pagination

offsetinteger

Pagination offset index, 0 based.

sortstring

Sorting criteria on fields in Invoice. Available values : issuing_date, -issuing_date

Response

200