Documentatie
difficulty level:
Module textPhrase before ModuleName Factuur Module textPhrase after ModuleName.
API - Invoice - GET invoice/filter
GET invoice/filter
Verwendet für
das Abrufen der Rechnungen. Über die Variablen search und columns lässt sich die Übersicht nach Wunsch anpassen.
Weitere Informationen zum Filtern finden Sie hier: Filter
Die Ergebnisse der Spalten werden sowohl in vollständiger Formatierung als auch im ursprünglichen Wert angezeigt. Der ursprüngliche Wert hat das Suffix "_raw".
Authentifizierung
Der Benutzer muss auf Administratorebene angemeldet sein.
Parameters
| Parameter | Beschreibung | Erforderlich | Standard | Beispiel |
|---|---|---|---|---|
| lang | Language | Nein | dutch | english |
| search | Suchzeichenfolge mit Kriterien Wenn nicht angegeben, wird das Ergebnis auf die ersten 100 Aktivitäten beschränkt |
Nein | PRODUCT IN (1,14) | |
| columns | Anzuzeigende Spalten | Nein | INVOICE_ID,INV_NUMBER | |
| start | Die erste zurückgegebene Zeile | Nein | 10 | |
| length | Die Anzahl der zurückgegebenen Zeilen | Nein | 100 | |
| expand | Möglichkeit, die zurückgegebenen Informationen zu erweitern | Nein | details |
Erweiterung
| Parameter | Beschreibung |
|---|---|
| details | Die Detailzeilen |
Response codes
- 200 OK
Beispiel
Abrufen der vollständigen Rechnungsliste mit einem optionalen Suchfilter und Spalten.
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": "...
Abrufen der Rechnungsliste mit Erweiterung auf 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
}
}
]
