TRANXACT.AI Help

Accounting · E-invoicing

E-invoicing Connections

The networks e-invoices are sent through: a Peppol access point, Italy’s SdI, Poland’s KSeF, a Mexican PAC. The credential is sealed and never shown again. These adapters have not been tried against a live network from this installation; send by file until a connection has been tested with real credentials.

Type REST8 operationsBase path /api/accounting/einvoice-connectionsPublished as /api/v1/einvoice-connections

Download specification (OpenAPI 3.1) Screen: E-invoicing Connections

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-invoicing Connections 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_connections · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/einvoice-connectionsList e-invoicing connections

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",
      "code": "COD-000001",
      "name": "Example",
      "provider_kind": "peppol_ap",
      "environment": "sandbox",
      "base_url": "https://example.com",
      "auth_kind": "none",
      "username": "Example",
      "secret_cipher": "text",
      "settings": {},
      "is_active": true,
      "last_status": "draft",
      "last_message": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/einvoice-connections?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/einvoice-connections/{id}Read one einvoice connections

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",
  "code": "COD-000001",
  "name": "Example",
  "provider_kind": "peppol_ap",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "auth_kind": "none",
  "username": "Example",
  "secret_cipher": "text",
  "settings": {},
  "is_active": true,
  "last_status": "draft",
  "last_message": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/einvoice-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/einvoice-connectionsCreate a einvoice connections

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
provider_kindtextNoNetwork — zatca_fatoora is the Saudi Fatoora API (clearance and reporting). Its adapter is a stub that has never been run against the sandbox, and the documents are not cryptographically stamped, so send ZATCA documents by file.
Allowed: peppol_ap sdi ksef pac zatca_fatoora generic
environmenttextNoEnvironment
Allowed: sandbox production
base_urltextNoAddress (https) — Where documents are posted.
auth_kindtextNoAuthentication
Allowed: none bearer basic api_key
usernametextNoUser name
settingsjsonbNoSettings
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "provider_kind": "peppol_ap",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "auth_kind": "none"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider_kind": "peppol_ap",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "auth_kind": "none",
  "username": "Example",
  "secret_cipher": "text",
  "settings": {},
  "is_active": true,
  "last_status": "draft",
  "last_message": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-connections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","provider_kind":"peppol_ap","environment":"sandbox","base_url":"https://example.com","auth_kind":"none"}'
PUT/api/accounting/einvoice-connections/{id}Change a einvoice connections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
provider_kindtextNoNetwork — zatca_fatoora is the Saudi Fatoora API (clearance and reporting). Its adapter is a stub that has never been run against the sandbox, and the documents are not cryptographically stamped, so send ZATCA documents by file.
Allowed: peppol_ap sdi ksef pac zatca_fatoora generic
environmenttextNoEnvironment
Allowed: sandbox production
base_urltextNoAddress (https) — Where documents are posted.
auth_kindtextNoAuthentication
Allowed: none bearer basic api_key
usernametextNoUser name
settingsjsonbNoSettings
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider_kind": "peppol_ap",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "auth_kind": "none",
  "username": "Example",
  "secret_cipher": "text",
  "settings": {},
  "is_active": true,
  "last_status": "draft",
  "last_message": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/einvoice-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/einvoice-connections/{id}Delete a einvoice connections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/einvoice-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/einvoice-connections/{id}/set-credentialSet credential

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):

secret

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/set-credential" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"secret":"value"}'
POST/api/accounting/einvoice-connections/{id}/testTest

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/einvoice-connections/{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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a einvoice connections, 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
codetextread, writeCode
nametextread, writeName
provider_kindtextread, writeNetwork — zatca_fatoora is the Saudi Fatoora API (clearance and reporting). Its adapter is a stub that has never been run against the sandbox, and the documents are not cryptographically stamped, so send ZATCA documents by file.
Allowed: peppol_ap sdi ksef pac zatca_fatoora generic
environmenttextread, writeEnvironment
Allowed: sandbox production
base_urltextread, writeAddress (https) — Where documents are posted.
auth_kindtextread, writeAuthentication
Allowed: none bearer basic api_key
usernametextread, writeUser name
secret_cipherbytearead onlySecret cipher
settingsjsonbread, writeSettings
is_activebooleanread, writeActive
last_statustextread onlyLast status
last_messagetextread onlyLast message
last_used_attimestamp with time zoneread onlyLast used at
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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-invoicing Connections 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.