Help Center
Login Sign up
  1. Home
  2. API reference
  3. API documentation (JSON/XML)
  4. Tasks

Invoice list

API reference (XML/JSON) · Updated 2023-09-18

Function

The  InvoiceList task inqired incoices .

You can find more information about list queries here. 

Description

Route: POST /invoice/_search

Query parameters

The data of the following keywords can be queried with the query parameter ?keys[]=:

  • addon
  • created
  • currency
  • failed
  • id
  • number
  • payment
  • status
  • type
  • updated
{
	"filters": [
		{
			"key": "number",
			"value": "*",
			"operator": "LIKE"
		}
	],
	"view": {
		"children": 1,
		"limit": 2,
		"from": "2019-11-01T00:00:00.000+0000",
		"to": "2021-11-31T00:00:00.000+0000"
	}
}
{
    "stid": "20220713-app2-dev-7251",
    "status": {
        "code": "S0885",
        "text": "The invoices were inquired successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "Invoice",
        "summary": 3228
    },
    "data": [
        {
            "created": "2019-11-07T04:00:57.000+0100",
            "updated": "2019-11-07T16:15:21.000+0100",
            "id": 441,
            "number": "40000017",
            "customer": {
                "number": 123456,
                "client": "ix"
            },
            "payment": "POST",
            "paymentMode": "WIRETRANSFER",
            "subType": "DOMAIN",
            "amount": 285.94,
            "vatAmount": 45.65,
            "status": "FINISHED",
            "type": "INVOICE",
            "failed": false,
            "currency": "EUR",
            "document": {
                "id": 5201
            },
            "addon": {
                "documentstore_csv_id": "5202",
                "neo_rechnungs_id": "1524486",
                "documentstore_txt_id": null
            }
        },
        {
            "created": "2019-11-07T04:00:59.000+0100",
            "updated": "2019-11-07T16:15:21.000+0100",
            "id": 442,
            "number": "70001712",
            "customer": {
                "number": 123456,
                "client": "ix"
            },
            "payment": "POST",
            "paymentMode": "WIRETRANSFER",
            "subType": "DOMAIN",
            "amount": 5224.9,
            "vatAmount": 834.23,
            "status": "FINISHED",
            "type": "INVOICE",
            "failed": false,
            "currency": "EUR",
            "document": {
                "id": 5203
            },
            "addon": {
                "documentstore_csv_id": "5204",
                "neo_rechnungs_id": "1524487",
                "documentstore_txt_id": null
            }
        }
    ]
}