List all Invoices

get

https://api.travelperk.com/invoices

Get list of invoices, filters may be added as query parameters. Only invoices issued on or after January 1st 2019 will be returned

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

profile_id

array of strings

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

profile_id

serial_number

array of strings

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

serial_number

serial_number_contains

string

Filter, only fetch invoices that partially match a serial_number

billing_period

string

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

travelperk_bank_account_number

string

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

customer_country_name

string

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

status

string

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

issuing_date_gte

date

Defaults to 2023-11-10

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_lte

date

Defaults to 2023-11-10

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_gte

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_lte

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.

limit

int32

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

offset

int32

Pagination offset index, 0 based.

sort

string

Defaults to -issuing_date

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

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200