API-v1

Application Programming Interface

InvoiceXpress Documentation

Documentation Introduction Accounts Users Invoices Invoice Receipts Simplified Invoices Credit Notes Debit Notes Transport Guides Shipping Guides Devolution Guides Quotes Proformas Fees Notes Clients Items Purchase Orders Schedules Taxes Sequences Dashboard Appendix List

Generate PDF

debit-notes.pdf

Returns the url of the PDF for the specified document. This is an asynchronous operation, which means the PDF file may not be ready immediately.

Usage

The correct usage pattern is to use a polling technique. You call this endpoint by submitting an HTTP GET request to the following URL:

https://{account-name}.app.invoicexpress.com/api/pdf/{debit-note-id}.xml

Parameters

Property Required Description
api_key Yes Your secret identifier. You can find your API Key under Account >> API in the Account section.
debit-note-id Yes The debit-note to convert to PDF.
second_copy No True to download copy of original document. If missing, the default value will be false.

Return Values

These are the results that will be returned on success and error.

Success

If successful, there are 2 valid responses:

First

The first one says that the request will be processed and you need to try again. This response is described by the following table:

Code Description
HTTP: 202 Accepted The request will be processed. You need to keep requesting until you get a response with HTTP status code 200.
Second

The second possible response says that the request was processed successfully and the url is passed back in the response in the following format:

Code Description
HTTP: 200 OK The request has been successfully processed.
<output>
 <pdfUrl>http://sum.url</pdfUrl>
</output>
Error
Code Description
HTTP: 401 Access denied The API Key parameter is missing or is incorrectly entered.
HTTP: 404 Not Found No debit-note matches the supplied {debit-note-id}.
HTTP: 406 Not Acceptable The {debit-note-id} provided is in an invalid state.

Engenharia e Design ao seu serviço!

Uma equipa de Engenharia e Produto que pensam, desenham e executam em detalhe cada pormenor da experiência dos utilizadores.

Uma equipa ao seu dispor que trabalha diariamente para si.

Conhecer o InvoiceXpress