TRANXACT.AI Help

Accounting · E-invoicing

E-invoicing Customer Identifiers

What each customer’s e-invoice must carry: the Peppol participant id, a German public buyer’s Leitweg-ID, the Italian codice destinatario or PEC, the Mexican RFC and uso CFDI, the Polish NIP.

Type REST6 operationsBase path /api/accounting/einvoice-party-idsPublished as /api/v1/einvoice-party-ids

Download specification (OpenAPI 3.1) Screen: E-invoicing Customer Identifiers

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 Customer Identifiers 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_party_ids · 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-party-idsList e-invoicing customer identifiers

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",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "preferred_format": "peppol-bis-3",
      "vat_id": "text",
      "legal_id": "text",
      "peppol_scheme": "text",
      "peppol_id": "text",
      "leitweg_id": "text",
      "buyer_reference": "text",
      "it_codice_destinatario": "text",
      "it_pec": "text",
      "it_codice_fiscale": "text",
      "mx_rfc": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_format": "peppol-bis-3",
  "vat_id": "text",
  "legal_id": "text",
  "peppol_scheme": "text",
  "peppol_id": "text",
  "leitweg_id": "text",
  "buyer_reference": "text",
  "it_codice_destinatario": "text",
  "it_pec": "text",
  "it_codice_fiscale": "text",
  "mx_rfc": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
account_iduuidYesCustomer
preferred_formattextNoPreferred format
Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl
vat_idtextNoVAT id (BT-48) — With its country prefix. Empty takes the customer record’s tax number.
legal_idtextNoRegistration number (BT-47)
peppol_schemetextNoPeppol scheme
peppol_idtextNoPeppol participant id
leitweg_idtextNoLeitweg-ID (Germany, BT-10) — A German public buyer’s routing id, such as 991-12345-67.
buyer_referencetextNoBuyer reference (BT-10) — Whatever the buyer asks invoices to quote.
it_codice_destinatariotextNoCodice destinatario (Italy) — Seven characters; 0000000 when invoices go to a PEC address.
it_pectextNoPEC address (Italy)
it_codice_fiscaletextNoCodice fiscale (Italy)
mx_rfctextNoRFC (Mexico)
mx_uso_cfditextNoUso CFDI (Mexico) — G03 gastos en general, for instance.
mx_regimen_fiscaltextNoRégimen fiscal (Mexico)
mx_domicilio_cptextNoDomicilio fiscal postcode (Mexico)
pl_niptextNoNIP (Poland)
streettextNoStreet — The address the e-invoice gives, when the customer record’s will not do.
citytextNoCity
postal_codetextNoPostcode
subdivisiontextNoRegion or province
countrytextNoCountry (ISO code)
notestextNoNotes

Sample body

{
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_format": "peppol-bis-3",
  "vat_id": "text",
  "legal_id": "text",
  "peppol_scheme": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_format": "peppol-bis-3",
  "vat_id": "text",
  "legal_id": "text",
  "peppol_scheme": "text",
  "peppol_id": "text",
  "leitweg_id": "text",
  "buyer_reference": "text",
  "it_codice_destinatario": "text",
  "it_pec": "text",
  "it_codice_fiscale": "text",
  "mx_rfc": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/einvoice-party-ids" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","preferred_format":"peppol-bis-3","vat_id":"text","legal_id":"text","peppol_scheme":"text"}'
PUT/api/accounting/einvoice-party-ids/{id}Change a einvoice party ids

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
account_iduuidYesCustomer
preferred_formattextNoPreferred format
Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl
vat_idtextNoVAT id (BT-48) — With its country prefix. Empty takes the customer record’s tax number.
legal_idtextNoRegistration number (BT-47)
peppol_schemetextNoPeppol scheme
peppol_idtextNoPeppol participant id
leitweg_idtextNoLeitweg-ID (Germany, BT-10) — A German public buyer’s routing id, such as 991-12345-67.
buyer_referencetextNoBuyer reference (BT-10) — Whatever the buyer asks invoices to quote.
it_codice_destinatariotextNoCodice destinatario (Italy) — Seven characters; 0000000 when invoices go to a PEC address.
it_pectextNoPEC address (Italy)
it_codice_fiscaletextNoCodice fiscale (Italy)
mx_rfctextNoRFC (Mexico)
mx_uso_cfditextNoUso CFDI (Mexico) — G03 gastos en general, for instance.
mx_regimen_fiscaltextNoRégimen fiscal (Mexico)
mx_domicilio_cptextNoDomicilio fiscal postcode (Mexico)
pl_niptextNoNIP (Poland)
streettextNoStreet — The address the e-invoice gives, when the customer record’s will not do.
citytextNoCity
postal_codetextNoPostcode
subdivisiontextNoRegion or province
countrytextNoCountry (ISO code)
notestextNoNotes

Sample body

{
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_format": "peppol-bis-3"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_format": "peppol-bis-3",
  "vat_id": "text",
  "legal_id": "text",
  "peppol_scheme": "text",
  "peppol_id": "text",
  "leitweg_id": "text",
  "buyer_reference": "text",
  "it_codice_destinatario": "text",
  "it_pec": "text",
  "it_codice_fiscale": "text",
  "mx_rfc": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/einvoice-party-ids/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","preferred_format":"peppol-bis-3"}'
DELETE/api/accounting/einvoice-party-ids/{id}Delete a einvoice party ids

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-party-ids/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/einvoice-party-ids/{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-party-ids/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 party ids, 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
account_iduuidread, writeCustomer
preferred_formattextread, writePreferred format
Allowed: peppol-bis-3 xrechnung-ubl xrechnung-cii factur-x fatturapa ksef-fa2 ksef-fa3 cfdi-40 zatca zatca-ubl
vat_idtextread, writeVAT id (BT-48) — With its country prefix. Empty takes the customer record’s tax number.
legal_idtextread, writeRegistration number (BT-47)
peppol_schemetextread, writePeppol scheme
peppol_idtextread, writePeppol participant id
leitweg_idtextread, writeLeitweg-ID (Germany, BT-10) — A German public buyer’s routing id, such as 991-12345-67.
buyer_referencetextread, writeBuyer reference (BT-10) — Whatever the buyer asks invoices to quote.
it_codice_destinatariotextread, writeCodice destinatario (Italy) — Seven characters; 0000000 when invoices go to a PEC address.
it_pectextread, writePEC address (Italy)
it_codice_fiscaletextread, writeCodice fiscale (Italy)
mx_rfctextread, writeRFC (Mexico)
mx_uso_cfditextread, writeUso CFDI (Mexico) — G03 gastos en general, for instance.
mx_regimen_fiscaltextread, writeRégimen fiscal (Mexico)
mx_domicilio_cptextread, writeDomicilio fiscal postcode (Mexico)
pl_niptextread, writeNIP (Poland)
streettextread, writeStreet — The address the e-invoice gives, when the customer record’s will not do.
citytextread, writeCity
postal_codetextread, writePostcode
subdivisiontextread, writeRegion or province
countrytextread, writeCountry (ISO code)
notestextread, writeNotes
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 Customer Identifiers 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.