InvoiceXpress API

https://docs.invoicexpress.com/
Admin
InvoiceXpress API is a JSON REST API for creating and managing invoices, estimates, guides, clients,...
Tokens:59,976
Snippets:711
Trust Score:9.3
Update:20 hours ago
Show doc for...
Tokens:
Raw
### GET /guides.json

Source: https://docs.invoicexpress.com/guides.md

Returns a list of guides (Shippings, Transports and Devolutions). This endpoint is used to retrieve all guide documents.

```APIDOC
## GET /guides.json

### Description
Returns a list of guides (Shippings, Transports and Devolutions). This endpoint is used to retrieve all guide documents.

### Method
GET

### Endpoint
/guides.json

```

--------------------------------

### GET /taxes.json

Source: https://docs.invoicexpress.com/index.html.md

Returns all your taxes.

```APIDOC
## [GET] /taxes.json

### Description
Returns all your taxes.

### Method
GET

### Endpoint
/taxes.json

```

--------------------------------

### GET /{guides-type}/{document-id}.json

Source: https://docs.invoicexpress.com/guides.md

Retrieves a specific guide document by its ID and type. This endpoint is used to fetch details of a shipping, transport, or devolution.

```APIDOC
## GET /{guides-type}/{document-id}.json

### Description
Retrieves a specific guide document by its ID and type. This endpoint is used to fetch details of a shipping, transport, or devolution.

### Method
GET

### Endpoint
/{guides-type}/{document-id}.json

### Parameters
#### Path Parameters
- **guides-type** (string) - Required - The type of guide: shipping, transport, or devolution.
- **document-id** (integer) - Required - The ID of the guide document to retrieve.

```

--------------------------------

### GET /clients.json

Source: https://docs.invoicexpress.com/clients.md

Returns a list of all your clients.

```APIDOC
## GET /clients.json

### Description
Returns a list of all your clients.

### Method
GET

### Endpoint
/clients.json

```

--------------------------------

### GET /sequences.json

Source: https://docs.invoicexpress.com/index.html.md

Returns all your sequences.

```APIDOC
## [GET] /sequences.json

### Description
Returns all your sequences.

### Method
GET

### Endpoint
/sequences.json

```

--------------------------------

### GET /items.json

Source: https://docs.invoicexpress.com/index.html.md

Returns a list of all your items.

```APIDOC
## GET /items.json

### Description
Returns a list of all your items.

### Method
GET

### Endpoint
/items.json

```

--------------------------------

### Shipping Guide Fields

Source: https://docs.invoicexpress.com/guides/updateguide.md

Describes the request and response fields for the shipping guide resource, including item details, addresses, and tax information.

```APIDOC
## Shipping Guide Fields

### Description
This section documents the fields used when creating or retrieving a shipping guide. The wrapper key is "shipping" for the singular guide type.

### Request Fields

- `shipping.items.quantity` (string, required) - Example: "5"
- `shipping.items.unit` (string) - Restricted to a fixed set of unit values. Example: "service"
- `shipping.items.discount` (string) - Example: "50"
- `shipping.items.tax` (object)
- `shipping.tax_exemption_reason` (string) - Validated at 210 characters. Example: "M00"
- `shipping.load_site` (string) - No enforced character limit. Example: "Lisbon, Portugal"
- `shipping.delivery_site` (string) - No enforced character limit. Example: "Madrid, Spain"

### Response Fields (200 OK, application/json)

- `shipping` (object) - Wrapper key matches the singular of the requested guide type.
- `shipping.id` (integer) - Example: 541797
- `shipping.status` (string) - Example: "final"
- `shipping.archived` (boolean)
- `shipping.type` (string) - Example: "Shipping"
- `shipping.sequence_number` (string) - Example: "1/D"
- `shipping.inverted_sequence_number` (string) - Example: "D/1"
- `shipping.atcud` (string) - Example: "ABCD1234-1"
- `shipping.date` (string) - Example: "13/07/2017"
- `shipping.due_date` (string) - Format: dd/mm/yyyy. Example: "27/07/2026"
- `shipping.reference` (string, null)
- `shipping.observations` (string, null) - No enforced character limit.
- `shipping.retention` (string, null)
- `shipping.loaded_at` (string) - Format: dd/mm/yyyy HH:mm:ss. Example: "27/07/2026 23:00:00"
- `shipping.license_plate` (string, null) - Example: "11-AA-22"
- `shipping.permalink` (string) - Example: "https://web.invoicexpress.com/documents/541797d75bbee48911934cbd4a4294946a324295f52b08"
- `shipping.saft_hash` (string) - No enforced character limit. Example: "vaDf"
- `shipping.sum` (number) - Example: 1
- `shipping.discount` (number)
- `shipping.before_taxes` (number) - Example: 1
- `shipping.taxes` (number) - Example: 0.07
- `shipping.total` (number) - Example: 1.07
- `shipping.currency` (string) - Example: "Euro"
- `shipping.address_from` (object)
- `shipping.address_from.country` (string) - Example: "Portugal"
- `shipping.address_from.postal_code` (string) - Example: "1050-083"
- `shipping.address_from.detail` (string) - Example: "Avenida Duque D'Avila, 46 - 3ºA"
- `shipping.address_from.city` (string) - Example: "Lisboa"
- `shipping.address_to` (object)
- `shipping.client` (object)
- `shipping.client.name` (string) - Example: "John"
- `shipping.client.country` (string) - Example: "Portugal"
- `shipping.items` (array)
- `shipping.items.name` (string) - Maximum 60 characters. Example: "iPhone"
- `shipping.items.description` (string, null) - Maximum 200 characters and 20 lines.
- `shipping.items.unit_price` (string) - Example: "1.0"
- `shipping.items.unit` (string, null) - Restricted to a fixed set of unit values. Example: "service"
- `shipping.items.quantity` (string) - Example: "1.0"
- `shipping.items.tax` (object)
- `shipping.items.tax.value` (number) - Example: 7
- `shipping.items.subtotal` (number) - Example: 1
- `shipping.items.tax_amount` (number) - Example: 0.07
- `shipping.items.discount_amount` (number)
- `shipping.sequence_id` (integer, null) - Example: 12345
- `shipping.tax_exemption` (string) - Example: "M01"
- `shipping.at_doc_code_id` (string, null) - Read-only. Example: "999"
```

