API-v1

Application Programming Interface

InvoiceXpress Documentation



Change Log


23rd March 2017

Add payment_days and tax_exemption_code to clients.get endpoint. Check clients.get for details.


27th October 2016

Documents in draft state can be downloaded as PDFs.


20th October 2016

Info about request limits can be found here.


10th October 2016

Add inverted_sequence_number to document responses. This param returns the sequence number in the following format (serie/number), e.g. A/1. Please refer to the documentation.


22nd June 2016

Added saft hash element on get document endpoint. Please refer to the documentation. Saft hash is the four letter code associated with a document, that must be present when printed.


14th March 2016

Documents can be download as second copy. Please refer to the documentation.


18th February 2016

Add logo parameter on send document by email. Please refer to the documentation.


21st January 2016

Serie is optional on partial payment endpoint. Check invoices.partial_payment for details.


12nd January 2016

Partial payment endpoint return receipt data on body response. Check invoices.partial_payment for details.


28th October 2015

Make partial payments for documents. Check invoices.partial_payment for details.


7th October 2015

Invoices can now be filtered when listing them. Check invoices.list for details.

Estimates can now be filtered when listing them. Check quotes.list for details.

Guides can now be filtered when listing them. Check transport-guides.list for details.

Purchase Orders can now be filtered when listing them. Check purchase-orders.list for details.


1st October 2015

New endpoint to archive a document. Check invoices.archive for details.

New endpoint to unarchive a document. Check invoices.unarchive for details.


18th August 2015

New endpoint to update an account. Check accounts.update for details.


12th August 2015

New endpoint to suspend an account. Check accounts.suspend for details.

New endpoint to activate an account. Check accounts.activate for details.


9th August 2015

New endpoint to get subscription and plan data for an account. Check accounts.stats for details.


6th August 2015

New endpoint to get account data. Check accounts.get for details.


8th June 2015

Sequences allow JSON requests.


3rd June 2015

Set a sequence as the default sequence.


2nd June 2015

Added city field to client data.


26th May 2015

Taxes allow JSON requests.


3rd February 2015

Added a new endpoint to get related documents for an invoice. Check Related documents for details.

Added a new endpoint to get related documents for a simplified invoice. Check Related documents for details.


2nd February 2015

Added a new endpoint to download PDFs. Check Generate PDF for more details.

Added a new endpoint to create accounts. Check Accounts for more details.


1st December 2014

Added API for Invoice Receipts.

Added API for Transport Guides, Shipping Guides and Devolution Guides.

Added API for Quotes, Proformas and Fees Notes.


29th September 2013

Simplified invoices now have the same state machine as invoices (you need to finalize and settle).

When changing state to settled, a new receipt will be created.

Added endpoint to retrieve related documents.


20th December 2012

Added API for simplified invoices (Portugal only).


21th March 2012

Added a permalink element when getting all types of documents.

It’s now possible to handle clients via a code.

Added a new endpoint to find clients by code.


30th December 2011

Added several endpoints to allow creating documents for a specific client. Please check the new client functions.


28th December 2011

Added top debtors endpoint. Check documentation here

Added quarterly-results endpoint. Check documentation here ] Changed top clients endpoint response. Check documentation here


26th December 2011

Authentication documentation re-written.

Added clients/find-by-name endpoint. Please refer to the documentation for more details.


28th November 2011

Added login endpoint which accepts current login and password for a user, and it returns all the accounts that belong to him respectively. Please refer to the documentation for more details.

Added client invoices endpoint which accepts the client id and a filter, and returns all the invoices filtered for that client. Please refer to the documentation for more details.


12th July 2011

Dashboard charts data can now be obtained via API. Please refer to the documentation to see how it works.


7th April 2011

Credit notes can now be managed via API. Please refer to the documentation to see how it works. Special note for credit_notes.list which allows page and per_page optional params.

Debit notes can now be managed via API. Please refer to the documentation to see how it works. Special note for debit_notes.list which allows page and per_page as optional params.

Minor typos fixed on the documentation.


16th March 2011

Added page and per_page option to users.list. Please refer to the documentation.


9th March 2011

Cash invoices can now be managed via API. Please refer to the documentation to see how it works. Special note for cash_invoices.list which allows page and per_page as optional params.


8th January 2011

Added invoice timeline when requesting a particular invoice. Invoice timeline includes all the events that occured. You can check when and who created it. This can be obtained via invoices.get. Please refer to invoices.get for more details. All other types of invoice documents will inherit this behaviour when they are available.


2nd August 2010

MB reference can now be activated upon creating or updating an invoice via API. When an invoice is finalized, the MB reference is generated and included on the invoices.get response. All other types of invoice documents will inherit this behaviour when they are available. This option is only available for accounts which have CompraFacil enabled.


6th April 2010

Added endpoint to view accounts which are associated with the user making the API request. Please refer to the documentation for more details.

Added endpoint to change current account. Please refer to the documentation for more details.

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
Livro de Reclamação