API Docs

Do not send: accounting_supplier_party — the API sets the supplier from {profileId}. Do not send calculated or system fields (id, org_id, document_sequence, totals, meta_info, etc.) — those appear in the response only.

Field	Type	Required	Description	Validation
`issue_date`	string	Required	The date when the proforma was issued.	Format `yyyy-MM-dd`.
`invoice_type_code`	string	Required	The type of invoice.	API typically forces `380`.
`due_date`	string	Required	The date when payment is due.	Format `yyyy-MM-dd`.
`profile_execution_id`	string	Required	Invoice transaction type code.	Exactly 8 characters; each `0` or `1`. See Profile execution ID.
`document_currency_code`	string	Required	ISO 4217 currency code.	Valid ISO 4217 code.
`accounting_customer_party`	object	Required	The customer party.	See Party object.
`document_lines`	array	Required	Line items.	At least one line required. See Document line object.
`document_number`	string	Conditional	Proforma document number.	Required when auto-numbering is disabled.
`tax_currency_code`	string	Conditional	ISO 4217 currency code for tax amounts.	Required when `document_currency_code` is not `AED`—must be `AED`.
`tax_exchange_rate`	object	Conditional	Exchange rate for tax calculation in AED.	Required when `document_currency_code` is not `AED`.
`payment_means`	array	Conditional	Payment method.	Required unless deemed-supply flag applies. See Payment means array.
`buyer_customer_party`	object	Conditional	Beneficiary ID (UBL `BTAE-01`).	Required for Free Trade Zone (`profile_execution_id` first character is `1`).
`seller_supplier_party`	object	Conditional	Principle ID (UBL `BTAE-14`).	Required for Disclosed Agent Billing (`profile_execution_id` sixth character is `1`).
`delivery`	object	Conditional	Delivery details.	Required for exports (`profile_execution_id` eighth character is `1`).
`invoice_period`	object	Conditional	Billing period covered by the proforma.	Required for summary invoice (`profile_execution_id` fourth character is `1`, `IBR-138-AE`); at least one of `start_date` or `end_date` when present (`IBR-CO-19`); `description` optional.
`issue_time`	string	Optional	The time when the proforma was issued.	Format `HH:mm:ss`. Gulf Standard Time (GST, UTC+4). Default when omitted: `00:00:00`.
`tax_point_date`	string	Optional	Tax point date per UAE VAT Law.	If present: format `yyyy-MM-dd`.
`accounting_cost`	string	Optional	Accounting cost center identifier.	Free text.
`buyer_reference`	string	Optional	Buyer reference for the proforma.	Free text.
`note`	string	Optional	Additional notes on the proforma.	Free text.
`payee_party`	object	Optional	Party to whom payment should be made.	See Payee party object.
`tax_representative_party`	object	Optional	Tax representative party.	See Tax representative party object.
`order_reference`	object	Optional	Purchase order reference.	See Order reference object.
`billing_reference`	array	Optional	References to other billing documents.	See Billing reference object.
`despatch_document_reference`	object	Optional	Despatch document reference.	See Despatch document reference object.
`receipt_document_reference`	object	Optional	Receipt document reference.	See Receipt document reference object.
`statement_document_reference`	object	Optional	Statement document reference.	If present: `id` required; `issue_date` as `yyyy-MM-dd` when provided.
`originator_document_reference`	object	Optional	Originating document reference.	If present: `id` required; `issue_date` as `yyyy-MM-dd` when provided.
`contract_document_reference`	object	Optional	Contract reference.	See Contract document reference object.
`project_reference`	object	Optional	Project reference.	See Project reference object.
`charges`	array	Optional	Document-level charges.	See Charge object.
`allowances`	array	Optional	Document-level allowances.	See Allowance object.
`payment_terms`	object	Optional	Payment terms.	See Payment terms object.
`prepaid_amount`	number	Optional	Total prepaid amount.	Typically non-negative.
`payable_rounding_amount`	number	Optional	Rounding adjustment.	May be positive or negative.
`document_source`	string	Optional	Origin of the e-invoice document.	Defaults to `API` when omitted.
`attachments`	array	Optional	Supporting documents.	Entire POST body must not exceed 8 MB.

Party object

The accounting_supplier_party and accounting_customer_party fields are full party objects with the following attributes.

Field requirements depend on whether the party is the buyer or seller. See The Customer party object and The Supplier party object.

Field	Type	Required	Description	Validation
`name`	string	Required	Party name or display name.	Must be non-empty text.
`postal_address`	object	Required	Postal address. See Address object.	Required; must satisfy address object validation.
`email`	string	Required	Party email address.	Required for customer and supplier parties.
`party_name`	string	Conditional	Legal name of the party.	Required for business parties. Do not send for individual customers.
`tin`	string	Conditional	Taxpayer Identification Number (TIN).	Required for UAE business customers and UAE suppliers. Exactly 10 characters, must start with `1`. Do not send for non-UAE B2B parties.
`telephone`	string	Conditional	Party telephone number.	Required for UAE suppliers. Optional for customers.
`scheme_agency_id`	string	Optional	Registration type identifier, if you choose to include registration details.	Optional for customer and supplier parties. If sent, must match allowed values for the party type — see The Customer party object or The Supplier party object. See Get Registration Types.
`company_id`	string	Optional	Registration or identity number when registration details are included.	Optional. Distinct from VAT TRN in `party_tax_scheme.company_id`. Required only when `scheme_agency_id` is provided.
`authority_name`	string	Optional	Issuing authority for the trade license.	Optional. Required only when `scheme_agency_id` is `TL` and registration details are included.
`passport_issuing_country_code`	string	Optional	Country that issued the passport.	Optional. Required only when `scheme_agency_id` is `PAS` and registration details are included.
`party_tax_scheme`	object	Optional	Tax scheme with UAE VAT/TRN. Contains `company_id`, `tax_scheme`.	Optional for UAE parties. If either `company_id` or `tax_scheme` is provided, both are required. When `company_id` is set: 15 digits; starts with `1` and ends with `03`. Optional for non-UAE `accounting_customer_party` on export transactions (`profile_execution_id` position 8 is `1`, format `XXXXXXX1`). Forbidden for non-UAE B2B parties. See Get Tax Schemes and The Supplier party object.
`endpoint_id`	string	Required	Peppol endpoint identifier (participant identification).	Required on every document. Use the party's 10-digit TIN when Peppol-registered. For deemed supply, exports, or non-compliant parties, see Endpoint identification reference. Must be a valid Peppol endpoint for Phase 2 documents.
`endpoint_scheme_id`	string	Required	Peppol endpoint scheme identifier (participant scheme ID). Typically `0235` for UAE.	Required on every document. See Endpoint identification reference and Get Electronic Address Schemes