--------------------------------

### POST /{guides-type}.json

Source: https://docs.invoicexpress.com/guides.md

Creates a new shipping, transport, or devolution document. The guides-type parameter specifies the type of guide to create.

```APIDOC
## POST /{guides-type}.json

### Description
Creates a new shipping, transport, or devolution document. The guides-type parameter specifies the type of guide to create.

### Method
POST

### Endpoint
/{guides-type}.json

### Parameters
#### Path Parameters
- **guides-type** (string) - Required - The type of guide: shipping, transport, or devolution.

```

--------------------------------

### GET /api/export_saft.json

Source: https://docs.invoicexpress.com/saf-t/export_saft.md

Initiates the export of a SAF-T file for the specified period. The response may return a download URL, a message indicating the generation has started, or an error message.

```APIDOC
## GET /api/export_saft.json

### Description
Initiates the export of a SAF-T file for the specified period. The response may return a download URL, a message indicating the generation has started, or an error message.

### Method
GET

### Endpoint
/api/export_saft.json

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API Key. Example: "YOUR_API_KEY"
- **Saft Params** (object) - Required - Click to expand options.

### Response
#### Success Response (200)
- **Url** (string) - Link to download your SAF-T file. Absent when there are no documents to export in the selected period — see message instead. Example: "https://some.url"
- **message** (string) - Present instead of Url when there are no documents to export in the selected period. Example: "There aren't any documents to export on the selected period."

#### Response Example
{
  "Url": "https://some.url"
}

#### Success Response (202)
- **message** (string) - Example: "The SAF-T file generation was started. Please keep requesting until you get back the url."

#### Response Example
{
  "message": "The SAF-T file generation was started. Please keep requesting until you get back the url."
}

#### Error Response (401)
- **errors** (array) - List of errors.
- **errors.error** (string) - Example: "Authentication Error"

#### Response Example
{
  "errors": [
    {
      "error": "Authentication Error"
    }
  ]
}

#### Error Response (422)
- **message** (string) - Example: "There aren't any documents to export on the selected period."

#### Response Example
{
  "message": "There aren't any documents to export on the selected period."
}

#### Error Response (500)
- **message** (string) - Example: "Error generating SAF-T. Please try again."

#### Response Example
{
  "message": "Error generating SAF-T. Please try again."
}
```

--------------------------------

### POST /clients.json

Source: https://docs.invoicexpress.com/clients.md

Creates a new client.

```APIDOC
## POST /clients.json

### Description
Creates a new client.

### Method
POST

### Endpoint
/clients.json

```

--------------------------------

### POST /items.json

Source: https://docs.invoicexpress.com/items/createitem.md

Creates a new item. Requires an API key and an item object with name, description, and unit_price. Optional fields include unit and tax. Returns the created item on success, or error details on authentication or validation failure.

