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

Taxes

A Tax is applied to invoice items when creating invoices.

Operations

List All Taxes

Request

Returns all your taxes.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

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

Responses

Success.

Bodyapplication/json
taxesArray of objects
Response
application/json
{
  "taxes": [
    { … }
  ]
}

Create Taxes

Request

Creates a new tax.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
taxobjectrequired
tax.​namestringrequired

Tax name

Example: "IVA23"
tax.​valuestringrequired

Tax value (%)

Example: "23.0"
tax.​regionstring

Tax region. Required to export SAF-T PT.

Must be one of: PT, PT-AC, PT-MA, Desconhecido, or country codes.

Example: "PT"
tax.​codestring

Tax code.

Must be one of: NOR (Normal), INT (Intermediate), RED (Reduced), OUT (Other), ISE (Exempt).

Enum"NOR""INT""RED""OUT""ISE"
Example: "NOR"
tax.​default_taxinteger

If "1", the tax is chosen as the default tax on your account.

Example: 1
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/taxes.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tax": {
      "name": "IVA23",
      "value": "23.0",
      "region": "PT",
      "code": "NOR",
      "default_tax": 1
    }
  }'

Responses

SUCCESS

Bodyapplication/json
taxobject
Response
application/json
{
  "tax": {
    "id": 31540,
    "name": "IVA23",
    "value": 23,
    "region": "PT",
    "code": "NOR",
    "default_tax": 1
  }
}

Get Taxes

Request

Returns a specific tax.

Security
apiKeyAuth
Path
taxes_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/taxes/12345.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'

Responses

Success.

Bodyapplication/json
taxobject
Response
application/json
{
  "tax": {
    "id": 31540,
    "name": "IVA23",
    "value": 23,
    "region": "PT",
    "code": "NOR",
    "default_tax": 1
  }
}

Update Taxes

Request

Updates a tax.

Security
apiKeyAuth
Path
taxes_idstringrequired

ID of the sequence to register.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
taxobjectrequired
tax.​namestringrequired

Tax name

Example: "IVA23"
tax.​valuestringrequired

Tax value (%)

Example: "23.0"
tax.​regionstring

Tax region. Required to export SAF-T PT.

Must be one of: PT, PT-AC, PT-MA, Desconhecido, or country codes.

Example: "PT"
tax.​codestring

Tax code.

Must be one of: NOR (Normal), INT (Intermediate), RED (Reduced), OUT (Other), ISE (Exempt).

Enum"NOR""INT""RED""OUT""ISE"
Example: "NOR"
tax.​default_taxinteger

If "1", the tax is chosen as the default tax on your account.

Example: 1
curl -i -X PUT \
  'https://docs.invoicexpress.com/_mock/taxes/12345.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tax": {
      "name": "IVA23",
      "value": "23.0",
      "region": "PT",
      "code": "NOR",
      "default_tax": 1
    }
  }'

Responses

Success

Response
No content

Delete Tax

Request

Deletes a tax.

Security
apiKeyAuth
Path
taxes_idstringrequired

ID of the sequence to register.

Example: 12345
Query
api_keystringrequired

Your API Key.

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

Responses

Success

Response
No content

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.