Address object

Postal and delivery addresses use the shared address object structure.

Field	Type	Required	Description	Validation
`street_name`	string	Required	Street name or primary address line (UBL address line 1).	Must not be blank.
`city_name`	string	Required	City or town name.	Must not be blank.
`country_subentity`	string	Required	Country subdivision—emirate, state, or region code.	Must not be blank. When `country_code` is `AE`, use an approved emirate code from Get UAE Subdivisions.
`country`	string	Required	Country name (e.g. `United Arab Emirates`).	Must not be blank.
`country_code`	string	Required	ISO 3166-1 alpha-2 country code (e.g. `AE`).	Must not be blank. See Get Countries.
`additional_street_name`	string	Optional	Additional street name or address line 2.	Free text when provided.
`postal_zone`	string	Optional	Postal or ZIP code.	Free text when provided.
`address_line`	string	Optional	Additional unstructured address line.	Free text when provided.

Tax category object

Tax categories share the same structure on line items (classified_tax_category) and charge/allowance tax_category fields. classified_tax_category is required on each line. Document-level charge and allowance tax categories are required; line-level charge and allowance tax categories are optional.

Field	Type	Required	Description	Validation
`id`	string	Required	Tax category code (UBL classified tax category ID).	Must not be blank. Valid codes include `S`, `Z`, `E`, `O`, `AE`, `N`. See Get Tax Categories.
`tax_exemption_reason_code`	string	Conditional	FTA tax exemption reason code.	Required when `id` is `E` (exempt). See Get Tax Exemption Reason Codes.
`tax_exemption_reason`	string	Conditional	Tax exemption reason description.	Required when `id` is `E` (exempt). Must match the selected `tax_exemption_reason_code` description.
`percent`	number	Optional	VAT rate as a percentage (e.g. `5` for 5%).	Should align with the selected `id`.
`tax_scheme`	string	Optional	Tax scheme identifier (typically `VAT` for UAE).	See Get Tax Schemes.

Buyer customer party object

The buyer_customer_party field carries the Beneficiary ID (UBL BTAE-01). It is not a full party reference—only the beneficiary identifier is sent in the API.

Field	Type	Required	Description	Validation
`id`	string	Conditional	Beneficiary ID (TIN). Mapped to `BTAE-01` in the generated XML.	Required when Free Trade Zone applies (`profile_execution_id` first character is `1`). Must be a valid TIN; do not use `accounting_customer_party` TRN here.

Seller supplier party object

The seller_supplier_party field carries the Principle ID (UBL BTAE-14). It is not a full party reference—only the Principle ID TRN is sent in the API.

Field	Type	Required	Description	Validation
`id`	string	Conditional	Principle ID TRN. Mapped to `BTAE-14` in the generated XML.	Required when Disclosed Agent Billing applies (`profile_execution_id` sixth character is `1`). Must be a valid TRN; must differ from the seller VAT identifier (`accounting_supplier_party.party_tax_scheme.company_id`).

Payee party object

The payee_party field is an object with the following attributes:

Field	Type	Required	Description	Validation
`party_identification`	object	Optional	Payee identification.	Optional; structure depends on your implementation.
`party_name`	string	Optional	Name of the payee.	If provided, must be non-empty text.
`financial_account`	object	Optional	Financial account details for payment.	If present, must contain valid account identifiers as required by your bank.

Tax representative party object

The tax_representative_party field is an object with the following attributes:

Field	Type	Required	Description	Validation
`party_identification`	object	Optional	Tax representative identification.	Optional; should uniquely identify the tax representative where used.
`party_name`	string	Optional	Name of the tax representative.	If provided, must be non-empty.
`postal_address`	object	Optional	Address of the tax representative.	If present, see Address object.

Delivery object

The delivery field is an object with the following attributes. JSON property names use snake_case as shown.

Field	Type	Required	Description	Validation
`actual_delivery_date`	string	Optional	Actual date of delivery.	If present, format `yyyy-MM-dd`.
`delivery_location`	object	Required when `delivery` is sent	Where goods or services are delivered. See Delivery location object below.	Must be present whenever the `delivery` object is included.
`party_name`	string	Optional	Name of the delivery-related party.	Free text when provided.
`party_id`	string	Optional	Identifier of the delivery-related party.	Free text when provided.
`terms`	string	Optional	Incoterms (PEPPOL BTAE-22), e.g. `FCA`, `DDP`.	Optional even when `delivery` is present.

Delivery location object

The delivery_location object has the following attributes.

Field	Type	Required	Description	Validation
`address`	object	Required	Postal address of the delivery location.	Required when `delivery_location` is present. See Address object.
`id`	string	Optional	Delivery location identifier.	Free text when provided.

Order reference object

The order_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Order number or identifier.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Order date.	If present, format `yyyy-MM-dd`.
`sales_order_id`	string	Optional	Sales order identifier.	Free-form identifier.

Billing reference object

Each element of the billing_reference array is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Referenced document number.	Must be non-empty when the entry is present.
`issue_date`	string	Optional	Referenced document date.	If present, format `yyyy-MM-dd`.

Despatch document reference object

