Invoice Add/Update API

The Invoice Add/Update API allows you to add or update Invoices for your orders.

This API is intended to be used in white label business model approach where you want to be in control of the Invoice files.

Do you have questions about how your server should add or update Invoice files for your orders? Visiting our demo page will help you out.

We’ve developed a sandbox server, which is an isolated server (not hooked up to a payment system or production environment, allowing you to test the service without getting billed) to try out your code and integration with us. As the sandbox server is an isolated server, it requires different credentials than the production site.

The demo page of Invoice Add/Update API on sandbox server:

https://imatsandbox.materialise.net/api/demo/documents-add-update-api.htm

The sandbox and production server contain API demo pages which send well-formed API requests to our site.

The demo page of Invoice Add/Update API on production server:

https://i.materialise.com/api/demo/documents-add-update-api.htm

This API requires the personal API code. It is therefore not possible to use AJAX requests.

The Invoice Add/Update API works by posting data to our service.

You can use either XML or JSON formats for posting. The HTTP encoding type of a particular request depends on the type of API you are going to use. This will be described in the corresponding section of this page.

To specify the exact content type which your client can accept and parse, the Accept header in your request has to be set to one of the following encoding types:

• text/json
• application/json
• text/xml
• application/xml

To add/update Invoice for an order through the Invoice Add/Update API, POST a well-structured request via “HTTPS” to this URL:

https://i.materialise.com/web-api/order/[Order ID]/invoice

To use APIs of the sandbox, the POST needs to be submitted to:

https://imatsandbox.materialise.net/web-api/order/[Order ID]/invoice

The API code needs to be specified in the APICode HTTP header.

The Invoice add/update should be done using POST HTTP Method:

Request Method:POST

You should create HTTP multipart request to be able add/update Invoice file. HTTP multipart request is a type of HTTP request that HTTP clients construct to send file and data over to the server side.

You can either upload the Invoice file in your request or indicate an freely accessible url where the Invoice can be found. The Invoice should be either a .doc, .docx, .pdf, .xls or .xlsx format.

Request header

Request body

Request Method:POST
...
Accept:application/json
...
APICode:A1F1BAE8-3F1B-4B8D-8D95-D19E17595034
...
Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryMsjJ3JrEorerhu6H
...
------WebKitFormBoundaryMsjJ3JrEorerhu6H
Content-Disposition: form-data; name="FileUrl"


------WebKitFormBoundaryMsjJ3JrEorerhu6H
Content-Disposition: form-data; name="File"; filename="INVOICE_TEST.pdf"
Content-Type: application/octet-stream
...

In case of success, Status Code:200 is shown in the response, otherwise Error is shown.

In case of error in the request or when Invoice note cannot be added/updated, one of following error appears in the response.

Example of Response with error in JSON

{
    "error":{
        "message":"Order is already shipped or cancelled",
        "code":103
    }
}

Example of Response with error in XML

<InvoiceResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>Incorrect document link format</Message>
    <Code>104</Code>
  </Error>
</InvoiceResponse>