Skip to content

InvoiceXpress API (2.0.0)

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

Welcome to our API v2 in JSON

If you're reading this, let me guess, you need to issue invoices but don't want to lose focus from building a great solution and writing amazing code. Did we cover your scenario? Ok, great. Let's do this.

Quick Start

  1. Sign up FREE for 30 days
  2. Get your API key
  3. Create an Invoice

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

SAF-T

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

Operations

Clients

A Client is an entity you send invoices to.

Operations

Items

An Item is the product or service you invoice.

Operations

Treasury

Section dedicated to treasury movements.

Operations

Get Client Balance

Request

Returns the balance of a specific client.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Bodyapplication/json
currencyobject
initial_balanceobject
balanceobject
overdue_balanceobject
remaining_balanceobject
Response
application/json
{
  "currency": {
    "symbol": "€",
    "code": "EUR"
  },
  "initial_balance": {
    "value": 0,
    "created_at": "1970-01-01",
    "observation": "null"
  },
  "balance": {
    "with_vat": 0,
    "without_vat": 0
  },
  "overdue_balance": {
    "with_vat": 0,
    "without_vat": 0
  },
  "remaining_balance": {
    "total": 0,
    "value": 0
  }
}

Update Initial Balance

Request

Updates the initial balance of a specific client.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
initial_balanceobjectrequired
initial_balance.​valuenumberrequired
Example: 123.45
initial_balance.​datestringrequired
Example: "2023-05-19"
initial_balance.​observationstring
Example: "null"
curl -i -X PUT \
  'https://docs.invoicexpress.com/_mock/api/v3/clients/12345/initial_balance.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "initial_balance": {
      "value": 123.45,
      "date": "2023-05-19",
      "observation": "null"
    }
  }'

Responses

SUCCESS

Bodyapplication/json
initial_balanceobject
Response
application/json
{
  "initial_balance": {
    "value": 123.45,
    "date": "2023-05-19",
    "observation": "null"
  }
}

Get Client Regularization

Request

Returns a list of all your client’s regularization.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Bodyapplication/json
regularizationArray of objects
paginationobject
Response
application/json
{
  "regularization": [
    { … }
  ],
  "pagination": {
    "total_entries": 1,
    "current_page": 1,
    "total_pages": 1,
    "per_page": 10
  }
}

Create Regularization

Request

Creates a new client’s regularization.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
regularizationobjectrequired
regularization.​valuenumberrequired
Example: 123.45
regularization.​datestringrequired
Example: "2023-08-24"
regularization.​observationstring
Example: "null"
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/api/v3/clients/12345/regularization.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "regularization": {
      "value": 123.45,
      "date": "2023-08-24",
      "observation": "null"
    }
  }'

Responses

SUCCESS

Bodyapplication/json
regularizationArray of objects
Response
application/json
{
  "regularization": [
    { … }
  ]
}

Delete Regularization

Request

Deletes a client’s regularization.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
idintegerrequired

The ID of the regularization you want to delete.

Example: 1
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Response
No content

Create Treasury Movement

Request

Creates a new client’s treasury movement.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
treasury_movementobjectrequired
treasury_movement.​valuenumberrequired
Example: 123.45
treasury_movement.​movement_typestringrequired
Enum"Reimbursement""Payment"
Example: "Reimbursement"
treasury_movement.​payment_methodstring

Treasury movement can be CC “Cartão de crédito”, CD “Cartão de débito”, CH “Cheque bancário”, CI “Crédito documentário internacional”, CO “Cheque ou cartão oferta”, CS “Compensação de saldos de conta corrente”, DE “Dinheiro electrónico”, LC “Letra comercial”, MB “Referências de pagamento para Multibanco”, NU “Numerário”, or “Outros meios aqui não assinalados”, PR “Permuta de bens”, TB “Transferência bancária ou débito direto autorizado”, TR “Ticket restaurante”

Example: "MB"
treasury_movement.​datestringrequired
Example: "2023-04-28"
treasury_movement.​seriestring
Example: "2023"
treasury_movement.​observationstring
Example: "Payment observation"
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/api/v3/clients/12345/treasury_movements.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "treasury_movement": {
      "value": 123.45,
      "movement_type": "Reimbursement",
      "payment_method": "MB",
      "date": "2023-04-28",
      "serie": "2023",
      "observation": "Payment observation"
    }
  }'

Responses

SUCCESS

Bodyapplication/json
treasury_movementobject
Response
application/json
{
  "treasury_movement": {
    "value": 123.45,
    "movement_type": "Reimbursement",
    "payment_method": "MB",
    "date": "2023-04-28",
    "serie": "2023",
    "observation": "null"
  }
}

Delete Treasury Movement

Request

Deletes a client’s treasury movement.

Security
apiKeyAuth
Path
client_idstringrequired

ID of the client.

Example: 12345
idintegerrequired

The ID of the regularization you want to delete.

Example: 1
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Response
No content
Copyleft © Redocly Inc. No rights reserved.