The despatch_document_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Despatch document number.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Despatch document date.	If present, format `yyyy-MM-dd`.

Receipt document reference object

The receipt_document_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Receipt document number.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Receipt document date.	If present, format `yyyy-MM-dd`.

Statement document reference object

The statement_document_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Statement document number.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Statement document date.	If present, format `yyyy-MM-dd`.

Originator document reference object

The originator_document_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Originating document number or identifier.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Originating document date.	If present, format `yyyy-MM-dd`.

Contract document reference object

The contract_document_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Contract number or identifier.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Contract date.	If present, format `yyyy-MM-dd`.

Project reference object

The project_reference field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Required	Project identifier.	Must be non-empty when the object is present.
`name`	string	Optional	Project name.	Free text.

Price object

The price object on each document_lines[] entry carries the item net price and price base quantity.

Field	Type	Required	Source	Description	Validation
`base_amount`	number	Required	Client-provided	Item net price (ibt-146).	Must not be negative.
`base_quantity`	number	Required	Client-provided	Item price base quantity (ibt-149).	Must be a positive number above zero. Must use the same unit code as `document_lines[].unit_code` (ibt-150).
`allowance`	object	Optional	Client-provided	Price-level allowance (discount on the item net price).	If present, see price allowance below.
`allowance.amount`	number	Optional	Client-provided	Price-level discount amount.	Must not be negative when provided.

Document line object

Each element of the document_lines array represents one proforma line. For Item Type, HSN, and SAC mappings from your ERP or Marmin UI, see Line item classification (UI to API).

Field	Type	Required	Source	Description	Validation
`name`	string	Required	Client-provided	Item name (ibt-153): a name for the item.	Must be non-empty.
`description`	string	Required	Client-provided	Item description (ibt-154): a description for the item.	Must be non-empty.
`quantity`	number	Required	Client-provided	Invoiced quantity (ibt-129).	Must be a positive number.
`unit_code`	string	Required	Client-provided	Invoiced quantity unit of measure code (ibt-130).	Must be a valid UN/ECE Rec 20/21 code (e.g. `EA`, `KGM`, `LTR`). See Get Unit of Measure Codes.
`price`	object	Required	Client-provided	Item net price details. See Price object.	Must satisfy Price object validation.
`classified_tax_category`	object	Required	Client-provided	Line VAT information: VAT applicable for the goods and services invoiced on this line. See Tax category object.	Must satisfy Tax category object validation; `tax_exemption_reason_code` and `tax_exemption_reason` are required when `id` is `E`.
`additional_item_identification`	array	Conditional	Client-provided	Service Accounting Code (SAC) for service lines. Required when Item Type is Services (`S`) or Both (`B`). See Additional item identification object and Line item classification (UI to API).	When required: include at least one entry with `id` (SAC value) and `scheme_id`: `"SAC"` (`IBR-189-AE`).
`commodity_classification`	object	Conditional	Client-provided	Item type, HSN, and reverse-charge metadata for the line. Maps UI Item Type and Item Classification Identifier fields. See Commodity classification object and Line item classification (UI to API).	When Item Type is Goods (`G`) or Both (`B`): require `commodity_code`, `item_classification_code`, and `item_classification_list_id`: `"HS"`. When Services only (`S`): send `commodity_code`; use `additional_item_identification` for SAC.
`note`	string	Optional	Client-provided	Free-text note for the line.	Free text.
`accounting_cost`	string	Optional	Client-provided	Accounting cost center for this line.	Free text.
`invoice_period`	object	Optional	Client-provided	Line invoicing period (ibt-134, ibt-135). See Invoice period object.	If present: dates in `yyyy-MM-dd`, with `start_date` ≤ `end_date`; line period must fall within document-level `invoice_period` when both are sent.
`order_line_reference`	object	Optional	Client-provided	Invoice line identifier (ibt-126). See Order line reference object.	Required for compliance (`IBR-021`): must include `line_id` when sent.
`despatch_line_reference`	object	Optional	Client-provided	Reference to a despatch document line. See Despatch line reference object.	If present, must be valid.
`document_reference`	object	Optional	Client-provided	Reference to a related document for this line. See Line document reference object.	If present: `id` required.
`charges`	array	Optional	Client-provided	Line-level charges that increase the line amount. See Charge object.	If present: each item must include `reason` or `reason_code`. `tax_category` is optional at line level.
`allowances`	array	Optional	Client-provided	Line-level allowances (discounts) on the line. See Allowance object.	If present: each item must include `reason` or `reason_code`. `tax_category` is optional at line level.
`buyer_item_identification`	object	Optional	Client-provided	Buyer's item identification: an identifier assigned by the buyer for the item. See Buyer item identification object.	If present: must include `id`.
`seller_item_identification`	object	Optional	Client-provided	Seller's item identification: an identifier assigned by the seller for the item. See Seller item identification object.	If present: must include `id`.
`standard_item_identification`	object	Optional	Client-provided	Standard item identification (ibt-157): an item identifier based on a registered scheme. See Standard item identification object.	If present: must include `id` and `scheme_id` (`IBR-064`).
`origin_country`	object	Optional	Client-provided	Origin country: country of origin for the item. See Origin country object.	If present: must include a valid country identification code.
`additional_item_property`	array	Optional	Client-provided	Item attributes: properties of the goods and services invoiced on this line. See Additional item property object.	If present: each item must include `name` and `value`.
`lot_number_id`	string	Optional	Client-provided	Batch number: an identifier for the production batch or lot that the items come from.	Free text.
`line_object_identifier`	string	Optional	Client-provided	Internal line object identifier used by your integration.	Free text.

Invoice period object

Used on document lines (document_lines[].invoice_period) and at document level (invoice_period).

