List invoices

List invoices

GET https://api.notify.cm/v2/invoices

Authentication: API keys

Query Parameters

Name	Type	Description
Limit	number	The number of invoices to return (max 250).
From	number	Used for pagination. Offset the result set to the invoice with this ID. The invoice with this ID is included in the result as well.

Headers

Name	Type	Description
Authorization	string	Your test or live API key

200

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
   "invoices": [
        {
            "resource": "customer",
            "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
            "status":"open",
            "invoiceNumber":"20210001",
            "invoiceDate":"21-01-2021",
            "invoiceDuedate":"21-02-2021",
            "invoiceTotal":"480.00",
            "invoiceBalance":"330.00",
            "document":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65.pdf",
            "customer": {
                "id":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65",
                "number":"10001",
                "name":"Creditparters B.V."
            }
        }, 
        {},
        {},
        {}
   ],
   "count": 5,
   "links": {
        "previous": null,
        "next": {
            "href": "https://api.notify.cm/v2/invoices?from=a0f0660d-6c8d-422b-8114-e363b260521e&limit=5",
            "type": "application/hal+json"
        }
   }
}

Example

curl -X GET https://api.notify.cm/v2/invoices \
   -H "Authorization: Bearer test_R7HQ9QpXgx8J32rW9X9UyXjgfNk6C7TQ2UD8M5rwf8vVnYxnSETvSuEC6SKFW8Ug" \

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
   "invoices": [
        {
            "resource": "customer",
            "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
            "status":"open",
            "invoiceNumber":"20210001",
            "invoiceDate":"21-01-2021",
            "invoiceDuedate":"21-02-2021",
            "invoiceTotal":"480.00",
            "invoiceBalance":"330.00",
            "document":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65.pdf",
            "customer": {
                "id":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65",
                "number":"10001",
                "name":"Creditparters B.V."
            }
        }, 
        {},
        {},
        {}
   ],
   "count": 5,
   "links": {
        "previous": null,
        "next": {
            "href": "https://api.notify.cm/v2/invoices?from=a0f0660d-6c8d-422b-8114-e363b260521e&limit=250",
            "type": "application/hal+json"
        }
   }
}