Skip to content

InvoiceXpress API (2.0.0)

Endpoints for managing Accounts, Invoices, Estimates, and organization data in InvoiceXpress.

Download OpenAPI description
index.json
index.yaml
Overview
InvoiceXpress API Support
support@invoicexpress.com
Languages
Servers
Mock server
https://docs.invoicexpress.com/_mock/
Production Server
https://{account_name}.app.invoicexpress.com/

Accounts

Create, update and get info about your account.

Operations

Invoices

Create invoices, invoice receipts, simplified invoices, vat moss invoices, credit notes & debit notes and send them to your clients.

Operations

Estimates

Create quotes, proformas or fees notes and send them to your clients.

Operations

Guides

Create shippings, transports & devolutions and send them to your clients.

Operations

Sequences

A Sequence is used to group invoices in a sequential order.

Operations

Register Sequence

Request

Registers a document sequence with the Tax Authority (AT).

Security
apiKeyAuth
Path
sequence_idstringrequired

ID of the sequence to register.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -i -X PUT \
  'https://docs.invoicexpress.com/_mock/sequences/12345/register.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'

Responses

OK


Possible values for fields current_<document type>_validation_code:

ValueDescription
ABCD1234Validation code for each sequence that is registered in the Tax Authority.
N/DThe sequence is relevant for ATCUD but is not registered in the Tax Authority.
N/AThe sequence is not relevant for ATCUD and is not registered in the Tax Authority.
Bodyapplication/json
sequencesArray of objects
Response
application/json
{
  "sequences": [
    { … }
  ]
}

List All Sequences

Request

Returns all your sequences.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -i -X GET \
  'https://docs.invoicexpress.com/_mock/sequences.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'

Responses

Success.


Possible values for fields current_<document type>_validation_code:

ValueDescription
ABCD1234Validation code for each sequence that is registered in the Tax Authority.
N/DThe sequence is relevant for ATCUD but is not registered in the Tax Authority.
N/AThe sequence is not relevant for ATCUD and is not registered in the Tax Authority.
Bodyapplication/json
sequencesArray of objects
Response
application/json
{
  "sequences": [
    { … }
  ]
}

Create Sequence

Request

Creates and registers a new sequence. For portuguese accounts, it’s necessary to have AT credentials configured.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
sequenceobjectrequired
sequence.​seriestringrequired

Series name

Example: "2023"
sequence.​default_sequencestring

If "1", this sequence is chosen as the default sequence. Other values are ignored.

Example: "1"
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/sequences.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sequence": {
      "serie": "2023",
      "default_sequence": "1"
    }
  }'

Responses

SUCCESS. Created.


Possible values for fields current_<document type>_validation_code:

ValueDescription
ABCD1234Validation code for each sequence that is registered in the Tax Authority.
N/DThe sequence is relevant for ATCUD but is not registered in the Tax Authority.
N/AThe sequence is not relevant for ATCUD and is not registered in the Tax Authority.
Bodyapplication/json
sequencesobject
Response
application/json
{
  "sequences": {
    "id": 146090,
    "serie": "2022",
    "default_sequence": 1,
    "current_invoice_number": 0,
    "current_invoice_sequence_id": 146090,
    "current_invoice_validation_code": "ABCD1230",
    "current_invoice_receipt_number": 0,
    "current_invoice_receipt_sequence_id": 146092,
    "current_invoice_receipt_validation_code": "ABCD1231",
    "current_simplified_invoice_number": 0,
    "current_simplified_invoice_sequence_id": 146091,
    "current_simplified_invoice_validation_code": "ABCD1232",
    "current_credit_note_number": 0,
    "current_credit_note_sequence_id": 146095,
    "current_credit_note_validation_code": "ABCD1233",
    "current_debit_note_number": 0,
    "current_debit_note_sequence_id": 146094,
    "current_debit_note_validation_code": "ABCD1234",
    "current_receipt_number": 0,
    "current_receipt_sequence_id": 146093,
    "current_receipt_validation_code": "ABCD1235",
    "current_shipping_number": 0,
    "current_shipping_sequence_id": 146104,
    "current_shipping_validation_code": "ABCD1236",
    "current_transport_number": 0,
    "current_transport_sequence_id": 146106,
    "current_transport_validation_code": "ABCD1237",
    "current_devolution_number": 0,
    "current_devolution_sequence_id": 146105,
    "current_devolution_validation_code": "ABCD1238",
    "current_proforma_number": 0,
    "current_proforma_sequence_id": 146102,
    "current_proforma_validation_code": "ABCD1239",
    "current_quote_number": 0,
    "current_quote_sequence_id": 146101,
    "current_quote_validation_code": "ABCD1240",
    "current_fees_note_number": 0,
    "current_fees_note_sequence_id": 146103,
    "current_fees_note_validation_code": "N/A",
    "current_vat_moss_invoice_number": 0,
    "current_vat_moss_invoice_sequence_id": 146097,
    "current_vat_moss_invoice_validation_code": "N/A",
    "current_vat_moss_credit_note_number": 0,
    "current_vat_moss_credit_note_sequence_id": 146098,
    "current_vat_moss_credit_note_validation_code": "N/A",
    "current_vat_moss_receipt_number": 0,
    "current_vat_moss_receipt_sequence_id": 146099,
    "current_vat_moss_receipt_validation_code": "N/A"
  }
}

