API Docs

Document register request – all fields

All fields in the request body are listed below. The Required column indicates whether each field is mandatory or optional. The same structure applies to both Sales Register and Purchase Register.

Root level

Field	Type	Required	Description
`issue_date`	string	Required	Date the document was issued. Format: `YYYY-MM-DD`.
`transaction_date`	string	Required	Date of the transaction. Format: `YYYY-MM-DD`.
`accounting_period`	string	Required	Accounting period for the entry. Format: `YYYY-MM`.
`document_number`	string	Required	Your unique document reference number (for example invoice or credit note number).
`document_type`	string	Required	Type of document. One of: `INVOICE`, `CREDIT_NOTE`.
`entry_type`	string	Required	Type of register entry. For sales use `SALES` or `SALES_ADJUSTMENT`.
`note`	string	Required	Free‑text note or reason for the document (for example adjustment reason).
`accounting_supplier_party`	object	Optional	For sales the API sets the supplier from the business profile identified by `profile_id` in the URL.
`accounting_customer_party`	object	Required	Customer (buyer) party details. Must include `tax_scheme` and `postal_address`. See Party table below.
`document_lines`	array	Required	Line items. At least one item required. Each item uses the Document line structure below.
`document_currency_code`	string	Required	ISO currency code for all amounts (for example `AED`). See Get Currency Names and Codes.
`document_source`	string	Required	Source of the document (for example `WEB`, `API`).
`payable_amount`	number	Required	Total amount payable including tax. Must be ≥ 0.
`tax_amount`	number	Required	Total tax amount for the document. Must be ≥ 0.
`tax_exchange_rate`	object	Optional	Exchange rate when tax currency differs from document currency.

Party (accounting_supplier_party / accounting_customer_party)

Field	Type	Required	Description
`name`	string	Required	Legal or display name of the party.
`party_name`	string	Optional	Trading or business name of the party.
`tax_scheme`	string	Required	Tax scheme (for example `VAT` for UAE). See Get Tax Schemes.
`tin`	string	Optional	Tax identification number (TRN).
`email`	string	Optional	Party email address.
`telephone`	string	Optional	Party telephone number.
`gl_account`	string	Optional	GL account (often used on customer party).
`postal_address`	object	Required	Party address. See Address object below.

Address object

Party postal_address uses the address object structure.

Field	Type	Required	Description
`street_name`	string	Required	Street name and number.
`additional_street_name`	string	Optional	Additional street details.
`city_name`	string	Required	City name.
`postal_zone`	string	Optional	Postal or ZIP code.
`country_subentity`	string	Required	Emirate or region code (e.g. `DXB`, `SHJ`, `AUH`). See Get UAE Subdivisions.
`address_line`	string	Optional	Additional address line.
`country`	string	Required	Country name (e.g. `United Arab Emirates`).
`country_code`	string	Required	ISO 3166-1 alpha-2 country code (e.g. `AE`). See Get Countries.

Document line (each item in `document_lines`)

Field	Type	Required	Description
`name`	string	Required	Line item description or product/service name.
`quantity`	number	Required	Quantity. Must be ≥ 1.
`net_amount`	number	Required	Net amount (before tax) for this line. Must be ≥ 0.
`tax_amount`	number	Required	Tax amount for this line. Must be ≥ 0.
`classified_tax_category`	object	Required	Tax category for this line. See Tax category object below.

Tax category object

Line-item classified_tax_category uses the shared tax category structure.

Field	Type	Required	Description
`id`	string	Required	Tax category code (for example `S`, `Z`, `E`). See Get Tax Categories.
`percent`	number	Optional	Tax rate as percentage (0–100). Should align with `id`.
`tax_exemption_reason_code`	string	Conditional	FTA exemption reason code. Required when `id` is `E`. See Get Tax Exemption Reason Codes.
`tax_exemption_reason`	string	Optional	Exemption reason description. Free text when provided.
`tax_scheme`	string	Optional	Tax scheme (for example `VAT`). See Get Tax Schemes.