PINT AE field reference

Every business term of the UAE PINT AE profile, its UBL path, whether it is required, and the API field that carries it.

View as Markdown Open in Claude Open in ChatGPT

Generated from the catalogue that also drives the editor's field configuration and the MCP resource einvoicing://reference/pint-ae-fields. Seller terms (BG-4 to BG-6) come from the organization profile; computed terms are derived from lines and allowances.

Specification: urn:peppol:pint:billing-1@ae-1, profile urn:peppol:bis:billing, UBL 2.1 Invoice and CreditNote.

Document

BT	Name	UBL path	Required	API field	Notes
BT-1	Invoice number	`cbc:ID`	yes	`invoiceNumber`
BT-2	Issue date	`cbc:IssueDate`	yes	`issueDate`
BT-3	Invoice type code	`cbc:InvoiceTypeCode`	yes	`invoiceTypeCode`	UAE: 380, 381, 480, 81; self-billing: 389, 261
BT-5	Currency code	`cbc:DocumentCurrencyCode`	yes	`currency`
BT-6	VAT accounting currency	`cbc:TaxCurrencyCode`	no	`vatAccountingCurrency`	Set to AED automatically when the document currency is not AED
BT-7	Tax point date	`cbc:TaxPointDate`	no	`taxPointDate`
BT-9	Due date	`cbc:DueDate`	no	`dueDate`
BT-10	Buyer reference	`cbc:BuyerReference`	no	`buyerReference`	PO number or buyer's internal reference
BT-11	Project reference	`cac:ProjectReference > cbc:ID`	no	`projectReference`
BT-12	Contract reference	`cac:ContractDocumentReference > cbc:ID`	no	`contractReference`
BT-13	Order reference	`cac:OrderReference > cbc:ID`	no	`orderReference`
BT-14	Sales order reference	`cac:OrderReference > cbc:SalesOrderID`	no	`salesOrderReference`
BT-15	Receiving advice reference	`cac:ReceiptDocumentReference > cbc:ID`	no	`receiptReference`
BT-16	Despatch advice reference	`cac:DespatchDocumentReference > cbc:ID`	no	`despatchReference`
BT-17	Tender or lot reference	`cac:OriginatorDocumentReference > cbc:ID`	no	`tenderReference`
BT-19	Buyer accounting reference	`cbc:AccountingCost`	no	`buyerAccountingReference`
BTAE-05	Customs reference number	`cac:StatementDocumentReference > cbc:ID`	no	`customsReference`
BT-20	Payment terms text	`cac:PaymentTerms > cbc:Note`	no	`payment.termsText`
BT-22	Notes	`cbc:Note`	no	`notes`
BT-23	Business process type	`cbc:ProfileID`	yes	`(auto-set)`	urn:peppol:bis:billing
BT-24	Specification ID	`cbc:CustomizationID`	yes	`(auto-set)`	urn:peppol:pint:billing-1@ae-1

Delivery (BG-13)

BT	Name	UBL path	Required	API field	Notes
BTAE-22	Incoterms	`cac:DeliveryTerms > cbc:ID`	no	`incoterms`	Incoterms 2020 code
BT-72	Delivery date	`cac:Delivery > cbc:ActualDeliveryDate`	no	`deliveryDate`
BT-70	Delivery name	`cac:Delivery > cac:DeliveryLocation > cbc:Description`	no	`delivery.name`
BT-75	Delivery address street	`cac:Delivery > cac:DeliveryLocation > cac:Address > cbc:StreetName`	no	`delivery.street`
BT-77	Delivery city	`cac:Delivery > cac:DeliveryLocation > cac:Address > cbc:CityName`	no	`delivery.city`
BT-80	Delivery country code	`cac:Delivery > cac:DeliveryLocation > cac:Address > cac:Country > cbc:IdentificationCode`	no	`delivery.country`
BT-79	Delivery emirate, state or region	`cac:Delivery > cac:DeliveryLocation > cac:Address > cbc:CountrySubentity`	no	`deliveryAddressEmirate`	Required on e-commerce supplies and exports (IBR-142-AE, IBR-152-AE)

Preceding Invoice (BG-3)

