Country extensions

Country extensions add fields to GETS for a specific country. Find the relevant field paths and requirements before submitting that country's documents.

Start with the GETS field reference and select your country with the country dropdown. Remove any other selected countries. In Table, read Requirement and the conditions in Description; Enums lists fixed allowed values. The requirement summarises all document types, modifiers and variants for the country. Open List with sample request to select your document type, modifiers and variant under Scope and see the matching requirements and payload paths.

payload.extensions holds additional document-level fields; individual payload.lineItems[] can also have extensions. Do not send every extension you see in a sample: supply those that apply to your document.

Find the country requirements

The country guides provide local requirements. Use List with sample request in the GETS field reference to find exact payload paths and requirements for your selected document type.

Example: document and line extensions

These paths and sample values appear in a UAE Unify request example. This is a payload excerpt, not a complete invoice. Include a country field only when its condition applies:

UAE extension fields (excerpt)json
{
  "payload": {
    "lineItems": [
      {
        "extensions": {
          "ae_itemType": "Services"
        }
      }
    ],
    "extensions": {
      "ae_buyer_authorityName": "Dubai Department of Economy and Tourism",
      "peppol_buyer_peppolIdScheme": "0235"
    }
  }
}

ae_itemType belongs to a line, while ae_buyer_authorityName belongs to the document. The peppol_buyer_peppolIdScheme value describes the buyer’s Peppol identifier scheme. Use the field reference to check the requirement and allowed values for your selection. The quickstart has a complete UAE invoice you can submit in sandbox.

If validation fails

For 422, read each error’s getsPath and message. Check that the field is at the documented path, the country and document type match your selection, and coded values come from the applicable list. See Unify errors for the full error shape.

Last updated