Documentation
Difficulty level:
This section only applies if the module Invoice is active.
API - Invoice - GET invoice/filter
GET invoice/filter
Used for
Query / filter invoices. Via the search and columns variabeles the view can be adjusted.
For more information about filtering, click here: filters
The results are displayed in full format as well as the original value. The original value has the suffix "_raw".
Authentication
Authentication required
Parameters
| Parameter | Description | Mandatory | Standaard | Example |
|---|---|---|---|---|
| lang | Language | No | dutch | english |
| search | Search string with criteria If not supplied, the result is limited to 100 results |
No | INV_STATUS = 20 | |
| columns | Columns to display | No | INVOICE_ID,INV_NUMBER | |
| start | The first row to be returned | No | 10 | |
| length | The number of rows to be returned | No | 100 | |
| expand | Option to expand the returned information | No | details |
Expansion
| Parameter | Description |
|---|---|
| details | The detail lines |
Response codes
- 200 OK
Example
Get a list of invoices.
GET api/rest/invoice/filter?search=INV_STATUS IN (20)&columns=INVOICE_ID,INV_NUMBER,INV_STATUS
Response:
[
{
"INVOICE_ID": "10",
"INV_NUMBER": "",
"INV_STATUS": "Concept",
"BOOKING_ID": null,
"CUSTOMER_ID": "10378",
"inv_id": "10",
"inv_cust_id": "10378",
"id": 1,
"INVOICE_ID_raw": "10",
"INV_NUMBER_raw": null,
"INV_STATUS_raw": "Concept",
"BOOKING_ID_raw": null
},
{
"INVOICE_ID": "...
Get a list of invoices with expansion on details.
GET api/rest/invoice/filter?search=INV_STATUS IN (20)&columns=INVOICE_ID,INV_NUMBER,INV_STATUS&expand=details
Response:
[
{
"INVOICE_ID": "10",
"INV_NUMBER": "",
"INV_STATUS": "Concept",
"BOOKING_ID": null,
"CUSTOMER_ID": "10378",
"inv_id": "10",
"inv_cust_id": "10378",
"id": 1,
"INVOICE_ID_raw": "10",
"INV_NUMBER_raw": null,
"INV_STATUS_raw": "Concept",
"BOOKING_ID_raw": null,
"details": {
"inv_id": "10",
"inv_owner": "3",
"inv_number": null,
"inv_sub_run_id": null,
"inv_fee_run_id": null,
"inv_sub_id": "1",
"inv_date": null,
"inv_draftdate": "2018-08-23",
"inv_finaldate": null,
"inv_status": "10",
"inv_res_id": null,
"inv_cust_id": "10378",
"inv_comp_id": null,
"inv_export": null,
"inv_price": "14.19",
"inv_currency": "EUR",
"inv_pay_price": null,
"inv_pay_currency": null
}
},
{
"INVOICE_ID": "11",
"INV_NUMBER": "",
"INV_STATUS": "Concept",
"BOOKING_ID": null,
"CUSTOMER_ID": null,
"inv_id": "11",
"id": 2,
"INVOICE_ID_raw": "11",
"INV_NUMBER_raw": null,
"INV_STATUS_raw": "Concept",
"BOOKING_ID_raw": null,
"details": {
"inv_id": "11",
"inv_owner": "3",
"inv_number": null,
"inv_sub_run_id": null,
"inv_fee_run_id": null,
"inv_sub_id": null,
"inv_date": "2018-08-23",
"inv_draftdate": "2018-08-23",
"inv_finaldate": null,
"inv_status": "10",
"inv_res_id": null,
"inv_cust_id": null,
"inv_comp_id": null,
"inv_export": null,
"inv_price": "3.45",
"inv_currency": "EUR",
"inv_pay_price": null,
"inv_pay_currency": null
}
},
{
"INVOICE_ID": "12",
"INV_NUMBER": "",
"INV_STATUS": "Concept",
"BOOKING_ID": null,
"CUSTOMER_ID": null,
"inv_id": "12",
"id": 3,
"INVOICE_ID_raw": "12",
"INV_NUMBER_raw": null,
"INV_STATUS_raw": "Concept",
"BOOKING_ID_raw": null,
"details": {
"inv_id": "12",
"inv_owner": "3",
"inv_number": null,
"inv_sub_run_id": null,
"inv_fee_run_id": null,
"inv_sub_id": null,
"inv_date": "2018-08-28",
"inv_draftdate": "2018-08-28",
"inv_finaldate": null,
"inv_status": "10",
"inv_res_id": null,
"inv_cust_id": null,
"inv_comp_id": null,
"inv_export": null,
"inv_price": "1.12",
"inv_currency": "EUR",
"inv_pay_price": null,
"inv_pay_currency": null
}
}
]
