Skip to content

InvoiceXpress API (3.1.0)

The InvoiceXpress v3 API: invoicing documents (invoices, guides, estimates) and their series, clients, items, taxes, schedules and favorites; account, user, AT-communication and payment-service settings; batch CSV imports of invoices, products and clients; dashboard KPIs, reports, SAF-T export, digital signatures, EDI (CIUS-PT), Social Security declarations, and reference lists (currencies, tax countries, phone calling codes).

What changed between versions of this reference is listed under Changelog, at the end of the navigation.

Authentication

Send your api_key as a query parameter on JSON (or XML) requests. A request with no valid api_key answers 401. The Authorization: Bearer and X-Account headers authenticate the InvoiceXpress web app only; they are not meant for API clients. Endpoints marked as public need no key.

Download OpenAPI description
Overview
InvoiceXpress API Support
Languages
Servers
Production Server
https://api-v3.app.invoicexpress.com/

Invoices

Create invoices, invoice receipts, simplified invoices, vat moss invoices, credit notes & debit notes and send them to your clients.

Operations

Guides

Create shippings, transports & devolutions and send them to your clients.

Operations

Estimates

Create quotes, proformas and fees notes and send them to your clients.

Operations

Sequences

A Sequence is used to group invoices in a sequential order.

Operations

Clients

A Client is an entity you send invoices to.

Operations

Accounts

Manage your InvoiceXpress account settings, users, AT communication, and billing.

Operations

Get Account

Request

Returns the current account details.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
accountobject(V3AccountObject)
Response
application/json
{ "account": { "id": 148306, "address": "Avenida Duque D'Avila, Saldanha", "address_country": "PT", "at_communication_type": "manual", "at_subuser": "12345689/0", "at_configured": true, "billing_address": "Avenida Duque D'Avila, Saldanha", "billing_city": "Lisbon", "billing_country_id": 1, "billing_email": "tito.reis@visma.com", "billing_fiscal_id": "999999990", "billing_organization_name": "invoicexpress", "billing_postal_code": "1500-555", "billing_address_country": "PT", "can_change_nif": false, "capital_social": null, "city": "Lisbon", "conservatoria": null, "currency_id": 1, "decimal_marker": ",", "documents_from_last_year": false, "email": "tito.reis@visma.com", "fiscal_id": "999999990", "fiscal_region": null, "iva_caixa": false, "language": "en", "logo_url": null, "observations": null, "organization_name": "invoicexpress", "payment_days": null, "payment_mechanism": null, "postal_code": "1500-555", "send_options": null, "state": "active", "tax_exemption_code": null, "tax_location_id": 1, "trial": false } }

Create Account

Request

Creates a new InvoiceXpress account. The response shape depends on whether it is an API or a web request (see the response schema).

Bodyapplication/jsonrequired
emailstring<= 255 charactersrequired
Example: "john.doe@example.com"
passwordstringrequired
Example: "Fa8aVs.B!~k+"
password_confirmationstring

Ignored. The server always uses password as the confirmation.

Example: "Fa8aVs.B!~k+"
accountobjectrequired
account.​organization_namestring<= 100 charactersrequired

Values longer than 100 characters are rejected with HTTP 422.

Example: "Strong Security"
account.​fiscal_idstring<= 255 charactersrequired

Required. Missing or blank is rejected with 422 ("VAT Number can't be blank").

Example: "123456789"
account.​addressstring<= 210 charactersrequired

Required. Missing or blank is rejected with 422 ("Address can't be blank"); values longer than 210 characters are rejected with HTTP 422.

Example: "Avenida da Liberdade"
account.​postal_codestring<= 255 charactersrequired

Required. Missing or blank is rejected with 422 ("Postal code can't be blank").

Example: "1250-144"
account.​citystring<= 50 charactersrequired

Required. Missing or blank is rejected with 422 ("City can't be blank"); values longer than 50 characters are rejected with HTTP 422.

Example: "Lisboa"
account.​languagestring<= 4 characters
Example: "pt"
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
successbooleanrequired
Example: true
tokenstringrequired
Example: "a41f5ef81ad1a93f6e362ef94818ef6497f857745346dba064d081229102e28593818d4496d70fdfe436195a4eed6ed813cd560e043c8fd9aa5889b044d47848"
urlstring

API requests only. Home URL of the new account.

