API - Invoice - GET invoice/filter

GET invoice/filter

Gebruikt voor

het ophalen van de facturen. Via de search en columns variabelen is het overzicht naar wens aan te passen.
Voor meer informatie over filteren, kijk hier: filters
De resultaten van de kolommen worden zowel in volledige opmaak als in originele waarde weergegeven. De originele waarde heeft als suffix "_raw".

Authenticatie

Gebruiker dient ingelogd te zijn op beheerdersniveau.

Parameters

Expansie

Response codes

• 200 OK

Voorbeeld

Ophalen volledige factuur lijst met een optionele zoek filter en kolommen.

GET api/rest/invoice/filter?search=INV_STATUS IN (20)&columns=INVOICE_ID,INV_NUMBER,INV_STATUS

Response: 
[
  {
    "id": 1,
    "INVOICE_ID": "<a href="https://mijndomein.nl/front.php?mod=invoiceedit&invoice_id=10">10</a>",
    "INV_NUMBER": "",
    "INV_STATUS": "Concept",
    "BOOKING_ID": null,
    "CUSTOMER_ID": "10378",
    "inv_id": "10",
    "inv_cust_id": "10378",
    "INVOICE_ID_raw": "10",
    "INV_NUMBER_raw": null,
    "INV_STATUS_raw": "Concept",
    "BOOKING_ID_raw": null
  },
  {
    "INVOICE_ID": "...

Ophalen factuur lijst met expansie op details.

GET api/rest/invoice/filter?search=INV_STATUS IN (20)&columns=INVOICE_ID,INV_NUMBER,INV_STATUS&expand=details

Response: 
[
  {
    "id": 1,
    "INVOICE_ID": "<a href="https://mijndomein.nl/front.php?mod=invoiceedit&invoice_id=10">10</a>",
    "INV_NUMBER": "",
    "INV_STATUS": "Concept",
    "BOOKING_ID": null,
    "CUSTOMER_ID": "10378",
    "inv_id": "10",
    "inv_cust_id": "10378",
    "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": "<a href="https://mijndomein.nl/front.php?mod=invoiceedit&invoice_id=11">11</a>",
    "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": "<a href="https://uwdomein.i-reserve.net/mod=invoiceedit&invoice_id=12">12</a>",
    "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
    }
  }
]