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

List All Items

Request

Returns a list of all your items.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
pageinteger

You can ask for a specific page of results. Defaults to 1.

Example: page=1
per_pageinteger

You can specify how many results you want to fetch. Defaults to 10 or value defined in account settings (10, 20 or 30).

Example: per_page=30
curl -i -X GET \
  'https://docs.invoicexpress.com/_mock/items.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE&page=1&per_page=30'

Responses

SUCCESS

Bodyapplication/json
itemsArray of objects
Response
application/json
{
  "items": [
    { … }
  ]
}

Create Item

Request

Creates a new item.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
itemobjectrequired
item.​namestringrequired
Example: "Item name"
item.​descriptionstringrequired
Example: "Item description"
item.​unit_pricenumberrequired
Example: 9.99
item.​unitstring
Example: "service"
item.​taxobject
curl -i -X POST \
  'https://docs.invoicexpress.com/_mock/items.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "name": "Item name",
      "description": "Item description",
      "unit_price": 9.99,
      "unit": "service",
      "tax": {
        "name": "IVA23"
      }
    }
  }'

Responses

SUCCESS. Returns the created item.

Bodyapplication/json
itemobject
Response
application/json
{
  "item": {
    "id": 402321,
    "name": "Medium",
    "description": "foo",
    "unit_price": 16.2602,
    "unit": "service",
    "tax": { … }
  }
}

Get Item

Request

Returns a specific item.

Security
apiKeyAuth
Path
item_idstringrequired

ID of the item.

Example: 12345
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Bodyapplication/json
itemobject
Response
application/json
{
  "item": {
    "id": 402321,
    "name": "Medium",
    "description": "foo",
    "unit_price": 16.2602,
    "unit": "service",
    "tax": { … }
  }
}

Update Item

Request

Updates an item.

Security
apiKeyAuth
Path
item_idstringrequired

ID of the item.

Example: 12345
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
itemobjectrequired
item.​namestringrequired
Example: "Item name"
item.​descriptionstringrequired
Example: "Item description"
item.​unit_pricenumberrequired
Example: 9.99
item.​unitstring
Example: "service"
item.​taxobject
curl -i -X PUT \
  'https://docs.invoicexpress.com/_mock/items/12345.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "name": "Item name",
      "description": "Item description",
      "unit_price": 9.99,
      "unit": "service",
      "tax": {
        "name": "IVA23"
      }
    }
  }'

Responses

SUCCESS

Response
No content

Delete Item

Request

Deletes an item.

Security
apiKeyAuth
Path
item_idstringrequired

ID of the item.

Example: 12345
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Response
No content

Treasury

Section dedicated to treasury movements.

Operations
Copyleft © Redocly Inc. No rights reserved.