Example: "https://strongsecurity.app.invoicexpress.com"
api_keystring

API requests only. API key of the user on the new account.

Example: "d8117512267a1d84ebb64c65b6294b0719e78134"
redirectstring

Web requests only. Home URL of the new account (replaces url and api_key).

Example: "https://strongsecurity.app.invoicexpress.com"
Response
application/json
{ "success": true, "token": "a41f5ef81ad1a93f6e362ef94818ef6497f857745346dba064d081229102e28593818d4496d70fdfe436195a4eed6ed813cd560e043c8fd9aa5889b044d47848", "url": "https://strongsecurity.app.invoicexpress.com", "api_key": "d8117512267a1d84ebb64c65b6294b0719e78134", "redirect": "https://strongsecurity.app.invoicexpress.com" }

Update Account

Request

Updates the current account details. Only the fields sent inside account are changed.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
retroactive_communication_optionstring

Optional. When the account ends up with at_communication_type auto (and is not a SAF-T big account), the documents of the chosen years are communicated to the AT retroactively. Any other value communicates nothing retroactively.

Enum"only_this_year""this_year_and_last_year"
Example: "only_this_year"
accountobjectrequired

Required. An empty body (no account key and no top-level account field) returns 422 "Param is missing"; top-level account fields are wrapped into account automatically. Only the fields sent are changed.

account.​address_countrystring or null

ISO country code of the address.

Example: "PT"
account.​billing_address_countrystring or null

ISO country code of the billing address.

Example: "PT"
account.​billing_data_confirmedboolean

Marks the billing data as confirmed. Once confirmed it is not changed again.

Example: true
account.​capital_socialstring or null<= 255 characters
Example: "5000 EUR"
account.​conservatoriastring or null<= 255 characters
Example: "Lisboa"
account.​currency_idinteger
Example: 1
account.​decimal_markerstring<= 255 characters
Example: ","
account.​emailstring<= 255 characters
Example: "billing@example.com"
account.​fiscal_regionstring or null

Cleared (set to null) when billing_country_id is sent with a country other than 1 and no fiscal_region is sent.

Example: null
account.​invoice_footerstring or null<= 200 characters

Values longer than 200 characters are rejected with HTTP 422.

Example: "Company registered in Lisbon."
account.​observationsstring or null<= 400 characters

Values longer than 400 characters are rejected with HTTP 422.

Example: null
account.​payment_mechanismstring or null<= 255 characters
Example: null
account.​tax_exemption_codestring or null<= 255 characters
Example: "M07"
account.​tax_location_idinteger

When different from 1 and sent together with fiscal_id, the VAT number is validated for that country; an invalid one returns 422 "VAT Number is invalid".

Example: 1
account.​addressstring<= 210 characters

Values longer than 210 characters are rejected with HTTP 422.

Example: "Avenida Duque D'Ávila 46 – 3ºA"
account.​at_communication_typestring<= 255 characters
Example: "auto"
account.​at_subuserstring<= 255 characters
Example: "599999993/1"
account.​at_passwordstring<= 255 characters

Checked against the AT before saving; rejected credentials return 422 "The tax authority rejected the at_subuser/at_password combination".

Example: "123456"
account.​bank_data1string<= 255 characters
Example: "PT50 123456789"
account.​bank_data2string<= 255 characters
Example: "1234"
account.​bank_data3string or null<= 255 characters
Example: null
account.​billing_addressstring<= 255 characters
Example: "Avenida Duque D'Ávila 46 – 3ºA"
account.​billing_citystring<= 255 characters
Example: "Porto"
account.​billing_country_idinteger
Example: 1
account.​billing_emailstring<= 255 characters
Example: "test@example.com"
account.​billing_fiscal_idstring<= 255 characters
Example: "999999990"
account.​billing_organization_namestring<= 255 characters
Example: "Invoice Xpress"
account.​billing_postal_codestring<= 255 characters
Example: "1011-123"
account.​citystring<= 50 characters

Values longer than 50 characters are rejected with HTTP 422.

Example: "Lisboa"
account.​fiscal_idstring<= 255 characters
Example: "508000111"
account.​iva_caixaboolean
Example: true
account.​languagestring<= 4 characters
Example: "pt"
account.​organization_namestring<= 100 characters

Values longer than 100 characters are rejected with HTTP 422.