Field	Type	Required	Source	Description	Validation
`start_date`	string	Conditional	Client-provided	Invoicing period start date (ibt-134 on lines, ibt-073 at document level).	Format `yyyy-MM-dd`; if both dates are sent, must be ≤ `end_date`.
`end_date`	string	Conditional	Client-provided	Invoicing period end date (ibt-135 on lines, ibt-074 at document level).	Format `yyyy-MM-dd`; if both dates are sent, must be ≥ `start_date`.
`description`	string	Optional	Client-provided	Frequency of billing for the period (UBL BTAE-06).	If present: must be a value from the frequency of billing code list — codes `DLY`, `WKY`, `Q15`, `MTH`, `Q45`, `Q60`, `QTR`, `YRL`, `HYR`, `OTH` or names `Daily`, `Weekly`, `Once in 15 days`, `Monthly`, `Once in 45 days`, `Once in 60 days`, `Quarterly`, `Yearly`, `Half-Yearly`, `Others`. When `OTH`/`Others`, document `note` is required.

Order line reference object

Field	Type	Required	Source	Description	Validation
`line_id`	string	Required	Client-provided	Invoice line identifier (ibt-126).	Must be non-empty when the object is present.
`order_reference_id`	string	Optional	Client-provided	Related order reference identifier for this line.	Free text.

Despatch line reference object

Field	Type	Required	Source	Description	Validation
`line_id`	string	Required	Client-provided	Despatch document line identifier.	Must be non-empty when the object is present.

Line document reference object

Field	Type	Required	Source	Description	Validation
`id`	string	Required	Client-provided	Referenced document identifier.	Must be non-empty when the object is present.
`issue_date`	string	Optional	Client-provided	Referenced document issue date.	If present, format `yyyy-MM-dd`.

Buyer item identification object

The buyer_item_identification field is an object with the following attributes:

Field	Type	Required	Source	Description	Validation
`id`	string	Required	Client-provided	Item buyer's identifier: an identifier, assigned by the buyer, for the item.	Must be non-empty when the object is present.

Seller item identification object

The seller_item_identification field is an object with the following attributes:

Field	Type	Required	Source	Description	Validation
`id`	string	Required	Client-provided	Item seller's identifier: an identifier, assigned by the seller, for the item.	Must be non-empty when the object is present.

Standard item identification object

The standard_item_identification field is an object with the following attributes:

Field	Type	Required	Source	Description	Validation
`id`	string	Required	Client-provided	Item standard identifier: an item identifier based on a registered scheme.	Must be non-empty when the object is present.
`scheme_id`	string	Required	Client-provided	Scheme identifier: the identification scheme identifier of the item standard identifier.	Must be a valid ISO 6523 ICD scheme (`IBR-CL-21`).

Additional item identification object

Use this array for Service Accounting Code (SAC) when the line Item Type is Services (S) or Both (B). In Marmin UI this is the Service Accounting Code field—not the Item Type dropdown.

Each element of the additional_item_identification array is an object with the following attributes:

Field	Type	Required	Source	Description	Validation
`id`	string	Required	Client-provided	Service Accounting Code (SAC): classifies the service by type or nature.	Must be non-empty when the object is present.
`scheme_id`	string	Required	Client-provided	SAC scheme identifier.	Must be `"SAC"` when SAC is provided (`IBR-189-AE`).
`scheme_version_id`	string	Optional	Client-provided	SAC scheme version identifier.	Free text when provided.

Line item classification (UI to API)

The tables below map common ERP/UI labels on a document line to the API fields on document_lines[]. Use them when building create payloads from your source system.

#### Item type

Layer	Name / value
UI label	Item Type
Form field	`commodity_code`
UI values	`G` = Goods, `S` = Services, `B` = Both
API (per line)	`commodity_classification.commodity_code`

#### Item classification identifier (HSN)

Applies when Item Type is Goods (`G`) or Both (`B`).

Layer	Name / value
UI label	Item Classification Identifier
Form field	`item_classification_identifier.code` (optional `description`)
API (per line)	`commodity_classification.item_classification_code` — HSN code string

#### Service accounting code (SAC)

Applies when Item Type is Services (`S`) or Both (`B`).

Layer	Name / value
UI label	Service Accounting Code
API (per line)	`additional_item_identification[].id` with `scheme_id`: `"SAC"`

#### Related fields

UI / form	API	Purpose
Item Type (`commodity_code`)	`commodity_classification.commodity_code`	Goods / Services / Both
Item Classification Identifier	`commodity_classification.item_classification_code` + `item_classification_list_id`: `"HS"`	HSN for goods
Service Accounting Code (Services / Both)	`additional_item_identification[].id` with `scheme_id`: `"SAC"`	SAC for services
`nature_code` (separate; reverse charge)	`commodity_classification.nature_code`	Not the Item Type dropdown

Commodity classification object

The commodity_classification object carries Item Type, HSN (for goods), and reverse-charge metadata. See Line item classification (UI to API) for UI mappings.

Field	Type	Required	Source	Description	Validation
`commodity_code`	string	Conditional	Client-provided	Item type (UI: Item Type). Whether the line is Goods, Services, or Both.	Required when classifying the line. Must be `G`, `S`, or `B`. Maps from UI/form field `commodity_code`.
`item_classification_code`	string	Conditional	Client-provided	Item classification identifier (UI: HSN). Harmonized System code for the goods on this line.	Required when `commodity_code` is `G` or `B` (`IBR-184-AE`). Must be non-empty. Maps from UI `item_classification_identifier.code`.
`item_classification_list_id`	string	Conditional	Client-provided	HSN scheme identifier (UNTDID 7143).	Required when `item_classification_code` is sent. Always `"HS"` for UAE (`IBR-188-AE`).
`item_classification_list_version_id`	string	Optional	Client-provided	HSN scheme version.	Send `null` (do not omit if your serializer requires the key).
`nature_code`	string	Optional	Client-provided	Type of goods or services subject to reverse charge (RCM). Separate from Item Type.	If present, must be a valid RCM nature code (`IBR-166-AE`). Not the Item Type dropdown.

Origin country object

Field	Type	Required	Source	Description	Validation
`identification_code`	string	Required	Client-provided	ISO 3166-1 alpha-2 country code for country of origin.	Must be a valid country code. See Get Countries.

