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

Create Account

Request

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
accountobjectrequired
account.​first_namestring
Example: "John"
account.​last_namestring
Example: "Doe"
account.​organization_namestringrequired
Example: "My Company"
account.​phonestring
Example: "912345678"
account.​emailstringrequired
Example: "john.doe@example.com"
account.​passwordstringrequired
Example: "secret123"
account.​fiscal_idstring
Example: "500100200"
account.​tax_countrystring
Enum"1""2""3"
Example: "1"
account.​languagestring
Enum"pt""en""es"
Example: "pt"
account.​termsstringrequired
Enum"1""0"
Example: "1"
account.​marketingstring
Enum"1""0"
Example: "0"
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/api/accounts/create.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "first_name": "John",
      "last_name": "Doe",
      "organization_name": "My Company",
      "phone": "912345678",
      "email": "john.doe@example.com",
      "password": "secret123",
      "fiscal_id": "500100200",
      "tax_country": "1",
      "language": "pt",
      "terms": "1",
      "marketing": "0"
    }
  }'

Responses

SUCCESS

Bodyapplication/json
accountobject
Response
application/json
{
  "account": {
    "id": "12345",
    "name": "My Company",
    "url": "https://mycompany.app.invoicexpress.com",
    "api_key": "abc123xyz456",
    "state": "active"
  }
}

Create for existing user

Request

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
accountobjectrequired
account.​first_namestring
Example: "John"
account.​last_namestring
Example: "Doe"
account.​organization_namestringrequired
Example: "My Company"
account.​phonestring
Example: "912345678"
account.​emailstringrequired
Example: "john.doe@example.com"
account.​passwordstringrequired
Example: "secret123"
account.​fiscal_idstring
Example: "500100200"
account.​tax_countrystring
Enum"1""2""3"
Example: "1"
account.​languagestring
Enum"pt""en""es"
Example: "pt"
account.​termsstringrequired
Enum"1""0"
Example: "1"
account.​marketingstring
Enum"1""0"
Example: "0"
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/api/accounts/create_already_user.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "first_name": "John",
      "last_name": "Doe",
      "organization_name": "My Company",
      "phone": "912345678",
      "email": "john.doe@example.com",
      "password": "secret123",
      "fiscal_id": "500100200",
      "tax_country": "1",
      "language": "pt",
      "terms": "1",
      "marketing": "0"
    }
  }'

Responses

SUCCESS

Bodyapplication/json
accountobject
Response
application/json
{
  "account": {
    "id": "12345",
    "name": "My Company",
    "url": "https://mycompany.app.invoicexpress.com",
    "api_key": "abc123xyz456",
    "state": "active"
  }
}

Get Account

Request

Security
apiKeyAuth
Path
account-idintegerrequired
Example: 1
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS.

Bodyapplication/json
accountobject
Response
application/json
{
  "account": {
    "organization_name": "My Company",
    "fiscal_id": "500100200",
    "email": "john.doe@example.com",
    "state": "active",
    "at_configured": true,
    "trial": true
  }
}

Update Account

Request

Security
apiKeyAuth
Path
account-idintegerrequired
Example: 1
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
accountobjectrequired
account.​first_namestring
Example: "My New Company Name"
account.​last_namestring
Example: "My New Company Name"
account.​organization_namestringrequired
Example: "My New Company Name"
account.​phonestring
Example: "210000000"
account.​emailstringrequired
Example: "billing@company.com"
account.​passwordstringrequired
Example: "secret123"
account.​fiscal_idstring

Cannot be changed

Example: "500100200"
account.​addressstring
Example: "Main Street, 123"
account.​citystring
Example: "Lisbon"
account.​postal_codestring
Example: "1000-001"
account.​websitestring
Example: "www.company.com"
account.​faxstring
Example: "210000001"
account.​termsstringrequired
Enum"1""0"
Example: "1"
account.​credentialsobject(Credentials)

AT Credentials.

curl -i -X PUT \
  'https://docs.invoicexpress.com/_mock/api/accounts/1/update.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "first_name": "My New Company Name",
      "last_name": "My New Company Name",
      "organization_name": "My New Company Name",
      "phone": "210000000",
      "email": "billing@company.com",
      "password": "secret123",
      "fiscal_id": "500100200",
      "address": "Main Street, 123",
      "city": "Lisbon",
      "postal_code": "1000-001",
      "website": "www.company.com",
      "fax": "210000001",
      "terms": "1",
      "credentials": {
        "username": "500100200/1",
        "password": "cGFzc3dvcmQ=",
        "type": "AT",
        "context": "Sequences"
      }
    }
  }'

Responses

SUCCESS

Response
No content

AT Communication

Request

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
at_communicationobjectrequired
at_communication.​at_subuserstringrequired
Example: "500100200/1"
at_communication.​at_passwordstringrequired
Example: "cGFzc3dvcmQ="
at_communication.​communication_typestringrequired
Enum"auto""manual""guides""portal_at"
Example: "auto"
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/api/v3/accounts/at_communication.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "at_communication": {
      "at_subuser": "500100200/1",
      "at_password": "cGFzc3dvcmQ=",
      "communication_type": "auto"
    }
  }'

Responses

SUCCESS

Bodyapplication/json
successstring
Example: "true"
Response
application/json
{
  "success": "true"
}

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

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.