Example: "Invoice Xpress"
account.​postal_codestring<= 255 characters
Example: "1011-123"
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/accounts?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
accountobject(V3AccountObject)
Response
application/json
{ "account": { "id": 148306, "address": "Avenida Duque D'Avila, Saldanha", "address_country": "PT", "at_communication_type": "manual", "at_subuser": "12345689/0", "at_configured": true, "billing_address": "Avenida Duque D'Avila, Saldanha", "billing_city": "Lisbon", "billing_country_id": 1, "billing_email": "tito.reis@visma.com", "billing_fiscal_id": "999999990", "billing_organization_name": "invoicexpress", "billing_postal_code": "1500-555", "billing_address_country": "PT", "can_change_nif": false, "capital_social": null, "city": "Lisbon", "conservatoria": null, "currency_id": 1, "decimal_marker": ",", "documents_from_last_year": false, "email": "tito.reis@visma.com", "fiscal_id": "999999990", "fiscal_region": null, "iva_caixa": false, "language": "en", "logo_url": null, "observations": null, "organization_name": "invoicexpress", "payment_days": null, "payment_mechanism": null, "postal_code": "1500-555", "send_options": null, "state": "active", "tax_exemption_code": null, "tax_location_id": 1, "trial": false } }

Get Years with Documents

Request

Returns an array of years that have documents.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/years_documents?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
yearsArray of integers
Example: [2026,2025,2024,2023]
Response
application/json
{ "years": [ 2026, 2025, 2024, 2023 ] }

Export Account Data

Request

Exports account data in XLS, CSV, or XML format. An email will be sent when the export is ready. Both data_type and data_format are required; account can only be exported as xml.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
data_typestringrequired

Data type to export. Missing returns 400; any other value returns 422.

Enum"account""contacts""invoices""items""inventory"
data_formatstringrequired

Export file format. Missing returns 400; any other value returns 422. With data_type=account only xml is accepted (any other format returns 422).

Enum"csv""xls""xml"
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/export?api_key=YOUR_API_KEY&data_type=invoices&data_format=xls"

Responses

SUCCESS

Bodyapplication/json
messagestring
Example: "We'll send you an email when it's done to: info@test.com."
Response
application/json
{ "message": "We'll send you an email when it's done to: info@test.com." }

Get Billing History

Request

Returns InvoiceXpress billing history for the account.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
pageinteger

Page number (default 1).

Example: page=1
per_pageinteger

Results per page (default 10).

Example: per_page=10
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/billing_history?api_key=YOUR_API_KEY&page=1&per_page=10"

Responses

SUCCESS

Bodyapplication/json
billing_historyArray of objects(V3BillingHistoryItem)
paginationobject
Response
application/json
{ "billing_history": [ { … } ], "pagination": { "total_entries": 0, "current_page": 1, "total_pages": 0, "per_page": 10 } }

Create Account for Existing User

Request

Creates a new account for an existing InvoiceXpress user, authenticated by the email and password in the body. The response shape depends on whether it is an API or a web request (see the response schema).

Bodyapplication/jsonrequired
emailstring<= 255 charactersrequired

Email (login) of the existing user.

Example: "john.doe@example.com"
passwordstringrequired

Current password of the existing user.

Example: "Fa8aVs.B!~k+"
accountobject(account)required
account.​organization_namestring<= 100 charactersrequired

Values longer than 100 characters are rejected with HTTP 422.

Example: "Strong Security"
account.​fiscal_idstring<= 255 charactersrequired

Required. Missing or blank is rejected with 422 ("VAT Number can't be blank").

Example: "123456789"
account.​addressstring<= 210 charactersrequired

Required. Missing or blank is rejected with 422 ("Address can't be blank"); values longer than 210 characters are rejected with HTTP 422.

Example: "Avenida da Liberdade"
account.​postal_codestring<= 255 charactersrequired

Required. Missing or blank is rejected with 422 ("Postal code can't be blank").

Example: "1250-144"
account.​citystring<= 50 charactersrequired

Required. Missing or blank is rejected with 422 ("City can't be blank"); values longer than 50 characters are rejected with HTTP 422.

Example: "Lisboa"
account.​languagestring<= 4 characters
Example: "pt"
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/create_already_user" -H "Content-Type: application/json" --data '{}'

Responses

CREATED

