GET invoices

get

https://api.bookingexperts.com/v3/administrations/{administration_id}/invoices

Returns invoices of the administration

Path Params

administration_id

string

required

Administration ID

Query Params

page[number]

integer

≥ 1

Page number

page[size]

integer

1 to 100

Page size

sort

string

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[invoice]

string

Fieldset. Specify a comma separated list of attributes to return

include

string

Includes list. Specify a comma separated list of resources to include.

filter[id]

string

Filter on ID

filter[date]

string

Filter on date

filter[type]

string

Filter on type

filter[invoice_nr]

string

Filter on invoice_nr

filter[company]

string

Filter on company

filter[country_code]

string

Filter on country_code

filter[city]

string

Filter on city

filter[address_line_1]

string

Filter on address_line_1

filter[address_line_2]

string

Filter on address_line_2

filter[postalcode]

string

Filter on postalcode

filter[address_subdivision]

string

Filter on address_subdivision

filter[memo]

string

Filter on memo

filter[period_start_date]

string

Filter on period_start_date

filter[period_end_date]

string

Filter on period_end_date

filter[total]

string

Filter on total

filter[last_sent]

string

Filter on last_sent

filter[created_at]

string

Filter on created_at

filter[updated_at]

string

Filter on updated_at

filter[owner]

string

Filter on owner. Specify a comma separated list of IDs to filter on.

filter[invoice_items]

string

Filter on invoice_items. Specify a comma separated list of IDs to filter on.

filter[administration]

string

Filter on administration. Specify a comma separated list of IDs to filter on.

filter[booking]

string

Filter on booking. Specify a comma separated list of IDs to filter on.

filter[inventory_objects]

string

Filter on inventory_objects. Specify a comma separated list of IDs to filter on.

filter[credited_invoice]

string

Filter on credited_invoice. Specify a comma separated list of IDs to filter on.

filter[previous_invoice]

string

Filter on previous_invoice. Specify a comma separated list of IDs to filter on.

filter[payments]

string

Filter on payments. Specify a comma separated list of IDs to filter on.

filter[security_deposits]

string

Filter on security_deposits. Specify a comma separated list of IDs to filter on.

filter[sent]

boolean

Filter on sent. When false, concept invoices will be returned.

filter[paid]

boolean

Filter on paid. When true, only fully paid invoices will be returned. When false, only invoices with an outstanding amount (either direction) will be returned.

Headers

Accept-Language

string

Supported languages. A comma separated list with one or more of the following locales: cs, da, de, de-AT, de-CH, en, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr. Default: 'en'.

Responses

200InvoiceCollectionResponse

429Error

defaultError