Update invoice

Update invoice

PATCH https://api.notify.cm/v2/invoices/{invoice_id}

Authentication: API keys With this API you can update your invoice information.

Headers

Name	Type	Description
Authorization	string	Your test of live API key

Request Body

Name	Type	Description
InvoiceDate	string	European date: 28-01-2021
InvoiceDuedate	string	European date: 28-02-2021
InvoiceTotal	number	Number format: 1100.00
InvoiceBalance	number	Number format: 1100.00
InvoiceStatus	string	Statuscode: concept open paid or cancelled

200

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

{
        "resource": "invoice",
        "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
        "status":"open",
        "invoiceNumber":"10001",
        "invoiceDate":"28-01-2021",
        "invoiceDuedate":"28-02-2021",
        "invoiceTotal":"500.00",
        "invoiceBalance":"330.00",
        "document":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65.pdf",
        "customer": {
                "id":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65",
                "number":"10001",
                "name":"Creditpartners B.V."
        }     
}

400

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "status": 400,
    "title": "Bad Request",
    "detail": "Field invoiceDate in wrong format""
}

404

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "status": 404,
    "title": "Not Found",
    "detail": "No invoice exists with id I_dont_exist."
}

Example

curl -X PATCH https://api.notify.cm/v2/invoices/a0f0660d-6c8d-422b-8114-e363b260521e \
   -H "Authorization: Bearer test_R7HQ9QpXgx8J32rW9X9UyXjgfNk6C7TQ2UD8M5rwf8vVnYxnSETvSuEC6SKFW8Ug" \
   -d "invoiceBalance=0.00" \
   -d "invoiceStatus=paid"

Response

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

{
        "resource": "invoice",
        "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
        "status":"paid",
        "invoiceNumber":"10001",
        "invoiceDate":"28-01-2021",
        "invoiceDuedate":"28-02-2021",
        "invoiceTotal":"500.00",
        "invoiceBalance":"0.00",
        "document":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65.pdf",
        "customer": {
                "id":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65",
                "number":"10001",
                "name":"Creditpartners B.V."
        }     
}