Accounting · E-invoicing
E-invoices
Every structured e-invoice generated from a customer invoice or credit note: its format, whether it validates, and what the network said. Generate one from Customer Invoices.
/api/accounting/einvoice-documentsPublished as /api/v1/einvoice-documentsOverview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › E-invoices on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.einvoice_documents · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/einvoice-documentsList e-invoices
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"format": "text",
"kind": "text",
"status": "draft",
"file_name": "Example",
"mime": "text",
"xml": "text",
"pdf": "text",
"sha256": "text",
"validation": {}
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-documents?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/einvoice-documents/{id}Read one einvoice documents
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"format": "text",
"kind": "text",
"status": "draft",
"file_name": "Example",
"mime": "text",
"xml": "text",
"pdf": "text",
"sha256": "text",
"validation": {}
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/einvoice-documents/generateGenerate
Request body
The keys this action reads (* = required; "one of" lists the only values):
invoiceId*, invoice_id, formatResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-documents/generate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"invoiceId":"value","invoice_id":"value","format":"value"}'GET/api/accounting/einvoice-documents/{id}/validationValidation
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/validation" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/einvoice-documents/{id}/downloadDownload
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/einvoice-documents/{id}/eventsEvents
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/einvoice-documents/{id}/sendSend
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/einvoice-documents/{id}/record-responseRecord response
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
status, message, referenceResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/record-response" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"status":"value","message":"value","reference":"value"}'POST/api/accounting/einvoice-documentsPost e-invoices
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-documents" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/einvoice-documents/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/accounting/einvoice-documents/{id}Put e-invoices
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/einvoice-documents/{id}Delete e-invoices
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/einvoice-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a einvoice documents, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
document_no | text | read only | Document no |
invoice_id | uuid | read only | Invoice id |
profile_id | uuid | read only | Profile id |
format | text | read only | Format |
kind | text | read only | Kind |
status | text | read only | Status |
file_name | text | read only | File name |
mime | text | read only | Mime |
xml | text | read only | Xml |
pdf | bytea | read only | |
sha256 | text | read only | Sha256 |
validation | jsonb | read only | Validation |
error_count | integer | read only | Error count |
warning_count | integer | read only | Warning count |
transport | text | read only | Transport |
connection_id | uuid | read only | Connection id |
transport_ref | text | read only | Transport ref |
sent_at | timestamp with time zone | read only | Sent at |
responded_at | timestamp with time zone | read only | Responded at |
response_message | text | read only | Response message |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
icv | bigint | read only | Icv |
invoice_hash | text | read only | Invoice hash |
previous_invoice_hash | text | read only | Previous invoice hash |
print_template_id | uuid | read only | Print template id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › E-invoices for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.