The client's record
- In the sandbox
Since 0.24.0 (C14). The operator's key or the read-only operator key, and since 0.25.0 a partner key for a client whose record names its partner (403 for any other). 404 when no record is set.
apiKeyAuthorizationBearer <token>Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.
client*string^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$The record.
application/json- response
client*stringname*stringpartner?string|nullstage*string"pilot""production""paused"contact_email?string|nulllegal_entities*array<string>countries*array<string>updated_at*stringdate-timecurl -X GET "https://example.com/clients/string/profile" \ -H "Authorization: Bearer <your-api-key>"{ "client": "string", "name": "string", "partner": "string", "stage": "pilot", "contact_email": "string", "legal_entities": [ "string" ], "countries": [ "string" ], "updated_at": "2019-08-24T14:15:22Z"}Submit a finished UBL or CII document (pass-through) POST
For ERPs that already write UBL or CII, or FA(3) for the KSeF route. No mapping happens: the service runs the official validators for the route (for FA(3): the XSD plus KSeF's file and date rules) and sends the file unchanged. A Factur-X or ZUGFeRD PDF goes through the same endpoint as application/pdf. The XML is parsed with entities, DTDs and network access off, and a file with a DOCTYPE is refused (EI-XML-DTD) before any validator reads it, as is a file that is not well-formed (EI-XML-SYNTAX) or not an invoice the route knows (EI-XML-TYPE). Since 0.18.4 the same file sent again for the client and route is the invoice already held (duplicate_of), as on POST /invoices; nothing new is sent.
The client records, by partner GET
Since 0.24.0 (C14). The operator's key or the read-only operator key; since 0.25.0 a partner key, which gets its own partner's list (naming another partner answers 403). The records set with PUT /clients/{client}/profile, by client id in byte order, 500 at a time. When truncated is true, next is the last id of the page, and after= that id reads the next page. partner narrows the list to one partner's clients. A client with keys but no record is not listed.