BT	Name	UBL path	Required	API field	Notes
BT-25	Preceding invoice reference	`cac:BillingReference > cac:InvoiceDocumentReference > cbc:ID`	no	`precedingInvoice.number`	Required for credit/debit notes (381, 81, 383)
BT-26	Preceding invoice issue date	`cac:BillingReference > cac:InvoiceDocumentReference > cbc:IssueDate`	no	`precedingInvoice.issueDate`

Seller (BG-4)

BT	Name	UBL path	Required	API field	Notes
BT-27	Seller name	`cac:AccountingSupplierParty > cac:Party > cac:PartyName > cbc:Name`	yes	`organization profile`
BT-31	Seller tax ID (TRN)	`cac:AccountingSupplierParty > cac:PartyTaxScheme > cbc:CompanyID`	yes	`organization profile`	Exactly 15 digits for UAE
BT-34	Seller endpoint ID	`cac:AccountingSupplierParty > cac:EndpointID`	no	`organization profile`	Peppol participant ID
BTAE-14	Principal ID	`cac:SellerSupplierParty > cac:Party > cac:PartyIdentification > cbc:ID`	no	`principalId`	Disclosed agent billing (IBR-137-AE)

Seller Address (BG-5)

BT	Name	UBL path	Required	API field	Notes
BT-35	Seller address street	`cbc:StreetName`	yes	`organization profile`
BT-37	Seller city	`cbc:CityName`	yes	`organization profile`
BT-38	Seller postal code	`cbc:PostalZone`	no	`organization profile`
BT-39	Seller emirate/state	`cbc:CountrySubentity`	no	`organization profile`
BT-40	Seller country code	`cac:Country > cbc:IdentificationCode`	yes	`organization profile`	Default: AE

Seller Contact (BG-6)

BT	Name	UBL path	Required	API field
BT-41	Seller contact name	`cac:Contact > cbc:Name`	no	`organization profile`
BT-42	Seller contact telephone	`cac:Contact > cbc:Telephone`	no	`organization profile`
BT-43	Seller contact email	`cac:Contact > cbc:ElectronicMail`	no	`organization profile`

Buyer (BG-7)

BT	Name	UBL path	Required	API field	Notes
BT-44	Buyer name	`cac:AccountingCustomerParty > cac:PartyName > cbc:Name`	yes	`buyer.name`
BT-48	Buyer tax ID (TRN)	`cac:AccountingCustomerParty > cac:PartyTaxScheme > cbc:CompanyID`	no	`buyer.trn`	Required for VAT-registered buyers
BT-49	Buyer endpoint ID	`cac:AccountingCustomerParty > cac:EndpointID`	no	`buyer.peppolId`
BTAE-01	Beneficiary ID	`cac:BuyerCustomerParty > cac:Party > cac:PartyIdentification > cbc:ID`	no	`beneficiaryId`	Free zone supplies (IBR-007-AE); the buyer when left empty

Payee (BG-10)

BT	Name	UBL path	Required	API field	Notes
BT-59	Payee name	`cac:PayeeParty > cac:PartyName > cbc:Name`	no	`payee.name`	Required when payee differs from seller
BT-60	Payee identifier	`cac:PayeeParty > cac:PartyIdentification > cbc:ID`	no	`payee.id`

Tax Representative (BG-11)

BT	Name	UBL path	Required	API field	Notes
BT-62	Tax representative name	`cac:TaxRepresentativeParty > cac:PartyName > cbc:Name`	no	`taxRepresentative.name`
BT-63	Tax representative TRN	`cac:TaxRepresentativeParty > cac:PartyTaxScheme > cbc:CompanyID`	no	`taxRepresentative.trn`	Required when tax rep name is provided

Invoicing Period (BG-14)

BT	Name	UBL path	Required	API field	Notes
BTAE-06	Frequency of billing	`cac:InvoicePeriod > cbc:DescriptionCode`	no	`billingFrequency`	DLY, WKY, Q15, MTH, Q45, Q60, QTR, YRL, HYR, OTH
BT-73	Invoicing period start	`cac:InvoicePeriod > cbc:StartDate`	no	`billingPeriod.startDate`
BT-74	Invoicing period end	`cac:InvoicePeriod > cbc:EndDate`	no	`billingPeriod.endDate`