Bodyapplication/json
successbooleanrequired
Example: true
tokenstringrequired
Example: "a41f5ef81ad1a93f6e362ef94818ef6497f857745346dba064d081229102e28593818d4496d70fdfe436195a4eed6ed813cd560e043c8fd9aa5889b044d47848"
urlstring

API requests only. Home URL of the new account.

Example: "https://strongsecurity.app.invoicexpress.com"
api_keystring

API requests only. API key of the user on the new account.

Example: "d8117512267a1d84ebb64c65b6294b0719e78134"
redirectstring

Web requests only. Home URL of the new account (replaces url and api_key).

Example: "https://strongsecurity.app.invoicexpress.com"
Response
application/json
{ "success": true, "token": "a41f5ef81ad1a93f6e362ef94818ef6497f857745346dba064d081229102e28593818d4496d70fdfe436195a4eed6ed813cd560e043c8fd9aa5889b044d47848", "url": "https://strongsecurity.app.invoicexpress.com", "api_key": "d8117512267a1d84ebb64c65b6294b0719e78134", "redirect": "https://strongsecurity.app.invoicexpress.com" }

Get Account Settings

Request

Returns the account configuration settings for one documents tab, chosen with the required documents_tab query parameter.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
documents_tabstringrequired

Documents tab whose settings are returned. Plural and lowercase forms are also accepted (invoices, estimate, guides, ...); they are singularized and capitalized. Any other value returns 422 (Tab <value> doesn't exist); omitting the parameter returns 500.

Enum"Invoice""Estimate""Guide""Schedule"
Example: documents_tab=Invoice
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/settings?api_key=YOUR_API_KEY&documents_tab=Invoice"

Responses

SUCCESS

Bodyapplication/json
currency_separatorstring
Example: ","
currency_symbolstring
Example: "€"
currency_codestring
Example: "EUR"
languagestring<= 4 characters
Example: "en"
sequence_number_modestring
Example: "auto"
batch_import_ruleboolean
Example: true
first_documentboolean
Example: true
logo_urlstring
Example: "https://aws-s3-url-logo.com"
account_namestring
Example: "Company Test"
Response
application/json
{ "currency_separator": ",", "currency_symbol": "€", "currency_code": "EUR", "language": "en", "sequence_number_mode": "auto", "batch_import_rule": true, "first_document": true, "logo_url": "https://aws-s3-url-logo.com", "account_name": "Company Test" }

List Account Users

Request

Returns the account's users, paginated.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
pageinteger>= 1

Page number, starting at 1.

Default 1
Example: page=1
per_pageinteger>= 1

Number of entries per page. items_per_page and page_items are accepted as aliases.

Default 10
Example: per_page=10
sortstring

Field to sort by.

Default "users.id"
Enum"users.id""users.email"
Example: sort=users.email
sort_orderstring

Sort direction.

Default "ASC"
Enum"ASC""DESC"
Example: sort_order=DESC
termstring

Returns only users whose email contains this text.

Example: term=@example.com
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/users?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
usersArray of objects(V3AccountUserItem)
paginationobject
Response
application/json
{ "users": [ { … } ], "pagination": { "total_entries": 3, "current_page": 1, "total_pages": 1, "per_page": 10 } }

Create or Add Account User

Request

Creates a new user or adds an existing user to the account. user.role is optional; a missing or unknown role gives the user the contributor role.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
userobjectrequired
user.​emailstring<= 255 charactersrequired
Example: "john.doe@invoicexpress.com"
user.​rolestring

Optional. A missing or unknown role gives the user the contributor role.

Enum"administrator""contributor""contributor_guides"
Example: "contributor"
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/users?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
userobject
Response
application/json
{ "user": { "id": 147436, "email": "tito.reis@visma.com", "phone_country_id": 1, "role": "contributor" } }

Update Account User

Request

Updates a user's role on the account.

Security
apiKeyAuth
Path
idstringrequired

User id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
userobjectrequired

Required. A JSON body without the user key is wrapped into user automatically, so it fails with 422 "Role is invalid" rather than 500.

user.​rolestringrequired

New role of the user on the account. A missing or unknown role returns 422 "Role is invalid".

Enum"administrator""contributor""contributor_guides"
Example: "administrator"
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/accounts/users/1?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"user":{"role":"administrator"}}'

Responses

OK

Bodyapplication/json
userobject
Response
application/json
{ "user": { "id": 147436, "email": "tito.reis@visma.com", "phone_country_id": 1, "role": "contributor" } }