Get Sequence

Request

Returns a specific sequence.

Security
apiKeyAuth
Path
sequence_idstringrequired

ID of the sequence to register.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -i -X GET \
  'https://docs.invoicexpress.com/_mock/sequences/12345.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'

Responses

Success.


Possible values for fields current_<document type>_validation_code:

ValueDescription
ABCD1234Validation code for each sequence that is registered in the Tax Authority.
N/DThe sequence is relevant for ATCUD but is not registered in the Tax Authority.
N/AThe sequence is not relevant for ATCUD and is not registered in the Tax Authority.
Bodyapplication/json
sequencesobject
Response
application/json
{
  "sequences": {
    "id": 146090,
    "serie": "2022",
    "default_sequence": 1,
    "current_invoice_number": 0,
    "current_invoice_sequence_id": 146090,
    "current_invoice_validation_code": "ABCD1230",
    "current_invoice_receipt_number": 0,
    "current_invoice_receipt_sequence_id": 146092,
    "current_invoice_receipt_validation_code": "ABCD1231",
    "current_simplified_invoice_number": 0,
    "current_simplified_invoice_sequence_id": 146091,
    "current_simplified_invoice_validation_code": "ABCD1232",
    "current_credit_note_number": 0,
    "current_credit_note_sequence_id": 146095,
    "current_credit_note_validation_code": "ABCD1233",
    "current_debit_note_number": 0,
    "current_debit_note_sequence_id": 146094,
    "current_debit_note_validation_code": "ABCD1234",
    "current_receipt_number": 0,
    "current_receipt_sequence_id": 146093,
    "current_receipt_validation_code": "ABCD1235",
    "current_shipping_number": 0,
    "current_shipping_sequence_id": 146104,
    "current_shipping_validation_code": "ABCD1236",
    "current_transport_number": 0,
    "current_transport_sequence_id": 146106,
    "current_transport_validation_code": "ABCD1237",
    "current_devolution_number": 0,
    "current_devolution_sequence_id": 146105,
    "current_devolution_validation_code": "ABCD1238",
    "current_proforma_number": 0,
    "current_proforma_sequence_id": 146102,
    "current_proforma_validation_code": "ABCD1239",
    "current_quote_number": 0,
    "current_quote_sequence_id": 146101,
    "current_quote_validation_code": "ABCD1240",
    "current_fees_note_number": 0,
    "current_fees_note_sequence_id": 146103,
    "current_fees_note_validation_code": "N/A",
    "current_vat_moss_invoice_number": 0,
    "current_vat_moss_invoice_sequence_id": 146097,
    "current_vat_moss_invoice_validation_code": "N/A",
    "current_vat_moss_credit_note_number": 0,
    "current_vat_moss_credit_note_sequence_id": 146098,
    "current_vat_moss_credit_note_validation_code": "N/A",
    "current_vat_moss_receipt_number": 0,
    "current_vat_moss_receipt_sequence_id": 146099,
    "current_vat_moss_receipt_validation_code": "N/A"
  }
}

Set Sequence as Default

Request

Sets a specific sequence as the default.

Security
apiKeyAuth
Path
sequence_idstringrequired

ID of the sequence to register.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -i -X PUT \
  'https://docs.invoicexpress.com/_mock/sequences/12345/set_current.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'

Responses

SUCCESS

Response
No content

Taxes

A Tax is applied to invoice items when creating invoices.

Operations

SAFT

Export the Standard Audit File for Tax (SAF-T PT) required by the Portuguese Tax Authority.

SAF-T

Operations
Copyleft © Redocly Inc. No rights reserved.