Payment (BG-16)

BT	Name	UBL path	Required	API field	Notes
BT-81	Payment means code	`cac:PaymentMeans > cbc:PaymentMeansCode`	yes	`paymentMeans[].code`	Several payment methods per invoice. UAE: 1, 10, 20, 21, 30, 49, 54, 55, 68. Required except on credit notes and deemed supplies (IBR-191-AE)
BT-82	Payment means text	`cac:PaymentMeans > cbc:PaymentMeansCode/@name`	no	`paymentMeans[].information`
BT-83	Remittance information (payment reference)	`cac:PaymentMeans > cbc:PaymentID`	no	`paymentMeans[].reference`
BT-84	Payment account (IBAN)	`cac:PayeeFinancialAccount > cbc:ID`	no	`paymentMeans[].accountId`	Required for credit transfer (IBR-192-AE); defaults to the account in Settings → Bank details
BT-85	Payment account name	`cac:PayeeFinancialAccount > cbc:Name`	no	`paymentMeans[].accountName`
BT-86	Payment BIC/SWIFT	`cac:PayeeFinancialAccount > cac:FinancialInstitutionBranch > cbc:ID`	no	`paymentMeans[].bic`
BT-87	Payment card number (last digits)	`cac:CardAccount > cbc:PrimaryAccountNumberID`	no	`paymentMeans[].cardPan`	Last 4 to 6 digits only; at most one card per invoice (IBR-066)
BT-88	Payment card holder	`cac:CardAccount > cbc:HolderName`	no	`paymentMeans[].cardHolder`
BT-89	Mandate reference	`cac:PaymentMandate > cbc:ID`	no	`paymentMeans[].mandateReference`	At most one direct debit per invoice (IBR-067)
BT-90	Bank-assigned creditor identifier	`cac:AccountingSupplierParty > cac:Party > cac:PartyIdentification > cbc:ID[@schemeID='SEPA']`	no	`paymentMeans[].creditorId`
BT-91	Debited account	`cac:PaymentMandate > cac:PayerFinancialAccount > cbc:ID`	no	`paymentMeans[].debitedAccount`
BT-178	Payment instructions ID	`cac:PaymentMeans > cbc:ID`	no	`paymentMeans[].instructionId`

Allowances/Charges (BG-20/21)

BT	Name	UBL path	Required	API field	Notes
BT-92	Allowance amount	`cac:AllowanceCharge > cbc:Amount`	yes	`allowances[].amount`	Must be > 0
BT-93	Allowance base amount	`cac:AllowanceCharge > cbc:BaseAmount`	no	`allowances[].baseAmount`
BT-94	Allowance percentage	`cac:AllowanceCharge > cbc:MultiplierFactorNumeric`	no	`allowances[].percentage`
BT-97	Allowance reason	`cac:AllowanceCharge > cbc:AllowanceChargeReason`	no	`allowances[].reason`	Reason or reason code required
BT-99	Charge amount	`cac:AllowanceCharge > cbc:Amount`	yes	`allowances[].amount`	charge_indicator=true
BT-104	Charge reason	`cac:AllowanceCharge > cbc:AllowanceChargeReason`	no	`allowances[].reason`	charge_indicator=true

Totals (BG-22)

BT	Name	UBL path	Required	API field
BT-106	Sum of line net amounts	`cac:LegalMonetaryTotal > cbc:LineExtensionAmount`	yes	`(computed)`
BT-109	Tax exclusive amount	`cbc:TaxExclusiveAmount`	yes	`(computed)`
BT-110	Tax total amount	`cac:TaxTotal > cbc:TaxAmount`	yes	`(computed)`
BT-112	Tax inclusive amount	`cbc:TaxInclusiveAmount`	yes	`(computed)`
BT-115	Payable amount	`cbc:PayableAmount`	yes	`(computed)`

Line (BG-25)

