Which PINT AE fields the API supports
How the business terms (BT / IBT) of PINT AE map to the JSON fields of the Alya Books API.
PINT AE names each piece of invoice data with a business term such as BT-1 (invoice number). The tables show the matching camelCase JSON field of the Alya Books API. Terms not listed (for example BT-23, BT-24) are set by Alya Books.
Document level
| Term | Meaning | API field |
|---|---|---|
| BT-1 | Invoice number | invoiceNumber (optional, allocated from the series) |
| BT-2 / BT-9 | Issue date / due date | issueDate; dueDate or payment.termsDays |
| BT-3 | Type code | invoiceTypeCode (380, 381, 480, 81; 389 and 261 with self-billing on) |
| BT-5 / BT-6 | Currency / VAT accounting currency | currency, vatAccountingCurrency |
| BT-10 / BT-13 | Buyer reference / order reference | buyerReference, order reference |
| BT-22 | Notes | notes |
| BT-25 / BT-26 | Preceding invoice number / date | precedingInvoice.number, precedingInvoice.issueDate |
| IBG-03 | Prepayment invoice (on an invoice) | prepaymentInvoice.number, prepaymentInvoice.issueDate |
| IBT-113 / IBT-114 / IBT-115 | Paid in advance / rounding / amount due | prepaidAmount, roundingAmount; payableAmount is returned |
| BTAE-02 | Transaction type flags | transactionType |
| BTAE-01 | Beneficiary ID (free zone) | beneficiaryId; the buyer when left out |
| BTAE-14 | Principal ID (disclosed agent) | principalId |
| BTAE-06 | Frequency of billing | billingPeriod.frequency |
| IBT-079 | Delivery emirate, state or region | delivery.emirate |
| IBG-12 | Tax representative address | taxRepresentative.street, .city, .emirate, .country |
Other header terms (BT-7, BT-11, BT-12, BT-20, BT-59 to BT-80: tax point, project, contract, payment terms, payee, tax representative, delivery) are completed in the app's field configuration.
Parties
| Term | Meaning | Source |
|---|---|---|
| BT-27 to BT-43 | Seller name, TRN, Peppol ID, address, contact | Settings (not per request) |
| BT-44, BT-48, BT-49 | Buyer name, TRN, Peppol ID | buyer.name, buyer.trn, buyer.peppolId |
| BG-8 | Buyer address | buyer.address.{street, additional, city, emirate, postalCode, country} |
Payment, allowances and lines
| Term | Meaning | API field |
|---|---|---|
| BT-81 to BT-86 | Payment means, payment ID, IBAN, account name, BIC | payment.accountId and related payment fields |
| BT-92 to BT-104 | Document discounts and charges | allowances[] with amount, chargeIndicator, reason, taxCategory, taxRate |
| BT-126 to BT-146 | Line ID, quantity, unit, net amount, net price | items[] position, quantity, unit code, unitPrice; amount computed |
| BT-151 / BT-152 | Tax category / rate | items[].taxCategory (standard, zero_rated, exempt, reverse_charge), items[].taxRate |
| BT-153 / BT-158 | Description / HS code | items[].description, items[].hsnSacCode |
| BTAE-13 / BTAE-17 | Item type / service accounting code | items[].itemType (G, S, B), items[].serviceAccountingCode |
| IBT-134 / IBT-135 | Line billing period start / end | items[].billingPeriod.startDate, items[].billingPeriod.endDate |
Good to know
- The full list with UBL paths is on the Fields tab of PINT AE Reference and in the OpenAPI specification linked from API access.
- Optional terms such as address line 3, the deliver-to party, line references and item attributes are sent in
optionalFieldson the invoice and on each item. Each belongs to a group that Alya Books support switches on per company; see Optional e-invoice fields. A field whose group is off is refused, and the error names it. exchangeRateSourcenames where a suppliedexchangeRatecomes from (free text, 200 characters); give it for currencies the Central Bank does not publish. It is kept with the invoice and not written to the XML.- A buyer abroad (
buyer.address.countrynotAE) may have any VAT number inbuyer.trn, up to 30 characters; for UAE buyers it must be 15 digits. - Custom fields (
metadata) are not PINT AE terms and are not written to the XML. Totals (BT-106 to BT-115) are always computed by Alya Books.