```APIDOC
## POST /items.json

### Description
Creates a new item.

### Method
POST

### Endpoint
/items.json

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API Key. Example: "YOUR_API_KEY"

#### Request Body
- **item** (object) - Required
- **item.name** (string) - Required - Item name. Values longer than 60 characters are rejected with HTTP 422 — they are not truncated. Example: "Item name"
- **item.description** (string) - Required - Item description. Values longer than 200 characters are rejected with HTTP 422 — they are not truncated. Example: "Item description"
- **item.unit_price** (number) - Required - Example: 9.99
- **item.unit** (string) - Optional - One of: hour, day, month, unit, service, tax, other, product, article. Example: "service"
- **item.tax** (object) - Optional
- **item.tax.name** (string) - Optional - Example: "IVA23"

### Request Example
{
  "item": {
    "name": "Item name",
    "description": "Item description",
    "unit_price": 9.99,
    "unit": "service",
    "tax": {
      "name": "IVA23"
    }
  }
}

### Response
#### Success Response (201)
- **item** (object)
- **item.id** (integer) - Example: 402321
- **item.name** (string) - Example: "Medium"
- **item.description** (string, null) - Example: "foo"
- **item.unit_price** (string) - Example: "16.2602"
- **item.unit** (string) - One of: hour, day, month, unit, service, tax, other, product, article. Example: "service"
- **item.tax** (object)
- **item.tax.value** (string) - Example: "23.0"
- **item.tax.comment** (string) - Example: "tax value:23.0%"

#### Response Example (201)
{
  "item": {
    "id": 402321,
    "name": "Medium",
    "description": "foo",
    "unit_price": "16.2602",
    "unit": "service",
    "tax": {
      "value": "23.0",
      "comment": "tax value:23.0%"
    }
  }
}

#### Error Response (401)
- **errors** (array)
- **errors.error** (string) - Example: "Authentication Error"

#### Error Response Example (401)
{
  "errors": [
    {
      "error": "Authentication Error"
    }
  ]
}

#### Error Response (422)
- **errors** (array) - Lista de objetos contendo mensagens de erro detalhadas. Example: [{"error":"Price is a required field"},{"error":"RRP is a required field"},{"error":"Name is a required field"}]
- **errors.error** (string)

#### Error Response Example (422)
{
  "errors": [
    {
      "error": "Price is a required field"
    },
    {
      "error": "RRP is a required field"
    },
    {
      "error": "Name is a required field"
    }
  ]
}
```

--------------------------------

### GET /api/accounts/{account-id}/get.json

Source: https://docs.invoicexpress.com/accounts.md

Gets information about a specific account.

```APIDOC
## GET /api/accounts/{account-id}/get.json

### Description
Gets information about a specific account.

### Method
GET

### Endpoint
/api/accounts/{account-id}/get.json

### Parameters
#### Path Parameters
- **account-id** (string) - Required - The ID of the account to retrieve.

```

--------------------------------

### POST /api/accounts/create.json

Source: https://docs.invoicexpress.com/accounts.md

Creates a new account.

```APIDOC
## POST /api/accounts/create.json

### Description
Creates a new account.

### Method
POST

### Endpoint
/api/accounts/create.json

```

--------------------------------

### GET /invoices.json

Source: https://docs.invoicexpress.com/index.html.md

Returns a list of invoices.

```APIDOC
## GET /invoices.json

### Description
Returns a list of invoices.

### Method
GET

### Endpoint
/invoices.json

```

--------------------------------

### POST /items.json

Source: https://docs.invoicexpress.com/index.html.md

Creates a new item.

```APIDOC
## POST /items.json

### Description
Creates a new item.

### Method
POST

### Endpoint
/items.json

```

--------------------------------

### PUT /{guides-type}/{document-id}/change-state.json

Source: https://docs.invoicexpress.com/guides.md

Changes the state of guide documents (shippings, transports, devolutions). The allowed state transitions are: draft to final (event: finalized), draft to deleted (event: deleted), and final to canceled (event: canceled).

```APIDOC
## PUT /{guides-type}/{document-id}/change-state.json

### Description
Changes the state of guide documents (shippings, transports, devolutions). The allowed state transitions are: draft to final (event: finalized), draft to deleted (event: deleted), and final to canceled (event: canceled).

### Method
PUT

### Endpoint
/{guides-type}/{document-id}/change-state.json

### Parameters
#### Path Parameters
- **guides-type** (string) - Required - The type of guide: shipping, transport, or devolution.
- **document-id** (integer) - Required - The ID of the guide document to change state.

### State Transitions
| From | To | Event |
| :--- | :--- | :--- |
| draft | final | finalized |
| draft | deleted | deleted |
| final | canceled | canceled |

```

--------------------------------

### GET /clients/find-by-code.json

Source: https://docs.invoicexpress.com/clients.md

Returns a specific client.

```APIDOC
## GET /clients/find-by-code.json

### Description
Returns a specific client.

### Method
GET

### Endpoint
/clients/find-by-code.json

```

--------------------------------

### POST /api/v3/clients/{client_id}/regularization.json

Source: https://docs.invoicexpress.com/index.html.md

Creates a new client’s regularization.

```APIDOC
## POST /api/v3/clients/{client_id}/regularization.json

### Description
Creates a new client’s regularization.

### Method
POST

### Endpoint
/api/v3/clients/{client_id}/regularization.json

### Parameters
#### Path Parameters
- **client_id** (string) - Required - The ID of the client.

```

--------------------------------

### GET /clients/find-by-name.json

Source: https://docs.invoicexpress.com/clients.md

Returns a specific client.

```APIDOC
## GET /clients/find-by-name.json

### Description
Returns a specific client.

### Method
GET

### Endpoint
/clients/find-by-name.json

```
Tokens:
Raw