Additional item property object

Field	Type	Required	Source	Description	Validation
`name`	string	Required	Client-provided	Attribute name (e.g. color, size, material).	Must be non-empty when the object is present.
`value`	string	Required	Client-provided	Attribute value.	Must be non-empty when the object is present.

Charge object

Each element of the charges array is an object with the following attributes:

Field	Type	Required	Description	Validation
`reason`	string	Conditional	Free-text charge reason. Use this for a custom charge reason when no code applies.	At least one of `reason` or `reason_code` must be provided.
`reason_code`	string	Conditional	UN/ECE Recommendation 20 charge reason code.	At least one of `reason` or `reason_code` must be provided. Must be a valid charge reason code (e.g. `FC`). See Get Charge Reason Codes.
`tax_category`	object	Conditional	Tax category applied to the charge.	Required for document-level charges. Optional for line-level charges. If present, see Tax category object. `tax_exemption_reason_code` and `tax_exemption_reason` are required when `id` is `E`.
`amount`	number	Optional	Charge amount.	Numeric amount for the charge.
`multiplier_factor_numeric`	number	Optional	Percentage or multiplier used to calculate the charge.	If sent, `base_amount` must also be sent.
`base_amount`	number	Optional	Base amount for the charge.	If sent, `multiplier_factor_numeric` must also be sent.

Allowance object

Each element of the allowances array is an object with the following attributes:

Field	Type	Required	Description	Validation
`reason`	string	Conditional	Free-text allowance or discount reason. Use this for a custom reason when no code applies.	At least one of `reason` or `reason_code` must be provided.
`reason_code`	string	Conditional	UN/ECE Recommendation 20 allowance reason code.	At least one of `reason` or `reason_code` must be provided. Must be a valid code (e.g. `95`). See Get Discount Reason Codes.
`tax_category`	object	Conditional	Tax category for allowance adjustment.	Required for document-level allowances. Optional for line-level allowances. If present, see Tax category object. `tax_exemption_reason_code` and `tax_exemption_reason` are required when `id` is `E`.
`amount`	number	Optional	Allowance amount.	Numeric amount for the allowance.
`multiplier_factor_numeric`	number	Optional	Percentage or multiplier used to calculate the allowance.	If sent, `base_amount` must also be sent.
`base_amount`	number	Optional	Base amount for the allowance.	If sent, `multiplier_factor_numeric` must also be sent.

Payment means array

The payment_means field is an array; each element is an object with the following attributes:

Field	Type	Required	Description	Validation
`payment_means_code`	string	Required	Payment means code (e.g. `54` for credit card).	Required when a `payment_means` item is sent. Must not be blank. Must be one of: `1`, `10`, `20`, `21`, `30`, `49`, `54`, `55`, `68`. See Get Payment Means Modes.
`card_account`	object	Conditional	Card account details.	Mandatory when `payment_means_code` is `54` or `55`.
`payee_financial_account`	object	Conditional	Payee bank/financial account details.	Mandatory when `payment_means_code` is `30`.
`payment_mandate`	object	Conditional	Payment mandate details.	Mandatory when `payment_means_code` is `49`.
`id`	string	Optional	Payment means identifier.	Optional identifier for the payment instruction.
`payment_id`	array of strings	Optional	Payment reference identifiers.	Used for payment reconciliation.

Card account object

The card_account field is an object with the following attributes:

Field	Type	Required	Description	Validation
`primary_account_number_id`	string	Required	Primary account number identifier. UI label: PAN.	Mandatory when `payment_means_code` is `54` or `55`; must not be blank.
`network_id`	string	Required	Card network identifier. UI label: Network ID.	Mandatory when `payment_means_code` is `54` or `55`; must not be blank.
`holder_name`	string	Optional	Card holder name.	Free text.

Payee financial account object

The payee_financial_account field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Optional	Payee financial account identifier. UI label: Payment account identifier.	Mandatory when `payment_means_code` is `30`.
`name`	string	Optional	Payee financial account name.	Free text.
`financial_institution_branch_id`	string	Optional	Financial institution branch identifier.	Free text.
`address`	object	Optional	Payee financial account address.	If present, see Address object.

Payment mandate object

The payment_mandate field is an object with the following attributes:

Field	Type	Required	Description	Validation
`id`	string	Optional	Payment mandate identifier. UI label: Mandate reference Identifier.	Mandatory when `payment_means_code` is `49`.
`payer_financial_account_id`	string	Optional	Payer financial account identifier. UI label: Payer Financial Account Identifier.	Mandatory when `payment_means_code` is `49`.

Payment terms object

The payment_terms field is an object with the following attributes:

Field	Type	Required	Description	Validation
`note`	string	Optional	Payment terms description.	Free text.
`due_date`	string	Optional	Payment due date.	If present, format `yyyy-MM-dd`.
`installment_due_date`	string	Optional	Installment due date.	If present, format `yyyy-MM-dd`.
`amount`	number	Optional	Amount due.	Must be numeric if provided.

Tax exchange rate object

The tax_exchange_rate field is an object with the following attributes:

Field	Type	Required	Description	Validation
`source_currency_code`	string	Required	Source currency (ISO 4217).	Must be a valid ISO 4217 code. See Get Currency Names and Codes.
`target_currency_code`	string	Required	Target currency (ISO 4217).	Must be a valid ISO 4217 code and usually match `tax_currency_code`. See Get Currency Names and Codes.
`calculation_rate`	number	Required	Exchange rate for tax calculation.	Must be a positive numeric rate.

Meta info object

The meta_info field is an object with the following attributes:

Field	Type	Required	Description	Validation

Profile execution ID

profile_execution_id is an 8-character binary flag string (each character 0 or 1) that encodes UAE special transaction types. Use 00000000 for a standard proforma with no special types.

Transaction scenarios follow PINT AE. Set the corresponding position to 1 when the supply matches that scenario; leave it 0 otherwise. Multiple flags may be 1 when more than one scenario applies.

