Base and modifiers
A base identifies the document you are sending; a variant or modifier refines it. Select the combination for your country before filling the GETS payload.
In a Unify submission, documentType is an object beside payload. Select exactly one base. Send modifiers as an array, even when it is empty. Include variant only when the country and base offer one. These selections affect which GETS fields you must supply; see the field reference.
In the field reference, select your country with the country dropdown and remove any other selected countries. The Table view summarises requirements across all document types in Requirement and explains conditions in Description; Enums lists fixed allowed values. Open List with sample request to choose your document type, modifiers and variant under Scope and see the matching field paths and sample.
| Selection | Request field | Meaning |
|---|---|---|
| Base | documentType.base | The document category, such as tax_invoice or credit_note. See document types for country availability. |
| Variant | documentType.variant | An optional subtype of the base. Select no more than one. |
| Modifiers | documentType.modifiers | Additional treatments or classifications, selected as an array. Use [] when none apply. |
For an ordinary UAE tax invoice:
{
"country": "AE",
"documentType": {
"base": "tax_invoice",
"modifiers": []
}
}This is a selection excerpt, not a complete request. The quickstart supplies the GETS payload and other required request fields.
What modifiers change
A modifier can change the required fields or the treatment of a document. These are examples of available modifiers, not a list of valid combinations:
| Selection | What to check |
|---|---|
out_of_scope (UAE) | Out-of-scope commercial documents use their own UAE document type codes and tax rules. |
self_billed (UAE) | A self-billed invoice or credit note uses the UAE self-billing validation profile. |
reverse_charge (UAE) | Supply the applicable reverse-charge information on each affected line. |
b2g (Germany, Belgium, Saudi Arabia) | Check the field reference for the fields required by this selection in your country. |
The UAE has no separate variant. For example, an out-of-scope UAE invoice uses base: "tax_invoice" with modifiers: ["out_of_scope"], not an out_of_scope variant. Do not combine UAE out_of_scope with self_billed, reverse_charge, export, deemed_supply, margin_scheme or summary. See UAE document types and UAE fields for the supported routes and their requirements.
Variants are country-specific: Germany’s partial is an invoice variant; Malaysia’s refund is a credit-note variant. In the field reference, open List with sample request to see the available choices and the fields each one changes. Do not assume a modifier or variant accepted for one country is accepted for another.
If the selection is rejected
Check country, base, variant and each modifiers value against your chosen country’s options. Then use the field reference to supply any newly required fields. A validation failure returns 422 with field-level errors; Unify errors explains the response and how to correct it.
Last updated