GET invoices
Changed onReturns invoices of the administration
Request
- Base URLhttps://api.bookingexperts.com
- Auth
- API key in header X-API-KEY
- or OAuth 2Authorization code/oauth/authorizeToken URL/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Administration ID
Query parameters
Page number
Page size
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
Fieldset. Specify a comma separated list of attributes to return
Includes list. Specify a comma separated list of resources to include.
Filter on ID
Filter on date
Filter on type
Filter on invoice_nr
Filter on company
Filter on country_code
Filter on city
Filter on address_line_1
Filter on address_line_2
Filter on postalcode
Filter on address_subdivision
Filter on memo
Filter on period_start_date
Filter on period_end_date
Filter on total
Filter on last_sent
Filter on created_at
Filter on updated_at
Filter on owner. Specify a comma separated list of IDs to filter on.
Filter on invoice_items. Specify a comma separated list of IDs to filter on.
Filter on debtor. Specify a comma separated list of IDs to filter on.
Filter on administration. Specify a comma separated list of IDs to filter on.
Filter on booking. Specify a comma separated list of IDs to filter on.
Filter on inventory_objects. Specify a comma separated list of IDs to filter on.
Filter on credited_invoice. Specify a comma separated list of IDs to filter on.
Filter on previous_invoice. Specify a comma separated list of IDs to filter on.
Filter on payments. Specify a comma separated list of IDs to filter on.
Filter on security_deposits. Specify a comma separated list of IDs to filter on.
Filter on sent. When false, concept invoices will be returned.
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
Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.
Response
InvoiceCollectionResponse
Example response
{
"data": [
{
"id": "1",
"type": "invoice",
"relationships": {
"owner": {
"data": {
"type": "owner"
}
},
"invoice_items": {
"data": [
{
"type": "invoice_item"
}
]
},
"debtor": {
"data": {
"type": "debtor"
}
},
"administration": {
"data": {
"type": "administration"
}
},
"reservation": {
"data": {
"type": "reservation"
}
},
"booking": {
"data": {
"type": "booking"
}
},
"inventory_objects": {
"data": [
{
"type": "inventory_object"
}
]
},
"credited_invoice": {
"data": {
"type": "invoice"
}
},
"previous_invoice": {
"data": {
"type": "invoice"
}
},
"payments": {
"data": [
{
"type": "payment"
}
]
},
"security_deposits": {
"data": [
{
"type": "security_deposit"
}
]
}
}
}
],
"included": [
{
"id": "1",
"type": "owner",
"attributes": {
"title": "mr",
"locale": "cs",
"country_code": "NL"
},
"relationships": {
"primary_contact": {
"data": {
"type": "contact"
}
},
"contacts": {
"data": [
{
"type": "contact"
}
]
},
"administration": {
"data": {
"type": "administration"
}
},
"active_inventory_objects": {
"data": [
{
"type": "inventory_object"
}
]
},
"owner_guests": {
"data": [
{
"type": "owner_guest"
}
]
},
"active_rentable_identities": {
"data": {
"type": "rentable_identity"
}
},
"labels": {
"data": [
{
"type": "label"
}
]
}
}
}
]
}Changes
- warning
added the new
da-DKenum value to the///////response property for the response status - warning
added the new
da-DKenum value to the///////response property for the response status - warning
added the new
da-DKenum value to the///////response property for the response status - warning
added the new
en-GBenum value to the///////response property for the response status - warning
added the new
en-GBenum value to the///////response property for the response status - warning
added the new
en-GBenum value to the///////response property for the response status - warning
added the new
en-USenum value to the///////response property for the response status - warning
added the new
en-USenum value to the///////response property for the response status - warning
added the new
en-USenum value to the///////response property for the response status - info
added the new optional
queryrequest parameterfilter[debtor] - info
added the optional property
///to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added to the
/response propertyanyOflist for the response status
- warning