Update notices

19 Nov 2026: Download the XML of a sent or received invoice; invoice docs split in two

Two new endpoints return the XML an invoice was sent with, or came in. The invoice reference is now two sub-sections, Send invoices and Receive invoices. The Partner overview has a customer onboarding diagram, and the Entities reference lists create and delete for Development only.

OAuth API

New

Download the XML of a sent invoice, and of a received invoice

  • GET /oauth/invoices/sent/{invoice_id}/xml returns the UBL (PINT-AE) XML the invoice was delivered to Peppol with, exactly as kept when its status became SENT_TO_PEPPOL.
  • GET /oauth/invoices/received/{invoice_id}/xml returns the XML a received invoice came in.
  • Both answer with the XML as the response body (Content-Type application/xml; charset=utf-8, as a download named Invoice_<number>.xml). Nothing is stored again.
  • A sent invoice that has not reached SENT_TO_PEPPOL, or whose send failed, answers 409 invoice_not_sent. The XML of a conversion that was never delivered is never returned.
  • The invoice id is checked first: a sent invoice's id is its 24-character invoice_id; a received invoice's id is letters, digits, - and _ (at most 64). Anything else is 400 invalid_invoice_id.
  • An invoice of an entity your app cannot reach, or one that does not exist, is 404. A sent or received invoice whose XML is no longer stored is 404 xml_not_available. Errors are { error, code }.
  • Files the document carried are links in the XML, not content: download them from the attachments endpoints.
  • Any role your app holds on the entity may download. They share the file-download limit of 120 a minute per app; over it, 429 with Retry-After.
Why we changed this
  • An integrator needs its own copy of the exact document that was delivered or received, for its records and for audits, without rebuilding it from the invoice data.

What to do: Nothing to change. Call the endpoint when you need the XML; for a sent invoice, wait for SENT_TO_PEPPOL.

Download the XML of a sent invoice →Download the XML of a received invoice →

Application

No change

Nothing changes in the application

  • The application's screens and rules are unchanged.

Documentation

Documentation

FAQ: going live answers

  • A new FAQ group, Going live, answers what integrators ask before they connect: the production URL (https://api.taxstar.app/einv) and that sending there is closed until the FTA activation date while validation works; POST /oauth/invoices/send is an alias of POST /oauth/invoices; the seller block is optional.
  • It also explains when beneficiary_id, principal_id, einv_scope_note, discount_percent and account_code apply, and that there is no debit note: reduce with a credit note, increase with a new Tax Invoice.
  • Credit notes: the original is sent first and its credit note only once it shows as sent, because processing order is not guaranteed; a PROCESSING invoice after 15 minutes should be reported to support.
  • Poll the sent list every 5 to 15 minutes as a fallback to webhooks, and map tax rates to S, Z, E, O or AE (not N).
  • The access token answer now also says the refresh token's lifetime is returned as refresh_token_expires_in.

FAQ →

Documentation

Invoices are two sub-sections: Send invoices and Receive invoices

  • The sidebar's Invoices heading now holds two pages: Send invoices (at /invoices, as before) and Receive invoices (new, at /received-invoices).
  • Send invoices keeps the sending endpoints and guide: push, bulk, validate, update, the sent list and detail, the sent PDF, XML and attachments.
  • Receive invoices holds the received list and detail, the received PDF, XML and attachments, and the guide to the document you get back (statuses, the daily sync).
  • The links to the received endpoints moved with them: use /received-invoices#list-received-invoices and /received-invoices#received-invoices.
  • The API overview and the home page list both pages.

Send invoices →Receive invoices →

Documentation

Entities: create and delete are shown on Development only

  • POST /oauth/entities (create an entity) and DELETE /oauth/entities/{entity_id} (delete one) are back in the Entities reference, marked Development only. They appear only while Development is selected in the top bar, and are hidden on Production.
  • On production no entity is created through the API: every entity is created for you by FTA onboarding, and both endpoints answer 404 Resource Not Found. Use GET /oauth/entities to find the entity_id.
  • On Development the TRN must be a conformant UAE TRN (15 digits, starting with 1, ending with 03 or 001) and unique. The seller's legal registration is optional when creating but mandatory before the entity can send.
  • Deleting needs admin access to the entity and releases its Peppol registration first; if that fails nothing is deleted (502).
  • The API overview and the quickstart step 1 say the same: FTA onboarding on production, POST /oauth/entities on Development.

Entities →

Documentation

Partner overview: onboard a customer end to end

  • A new card, Onboard a customer with no Tax Star sign-up, shows the whole journey of one customer in four lanes: the customer, your app, Tax Star and EmaraTax (the FTA portal).
  • Below the diagram the same journey is written as six steps: the customer signs up on your app, consents to your raising invoices, you pre-register the client, the customer onboards on EmaraTax and selects Tax Star as ASP, Tax Star links the company and registers it on Peppol, and you go live.
  • The diagram's text is small at page width, so a View full screen button opens it in a viewer you can zoom in and out of; Esc or Close returns to the page.
  • The customer never creates or uses a Tax Star account. Their actions are in your app and on the FTA portal only.
  • A note maps the diagram's temp_onboarding_id to the id of the client that pre-register returns, and says the client.onboarded webhook does not carry entity_id: read it from GET /oauth/partners/pre-register/clients/{client_id}.

Partner overview →