Guide for FTA e-invoice Fields
How to read this guide:
Every field on the DocFlow e-invoice platform is listed below with its API key, PINT-AE business term, requirement level, definition and accepted values. Fields are grouped by form tab and numbered continuously across the guide.
Line Items tab
At least one line is required. Every key below sits inside an element of the lines[] array (the form posts them as items[n].*). Line net amount, VAT amount, line total and the AED restatements are calculated from quantity, price, allowance and charge.
item
#
field name
API key
business term
Required
description
accepted values
85
Line ID
lines[].lineNo
iBT-126
FTA mandatory
A unique identifier for the individual line within the Invoice.
Unique within the invoice; e.g. 1, 2, 3
86
Item name
lines[].item.name
ibt-153
FTA mandatory
A name for an item.
Free text
87
Item description
lines[].item.description
IBT-154
FTA mandatory
A description for an item.
Free text
88
Seller item ID
lines[].item.sellerItemId
IBT-155
optional
An identifier, assigned by the Seller, for the item.
An identifier, assigned by the Seller, for the item.
89
Item type
lines[].item.itemType
btae-13
Conditional — PINT-AE mandatory if applicable
The type of commodity, whether it is Goods or Services or Both.
GOODS; SERVICE; BOTH
90
Goods / services type
lines[].item.goodsOrServicesType
btae-09
Conditional — required when the item falls under the reverse charge mechanism
List of goods or services which are subject to RCM.
DL8.48.8.2 Electronic Devices; DL8.48.8.1 Gold and Diamonds; DL8.48.3.1 Crude or refined oil; DL8.48.3.2 Unprocessed or processed natural gas; DL8.48.3.3 Pure hydrocarbons
91
Standard item identifier
lines[].item.standardIdentifier.id
ibt-157
optional
An item identifier based on a registered scheme.
Identifier under the chosen scheme; e.g. GTIN 6291041500213
92
Standard item identifier scheme
lines[].item.standardIdentifier.schemeId
IBT-157-1
Conditional — required with a standard item identifier
The identification scheme identifier of the Item standard identifier.
ISO/IEC 6523 ICD code from the form list (0002–0248); e.g. 0160 GTIN, 0088 EAN Location Code
93
Country of origin
lines[].item.countryOfOriginCode
ibt-159
optional
The code identifying the country from which the item originates.
ISO 3166-1 alpha-2 code from the form list
94
Service accounting code
lines[].item.serviceAccountingCode
btae-17
Conditional — PINT-AE mandatory if applicable
A code for classifying the services based on its type or nature.
Service accounting code (SAC)
95
Object identifier
lines[].item.objectIdentifier
IBT-128
optional
An identifier for an object on which the invoice line is based, given by the Seller.
Free text; e.g. a meter or subscription number
quantity & price
#
field name
API key
business term
Required
description
accepted values
96
quantity
lines[].quantity
ibt-129
FTA mandatory
The quantity of items (goods or services) that is charged in the Invoice line.
15 digits TRN
97
Unit of measure
lines[].unitCode
ibt-130
FTA mandatory
The unit of measure that applies to the invoiced quantity.
UN/ECE Recommendation 20 and 21 code from the form list; e.g. H87 Piece, EA Each, KGM Kilogram, LTR Litre, MTR Metre, HUR Hour, DAY Day, MON Month
98
Gross price
lines[].price.grossPrice
ibt-148
FTA mandatory
The unit price, exclusive of tax, before subtracting Item price discount.
Decimal amount, 2 decimals
99
Price discount
lines[].price.priceDiscount
IBT-147
Conditional — when a unit-price discount applies
The total discount subtracted from the Item gross price to calculate the Item net price.
Decimal amount, 2 decimals
100
Net price
lines[].price.netPrice
IBT-146
FTA mandator — Calculated
The price of an item, exclusive of tax, after subtracting item price discount.
Gross price minus price discount; read-only on the form
101
Price base quantity
lines[].price.baseQuantity
ibt-149
FTA mandatory
The number of item units to which the price applies.
Decimal number; default 1
102
Base quantity unit
lines[].price.baseQuantityUnitCode
ibt-150
Conditional — when the base quantity is given
The unit of measure that applies to the Item price base quantity.
UN/ECE Recommendation 20 and 21 code, same list as Unit of measure
Line allowance and charge
#
field name
API key
business term
Required
description
accepted values
103
Discount amount
lines[].allowanceCharges[].amount (isCharge: false)
ibt-136
Conditional — when a line discount applies
The amount of an allowance, without tax.
Decimal amount, 2 decimals
104
Discount %
lines[].allowanceCharges[].percentage (isCharge: false)
ibt-138
optional
The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line allowance amount.
Percentage, 0–100
105
Discount base amount
lines[].allowanceCharges[].baseAmount (isCharge: false)
IBT-137
optional
The base amount that may be used, in conjunction with the Invoice line allowance percentage, to calculate the Invoice line allowance amount.
Decimal Amount
106
Discount reason
lines[].allowanceCharges[].reason(isCharge: false)
ibt-139
optional
The reason for the Invoice line allowance, expressed as text.
Free text
107
Discount reason code
lines[].allowanceCharges[].reasonCode (isCharge: false)
IBT-140
optional
The reason for the Invoice line allowance, expressed as a code.
UNTDID 5189 code from the form list: 41, 42, 60, 62, 63, 64, 65, 66, 67, 68, 70, 71, 88, 95 Discount, 100, 102, 103, 104, 105
108
Charge amount
lines[].allowanceCharges[].amount (isCharge: true)
IBT-141
Conditional — when a line charge applies
The amount of a charge, without tax.
Decimal amount, 2 decimals
109
Charge %
lines[].allowanceCharges[].percentage (isCharge: true)
ibt-143
optional
The percentage that may be used, in conjunction with the Invoice line charge base amount, to calculate the Invoice line charge amount.
Percentage, 0–100
110
Charge base amount
lines[].allowanceCharges[].baseAmount (isCharge: true)
ibt-142
optional
The base amount that may be used, in conjunction with the Invoice line charge percentage, to calculate the Invoice line charge amount.
Decimal amount
111
Charge reason
lines[].allowanceCharges[].reason (isCharge: true)
ibt-144
optional
The reason for the Invoice line charge, expressed as text.
Free text
112
Charge reason code
lines[].allowanceCharges[].reasonCode (isCharge: true)
ibt-145
optional
The reason for the Invoice line charge, expressed as a code.
UNTDID 7161 code from the form list (AA–ZZZ); e.g. EG Engraving, FC Freight service, DL Delivery, PC Packing, AEC Distribution
VAT
#
field name
API key
business term
Required
description
accepted values
113
Tax scheme
lines[].tax.scheme
ibt-167
optional — fixed
A code indicating the type of tax. Default value of VAT to be used.
VAT (read-only)
114
VAT category
lines[].tax.categoryCode
ibt-151
FTA mandatory
The VAT category code for the invoiced item.
S Standard rate; E Exempt; O Out of scope; AE Reverse charge; Z Zero rated; N Profit margin scheme
115
VAT rate %
lines[].tax.rate
ibt-152
fTA mandatory
The VAT rate, represented as percentage that applies to the invoiced item.
Percentage; 5.00 for S, 0.00 for E, O, AE, Z
116
exemption reason code
lines[].tax.exemptionReasonCode
ibt-186
Conditional — when the VAT category is E, O or AE
A coded statement of the reason for why the line amount is exempted from VAT.
DL8.46.1 Certain financial services; DL8.46.2 Supply of residential units (lease or sale); DL8.46.3 Bare land; DL8.46.4 Local passenger transport
117
Exemption reason
lines[].tax.exemptionReasonText
ibt-185
Conditional — when the VAT category is E, O or AE
A textual statement of the reason why the line amount is exempted from VAT or why no VAT is being charged.
Free text
Line amounts (calculated)
#
field name
API key
business term
Required
description
accepted values
118
Line net amount
lines[].amounts.lineExtensionAmount
ibt-131
FTA mandator— Calculated
The total amount of the Invoice line (before tax).
Quantity × net price ÷ base quantity, minus discount, plus charge; 2 decimals
119
VAT amount
lines[].amounts.taxAmount
--
Calculated
Line net amount plus VAT amount (form).
Line net amount plus VAT amount (form).
120
Line total
lines[].amounts.lineTotalAmount
--
Calculated
Line net amount plus VAT amount (form).
Decimal amount, 2 decimals
121
VAT in AED
lines[].amounts.taxAmountAed
btae-08
FTA mandator— Calculated
The VAT amount for each line item expressed in AED.
VAT amount × exchange rate; equals VAT amount when the invoice currency is AED
122
Total in AED
lines[].amounts.lineTotalAmountAed
btae-10
fTA mandatory— Calculated
The total amount payable for each line item expressed in AED.
Line total × exchange rate; equals line total when the invoice currency is AED
References and period
#
field name
API key
business term
Required
description
accepted values
123
Order line reference
lines[].orderLineReference
ibt-132
optional
An identifier for a referenced line within a purchase order, issued by the Buyer.
Free text; e.g. PO-2026-0457/1
124
Buyer accounting ref.
lines[].buyerAccountingReference
ibt-133
optional
A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
Free text; e.g. a GL account code
125
Line period start
lines[].period.start
ibt-134
optional
The date when the Invoice period for this Invoice line starts.
Date, YYYY-MM-DD
126
Line period end
lines[].period.end
ibt-135
optional
The date when the Invoice period for this Invoice line ends.
Date, YYYY-MM-DD; on or after the line period start
Amounts & Tax tab — Allowances and charges
Each element of allowanceCharges[] is either an allowance (discount) or a charge, decided by isCharge; the same keys carry the allowance term (IBT-092 to IBT-098, IBT-196, IBT-197) or the charge term (IBT-099 to IBT-105, IBT-198, IBT-199). They feed the document totals and the VAT breakdown.
#
field name
API key
business term
Required
description
accepted values
127
Type
allowanceCharges[].isCharge
SB-AUTO-67 / SB-AUTO-75
Required
Syntax binding qualifier: use false when informing about allowances and true when informing about charges.
false Allowance (discount); true Charge
128
Amount
allowanceCharges[].amount
IBT-092 / IBT-099
Required — PINT-AE mandatory once the row exists
The amount of an allowance or charge, without tax.
Decimal amount, 2 decimals, in the invoice currency
129
Reason code
allowanceCharges[].reasonCode
IBT-098 / IBT-105
Conditional — PINT-AE mandatory if applicable
The reason for the document level allowance or charge, expressed as a code.
Allowances: UNTDID 5189 codes (41–105, e.g. 95 Discount, 100 Special rebate); charges: UNTDID 7161 codes (e.g. FC Freight service, IS Invoicing, PC Packing)
130
Base amount
allowanceCharges[].baseAmount
IBT-093 / IBT-100
optional
The base amount that may be used, in conjunction with the percentage, to calculate the allowance or charge amount.
Decimal amount
131
Percentage
allowanceCharges[].percentage
IBT-094 / IBT-101
optional
The percentage that may be used, in conjunction with the base amount, to calculate the allowance or charge amount.
Percentage, 0–100
132
Reason
allowanceCharges[].reason
IBT-097 / IBT-104
Conditional — PINT-AE mandatory if applicable
The reason for the document level allowance or charge, expressed as text.
Free text; e.g. Early settlement discount, Freight
133
Tax scheme
allowanceCharges[].tax.scheme
IBT-095-1 / IBT-102-1
optional — fixed
A code indicating the type of tax. Default value of VAT to be used.
VAT
134
VAT category
allowanceCharges[].tax.categoryCode
IBT-095 / IBT-102
Conditional — PINT-AE mandatory if applicable
A coded identification of what VAT category applies to the document level allowance or charge.
S Standard rate; E Exempt; O Out of scope; AE Reverse charge; Z Zero rated; N Profit margin scheme
135
VAT rate %
allowanceCharges[].tax.rate
IBT-096 / IBT-103
Conditional — PINT-AE mandatory if applicable
The VAT rate, represented as percentage that applies to the document level allowance or charge.
Percentage; must match a rate used in the VAT breakdown
136
Exemption code
allowanceCharges[].tax.exemptionReasonCode
IBT-196 / IBT-198
Conditional — when the VAT category is E, O or AE
A coded statement of the reason for why the allowance or charge amount is exempted from VAT.
DL8.46.1 Certain financial services; DL8.46.2 Supply of residential units (lease or sale); DL8.46.3 Bare land; DL8.46.4 Local passenger transport
137
Exemption reason
allowanceCharges[].tax.exemptionReasonText
IBT-197 / IBT-199
Conditional — when the VAT category is E, O or AE
A textual statement of the reason why the allowance or charge amount is exempted from VAT or why no VAT is being charged.
Free text
Amounts & Tax tab — VAT breakdown, tax currency and totals
The VAT breakdown holds one row per VAT category and rate, built from lines, allowances and charges; at least one row is required. Tax-currency fields apply only when the invoice currency is not AED. Document totals are calculated unless "Override calculated totals" is on.
VAT breakdown
#
field name
API key
business term
Required
description
accepted values
138
VAT category
taxBreakdown[].categoryCode
iBT-118
FTA mandatory
Coded identification of a VAT category.
S Standard rate; E Exempt; O Out of scope; AE Reverse charge; Z Zero rated; N Profit margin scheme
139
Tax scheme
taxBreakdown[].scheme
ibt-118-1
Optional — fixed
The scheme of the tax category. Default value of VAT to be used.
VAT
140
Rate %
taxBreakdown[].rate
IBT-119
FTA mandatory
The VAT rate, represented as percentage that applies for the relevant VAT category.
Percentage; e.g. 5.00
141
Taxable amount
taxBreakdown[].taxableAmount
IBT-116
FTA mandator — Calculated
Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the tax category rate is applicable).
Decimal amount, 2 decimals
142
Tax amount
taxBreakdown[].taxAmount
IBT-117
FTA mandator— Calculated
The total tax amount for a given VAT category.
Taxable amount × rate; 2 decimals
143
Exemption reason code
taxBreakdown[].exemptionReasonCode
--
Conditional — when the category is E, O or AE
Coded reason why the category is exempt from VAT or carries no VAT (form).
Coded reason why the category is exempt from VAT or carries no VAT (form).
144
Exemption reason
taxBreakdown[].exemptionReasonText
--
Conditional — when the category is E, O or AE
Textual reason why the category is exempt from VAT or carries no VAT (form).
Free text
Tax accounting currency
#
field name
API key
business term
Required
description
accepted values
145
Tax currency code
taxCurrency.code
ibt-006
Conditional — required when the invoice currency is not AED
The currency used for tax accounting and reporting purposes as accepted or required in the country of the Seller.
ISO 4217 code; AED for UAE sellers
146
Exchange rate
taxCurrency.exchangeRate
btae-04
Conditional — required when the invoice currency is not AED
The exchange rate between the document currency and the tax currency.
Decimal rate, invoice currency to tax currency; e.g. 1.0000
147
VAT total (tax currency)
taxCurrency.taxTotal
ibt-111
Conditional — required when the invoice currency is not AED; Calculated
The tax total amount expressed in the accounting currency accepted or required in the country of the Seller.
VAT total × exchange rate; 2 decimals
148
Total with VAT (tax currency)
taxCurrency.taxInclusiveAmount
btae-20
Conditional — required when the invoice currency is not AED; Calculated
The Invoice total amount with VAT expressed in the accounting currency accepted or required in the country of the Seller.
Total with VAT × exchange rate; 2 decimals
Document totals
#
field name
API key
business term
Required
description
accepted values
149
Sum of line net amounts
totals.lineExtensionTotal
ibt-106
FTA mandatory— Calculated
Sum of all Invoice line net amounts in the Invoice.
Decimal amount greater than 0, 2 decimals
150
Document-level discounts
IBT-107
Conditional — when document-level allowances exist; Calculated
Conditional — when document-level allowances exist; Calculated
Sum of allowance rows; 2 decimals
151
Document-level charges
totals.chargeTotal
IBT-108
Conditional — when document-level charges exist; Calculated
Sum of all charges on document level in the Invoice.
Sum of all charges on document level in the Invoice.
152
Total without VAT
totals.taxExclusiveAmount
ibt-109
FTA mandatory— Calculated
The total amount of the Invoice without tax.
Line net total − discounts + charges; 2 decimals
153
VAT total
totals.taxTotal
IBT-110
FTA mandatory— Calculated
The total VAT amount for the Invoice.
Sum of VAT breakdown tax amounts; 2 decimals
154
Total with VAT
totals.taxInclusiveAmount
IBT-112
FTA mandatory — Calculated
The total amount of the Invoice with tax.
Total without VAT + VAT total; greater than 0; 2 decimals
155
Prepaid amount
totals.prepaidAmount
ibt-113
Conditional — when an advance was paid
The sum of amounts which have been paid in advance.
Decimal amount, 2 decimals
156
of which VAT
totals.prepaidTaxAmount
--
optional
VAT portion of the prepaid amount (form).
Decimal amount, 2 decimals
157
Rounding amount
totals.roundingAmount
ibt-114
Conditional — when the payable amount is rounded
The amount to be added to the invoice total to round the amount to be paid.
Signed decimal amount, 2 decimals
158
Amount due
totals.payableAmount
ibt-115
FTA mandator— Calculated
The outstanding amount that is requested to be paid.
Total with VAT − prepaid amount + rounding amount; 2 decimals
Payment & Terms tab
An invoice can carry several payment instructions (paymentInstructions[]) and several terms or instalments (paymentTerms[]). Within a payment, only the group matching the payment means code is used: credit transfer for code 30, card for 54 and 55, direct debit for 49.
Payment means
#
field name
API key
business term
Required
description
accepted values
159
Payment means code
paymentInstructions[].meansCode
iBT-081
FTA mandatory
The means, expressed as code, for how a payment is expected to be or has been settled.
1 Instrument not defined; 10 In cash; 20 Cheque; 21 Banker's draft; 30 Credit transfer; 49 Direct debit; 54 Credit card; 55 Debit card; 68 Online payment service
160
Payment means text
paymentInstructions[].meansText
ibt-082
Optional
A textual description of the means/methods by which the payment is expected to be or has been settled.
Free text; e.g. Bank transfer
161
Payment instructions ID
paymentInstructions[].id
IBT-178
optional
A textual value used for payment routing or to establish a link between the payment and the Invoice.
Free text; usually the invoice number
162
Payment ID / remittance
paymentInstructions[].paymentId
IBT-083
optional
A textual value used for payment routing or to establish a link between the payment and the Invoice.
Free text; usually the invoice number
credit transfer
#
field name
API key
business term
Required
description
accepted values
163
Account identifier (IBAN)
paymentInstructions[].bankTransfer.accountId
ibt-084
Conditional — required for payment means 30
A unique identifier of the financial payment account, at a payment service provider, to which payment should be made.
IBAN (AE + 21 characters) or local account number
164
Account scheme
paymentInstructions[].bankTransfer.accountScheme
IBT-084-1
Conditional — with the account identifier
The identification of the identification scheme, for example IBAN.
IBAN; LOCAL (local account number)
165
Account name
paymentInstructions[].bankTransfer.accountName
ibt-085
optional
The name of the payment account, at a payment service provider, to which payment should be made.
Free text
166
Bank SWIFT / BIC
paymentInstructions[].bankTransfer.bic
IBT-086
optional
An identifier for the payment service provider where a payment account is located.
8 or 11 character BIC; e.g. EBILAEAD
167
Bank address
paymentInstructions[].bankTransfer.bankAddress
IBT-169
optional
The main address line in an address.
Free text
168
Bank city
paymentInstructions[].bankTransfer.bankCity
IBT-171
optional
The common name of the city, town or village, where the account address is located.
Free text
169
Bank country
paymentInstructions[].bankTransfer.bankCountryCode
IBT-175
optional
A code that identifies the country.
ISO 3166-1 alpha-2 code from the form list
Card
#
field name
API key
business term
Required
description
accepted values
170
Card number
paymentInstructions[].card.lastFourDigits
ibt-087
Conditional — required for payment means 54 or 55
The Primary Account Number (PAN) of the card used for payment.
Last 4 to 6 digits only; never a full card number
171
Card holder name
paymentInstructions[].card.holderName
IBT-088
optional
The name of the payment card holder.
Free text
172
Card network
paymentInstructions[].card.networkId
--
optional
Card scheme or network used for the payment (form).
Free text; e.g. VISA
direct debit
#
field name
API key
business term
Required
description
accepted values
173
Mandate reference
paymentInstructions[].directDebit.mandateReference
ibt-089
Conditional — required for payment means 49
Unique identifier assigned by the Payee for referencing the direct debit mandate.
Free text
terms
#
field name
API key
business term
Required
description
accepted values
174
Payment terms
paymentTerms[].note
ibt-020
optional
A textual description of the payment terms that apply to the amount due for payment (including description of possible penalties).
Free text; e.g. Net 30 days from invoice date
175
Terms amount
paymentTerms[].amount
IBT-176
optional
The payment amount that these terms apply to. When relevant, the amount includes tax.
Decimal amount, 2 decimals; one row per instalment
176
Instalment due date
paymentTerms[].dueDate
ibt-177
optional
The date before end of which the terms amount shall be settled.
Date, YYYY-MM-DD
177
Payment instructions ID
paymentTerms[].paymentInstructionsId
IBT-187
optional
The payment instructions that apply to these payment terms.
Must match an instructionsId on this invoice; e.g. PAY-1
178
Currency
paymentTerms[].currencyCode
SB-AUTO-65
calculated
Syntax required attribute; value must equal the invoice document currency (IBT-005).
Copied from the invoice currency code; read-only
Where Anyone Can Be an Accountant. We Make E-Invoicing Easy.
© 2026 DocFlow. All rights reserved.