Accounting · E-invoicing
E-invoicing Profiles
How this company issues structured e-invoices: the country, the format (Peppol BIS, XRechnung, Factur-X, FatturaPA, KSeF, CFDI 4.0), the seller’s identifiers and how documents leave. A company with no active profile issues no e-invoices.
/api/accounting/einvoice-profilesPublished as /api/v1/einvoice-profilesDownload specification (OpenAPI 3.1) Screen: E-invoicing Profiles
Overview
| 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-invoicing Profiles 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_profiles · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/einvoice-profilesList e-invoicing profiles
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",
"profile_no": "PRO-000001",
"name": "Example",
"country": "US",
"format": "peppol-bis-3",
"is_active": true,
"is_default": true,
"seller_name": "Example",
"seller_vat_id": "text",
"seller_tax_reg_id": "text",
"seller_legal_id": "text",
"seller_street": "text",
"seller_city": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-profiles?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/einvoice-profiles/{id}Read one einvoice profiles
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",
"profile_no": "PRO-000001",
"name": "Example",
"country": "US",
"format": "peppol-bis-3",
"is_active": true,
"is_default": true,
"seller_name": "Example",
"seller_vat_id": "text",
"seller_tax_reg_id": "text",
"seller_legal_id": "text",
"seller_street": "text",
"seller_city": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/einvoice-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/einvoice-profilesCreate a einvoice profiles
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
country | text | Yes | Country (ISO code) — DE, FR, IT, PL, MX, BE, NL... |
format | text | Yes | Format Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl |
is_active | boolean | No | Active |
is_default | boolean | No | Default format for this company |
seller_name | text | No | Seller name — Empty takes the company’s legal name. |
seller_vat_id | text | No | Seller VAT id (BT-31) — With its country prefix: DE123456789, IT01234567890. |
seller_tax_reg_id | text | No | Seller tax number (BT-32) |
seller_legal_id | text | No | Seller registration number (BT-30) |
seller_street | text | No | Street |
seller_city | text | No | City |
seller_postal_code | text | No | Postcode |
seller_subdivision | text | No | Region or province |
contact_name | text | No | Contact name |
contact_phone | text | No | Contact phone |
contact_email | text | No | Contact email |
peppol_scheme | text | No | Peppol endpoint scheme — 0088 GLN, 0192 Norwegian org no, 0208 Belgian enterprise no, 9930 German VAT... |
peppol_id | text | No | Peppol endpoint id |
it_regime_fiscale | text | No | Regime fiscale (Italy) — RF01 for the ordinary regime. |
it_codice_fiscale | text | No | Codice fiscale (Italy) |
it_progressivo_prefix | text | No | Progressivo invio prefix (Italy) |
mx_rfc | text | No | RFC (Mexico) |
mx_regimen_fiscal | text | No | Régimen fiscal (Mexico) — Three digits: 601 general de ley personas morales. |
mx_lugar_expedicion | text | No | Lugar de expedición (Mexico) — The postcode the invoice is issued from. |
mx_serie | text | No | Serie (Mexico) |
pl_nip | text | No | NIP (Poland) |
payment_means_code | text | No | Payment means (UNCL 4461) — 58 SEPA credit transfer, 30 credit transfer, 49 direct debit. |
iban | text | No | IBAN |
bic | text | No | BIC |
transport | text | No | Sends by — File: generated and downloaded, sent by whoever uploads it. HTTP: posted to the connection below. Allowed: file http |
connection_id | uuid | No | Connection |
notes | text | No | Notes |
auto_submit | boolean | No | Submit automatically when an invoice posts |
retry_max_attempts | integer | No | Attempts before a person is needed |
retry_backoff_minutes | integer | No | First retry after (minutes, doubled each time) |
invoice_template_id | uuid | No | Invoice printed on — The company's own invoice form (Platform > Printed Forms). Empty: the plain copy. |
credit_note_template_id | uuid | No | Credit note printed on |
Sample body
{
"name": "Example",
"country": "US",
"format": "peppol-bis-3",
"is_active": true,
"is_default": true,
"seller_name": "Example",
"seller_vat_id": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profile_no": "PRO-000001",
"name": "Example",
"country": "US",
"format": "peppol-bis-3",
"is_active": true,
"is_default": true,
"seller_name": "Example",
"seller_vat_id": "text",
"seller_tax_reg_id": "text",
"seller_legal_id": "text",
"seller_street": "text",
"seller_city": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-profiles" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","country":"US","format":"peppol-bis-3","is_active":true,"is_default":true,"seller_name":"Example","seller_vat_id":"text"}'PUT/api/accounting/einvoice-profiles/{id}Change a einvoice profiles
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
country | text | Yes | Country (ISO code) — DE, FR, IT, PL, MX, BE, NL... |
format | text | Yes | Format Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl |
is_active | boolean | No | Active |
is_default | boolean | No | Default format for this company |
seller_name | text | No | Seller name — Empty takes the company’s legal name. |
seller_vat_id | text | No | Seller VAT id (BT-31) — With its country prefix: DE123456789, IT01234567890. |
seller_tax_reg_id | text | No | Seller tax number (BT-32) |
seller_legal_id | text | No | Seller registration number (BT-30) |
seller_street | text | No | Street |
seller_city | text | No | City |
seller_postal_code | text | No | Postcode |
seller_subdivision | text | No | Region or province |
contact_name | text | No | Contact name |
contact_phone | text | No | Contact phone |
contact_email | text | No | Contact email |
peppol_scheme | text | No | Peppol endpoint scheme — 0088 GLN, 0192 Norwegian org no, 0208 Belgian enterprise no, 9930 German VAT... |
peppol_id | text | No | Peppol endpoint id |
it_regime_fiscale | text | No | Regime fiscale (Italy) — RF01 for the ordinary regime. |
it_codice_fiscale | text | No | Codice fiscale (Italy) |
it_progressivo_prefix | text | No | Progressivo invio prefix (Italy) |
mx_rfc | text | No | RFC (Mexico) |
mx_regimen_fiscal | text | No | Régimen fiscal (Mexico) — Three digits: 601 general de ley personas morales. |
mx_lugar_expedicion | text | No | Lugar de expedición (Mexico) — The postcode the invoice is issued from. |
mx_serie | text | No | Serie (Mexico) |
pl_nip | text | No | NIP (Poland) |
payment_means_code | text | No | Payment means (UNCL 4461) — 58 SEPA credit transfer, 30 credit transfer, 49 direct debit. |
iban | text | No | IBAN |
bic | text | No | BIC |
transport | text | No | Sends by — File: generated and downloaded, sent by whoever uploads it. HTTP: posted to the connection below. Allowed: file http |
connection_id | uuid | No | Connection |
notes | text | No | Notes |
auto_submit | boolean | No | Submit automatically when an invoice posts |
retry_max_attempts | integer | No | Attempts before a person is needed |
retry_backoff_minutes | integer | No | First retry after (minutes, doubled each time) |
invoice_template_id | uuid | No | Invoice printed on — The company's own invoice form (Platform > Printed Forms). Empty: the plain copy. |
credit_note_template_id | uuid | No | Credit note printed on |
Sample body
{
"name": "Example",
"country": "US"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"profile_no": "PRO-000001",
"name": "Example",
"country": "US",
"format": "peppol-bis-3",
"is_active": true,
"is_default": true,
"seller_name": "Example",
"seller_vat_id": "text",
"seller_tax_reg_id": "text",
"seller_legal_id": "text",
"seller_street": "text",
"seller_city": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/einvoice-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","country":"US"}'DELETE/api/accounting/einvoice-profiles/{id}Delete a einvoice profiles
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/einvoice-profiles/{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-profiles/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 profiles, 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 |
profile_no | text | read only | Profile no |
name | text | read, write | Name |
country | text | read, write | Country (ISO code) — DE, FR, IT, PL, MX, BE, NL... |
format | text | read, write | Format Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl |
is_active | boolean | read, write | Active |
is_default | boolean | read, write | Default format for this company |
seller_name | text | read, write | Seller name — Empty takes the company’s legal name. |
seller_vat_id | text | read, write | Seller VAT id (BT-31) — With its country prefix: DE123456789, IT01234567890. |
seller_tax_reg_id | text | read, write | Seller tax number (BT-32) |
seller_legal_id | text | read, write | Seller registration number (BT-30) |
seller_street | text | read, write | Street |
seller_city | text | read, write | City |
seller_postal_code | text | read, write | Postcode |
seller_subdivision | text | read, write | Region or province |
contact_name | text | read, write | Contact name |
contact_phone | text | read, write | Contact phone |
contact_email | text | read, write | Contact email |
peppol_scheme | text | read, write | Peppol endpoint scheme — 0088 GLN, 0192 Norwegian org no, 0208 Belgian enterprise no, 9930 German VAT... |
peppol_id | text | read, write | Peppol endpoint id |
it_regime_fiscale | text | read, write | Regime fiscale (Italy) — RF01 for the ordinary regime. |
it_codice_fiscale | text | read, write | Codice fiscale (Italy) |
it_progressivo_prefix | text | read, write | Progressivo invio prefix (Italy) |
mx_rfc | text | read, write | RFC (Mexico) |
mx_regimen_fiscal | text | read, write | Régimen fiscal (Mexico) — Three digits: 601 general de ley personas morales. |
mx_lugar_expedicion | text | read, write | Lugar de expedición (Mexico) — The postcode the invoice is issued from. |
mx_serie | text | read, write | Serie (Mexico) |
pl_nip | text | read, write | NIP (Poland) |
payment_means_code | text | read, write | Payment means (UNCL 4461) — 58 SEPA credit transfer, 30 credit transfer, 49 direct debit. |
iban | text | read, write | IBAN |
bic | text | read, write | BIC |
transport | text | read, write | Sends by — File: generated and downloaded, sent by whoever uploads it. HTTP: posted to the connection below. Allowed: file http |
connection_id | uuid | read, write | Connection |
notes | text | read, write | Notes |
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 |
auto_submit | boolean | read, write | Submit automatically when an invoice posts |
retry_max_attempts | integer | read, write | Attempts before a person is needed |
retry_backoff_minutes | integer | read, write | First retry after (minutes, doubled each time) |
invoice_template_id | uuid | read, write | Invoice printed on — The company's own invoice form (Platform > Printed Forms). Empty: the plain copy. |
credit_note_template_id | uuid | read, write | Credit note printed on |
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-invoicing Profiles 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.