Document types
Choose a GETS document type for your country. This reference lists available bases and shows how UAE invoice and credit-note selections differ.
Set country and documentType in your Unify submission. The base names the document category. Its availability depends on the country; a modifier or variant can change the fields and treatment. A selected document type does not replace the invoice data in payload.
Base choices by country
These are the base values available under Scope in List with sample request in the GETS field reference. The table does not imply that every modifier or variant can be combined with every base.
country | Available documentType.base values |
|---|---|
AE — United Arab Emirates | tax_invoice, credit_note |
SA — Saudi Arabia | tax_invoice, credit_note, debit_note, simplified_invoice, simplified_credit_note, simplified_debit_note |
OM — Oman | tax_invoice, credit_note, debit_note, simplified_invoice, simplified_credit_note, simplified_debit_note |
MY — Malaysia | tax_invoice, credit_note, debit_note |
BE — Belgium | tax_invoice, credit_note, debit_note |
DE — Germany | tax_invoice, credit_note, debit_note |
To find the required fields for a base, select its country with the country dropdown in the field reference and remove any other selected countries. The Table view’s Requirement column summarises all document types; Description explains conditions and Enums lists fixed allowed values. Open List with sample request and choose the document type, modifiers and variant under Scope to see requirements and payload paths for that selection. A credit note can need a reason or a preceding-invoice reference that an invoice does not. Check the relevant country fields before sending one.
UAE invoice and credit-note selections
The UAE offers two bases and no separate variant. For an ordinary document use modifiers: []; for out-of-scope or self-billed documents use the modifier shown here. These are document selections, not complete requests:
| Document | base | modifiers | UAE document type code |
|---|---|---|---|
| Ordinary tax invoice | tax_invoice | [] | 380 |
| Ordinary tax credit note | credit_note | [] | 381 |
| Out-of-scope commercial invoice | tax_invoice | ["out_of_scope"] | 480 |
| Out-of-scope commercial credit note | credit_note | ["out_of_scope"] | 81 |
| Self-billed tax invoice | tax_invoice | ["self_billed"] | 389 |
| Self-billed tax credit note | credit_note | ["self_billed"] | 261 |
For example, an ordinary UAE invoice starts with:
{
"country": "AE",
"documentType": {
"base": "tax_invoice",
"modifiers": []
}
}The quickstart shows the full request and the 200 response. UAE credit notes require a credit-note reason; ordinary credit notes also require a preceding-invoice reference unless the reason is Volume Discount. See UAE fields for conditions and allowed values. UAE debit notes are not available in this selection.
If a type or field is rejected
Check the country row, then remove any modifier or variant that does not apply to that base. If the base is accepted but fields fail, compare the getsPath in each 422 error with the paths in List with sample request in the field reference. For response details, see Unify errors.
Last updated