Flag order and field rules match sale invoice Profile execution ID. For ready-to-use payloads by scenario, see Sale invoice examples.

Transaction type	Position	When to use	When the flag is `1`
Free trade zone	1XXXXXXX	Supply of goods or services in a free trade zone.	Set `buyer_customer_party.id` (Beneficiary TIN).
Deemed supply	X1XXXXXX	Supply of goods or services without consideration.	No additional mandatory fields beyond standard validation.
Profit Margin Scheme	XX1XXXXX	Supply of goods under the profit margin scheme.	No additional mandatory fields beyond standard validation.
Summary invoice	XXX1XXXX	Taxable person makes more than one supply of goods or services to the same person in the same calendar month.	Set `invoice_period` with at least one of `start_date` or `end_date` (and optionally `description`).
Continuous Supply	XXXX1XXX	Supply of goods and/or services made on a recurrent basis.	No additional mandatory fields beyond standard validation.
Agent billing	XXXXX1XX	Agent who is a registrant makes a supply on behalf of the principal.	Set `seller_supplier_party.id` (Principle ID TRN) for disclosed agent billing payloads. See Seller supplier party object. Example payload: Disclosed agent billing.
Supply through e-commerce	XXXXXX1X	Supply of goods or services via e-commerce.	Include `delivery` with `delivery_location.address` when required by your business scenario. See Delivery object.
Exports	XXXXXXX1	Supply of goods or services outside the country.	Include `delivery` with `delivery_location.address`. `accounting_customer_party.party_tax_scheme` is optional when the buyer is non-UAE. See Delivery object. Example payload: Export transaction with delivery.

*Each position X is 0 or 1 depending on your scenario.*

Payment means: If position 2 is 0, you must provide payment_means. If position 2 is 1, payment_means is optional. If you include a payment_means item, payment_means_code is required for that item.

Scenario	Examples page
Free Trade Zone, summary invoice, disclosed agent, export	Sale invoice examples

Parameter	Type	Required	Description
`supplier_profile_id`	string	Required	The business profile ID of the supplier issuing the invoice. Must exist in your organization.

Required data

Customer party objects — Complete accounting customer party with name, address, and tax scheme when required
Supplier profile identifier — Business profile ID of the supplier (in path)
Business profile identifier — Must exist in your organization
Line items — At least one document line with name, quantity, unit code, price, and classified tax category
VAT information — Tax category and scheme per line and for charges/allowances as applicable

System behavior

VAT rules are applied according to UAE VAT law
The proforma invoice is recorded
Invoice status and transmission events are tracked

Validation rules

Rule	Description
Time fields	When sending `issue_time` or `delivery_time`, use Gulf Standard Time (GST, UTC+4). Format `HH:mm:ss`.
Profile execution ID	Must match pattern `^[0-1]{8}$`
UAE addresses	Must include `country_subentity` (emirate code: DXB, AUH, SHJ, etc.)
Party VAT (`party_tax_scheme`)	Optional for UAE parties. If either `company_id` or `tax_scheme` is provided, both are required with UAE VAT format
VAT/TRN format	15 digits; starts with `1` and ends with `03`
Customer registration	Optional. If `scheme_agency_id` is provided, `company_id` is required and type-specific rules apply. See The Customer party object.
UAE business customer TIN	Required for UAE business customers. Exactly 10 characters, must start with `1`
Document number	Must be unique within organization (if provided)
Business profile ID	Must exist in your organization
Permissions	User must have permission to create invoices for the specified business profile

Response

Status code: 201 Created

Returns the created proforma invoice with all request fields echoed plus system-generated and calculated fields.

Response body fields

Document lines in response

Each line includes calculated fields: base_amount, net_amount, total_amount, tax_amount. The price object in the response contains price_amount (instead of base_amount in the request).

Charges and allowances

Document-level charges and allowances are applied after line item totals
Line-level charges and allowances are applied per line item
All charges and allowances require a tax_category for proper VAT calculation

See the right panel for complete response JSON.

Error responses

Status	Description
400 Bad Request	Invalid request parameters or validation failed. For validation errors, the response includes field-specific errors.
401 Unauthorized	Authentication required or invalid token.
500 Internal Server Error	An error occurred while processing the request.

Request

# Base URL: https://api-sandbox.ae.marmin.ai
# POST /api/proforma-invoices/{supplier_profile_id}

