TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/accounting/einvoice-profilesPublished as /api/v1/einvoice-profiles

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

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 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.
Tableacct.einvoice_profiles · 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

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

GET/api/accounting/einvoice-profilesList e-invoicing profiles

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
nametextYesName
countrytextYesCountry (ISO code) — DE, FR, IT, PL, MX, BE, NL...
formattextYesFormat
Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl
is_activebooleanNoActive
is_defaultbooleanNoDefault format for this company
seller_nametextNoSeller name — Empty takes the company’s legal name.
seller_vat_idtextNoSeller VAT id (BT-31) — With its country prefix: DE123456789, IT01234567890.
seller_tax_reg_idtextNoSeller tax number (BT-32)
seller_legal_idtextNoSeller registration number (BT-30)
seller_streettextNoStreet
seller_citytextNoCity
seller_postal_codetextNoPostcode
seller_subdivisiontextNoRegion or province
contact_nametextNoContact name
contact_phonetextNoContact phone
contact_emailtextNoContact email
peppol_schemetextNoPeppol endpoint scheme — 0088 GLN, 0192 Norwegian org no, 0208 Belgian enterprise no, 9930 German VAT...
peppol_idtextNoPeppol endpoint id
it_regime_fiscaletextNoRegime fiscale (Italy) — RF01 for the ordinary regime.
it_codice_fiscaletextNoCodice fiscale (Italy)
it_progressivo_prefixtextNoProgressivo invio prefix (Italy)
mx_rfctextNoRFC (Mexico)
mx_regimen_fiscaltextNoRégimen fiscal (Mexico) — Three digits: 601 general de ley personas morales.
mx_lugar_expediciontextNoLugar de expedición (Mexico) — The postcode the invoice is issued from.
mx_serietextNoSerie (Mexico)
pl_niptextNoNIP (Poland)
payment_means_codetextNoPayment means (UNCL 4461) — 58 SEPA credit transfer, 30 credit transfer, 49 direct debit.
ibantextNoIBAN
bictextNoBIC
transporttextNoSends by — File: generated and downloaded, sent by whoever uploads it. HTTP: posted to the connection below.
Allowed: file http
connection_iduuidNoConnection
notestextNoNotes
auto_submitbooleanNoSubmit automatically when an invoice posts
retry_max_attemptsintegerNoAttempts before a person is needed
retry_backoff_minutesintegerNoFirst retry after (minutes, doubled each time)
invoice_template_iduuidNoInvoice printed on — The company's own invoice form (Platform > Printed Forms). Empty: the plain copy.
credit_note_template_iduuidNoCredit 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

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
nametextYesName
countrytextYesCountry (ISO code) — DE, FR, IT, PL, MX, BE, NL...
formattextYesFormat
Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl
is_activebooleanNoActive
is_defaultbooleanNoDefault format for this company
seller_nametextNoSeller name — Empty takes the company’s legal name.
seller_vat_idtextNoSeller VAT id (BT-31) — With its country prefix: DE123456789, IT01234567890.
seller_tax_reg_idtextNoSeller tax number (BT-32)
seller_legal_idtextNoSeller registration number (BT-30)
seller_streettextNoStreet
seller_citytextNoCity
seller_postal_codetextNoPostcode
seller_subdivisiontextNoRegion or province
contact_nametextNoContact name
contact_phonetextNoContact phone
contact_emailtextNoContact email
peppol_schemetextNoPeppol endpoint scheme — 0088 GLN, 0192 Norwegian org no, 0208 Belgian enterprise no, 9930 German VAT...
peppol_idtextNoPeppol endpoint id
it_regime_fiscaletextNoRegime fiscale (Italy) — RF01 for the ordinary regime.
it_codice_fiscaletextNoCodice fiscale (Italy)
it_progressivo_prefixtextNoProgressivo invio prefix (Italy)
mx_rfctextNoRFC (Mexico)
mx_regimen_fiscaltextNoRégimen fiscal (Mexico) — Three digits: 601 general de ley personas morales.
mx_lugar_expediciontextNoLugar de expedición (Mexico) — The postcode the invoice is issued from.
mx_serietextNoSerie (Mexico)
pl_niptextNoNIP (Poland)
payment_means_codetextNoPayment means (UNCL 4461) — 58 SEPA credit transfer, 30 credit transfer, 49 direct debit.
ibantextNoIBAN
bictextNoBIC
transporttextNoSends by — File: generated and downloaded, sent by whoever uploads it. HTTP: posted to the connection below.
Allowed: file http
connection_iduuidNoConnection
notestextNoNotes
auto_submitbooleanNoSubmit automatically when an invoice posts
retry_max_attemptsintegerNoAttempts before a person is needed
retry_backoff_minutesintegerNoFirst retry after (minutes, doubled each time)
invoice_template_iduuidNoInvoice printed on — The company's own invoice form (Platform > Printed Forms). Empty: the plain copy.
credit_note_template_iduuidNoCredit 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

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-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/einvoice-profiles/{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-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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
profile_notextread onlyProfile no
nametextread, writeName
countrytextread, writeCountry (ISO code) — DE, FR, IT, PL, MX, BE, NL...
formattextread, writeFormat
Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl
is_activebooleanread, writeActive
is_defaultbooleanread, writeDefault format for this company
seller_nametextread, writeSeller name — Empty takes the company’s legal name.
seller_vat_idtextread, writeSeller VAT id (BT-31) — With its country prefix: DE123456789, IT01234567890.
seller_tax_reg_idtextread, writeSeller tax number (BT-32)
seller_legal_idtextread, writeSeller registration number (BT-30)
seller_streettextread, writeStreet
seller_citytextread, writeCity
seller_postal_codetextread, writePostcode
seller_subdivisiontextread, writeRegion or province
contact_nametextread, writeContact name
contact_phonetextread, writeContact phone
contact_emailtextread, writeContact email
peppol_schemetextread, writePeppol endpoint scheme — 0088 GLN, 0192 Norwegian org no, 0208 Belgian enterprise no, 9930 German VAT...
peppol_idtextread, writePeppol endpoint id
it_regime_fiscaletextread, writeRegime fiscale (Italy) — RF01 for the ordinary regime.
it_codice_fiscaletextread, writeCodice fiscale (Italy)
it_progressivo_prefixtextread, writeProgressivo invio prefix (Italy)
mx_rfctextread, writeRFC (Mexico)
mx_regimen_fiscaltextread, writeRégimen fiscal (Mexico) — Three digits: 601 general de ley personas morales.
mx_lugar_expediciontextread, writeLugar de expedición (Mexico) — The postcode the invoice is issued from.
mx_serietextread, writeSerie (Mexico)
pl_niptextread, writeNIP (Poland)
payment_means_codetextread, writePayment means (UNCL 4461) — 58 SEPA credit transfer, 30 credit transfer, 49 direct debit.
ibantextread, writeIBAN
bictextread, writeBIC
transporttextread, writeSends by — File: generated and downloaded, sent by whoever uploads it. HTTP: posted to the connection below.
Allowed: file http
connection_iduuidread, writeConnection
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
auto_submitbooleanread, writeSubmit automatically when an invoice posts
retry_max_attemptsintegerread, writeAttempts before a person is needed
retry_backoff_minutesintegerread, writeFirst retry after (minutes, doubled each time)
invoice_template_iduuidread, writeInvoice printed on — The company's own invoice form (Platform > Printed Forms). Empty: the plain copy.
credit_note_template_iduuidread, writeCredit note printed on
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 Profiles 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.