Is there a test (sandbox) environment?

Yes. You can create an account just for testing and we will switch it to sandbox mode.

🚀 How to get a test (sandbox) account

  1. Create a new account, just for testing, here: https://web.invoicexpress.com/signup
  2. Tell us the name of the account you created (support@invoicexpress.com), so we can switch it to sandbox mode.
  3. Find the account_name and the API_KEY in Settings > API. ✅

🔀 Which test account should I create?

It depends on what you need to test. Since 01.01.2023, documents can only be finalized in registered series, and the ATCUD code must appear on the documents, as required by the Portuguese Tax Authority (AT).

What you want to test Test account
Series creation, ATCUD registration and QR CODE Account created with a real tax number (NIF), added by us to the AT pre-production environment
Other tests (without the series creation endpoint or the QR CODE GET) Account created without a real tax number, without registering the ATCUD

🧾 I want to test series, ATCUD and QR CODE

To test series creation, ATCUD registration and the QR CODE, the test account must be created with a real tax number (NIF).

So you can test document status changes and series creation, we can add the test account to an AT pre-production environment. This lets you register series in a "fictitious" way: you need to add AT credentials (real data) and register the series, but these series will not be considered real.

  1. Create the test account with the real tax number (NIF).
  2. Contact us (support@invoicexpress.com) so we can add the account to sandbox mode and to the AT test environment.
  3. Only after the account has been added, configure the ATCUD on the account. ✅

⚠️ Important: the ATCUD should only be configured after the account has been created and we have added it to the AT pre-production environment. We will help you with every step.

📝 I don't need to test series or the QR CODE

If you don't need to test the series creation endpoint or the GET to obtain the QR CODE, you can create the test account without a real tax number and without registering the ATCUD.

You will be able to finalize documents in the INVOICEXPRESSDEMO series, as fiscally invalid documents.

📚 Where can I find the API documentation?

The InvoiceXpress API documentation is available here: https://docs.invoicexpress.com/v2

💬 Common questions

❓ Where can I find the API documentation?

At https://docs.invoicexpress.com/v2.

❓ Where do I find the account_name and the API_KEY?

In Settings > API, after creating the account.

❓ Do I need a real tax number for the test account?

Only if you want to test series creation, ATCUD registration and the QR CODE. For other tests, you can create the account without a real tax number.

❓ Are the series registered in the AT pre-production environment real?

No. They are registered in a "fictitious" way and are not considered real series.

❓ Are documents finalized in the INVOICEXPRESSDEMO series valid?

No. They are fiscally invalid documents, for testing only.

Respondeu à sua questão? Obrigado pelo seu feedback! Aconteceu um problema a submeter o seu feedback...