curl -X POST "https://api-sandbox.ae.marmin.ai/api/proforma-invoices/MBP-1234567890abcdef" \
  -H "Authorization: Bearer <access_token>" \
  -H "X-MARMIN-VERSION: 20260507" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_execution_id": "00000000",
    "document_number": "INV-001",
    "issue_date": "2025-05-24",
    "issue_time": "10:30:00",
    "note": "Thank you for your business",
    "tax_point_date": "2025-05-24",
    "document_currency_code": "AED",
    "tax_currency_code": "AED",
    "accounting_cost": "COST-001",
    "buyer_reference": "BR-REF-001",
    "invoice_period": {
      "start_date": "2025-05-01",
      "end_date": "2025-05-31",
      "description": "Monthly"
    },
    "order_reference": {
      "id": "ORD-001",
      "sales_order_id": "SO-001"
    },
    "billing_reference": [
      {
        "id": "INV-PRE-001",
        "issue_date": "2025-04-15"
      }
    ],
    "despatch_document_reference": { "id": "DESP-001" },
    "receipt_document_reference": { "id": "REC-001" },
    "statement_document_reference": { "id": "STMT-001" },
    "originator_document_reference": { "id": "ORIG-001" },
    "contract_document_reference": {
      "id": "CONTRACT-001",
      "document_description": "Master agreement"
    },
    "payee_party": {
      "party_name": "Payee Name",
      "party_identification_id": "PID-001",
      "company_id": "123456",
      "company_scheme_id": "002"
    },
    "buyer_customer_party": { "id": "1001234567" },
    "seller_supplier_party": { "id": "100123456789003" },
    "tax_representative_party": {
      "endpoint_id": "EP-001",
      "endpoint_scheme_id": "0235",
      "party_name": "Tax Rep Ltd",
      "profile_id": "PROF-001",
      "postal_address": {
        "street_name": "123 Rep Street",
        "additional_street_name": null,
        "city_name": "Dubai",
        "postal_zone": "12345",
        "country_subentity": "DXB",
        "address_line": null,
        "country": "United Arab Emirates",
        "country_code": "AE"
      },
      "party_tax_scheme": {
        "company_id": "300123456789003",
        "tax_scheme": "VAT"
      },
      "tin": null,
      "scheme_agency_id": "TL",
      "company_id": "123456",
      "company_scheme_id": null,
      "authority_name": "Dubai Department of Economy and Tourism",
      "passport_issuing_country_code": null,
      "company_legal_form": null,
      "name": "Tax Representative",
      "email": "rep@example.com",
      "telephone": null,
      "logo_url": null
    },
    "delivery": {
      "actual_delivery_date": "2025-05-25",
      "delivery_location": {
        "id": "LOC-001",
        "address": {
          "street_name": "456 Delivery St",
          "additional_street_name": null,
          "city_name": "Abu Dhabi",
          "postal_zone": "54321",
          "country_subentity": "AUH",
          "address_line": null,
          "country": "United Arab Emirates",
          "country_code": "AE"
        }
      },
      "party_name": null,
      "party_id": null,
      "terms": null
    },
    "invoice_type_code": "380",
    "due_date": "2025-06-24",
    "payment_means": [{
      "id": null,
      "payment_means_code": "30",
      "payment_id": ["PAY-REF-001"],
      "card_account": null,
      "payee_financial_account": {
        "id": "IBAN123",
        "name": "Account Name",
        "financial_institution_branch_id": null,
        "address": null
      },
      "payment_mandate": null
    }],
    "project_reference": { "id": "PRJ-001" },
    "charges": [
      {
        "reason_code": "FC",
        "reason": "Freight charge",
        "amount": 50.0,
        "multiplier_factor_numeric": null,
        "base_amount": null,
        "tax_category": {
          "id": "S",
          "percent": 5.0,
          "tax_exemption_reason_code": null,
          "tax_exemption_reason": null,
          "tax_scheme": "VAT"
        }
      }
    ],
    "allowances": [
      {
        "reason_code": "95",
        "reason": "Discount",
        "amount": 10.0,
        "multiplier_factor_numeric": null,
        "base_amount": null,
        "tax_category": {
          "id": "S",
          "percent": 5.0,
          "tax_exemption_reason_code": null,
          "tax_exemption_reason": null,
          "tax_scheme": "VAT"
        }
      }
    ],
    "tax_exchange_rate": {
      "source_currency_code": "USD",
      "target_currency_code": "AED",
      "calculation_rate": 3.6725
    },
    "prepaid_amount": 0.0,
    "payable_rounding_amount": 0.0,
    "document_lines": [
      {
        "note": null,
        "quantity": 2.0,
        "unit_code": "EA",
        "accounting_cost": null,
        "invoice_period": null,
        "order_line_reference": { "line_id": "LINE-001" },
        "despatch_line_reference": null,
        "document_reference": null,
        "charges": null,
        "allowances": null,
        "description": "Product A description",
        "name": "Product A",
        "buyer_item_identification": null,
        "seller_item_identification": null,
        "standard_item_identification": null,
        "additional_item_identification": null,
        "origin_country": null,
        "commodity_classification": null,
        "classified_tax_category": {
          "id": "S",
          "percent": 5.0,
          "tax_exemption_reason_code": null,
          "tax_exemption_reason": null,
          "tax_scheme": "VAT"
        },
        "additional_item_property": null,
        "lot_number_id": null,
        "price": {
          "base_amount": 100.0,
          "base_quantity": 1.0,
          "allowance": null
        },
        "line_object_identifier": null
      }
    ],
    "document_source": "API",
    "accounting_supplier_party": null,
    "accounting_customer_party": {
      "endpoint_id": "0199:265627835",
      "endpoint_scheme_id": "0235",
      "party_name": "Buyer Business LLC",
      "profile_id": null,
      "postal_address": {
        "street_name": "100 Buyer Street",
        "additional_street_name": null,
        "city_name": "Dubai",
        "postal_zone": "00000",
        "country_subentity": "DXB",
        "address_line": null,
        "country": "United Arab Emirates",
        "country_code": "AE"
      },
      "party_tax_scheme": { "company_id": "100123456789003", "tax_scheme": "VAT" },
      "tin": null,
      "scheme_agency_id": "TL",
      "company_id": "265627835",
      "company_scheme_id": "002",
      "authority_name": "Dubai Department of Economy and Tourism",
      "passport_issuing_country_code": null,
      "company_legal_form": null,
      "name": "Buyer Party",
      "email": "buyer@example.com",
      "telephone": null,
      "logo_url": null
    }
  }'

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "org-456",
  "profile_execution_id": "00000000",
  "document_number": "INV-001",
  "document_sequence": 1,
  "issue_date": "2025-05-24",
  "issue_time": "10:30:00",
  "invoice_type_code": "380",
  "due_date": "2025-06-24",
  "note": "Thank you for your business",
  "tax_point_date": "2025-05-24",
  "document_currency_code": "AED",
  "tax_currency_code": "AED",
  "accounting_cost": "COST-001",
  "buyer_reference": "BR-REF-001",
  "invoice_period": {
    "start_date": "2025-05-01",
    "end_date": "2025-05-31",
    "description": "Monthly"
  },
  "order_reference": {
    "id": "ORD-001",
    "sales_order_id": "SO-001"
  },
  "billing_reference": [
    {
      "id": "INV-PRE-001",
      "issue_date": "2025-04-15"
    }
  ],
  "despatch_document_reference": {
    "id": "DESP-001"
  },
  "receipt_document_reference": {
    "id": "REC-001"
  },
  "statement_document_reference": {
    "id": "STMT-001"
  },
  "originator_document_reference": {
    "id": "ORIG-001"
  },
  "contract_document_reference": {
    "id": "CONTRACT-001",
    "document_description": "Master agreement"
  },
  "project_reference": {
    "id": "PRJ-001"
  },
  "accounting_supplier_party": {
    "endpoint_id": "0199:265627835",
    "endpoint_scheme_id": "0235",
    "party_name": "Seller Business",
    "profile_id": "SELLER-PROFILE-001",
    "postal_address": {
      "street_name": "123 Seller St",
      "additional_street_name": null,
      "city_name": "Dubai",
      "postal_zone": "12345",
      "country_subentity": "DXB",
      "address_line": null,
      "country": "United Arab Emirates",
      "country_code": "AE"
    },
    "party_tax_scheme": {
      "company_id": "123456789",
      "tax_scheme": "VAT"
    },
    "tin": null,
    "scheme_agency_id": "TL",
    "company_id": "265627835",
    "company_scheme_id": null,
    "authority_name": "Dubai Department of Economy and Tourism",
    "passport_issuing_country_code": null,
    "company_legal_form": null,
    "name": "Seller Party",
    "email": "seller@example.com",
    "telephone": null,
    "logo_url": null
  },
  "accounting_customer_party": {
    "endpoint_id": "0199:265627835",
    "endpoint_scheme_id": "0235",
    "party_name": "Buyer Business LLC",
    "profile_id": null,
    "postal_address": {
      "street_name": "100 Buyer Street",
      "additional_street_name": null,
      "city_name": "Dubai",
      "postal_zone": "00000",
      "country_subentity": "DXB",
      "address_line": null,
      "country": "United Arab Emirates",
      "country_code": "AE"
    },
    "party_tax_scheme": {
      "company_id": "100123456789003",
      "tax_scheme": "VAT"
    },
    "tin": null,
    "scheme_agency_id": "TL",
    "company_id": "265627835",
    "company_scheme_id": "002",
    "authority_name": "Dubai Department of Economy and Tourism",
    "passport_issuing_country_code": null,
    "company_legal_form": null,
    "name": "Buyer Party",
    "email": "buyer@example.com",
    "telephone": null,
    "logo_url": null
  },
  "payee_party": null,
  "buyer_customer_party": null,
  "seller_supplier_party": null,
  "tax_representative_party": null,
  "delivery": null,
  "payment_means": [{
    "id": null,
    "payment_means_code": "30",
    "payment_id": ["PAY-REF-001"],
    "card_account": null,
    "payee_financial_account": { "id": "IBAN123", "name": "Account Name", "financial_institution_branch_id": null, "address": null },
    "payment_mandate": null
  }],
  "payment_terms": null,
  "charges": [],
  "allowances": [],
  "tax_exchange_rate": null,
  "tax_breakdown": [
    {
      "tax_category_id": "S",
      "taxable_amount": 200.0,
      "tax_amount": 10.0,
      "percent": 5.0
    }
  ],
  "allowance_total_amount": 10.0,
  "charge_total_amount": 50.0,
  "line_extension_amount": 200.0,
  "tax_exclusive_amount": 240.0,
  "tax_amount": 12.0,
  "tax_amount_in_aed": 12.0,
  "tax_inclusive_amount": 252.0,
  "prepaid_amount": 0.0,
  "payable_rounding_amount": 0.0,
  "payable_amount": 252.0,
  "payable_amount_in_aed": 252.0,
  "total_item_allowances": 0.0,
  "total_item_charges": 0.0,
  "total_taxable_amount": 240.0,
  "total_non_taxable_amount": 0.0,
  "document_lines": [
    {
      "note": null,
      "quantity": 2.0,
      "unit_code": "EA",
      "accounting_cost": null,
      "invoice_period": null,
      "order_line_reference": null,
      "despatch_line_reference": null,
      "document_reference": null,
      "charges": null,
      "allowances": null,
      "description": "Product A description",
      "name": "Product A",
      "buyer_item_identification": null,
      "seller_item_identification": null,
      "standard_item_identification": null,
      "additional_item_identification": null,
      "origin_country": null,
      "commodity_classification": null,
      "classified_tax_category": {
        "id": "S",
        "percent": 5.0,
        "tax_exemption_reason_code": null,
        "tax_exemption_reason": null,
        "tax_scheme": "VAT"
      },
      "additional_item_property": null,
      "lot_number_id": null,
      "price": { "base_amount": 100.0, "base_quantity": 1.0, "allowance": null },
      "line_object_identifier": null,
      "net_amount": 200.0,
      "base_amount": 200.0,
      "total_amount": 210.0,
      "total_amount_in_aed": 210.0,
      "tax_amount": 10.5,
      "tax_amount_in_aed": 10.5
    }
  ],
  "document_source": "API",
  "meta_info": null,
  "is_phase2_document": false
}

Create a Proforma invoice

Rate limit

Path parameters

Request body

Request fields

Party object

Address object

Tax category object

Buyer customer party object

Seller supplier party object

Payee party object

Tax representative party object

Delivery object

Delivery location object

Order reference object

Billing reference object

Despatch document reference object

Receipt document reference object

Statement document reference object

Originator document reference object

Contract document reference object

Project reference object

Price object

Document line object

Invoice period object

Order line reference object

Despatch line reference object

Line document reference object

Buyer item identification object

Seller item identification object

Standard item identification object

Additional item identification object

Line item classification (UI to API)

Commodity classification object

Origin country object

Additional item property object

Charge object

Allowance object

Payment means array

Card account object

Payee financial account object

Payment mandate object

Payment terms object

Tax exchange rate object

Meta info object

Profile execution ID

Related examples

Required data

System behavior

Validation rules

Response

Response body fields

Document lines in response

Charges and allowances

Error responses