Remove Account User

Request

Removes one or more users from the account. Ids that are not users of this account are skipped.

Security
apiKeyAuth
Path
idstringrequired

User id, or a comma-separated list of user ids.

Example: 12,34
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/accounts/users/1?api_key=YOUR_API_KEY"

Responses

SUCCESS

Response
No content

Get Document Customization

Request

Returns the document customization of the account, or of one série with serie_name.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
serie_namestring

Name of a série of the account. When sent, the customization of that série is returned instead of the account's, and has_series_configuration says whether the série has its own customization.

Example: serie_name=2026
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
has_series_configurationboolean

Whether the série given in serie_name has its own customization (instead of using the account's). Always false without serie_name.

Example: false
organization_namestring or null<= 100 characters

Values longer than 100 characters are rejected with HTTP 422.

Example: "invoicexpress"
fiscal_idstring or null<= 255 characters
Example: "999999990"
addressstring or null<= 210 characters

Values longer than 210 characters are rejected with HTTP 422.

Example: "Avenida Duque D'Avila, Saldanha"
postal_codestring or null<= 255 characters
Example: "1500-555"
citystring or null<= 50 characters

Values longer than 50 characters are rejected with HTTP 422.

Example: "Lisbon"
countrystring or null
Example: "Portugal"
share_capitalstring or null
Example: null
register_officestring or null
Example: null
logo_urlstring or null
Example: ""
remarksstring or null
Example: null
footerstring or null
Example: null
document_copiesinteger
Example: 1
payment_daysinteger
Example: 0
emailstring or null<= 255 characters
Example: "tito.reis@visma.com"
phonestring or null<= 255 characters
Example: null
websitestring or null<= 255 characters
Example: null
phone_country_idinteger or null
Example: 1
tax_exemption_codestring or null<= 255 characters
Example: null
bank_data_type_1string or null<= 255 characters
Example: null
bank_data_value_1string or null<= 255 characters
Example: ""
bank_data_type_2string or null<= 255 characters
Example: null
bank_data_value_2string or null<= 255 characters
Example: ""
bank_data_type_3string or null<= 255 characters
Example: null
bank_data_value_3string or null<= 255 characters
Example: ""
Response
application/json
{ "has_series_configuration": false, "organization_name": "invoicexpress", "fiscal_id": "999999990", "address": "Avenida Duque D'Avila, Saldanha", "postal_code": "1500-555", "city": "Lisbon", "country": "Portugal", "share_capital": null, "register_office": null, "logo_url": "", "remarks": null, "footer": null, "document_copies": 1, "payment_days": 0, "email": "tito.reis@visma.com", "phone": null, "website": null, "phone_country_id": 1, "tax_exemption_code": null, "bank_data_type_1": null, "bank_data_value_1": "", "bank_data_type_2": null, "bank_data_value_2": "", "bank_data_type_3": null, "bank_data_value_3": "" }

Update Document Customization

Request

Replaces the document customization of the account (or of one série, with serie_name).

This is a full replace: every customization field that is not sent (or is sent blank) is set to null. Send all the values you want to keep, not only the ones you change. See the request body for the list of fields.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyrequired
emailstring(email)

Must be a valid email address ("email_invalid").

Example: "billing@example.com"
phonestring
Example: "213456789"
websitestring
Example: "https://example.com"
phone_country_idinteger

Id of the phone calling code (see Phone Calling Codes).

Example: 1
tax_exemption_codestring

Default tax exemption code. Account level only.

Example: "M07"
remarksstring<= 400 characters

Default document observations. Maximum 400 characters ("observations_too_long"). Account level only.

Example: "Thank you for your business."
footerstring<= 200 characters

Document footer. Maximum 200 characters ("invoice_footer_too_long").

Example: "Company registered in Lisbon."
document_copiesinteger

Number of document copies. Account level only.

Example: 2
payment_daysinteger

Default payment days. Account level only.

Example: 15
bank_data_type_1string

When set, bank_data_value_1 is required ("bank_data1_blank").

Example: "IBAN"
bank_data_value_1string
Example: "PT50000201231234567890154"
bank_data_type_2string

When set, bank_data_value_2 is required ("bank_data2_blank").

Example: "SWIFT"
bank_data_value_2string
Example: "CGDIPTPL"
bank_data_type_3string

When set, bank_data_value_3 is required ("bank_data3_blank").

Example: ""
bank_data_value_3string
Example: ""
serie_namestring

Name of a série of the account. When present, the customization of that série is replaced instead of the account's.

Example: "2026"
filestring(binary)

Logo image (multipart/form-data only). PNG, JPEG or JPG, at most 200 KB and 1000x1000 pixels; otherwise 422 "The image is not valid. It must be in 'png', 'jpeg' or 'jpg' format, and have a maximum of 1000 pixels."

curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"email":"billing@example.com","phone":"213456789","website":"https://example.com","phone_country_id":1,"tax_exemption_code":"M07","remarks":"Thank you for your business.","footer":"Company registered in Lisbon.","document_copies":2,"payment_days":15,"bank_data_type_1":"IBAN","bank_data_value_1":"PT50000201231234567890154"}'