BT	Name	UBL path	Required	API field	Notes
BT-126	Line ID	`cac:InvoiceLine > cbc:ID`	yes	`items[].lineNumber`
BT-129	Invoiced quantity	`cbc:InvoicedQuantity`	yes	`items[].quantity`	Must be > 0
BT-130	Quantity unit code	`cbc:InvoicedQuantity@unitCode`	yes	`items[].unitCode`	UN/ECE Rec 20 codes (EA, KGM, etc.)
BT-131	Line net amount	`cbc:LineExtensionAmount`	yes	`items[].(computed)`	Must match qty × price
BT-146	Item net price	`cac:Price > cbc:PriceAmount`	yes	`items[].unitPrice`
BT-151	Tax category code	`cac:ClassifiedTaxCategory > cbc:ID`	yes	`items[].taxCategory`	S=Standard, Z=Zero-rated, E=Exempt, AE=Reverse charge
BT-121	VAT exemption reason code	`cac:ClassifiedTaxCategory > cbc:TaxExemptionReasonCode`	no	`items[].taxExemptionReasonCode`	UAE list DL8.46.1 to DL8.46.4; required on exempt lines (IBR-167-AE)
BT-152	Tax rate (%)	`cac:ClassifiedTaxCategory > cbc:Percent`	yes	`items[].taxRate`	UAE standard = 5%
BT-153	Item description	`cac:Item > cbc:Description`	yes	`items[].description`
BT-127	Line note	`cac:InvoiceLine > cbc:Note`	no	`items[].note`
BT-136	Line allowance (discount)	`cac:InvoiceLine > cac:AllowanceCharge[ChargeIndicator=false] > cbc:Amount`	no	`items[].allowanceAmount`	With reason IBT-139 / IBT-140
BT-141	Line charge	`cac:InvoiceLine > cac:AllowanceCharge[ChargeIndicator=true] > cbc:Amount`	no	`items[].chargeAmount`	With reason IBT-144 / IBT-145
BT-156	Buyer's item identifier	`cac:BuyersItemIdentification > cbc:ID`	no	`items[].buyerItemId`
BT-159	Item country of origin	`cac:OriginCountry > cbc:IdentificationCode`	no	`items[].originCountry`
BTAE-23	Batch number	`cac:ItemInstance > cac:LotIdentification > cbc:LotNumberID`	no	`items[].batchNumber`
BTAE-13	Item type	`cac:CommodityClassification > cbc:CommodityCode`	no	`items[].itemType`	G goods, S services, B both
BTAE-17	Service accounting code	`cac:AdditionalItemIdentification > cbc:ID[@schemeID='SAC']`	no	`items[].serviceAccountingCode`	Required for services (IBR-185-AE)
BT-158	Item classification (HS code)	`cac:CommodityClassification > cbc:ItemClassificationCode`	no	`items[].hsnCode`

Optional field groups in the editor

These switches in the editor's Fields dialog reveal groups of business terms; the API accepts them at any time.

Group	Business terms	API keys
Buyer reference / PO number	BT-10	`buyerReference`
Order reference	BT-13	`orderReference`
Sales order reference	BT-14	`salesOrderReference`
Contract reference and value	BT-12	`contractReference`, `contractValue`
Despatch and receiving advice	BT-16, BT-15	`despatchReference`, `receiptReference`
Tender or lot reference	BT-17	`tenderReference`
Customs reference and Incoterms	BTAE-22	`customsReference`, `incoterms`
Buyer accounting reference	BT-19	`buyerAccountingReference`
Project reference	BT-11	`projectReference`
Preceding invoice reference and date	BT-25, BT-26	`precedingInvoice.number`, `precedingInvoice.issueDate`
Invoicing period	BT-73, BT-74	`billingPeriod.startDate`, `billingPeriod.endDate`
Frequency of billing	BTAE-06	`billingFrequency`
Date of supply (tax point)	BT-7	`taxPointDate`
Delivery date and location	BT-72, BT-70	`deliveryDate`, `delivery.name`
Delivery address	BT-75, BT-77, BT-80	`delivery.street`, `delivery.city`, `deliveryAddressEmirate`, `delivery.country`
Payee (when different from seller)	BT-59, BT-60	`payee.name`, `payee.id`
Tax representative	BT-62, BT-63	`taxRepresentative.name`, `taxRepresentative.trn`, `sellerTaxRepStreet`, `sellerTaxRepCity`, `sellerTaxRepEmirate`, `sellerTaxRepCountryCode`
Beneficiary (free zone supplies)	BTAE-01	`beneficiaryId`
Principal (disclosed agent billing)	BTAE-14	`principalId`
Early payment discount tiers	BT-20	`earlyPaymentDiscounts`
Salutation, introduction and closing text	PDF only	`salutation`, `introduction`, `closing`, `signatureText`

