Site Tools

Invoice Add/Update API

What is the Invoice Add/Update API?

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

Who Should Use this API?

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

Try it Out

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:

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:

How Does it Work?

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:[Order ID]/invoice

To use APIs of the sandbox, the POST needs to be submitted to:[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.


Structure of the Request

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

What Type Required Explanation
ApiCode String (36) required format: Guid Y ApiCode received from i.materialise. This parameter should be sent in header of request.
Accept String N (“text/xml” is used by default) Preferred Content Type: multipart/form-data. This parameter should be sent in header of request.

Request body

What Type Required Explanation
FileUrl URL Y (if File is not defined) The URL where the i.materialise server can download the Invoice from.

It is not allowed to specify a File and FileUrl in the same request.
File File Y (if FileUrl is not defined) File ofInvoice.

The delivery note will be inserted into the shipment box.

It is not allowed to specify a File and FileUrl in the same request.

Request example

Request Method:POST
Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryMsjJ3JrEorerhu6H
Content-Disposition: form-data; name="FileUrl"

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

Structure of the Response

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

Errors Section of the Response

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

Code Message Description
100 Order ID is wrong Wrong Order ID was determined in request
101 Wrong API code The order was created by using different API code.
103 Order is already shipped or cancelled Invoice Add/Update API cannot be used for shipped and cancelled orders
104 Incorrect document link format The specified url was not recognized as a link
105 Document cannot be downloaded or timeout The server could not download a file using the specified fileUrl
106 Document file format is not supported. File should be of one of formats .doc, .docx, .pdf, .xls, .xlsx Invoice file extention is not .doc, .docx, .pdf, .xls, .xlsx
107 No document in request No invoice file specified
108 Invoice file cannot be empty File cannot be empty.
109 Invoice file should be not more than 10MB. Exceeded maximum size of delivery note document 10MB.
110 Please, use either FileUrl or File, but not both within the same request. It is not allowed to specify a File and FileUrl in the same request.

Example of Response with error in JSON

        "message":"Order is already shipped or cancelled",

Example of Response with error in XML

<InvoiceResponse xmlns:xsd="" xmlns:xsi="">
    <Message>Incorrect document link format</Message>