Responses

SUCCESS. When the logo could not be stored, the body also has logo_error; every other field was saved and the previous logo was kept.

Bodyapplication/json
successboolean
Example: true
logo_errorstring

Present only when the logo could not be stored. The other fields of the request were saved and the previous logo was kept; send the logo again.

Value"logo_upload_failed"
Example: "logo_upload_failed"
Response
application/json
{ "success": true, "logo_error": "logo_upload_failed" }

Account Credentials

Manage AT communication credentials for your account.

Operations

Collection Alerts

Configure automated payment collection alerts sent to clients.

Operations

Batch Invoices

Bulk-create invoices from a CSV file. Flow — GET batch → upload → process → mapping → configure_options → configure → validate → validation → available_docs → POST create → status. DELETE to discard.

Operations

Batch Products

Bulk import products from a CSV file. Flow — GET index (optional) → upload → process → GET/PUT mapping → validate → validation → POST create → status. DELETE to discard.

Operations

Batch Clients

Bulk import clients from a CSV file. Flow — GET index (optional) → upload → process → GET/PUT mapping → validate → validation → POST create → status. DELETE to discard. No configure step.

Operations

Items

An Item is the product or service you invoice.

Operations

Schedules

Create and manage recurring document schedules.

Operations

Taxes

Manage tax rates for your account.

Operations

Current User

Manage the currently authenticated user's own profile, API key, linked accounts, and password recovery.

Operations

Currencies

List supported currencies and look up exchange rates between them.

Operations

Dashboard

Retrieve dashboard KPIs and analytics about your clients and invoicing activity.

Operations

Favorites

Save and reuse custom filter presets for documents and other list views.

Operations

Payment Services

Configure and manage the payment service integration used to collect payments for your invoices.

Operations

Phone Calling Codes

List all phone country calling codes.

Operations

Reports

Reporting endpoints — currently covers the balance-per-client report, its summary, and XLSX export.

Operations

SAF-T

Generate the SAF-T (Standard Audit File for Tax) export for your account.

Operations

Tax Countries

List all tax countries.

Operations

Digital signatures

Allows opt-in for available digital signature providers, manage its credentials, and sign invoices.

Operations

EDI

Manage electronic invoice (CIUS-PT) generation and its additional customs/delivery fields. Note these endpoints are served under /api/v1/edi/ on the v3 host, and address documents by a bare id with no document-type segment.

Operations

Social Security

Helps self-employed accounts (trabalhadores independentes and ENI) fill in the quarterly income declaration for Segurança Social. InvoiceXpress calculates the quarter's totals from your invoices and an estimate of the monthly contribution; you record what you reported.

This feature submits nothing to Segurança Social. You type the figures into Segurança Social Direta yourself. It only calculates and records.

Authentication is api_key only, and every endpoint is JSON only. The declaration endpoints are served under /services/v1/social_security/... and the settings and report endpoints under /api/v3/accounts/..., all on the v3 host.

Operations

Changelog

Changes to the documented contract of the InvoiceXpress API v3: endpoints, fields, enum values, status codes and behaviour you can observe as an integrator. The newest version is at the top.

The version number is the one shown at the top of this reference, and it follows these rules:

  • Minor (3.1.0): something was added, such as a new endpoint, field or enum value. Existing integrations keep working.
  • Patch (3.0.1): the documentation was corrected and now describes what the API already did. No behaviour changed.
  • The major version stays at 3. A change that would break existing integrations is released as a new API version, not as 4.0.0 of this one.