TRANXACT.AI Help

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.

Type REST12 operationsBase path /api/accounting/einvoice-documentsPublished as /api/v1/einvoice-documents

Download specification (OpenAPI 3.1) Screen: E-invoices

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.einvoice_documents · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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, format

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, reference

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/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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
document_notextread onlyDocument no
invoice_iduuidread onlyInvoice id
profile_iduuidread onlyProfile id
formattextread onlyFormat
kindtextread onlyKind
statustextread onlyStatus
file_nametextread onlyFile name
mimetextread onlyMime
xmltextread onlyXml
pdfbytearead onlyPdf
sha256textread onlySha256
validationjsonbread onlyValidation
error_countintegerread onlyError count
warning_countintegerread onlyWarning count
transporttextread onlyTransport
connection_iduuidread onlyConnection id
transport_reftextread onlyTransport ref
sent_attimestamp with time zoneread onlySent at
responded_attimestamp with time zoneread onlyResponded at
response_messagetextread onlyResponse message
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
icvbigintread onlyIcv
invoice_hashtextread onlyInvoice hash
previous_invoice_hashtextread onlyPrevious invoice hash
print_template_iduuidread onlyPrint template id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › E-invoices for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.