MCP tools per group

Group	Tools
Invoice creation	`create_tax_invoice`, `create_credit_note`, `create_debit_note`, `create_invoices_batch`, `replace_draft_invoice`
Invoice management	`list_invoices`, `get_invoice`, `get_invoice_status`, `get_invoice_validation`, `validate_invoice`, `submit_invoice`, `send_invoice`, `download_invoice`, `delete_draft_invoice`, `update_invoice_housekeeping`, `list_design_templates`, `list_invoice_payments`, `record_invoice_payment`
Invoice numbers	`get_next_invoice_number`, `verify_invoice_number`, `get_invoice_number_settings`, `update_invoice_number_settings`
Incoming invoices	`simulate_incoming_invoice`, `import_incoming_invoice`, `list_incoming_imports`, `list_incoming_invoices`, `get_import`, `get_import_status`, `get_import_validation`, `get_import_content`, `get_import_summary`, `get_import_line_items`, `get_import_seller`, `get_import_buyer`, `get_import_taxes`, `get_import_payment_terms`, `get_import_payment_means`, `get_import_delivery`, `get_import_attachments`, `get_import_source`, `review_incoming_invoice`, `update_incoming_invoice`, `record_incoming_payment`, `delete_import`
Customers	`list_customers`, `get_customer`, `create_customer`, `update_customer`, `delete_customer`, `get_next_customer_number`, `verify_customer_number`, `lookup_peppol_participant`, `verify_customer_peppol`, `list_contact_persons`, `add_contact_person`, `update_contact_person`, `delete_contact_person`, `list_contact_addresses`, `add_contact_address`, `update_contact_address`, `delete_contact_address`, `import_customers`
Products	`list_products`, `get_product`, `create_product`, `update_product`, `delete_product`, `check_product_code`, `get_product_price`, `list_bundles`, `get_bundle`, `create_bundle`, `update_bundle`, `delete_bundle`, `expand_bundle`, `list_price_lists`, `get_price_list`, `create_price_list`, `update_price_list`, `delete_price_list`, `import_products`
Webhooks	`list_webhooks`, `list_webhook_events`, `create_webhook`, `update_webhook`, `delete_webhook`, `test_webhook`, `list_webhook_deliveries`, `retry_webhook_delivery`
Custom fields	`list_custom_fields`, `create_custom_field`, `update_custom_field`, `delete_custom_field`, `list_field_templates`, `create_field_template`, `update_field_template`, `activate_field_template`, `delete_field_template`
Projects	`list_projects`, `get_project`, `create_project`, `update_project`, `delete_project`, `list_project_documents`
Recurring invoices	`list_recurring_invoices`, `get_recurring_invoice`, `create_recurring_invoice`, `update_recurring_invoice`, `activate_recurring_invoice`, `pause_recurring_invoice`, `cancel_recurring_invoice`, `run_recurring_invoice_now`, `list_recurring_runs`, `preview_recurring_invoice`, `make_invoice_recurring`, `delete_recurring_invoice`
Settings	`list_email_templates`, `save_email_template`, `get_options`
VAT	`list_tax_rates`, `create_tax_rate`, `update_tax_rate`, `list_vat_periods`, `get_vat_worksheet`, `list_vat_returns`, `save_vat_return`, `reopen_vat_return`, `check_period_date`, `export_accounting`
ERP intake	`dry_run_invoice`, `dry_run_erp_message`, `send_erp_message`, `list_erp_messages`, `get_erp_message`, `replay_erp_message`, `list_erp_connectors`, `update_erp_connector`
Integrations	`list_connectors`, `sync_connector`
Payments	`create_payment_link`, `list_payment_links`, `cancel_payment_link`
Bank feeds	`list_bank_transactions`, `match_bank_transaction`, `ignore_bank_transaction`, `import_bank_statement`, `sync_bank_feeds`
Account	`get_account`, `list_managed_organizations`