{"openapi":"3.0.1","info":{"title":"DigiTax UAE API Endpoints","description":"DigiTax UAE Public API — Peppol PINT-AE compliant e-invoicing.","version":"3","termsOfService":"https://digitax.tech/page/terms","contact":{"name":"DigiTax","url":"https://digitax.tech","email":"support@namiri.tech"},"license":{"name":"Apache 2.0"}},"servers":[{"url":"https://api.digitax.tech/ae/v1","description":"API"}],"paths":{"/resources/countries":{"get":{"tags":["Resources"],"summary":"Get UAE Countries","description":"Returns the list of supported countries based on the ISO 3166-1 alpha-2 code list used in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of countries","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/currencies":{"get":{"tags":["Resources"],"summary":"Get UAE Currencies","description":"Returns the list of supported currencies based on ISO 4217.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of currencies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/tax-categories":{"get":{"tags":["Resources"],"summary":"Get UAE Tax Categories","description":"Returns the list of VAT category codes applicable in the UAE under the PINT-AE specification.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of tax category codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaxCategory"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/invoice-types":{"get":{"tags":["Resources"],"summary":"Get UAE Invoice Types","description":"Returns the list of invoice type codes (UN/CEFACT UNCL1001 subset) supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of invoice type codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceType"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/payment-means":{"get":{"tags":["Resources"],"summary":"Get UAE Payment Means","description":"Returns the list of payment means codes (UN/CEFACT UNCL4461) supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of payment means codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/commodity-codes":{"get":{"tags":["Resources"],"summary":"Get UAE Commodity Codes","description":"Returns the list of item type/commodity codes supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of commodity codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/item-classification-list":{"get":{"tags":["Resources"],"summary":"Get UAE Item Classification List","description":"Returns the valid item classification list identifiers (BT-158-scheme-id) supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of item classification list codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/international-code-designator-schemes":{"get":{"tags":["Resources"],"summary":"Get the ISO 6523 International Code Designator Schemes","description":"Returns the list of international code designator schemes supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of international code designator scheme codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/electronic-address-schemes":{"get":{"tags":["Resources"],"summary":"Get the Peppol Electronic Address Scheme (EAS) codes","description":"Returns the list of Peppol EAS codes usable as a party's `peppol_id_scheme`.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of Peppol EAS codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/tax-exemption-reasons":{"get":{"tags":["Resources"],"summary":"Get UAE Tax Exemption Reason Codes","description":"Returns the list of VAT exemption reason codes applicable in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of tax exemption reason codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/credit-reasons":{"get":{"tags":["Resources"],"summary":"Get UAE Credit Note Reason Codes","description":"Returns the list of valid reason codes for credit notes as specified by the UAE FTA.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of credit note reason codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/billing-frequencies":{"get":{"tags":["Resources"],"summary":"Get UAE Billing Frequency Codes","description":"Returns the list of billing frequency codes used in invoice periods under PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of billing frequency codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/units-of-measure":{"get":{"tags":["Resources"],"summary":"Get UAE Units of Measure","description":"Returns the list of UN/ECE Recommendation 20 unit of measure codes supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of unit of measure codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/allowance-reasons":{"get":{"tags":["Resources"],"summary":"Get UAE Allowance Reason Codes","description":"Returns the list of allowance reason codes (UN/CEFACT UNCL5189) supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of allowance reason codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/charge-reasons":{"get":{"tags":["Resources"],"summary":"Get UAE Charge Reason Codes","description":"Returns the list of charge reason codes (UN/CEFACT UNCL7161) supported in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of charge reason codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/goods-types":{"get":{"tags":["Resources"],"summary":"Get UAE Goods Types","description":"Returns the list of goods type codes for items subject to reverse charge mechanism (RCM) in PINT-AE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of goods type codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/delivery-location-schemes":{"get":{"tags":["Resources"],"summary":"Get UAE Delivery Location Schemes","description":"Returns the list of delivery location schemes used in UAE e-invoices.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of delivery location schemes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/ae-country-subentities":{"get":{"tags":["Resources"],"summary":"Get UAE Country Subentities","description":"Returns the list of country subentities in the UAE.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of AE country subentities","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommonCode"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/resources/legal-registration-types":{"get":{"tags":["Resources"],"summary":"Get UAE Legal Registration Types","description":"Returns the list of legal registration identifier types used to classify a company identifier — e.g. Trade License, Emirates ID, Passport.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"List of legal registration type codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegalRegistrationType"}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/info":{"get":{"tags":["Business"],"summary":"Get UAE Business Info","description":"Returns information about the business as registered on DigiTax.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Branch info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/parties":{"get":{"tags":["Parties"],"summary":"Get UAE Parties","description":"Returns a paginated list of parties registered under the authenticated business.","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"List of parties","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Party"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Parties"],"summary":"Create a UAE business Party","description":"Creates a new party for use in UAE e-invoices.","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PartyTaxpayer"},{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}]}}}},"responses":{"201":{"description":"Created party","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Party"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/parties/{party_id}":{"get":{"tags":["Parties"],"summary":"Get a UAE business party","description":"Retrieves information about a party given their ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"party_id","required":true,"schema":{"type":"string","example":"party_01HC3J1VVVM05YCTS61G7V3KC6"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Party"}}}},"default":{"$ref":"#/components/responses/Error"}}},"put":{"tags":["Parties"],"summary":"Update a UAE business party","description":"Updates party information given their ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"party_id","required":true,"schema":{"type":"string","description":"Party ID on DigiTax","example":"party_01HC3J1VVVM05YCTS61G7V3KC6"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"legal_entity":{"$ref":"#/components/schemas/PartyLegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The updated contact person name","example":"Sara Ahmed"},"contact_phone":{"type":"string","description":"The updated contact phone number in E.164 format","example":"+971501112222"},"contact_email":{"type":"string","format":"email","description":"The updated contact email address","example":"sara.ahmed@global-imports.ae"}}}}}},"responses":{"200":{"description":"Party updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Party"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/items":{"get":{"tags":["Items"],"summary":"Get UAE Items","description":"Returns a paginated list of business items","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"A list of items","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Items"],"summary":"Create a UAE Item","description":"Creates a new item that can be referenced in UAE e-invoices.","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","description","commodity_code","tax_category_code"],"properties":{"name":{"type":"string","description":"The name of the item","example":"Industrial Pump Model X-500"},"description":{"type":"string","description":"A description of the item","example":"High-pressure centrifugal pump for industrial fluid transfer"},"commodity_code":{"type":"string","description":"The commodity type code (G for goods, S for services, B for both). See `GET /resources/commodity-codes` for available values.","example":"G"},"hs_code":{"type":"string","description":"The Harmonized System (HS) code for the item. Required when commodity_code is G (goods) or B (both goods and services)","example":"84137000"},"service_accounting_code":{"type":"string","description":"The Service Accounting Code for the item. Required when commodity_code is S (services) or B (both goods and services)","example":"SAC-0001"},"tax_category_code":{"type":"string","description":"The VAT category code for this item. See `GET /resources/tax-categories` for available values.","example":"S"},"item_code":{"type":"string","description":"A unique code assigned to the item in the user's system. It will be used as the unique product identifier","example":"PUMP-X500-BLK"},"standard_item_id":{"type":"string","description":"A standardised item identifier","example":"09501101530003"},"standard_item_scheme":{"type":"string","description":"The scheme for the standard item identifier. See `GET /resources/international-code-designator-schemes` for available values.","example":"0160"},"origin_country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 code of the item's country of origin. See `GET /resources/countries` for available values.","example":"DE"},"item_properties":{"type":"array","description":"Additional item attributes","items":{"$ref":"#/components/schemas/ItemProperty"}}}}}}},"responses":{"201":{"description":"Item created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/items/{item_id}":{"get":{"tags":["Items"],"summary":"Get a UAE Item","description":"Retrieves information about an item given its ID on DigiTax.","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"item_id","required":true,"schema":{"type":"string","description":"Item ID on DigiTax","example":"item_01HC3J1VVVM05YCTS61G7V3KC6"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/invoices":{"get":{"tags":["Invoices"],"summary":"Get UAE Invoices","description":"Returns a paginated list of all invoices created by the business","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"A list of invoices","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Invoices"],"summary":"Create a UAE Invoice","description":"Creates a new PINT-AE compliant e-invoice and submits it to the Peppol network.","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trader_invoice_number","invoice_type_code","issue_date","document_currency_code","customer_party_id","items","payments"],"properties":{"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the supplier to uniquely identify the invoice in their system","example":"ACME-INV-2024-0042"},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["FREE_TRADE_ZONE","CONTINUOUS_SUPPLY"]},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code. See `GET /resources/invoice-types` for available values.","example":"380"},"issue_date":{"type":"string","format":"date","description":"The date on which the invoice was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.","example":"2026-07-14"},"issue_time":{"type":"string","description":"The invoice issue time (HH:MM:SS)","example":"10:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"document_currency_code":{"type":"string","description":"A code that specifies the currency in which the invoice is issued. See `GET /resources/currencies` for available values.","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document and tax currencies. Required and must be > 0 when `document_currency_code` is not `AED`. When `document_currency_code` is `AED`, must be `1` or omitted. Maximum 6 decimal places.","example":3.67},"customer_party_id":{"type":"string","description":"The DigiTax party ID of the buyer","example":"party_01HC3J1VVVM05YCTS61G7V3KC6"},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"tax_point_date":{"type":"string","format":"date","description":"The VAT point date (YYYY-MM-DD). Must be strictly before the issue_date.","example":"2026-07-13"},"buyer_reference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes.","example":"BR-2026-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CAPEX-2024-Q4"},"project_reference":{"type":"string","description":"A project reference","example":"PROJ-JEBEL-2024"},"note":{"type":"string","description":"A free-text note on the invoice","example":"General invoice details"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"billing_reference":{"type":"array","description":"References to preceding invoices","items":{"$ref":"#/components/schemas/DocumentReference"}},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"Additional supporting document references","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual payment terms","example":"Next 30 days"},"allowance_charges":{"type":"array","description":"Invoice-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment details for this invoice","items":{"$ref":"#/components/schemas/CreateInvoicePaymentRequest"}},"items":{"type":"array","description":"The invoice line items","items":{"$ref":"#/components/schemas/CreateInvoiceItemRequest"}},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid, to be deducted from the payable amount","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount","example":0},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary for Free Trade Zone supplies. Required when `transaction_types` includes `FREE_TRADE_ZONE`.","example":"123456789098703"},"principle_trn":{"type":"string","description":"The TRN of the principal for Disclosed Agent billing. Required when `transaction_types` includes `AGENT_BILLING`. Must differ from the business's own TRN.","example":"123456789098703"}}},"examples":{"commercial_invoice":{"description":"Invoice for a supply outside the scope of UAE VAT (type 480); no VAT collected","summary":"Commercial Invoice (Out of Scope)","value":{"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"480","issue_date":"2026-08-27","issue_time":"17:38:00","items":[{"gross_price":151,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":150,"price_discount":1,"quantity":1000,"tax_category_code":"O","tax_rate":0,"unit_of_measure_code":"H87"}],"payment_terms_note":"Cash payment","payments":[{"payment_means_code":"10"}],"trader_invoice_number":"AE-CI-001Test"}},"continuous_supply":{"description":"Recurring supply of goods and services billed on a continuous basis, spanning a standard-rated and an exempt line item","summary":"Continuous Supply","value":{"additional_documents":[{"id":"Cabbills"},{"id":"All signed cab bills"}],"allowance_charges":[{"amount":75,"base_amount":5000,"charge_indicator":true,"multiplier_rate":0.015,"reason":"Polyethylene wrap packing","reason_code":"ABU","tax_category_code":"S","tax_rate":0.05}],"contract_document_reference":{"document_description":"AED 1000000","id":"ZXC-CS-03"},"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-24","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":500,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":500,"price_discount":0,"quantity":10,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"TIP"},{"gross_price":0.5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS2","price_amount":0.5,"price_discount":0,"quantity":1455,"tax_category_code":"E","tax_exemption_reason":"Local passenger transport","tax_exemption_reason_code":"DL8.46.4","tax_rate":0,"unit_of_measure_code":"LN"}],"note":"Tax invoice","payable_rounding_amount":0.75,"payment_terms_note":"1 month","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"tax_point_date":"2026-08-19","trader_invoice_number":"AE-001CS-TEST","transaction_types":["CONTINUOUS_SUPPLY"]}},"deemed_supply":{"description":"Supply of goods or services without consideration (e.g. business assets given away); DEEMED_SUPPLY transaction type","summary":"Deemed Supply","value":{"additional_documents":[{"id":"Sample-05"},{"id":"Sample-05"}],"allowance_charges":[{"amount":14,"base_amount":280,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":150,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":140,"price_discount":10,"quantity":2,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payments":[{"payment_means_code":"1"}],"trader_invoice_number":"AE-001DS-Test","transaction_types":["DEEMED_SUPPLY"]}},"disclosed_agent_billing_invoice":{"description":"Invoice issued by an agent on behalf of a principal under disclosed agent billing; principle_trn is required and must differ from the issuing branch's TRN","summary":"Disclosed Agent Billing Invoice","value":{"allowance_charges":[{"amount":49.97,"base_amount":999.375,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"15:08:00","items":[{"allowance_charges":[{"amount":24.375,"base_amount":975,"charge_indicator":true,"multiplier_rate":0.025,"reason":"Technical Modification","reason_code":"AAC"}],"gross_price":20,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"Inspect the goods","price_amount":19.5,"price_discount":0.5,"quantity":50,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"cash payment","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"principle_trn":"198765432109103","trader_invoice_number":"AE-01DAB-TEST","transaction_types":["AGENT_BILLING"]}},"document_level_allowance_ae":{"description":"Document-level allowance under the Reverse Charge (AE) VAT category; VAT rate must be exactly 0. Note: submitting this exact example currently fails real-time validation (PINT-AE rule aligned-ibrp-ae-08-ae) due to a defect in that officially published rule, outside our control pending an upstream fix.","summary":"Document-Level Allowance — Reverse Charge (AE)","value":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Discount","reason_code":"95","tax_category_code":"AE","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","item_nature_code":"DL8.48.3.1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-AE-01"}},"document_level_allowance_e":{"description":"Document-level allowance under the Exempt (E) VAT category; no VAT rate applies and an exemption reason is required on the line","summary":"Document-Level Allowance — Exempt (E)","value":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Special Rebate","reason_code":"100","tax_category_code":"E","tax_exemption_reason":"Certain financial services","tax_exemption_reason_code":"DL8.46.1","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"E","tax_exemption_reason_code":"DL8.46.1","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Exempt supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-E-01"}},"document_level_allowance_o":{"description":"Document-level allowance under the Out of Scope (O) VAT category; no VAT rate applies","summary":"Document-Level Allowance — Out of Scope (O)","value":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Discount","reason_code":"95","tax_category_code":"O","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"O","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Not subject to VAT invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-O-01"}},"document_level_allowance_z":{"description":"Document-level allowance under the Zero Rated (Z) VAT category; VAT rate must be exactly 0","summary":"Document-Level Allowance — Zero Rated (Z)","value":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Discount","reason_code":"95","tax_category_code":"Z","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Zero rated supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-Z-01"}},"document_level_charge_ae":{"description":"Document-level charge under the Reverse Charge (AE) VAT category; VAT rate must be exactly 0. Note: submitting this exact example currently fails real-time validation (PINT-AE rule aligned-ibrp-ae-08-ae) due to a defect in that officially published rule, outside our control pending an upstream fix.","summary":"Document-Level Charge — Reverse Charge (AE)","value":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"AE","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","item_nature_code":"DL8.48.3.1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-AE-01"}},"document_level_charge_e":{"description":"Document-level charge under the Exempt (E) VAT category; no VAT rate applies and an exemption reason is required on the line","summary":"Document-Level Charge — Exempt (E)","value":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Handling fee","reason_code":"AAT","tax_category_code":"E","tax_exemption_reason":"Certain financial services","tax_exemption_reason_code":"DL8.46.1","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"E","tax_exemption_reason_code":"DL8.46.1","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Exempt supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-E-01"}},"document_level_charge_o":{"description":"Document-level charge under the Out of Scope (O) VAT category; no VAT rate applies","summary":"Document-Level Charge — Out of Scope (O)","value":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Handling fee","reason_code":"AAT","tax_category_code":"O","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"O","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Not subject to VAT invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-O-01"}},"document_level_charge_z":{"description":"Document-level charge under the Zero Rated (Z) VAT category; VAT rate must be exactly 0","summary":"Document-Level Charge — Zero Rated (Z)","value":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"Z","tax_rate":0}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":100,"price_discount":0,"quantity":10,"tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Zero rated supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-Z-01"}},"ecommerce":{"description":"B2C sale via online platform; delivery address with subdivision required; Incoterms required","summary":"E-Commerce Supply","value":{"additional_documents":[{"id":"DR-INV-001"},{"id":"DR-INV-02"}],"allowance_charges":[{"amount":5,"base_amount":100,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Discount","reason_code":"95","tax_category_code":"S","tax_rate":0.05},{"amount":2.5,"base_amount":100,"charge_indicator":true,"multiplier_rate":0.025,"reason":"Technical Modification","reason_code":"AAC","tax_category_code":"S","tax_rate":0.05}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","delivery":{"actual_delivery_date":"2026-08-27","delivery_address":{"additional_street_name":"Additional Street Name","address_line":"Address line 3","city_name":"Abu Dhabi","country_code":"AE","country_subentity":"AUH","postal_zone":"Postal Zone","street_name":"Street Name"},"delivery_location_id":"112345679000003","delivery_location_scheme_id":"0066","delivery_party_name":"Delivery Party Name","delivery_terms_id":"DAP"},"document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"11:35:10","items":[{"allowance_charges":[{"amount":2.5,"base_amount":100,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Discount","reason_code":"95"},{"amount":5,"base_amount":100,"charge_indicator":true,"multiplier_rate":0.05,"reason":"Technical Modification","reason_code":"AAC"}],"gross_price":101,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"Please check the invoice","price_amount":100,"price_discount":1,"quantity":1,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payable_rounding_amount":0,"payment_terms_note":"Instant Payment","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"prepaid_amount":0,"trader_invoice_number":"AE-001-E-Commerce-TEST","transaction_types":["SUPPLY_THROUGH_ECOMMERCE"]}},"exports":{"description":"Goods exported outside the UAE, invoiced in a foreign currency; zero-rated under UAE VAT Article 45(1)(a); EXPORTS transaction type with Incoterms and an AED-equivalent total reference","summary":"Export Invoice","value":{"additional_documents":[{"document_description":"AED 913621.44","document_type_code":"aedtotal-incl-vat","id":"AED"}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","delivery":{"delivery_address":{"city_name":"Riyadh","country_code":"SA","country_subentity":"Riyadh Region","street_name":"King Fahd Road"},"delivery_terms_id":"CIF"},"document_currency_code":"USD","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"17:31:00","items":[{"gross_price":50,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":49.75,"price_discount":0.25,"quantity":5000,"tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Tax invoice","order_reference":{"purchase_order_id":"EXP-09","sales_order_id":"EC-24-25-1001"},"payment_terms_note":"within 1 month","payments":[{"payment_means_code":"1"}],"tax_currency_exchange_rate":3.67285,"tax_point_date":"2026-08-20","trader_invoice_number":"AE-001-Exports-TEST","transaction_types":["EXPORTS"]}},"free_trade_zone":{"description":"Supply of goods to a buyer in a UAE Free Trade Zone; beneficiary tax number required; standard-rated with a document- and line-level allowance","summary":"Free Trade Zone Supply","value":{"additional_documents":[{"id":"Sample-04"},{"id":"Sample-04"}],"allowance_charges":[{"amount":3535,"base_amount":70700,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"beneficiary_tax_number":"123456789098703","customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-24","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"allowance_charges":[{"amount":700,"base_amount":70000,"charge_indicator":true,"multiplier_rate":0.01,"reason":"Technical Modification","reason_code":"AAC"}],"gross_price":150,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"Invoice line note","price_amount":140,"price_discount":10,"quantity":500,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"1 month","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"trader_invoice_number":"AE-001FTZ-TEST","transaction_types":["FREE_TRADE_ZONE"]}},"margin_scheme":{"description":"Second-hand goods sold under profit margin scheme — VAT applies only to the margin; category N","summary":"Profit Margin Scheme Invoice","value":{"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":1000,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"Margin scheme goods","price_amount":1000,"price_discount":0,"quantity":1,"tax_category_code":"N","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"Instant Payment","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"trader_invoice_number":"AE-001-Marginscheme-TEST","transaction_types":["PROFIT_MARGIN_SCHEME"]}},"multiple_tax_categories":{"description":"Invoice spanning S (standard 5%), Z (zero-rated), E (exempt — financial services), and AE (reverse charge) categories across four line items","summary":"Multiple Tax Categories","value":{"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":1000,"quantity":5,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"EA"},{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS2","price_amount":800,"quantity":3,"tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"EA"},{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS3","price_amount":600,"quantity":2,"tax_category_code":"E","tax_exemption_reason":"Certain financial services","tax_exemption_reason_code":"DL8.46.1","tax_rate":0,"unit_of_measure_code":"EA"},{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS4","item_nature_code":"DL8.48.8.1","price_amount":1500,"quantity":4,"tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"EA"}],"payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"ACME Trading LLC","payment_means_code":"30"}],"trader_invoice_number":"ACME-INV-2026-0011"}},"reverse_charge":{"description":"Imported services — VAT liability transferred to buyer under UAE Article 48; buyer self-accounts at 5%; item nature code required for reverse charge","summary":"Reverse Charge","value":{"additional_documents":[{"id":"DC"},{"id":"Delivery Challans"}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-10","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","item_nature_code":"DL8.48.3.1","price_amount":99,"price_discount":1,"quantity":30,"tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"K6"}],"note":"Tax invoice","payment_terms_note":"Within 15 days","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"trader_invoice_number":"AE-01RCTEST"}},"standard_invoice_minimal":{"description":"Minimal valid tax invoice containing only mandatory fields; useful as a starting point for integration","summary":"Standard Invoice — Mandatory Fields Only","value":{"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-03","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":10,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":10,"price_discount":0,"quantity":100,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"trader_invoice_number":"AE001-Test"}},"standard_tax_invoice":{"description":"Full-featured B2B VAT invoice with order reference, originator reference, a billing reference to a prior invoice, document- and line-level allowances/charges, and payment terms","summary":"Standard Tax Invoice","value":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"},{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"billing_reference":[{"id":"INV-234-2025","issue_date":"2026-08-27"}],"buyer_reference":"PO-AE-220","customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","due_date":"2026-09-03","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-21"},"invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"07:54:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Purchase goods","gross_price":5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Sales Goods","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Within a week","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"project_reference":"Regular work","tax_point_date":"2026-08-20","trader_invoice_number":"AE-01TEST"}},"summary_tax_invoice":{"description":"Monthly summary invoice for recurring supplies to the same customer in the same calendar month, spanning standard-rated and reverse-charge line items","summary":"Summary Tax Invoice","value":{"additional_documents":[{"id":"DC"},{"id":"Delivery Challans"}],"allowance_charges":[{"amount":80.16,"base_amount":10687.5,"charge_indicator":false,"multiplier_rate":0.0075,"reason":"Special rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-10","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"380","issue_date":"2026-08-27","items":[{"gross_price":15,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":14.25,"price_discount":0.75,"quantity":100,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"},{"gross_price":25,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS2","price_amount":23.75,"price_discount":1.25,"quantity":150,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"},{"gross_price":30,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS3","price_amount":28.5,"price_discount":1.5,"quantity":200,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"},{"gross_price":100,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS4","item_nature_code":"DL8.48.3.1","price_amount":99,"price_discount":1,"quantity":30,"tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"K6"}],"note":"Tax invoice","payable_rounding_amount":0.29,"payment_terms_note":"Within 15 days","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"trader_invoice_number":"AE-010TEST","transaction_types":["SUMMARY_INVOICE"]}},"zero_rated":{"description":"International transport service zero-rated under UAE VAT Article 45","summary":"Zero-Rated Supply","value":{"customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"17:31:00","items":[{"gross_price":50,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":49.75,"price_discount":0.25,"quantity":5000,"tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Tax invoice","order_reference":{"purchase_order_id":"EXP-09","sales_order_id":"EC-24-25-1001"},"payment_terms_note":"within 15 days","payments":[{"payment_means_code":"1"}],"tax_point_date":"2026-08-20","trader_invoice_number":"AE-001-ZeroRated-TEST"}}}}}},"responses":{"201":{"description":"Invoice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/invoices/{invoice_id}":{"get":{"tags":["Invoices"],"summary":"Get a UAE Invoice","description":"Retrieves information about an invoice given its ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"invoice_id","required":true,"schema":{"type":"string","description":"Invoice ID on DigiTax","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/credit-notes":{"get":{"tags":["Credit Notes"],"summary":"Get UAE Credit Notes","description":"Returns a paginated list of all credit notes created by the business","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"A list of credit notes","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Credit Notes"],"summary":"Create a UAE Credit Note","description":"Creates a new PINT-AE compliant credit note","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trader_invoice_number","credit_note_reason_code","credit_note_reason","issue_date","document_currency_code","customer_party_id","invoice_type_code","items"],"properties":{"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the supplier to uniquely identify the invoice in their system","example":"ACME-CN-2024-0003"},"credit_note_reason_code":{"type":"string","description":"The coded reason for the credit note. See `GET /resources/credit-reasons` for available values.","example":"DL8.61.1.A"},"credit_note_reason":{"type":"string","description":"The textual reason for the credit note","example":"Supply was cancelled"},"original_invoice_id":{"type":"string","description":"The DigiTax ID of the original invoice this credit note relates to","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code. If the credit note references an original invoice, the value should correspond to the original invoice type code (e.g. \"381\" for a standard credit note referencing a \"380\" invoice). See `GET /resources/invoice-types` for available values.","example":"381"},"issue_date":{"type":"string","format":"date","description":"The date on which the credit note was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.","example":"2026-07-14"},"issue_time":{"type":"string","description":"The credit note issue time (HH:MM:SS)","example":"09:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"document_currency_code":{"type":"string","description":"The currency code (ISO 4217). See `GET /resources/currencies` for available values.","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document and tax currencies. Required and must be > 0 when `document_currency_code` is not `AED`. When `document_currency_code` is `AED`, must be `1` or omitted. Maximum 6 decimal places.","example":1},"customer_party_id":{"type":"string","description":"The DigiTax party ID of the buyer","example":"party_01HC3J1VVVM05YCTS61G7V3KC6"},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"buyer_reference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes","example":"BR-2024-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CAPEX-2024-Q4"},"note":{"type":"string","description":"A free-text note on the credit note","example":"Credit for cancelled order"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"Additional supporting document references","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual payment terms","example":"Next 30 days"},"allowance_charges":{"type":"array","description":"Invoice-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment means for this credit note","items":{"$ref":"#/components/schemas/CreateInvoicePaymentRequest"}},"items":{"type":"array","description":"The credit note line items","items":{"$ref":"#/components/schemas/CreateInvoiceItemRequest"}},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount","example":0},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["EXPORTS","CONTINUOUS_SUPPLY"]},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary for Free Trade Zone supplies. Required when `transaction_types` includes `FREE_TRADE_ZONE`.","example":"123456789098703"},"principle_trn":{"type":"string","description":"The TRN of the principal for Disclosed Agent billing. Required when `transaction_types` includes `AGENT_BILLING`. Must differ from the business's own TRN.","example":"123456789098703"}}},"examples":{"disclosed_agent_billing":{"description":"Credit note issued by an agent on behalf of a principal under disclosed agent billing; principle_trn is required and must differ from the issuing branch's TRN","summary":"Disclosed Agent Billing Credit Note","value":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"buyer_reference":"PO-AE-220","credit_note_reason":"Tax treatment was applied in error — disclosed agent billing arrangement","credit_note_reason_code":"DL8.61.1.E","customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"381","issue_date":"2026-08-27","issue_time":"15:55:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Buyer Item Identification","gross_price":5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Seller Item Identification","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax Credit invoice","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"original_invoice_id":"invoice_01KMFSMEYVCDV0150T6P4WECVR","originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Will be adjusted against next invoice","principle_trn":"198765432109103","trader_invoice_number":"AE001-CN-TEST","transaction_types":["AGENT_BILLING"]}},"standard_credit_note_minimal":{"description":"Minimal valid credit note containing only mandatory fields; useful as a starting point for integration","summary":"Standard Credit Note — Mandatory Fields Only","value":{"credit_note_reason":"Supply was cancelled","credit_note_reason_code":"DL8.61.1.A","customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"381","issue_date":"2026-08-27","items":[{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":500,"quantity":1,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"EA"}],"original_invoice_id":"invoice_01KMFSMEYVCDV0150T6P4WECVR","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"ACME Trading LLC","payment_means_code":"30"}],"trader_invoice_number":"ACME-CN-2026-0003"}},"standard_tax_credit_note":{"description":"Full-featured credit note reversing a standard-rated B2B supply; includes billing reference, order reference, and document- and line-level allowances/charges","summary":"Standard Tax Credit Note","value":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"buyer_reference":"PO-AE-220","credit_note_reason":"Tax was charged in error on the original invoice","credit_note_reason_code":"DL8.61.1.E","customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"381","issue_date":"2026-08-27","issue_time":"15:55:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Buyer Item Identification","gross_price":5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Seller Item Identification","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax Credit invoice","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"original_invoice_id":"invoice_01KMFSMEYVCDV0150T6P4WECVR","originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Will be adjusted against next invoice","trader_invoice_number":"AE001-CN-TEST"}},"volume_discount_credit_note":{"description":"Credit note for a volume discount (reason code VD); no preceding invoice reference required per ibr-055-ae","summary":"Volume Discount Credit Note","value":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"buyer_reference":"PO-AE-220","credit_note_reason":"Volume discount","credit_note_reason_code":"VD","customer_party_id":"party_01HFXK2VV2M05YCTS61G7V3KC6","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"381","issue_date":"2026-08-27","issue_time":"15:55:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Buyer Item Identification","gross_price":5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Seller Item Identification","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Volume discount credit note — VD reason, no BillingReference required per ibr-055-ae","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Will be adjusted against next invoice","trader_invoice_number":"AE001-CN-VD"}}}}}},"responses":{"201":{"description":"Created credit note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/credit-notes/{credit_note_id}":{"get":{"tags":["Credit Notes"],"summary":"Get a UAE Credit Note","description":"Retrieves information about a credit note given its ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"credit_note_id","required":true,"schema":{"type":"string","description":"Credit note ID on DigiTax","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/suppliers":{"get":{"tags":["Suppliers"],"summary":"Get UAE Suppliers","description":"Returns a paginated list of suppliers registered under the authenticated business.","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"A list of suppliers","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Suppliers"],"summary":"Create a UAE Supplier","description":"Creates a new supplier for use in UAE self-billed e-invoices.","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Taxpayer"},{"type":"object","required":["tax_registration_number"],"properties":{"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN). Self-billing requires the supplier to be VAT-registered, so this is always required.","example":"100987654300003"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}]}}}},"responses":{"201":{"description":"Created supplier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/suppliers/{supplier_id}":{"get":{"tags":["Suppliers"],"summary":"Get a UAE Supplier","description":"Retrieves information about a supplier given their ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"supplier_id","required":true,"schema":{"type":"string","description":"Supplier ID on DigiTax","example":"supplier_01HC3J1VVVM05YCTS61G7V3KC6"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/self-billed-invoices":{"get":{"tags":["Self-Billed Invoices"],"summary":"Get UAE Self-Billed Invoices","description":"Returns a paginated list of all self-billed invoices created by the business","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"A list of self-billed invoices","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Self-Billed Invoices"],"summary":"Create a UAE Self-Billed Invoice","description":"Creates a new PINT-AE compliant self-billed e-invoice and submits it to the Peppol network.","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trader_invoice_number","invoice_type_code","issue_date","document_currency_code","supplier_id","items","payments"],"properties":{"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the buyer to uniquely identify the self-billed invoice in their system","example":"ACME-SBI-2024-0042"},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["CONTINUOUS_SUPPLY"]},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code. See `GET /resources/invoice-types` for available values.","example":"389"},"issue_date":{"type":"string","format":"date","description":"The date on which the self-billed invoice was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.","example":"2026-07-14"},"issue_time":{"type":"string","description":"The invoice issue time (HH:MM:SS)","example":"10:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"document_currency_code":{"type":"string","description":"A code that specifies the currency in which the invoice is issued. See `GET /resources/currencies` for available values.","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document and tax currencies. Required and must be > 0 when `document_currency_code` is not `AED`. When `document_currency_code` is `AED`, must be `1` or omitted. Maximum 6 decimal places.","example":1},"supplier_id":{"type":"string","description":"The DigiTax supplier ID of the supplier from whom the buyer is self-billing","example":"supplier_01HC3J1VVVM05YCTS61G7V3KC6"},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"tax_point_date":{"type":"string","format":"date","description":"The VAT point date (YYYY-MM-DD). Must be strictly before the issue_date.","example":"2026-07-13"},"buyer_reference":{"type":"string","description":"An identifier assigned by the buyer used for internal routing purposes","example":"BR-2026-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the buyer's financial accounts","example":"CAPEX-2024-Q4"},"project_reference":{"type":"string","description":"A project reference","example":"PROJ-JEBEL-2024"},"note":{"type":"string","description":"A free-text note on the self-billed invoice","example":"Self-billed invoice details"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"billing_reference":{"type":"array","description":"References to preceding invoices","items":{"$ref":"#/components/schemas/DocumentReference"}},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"Additional supporting document references","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual payment terms","example":"Next 30 days"},"allowance_charges":{"type":"array","description":"Invoice-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment details for this self-billed invoice","items":{"$ref":"#/components/schemas/CreateInvoicePaymentRequest"}},"items":{"type":"array","description":"The self-billed invoice line items","items":{"$ref":"#/components/schemas/CreateInvoiceItemRequest"}},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid, to be deducted from the payable amount","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount","example":0},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary for Free Trade Zone supplies. Required when `transaction_types` includes `FREE_TRADE_ZONE`.","example":"123456789098703"},"principle_trn":{"type":"string","description":"The TRN of the principal for Disclosed Agent billing. Required when `transaction_types` includes `AGENT_BILLING`. Must differ from the business's own TRN.","example":"123456789098703"}}},"examples":{"standard_self_billed_invoice":{"description":"Full-featured self-billed invoice (type 389) issued by the buyer; includes order reference, originator reference, a billing reference to a prior invoice, and document- and line-level allowances/charges","summary":"Standard Self-Billed Invoice","value":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"},{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"billing_reference":[{"id":"INV-234-2025","issue_date":"2026-08-27"}],"buyer_reference":"PO-AE-220","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","due_date":"2026-09-03","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-21"},"invoice_type_code":"389","issue_date":"2026-08-27","issue_time":"07:54:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Purchase goods","gross_price":5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Sales Goods","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Self Billing Tax invoice","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Within a week","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"project_reference":"Regular work","supplier_id":"supplier_01HC3J1VVVM05YCTS61G7V3KC6","tax_point_date":"2026-08-20","trader_invoice_number":"AE-01-SB-TEST"}},"standard_self_billed_invoice_minimal":{"description":"Minimal valid self-billed invoice containing only the required fields; useful as a starting point for integration","summary":"Standard Self-Billed Invoice — Mandatory Fields Only","value":{"document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"389","issue_date":"2026-08-27","items":[{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":500,"quantity":1,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"EA"}],"payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"ACME Trading LLC","payment_means_code":"30"}],"supplier_id":"supplier_01HC3J1VVVM05YCTS61G7V3KC6","trader_invoice_number":"ACME-SBI-2026-0002"}}}}}},"responses":{"201":{"description":"Self-billed invoice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/self-billed-invoices/{invoice_id}":{"get":{"tags":["Self-Billed Invoices"],"summary":"Get a UAE Self-Billed Invoice","description":"Retrieves information about a self-billed invoice given its ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"invoice_id","required":true,"schema":{"type":"string","description":"Self-billed invoice ID on DigiTax","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/self-billed-credit-notes":{"get":{"tags":["Self-Billed Credit Notes"],"summary":"Get UAE Self-Billed Credit Notes","description":"Returns a paginated list of all self-billed credit notes created by the business","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"}],"responses":{"200":{"description":"A list of self-billed credit notes","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}},"post":{"tags":["Self-Billed Credit Notes"],"summary":"Create a UAE Self-Billed Credit Note","description":"Creates a new PINT-AE compliant self-billed credit note","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trader_invoice_number","credit_note_reason_code","credit_note_reason","issue_date","document_currency_code","supplier_id","invoice_type_code","items"],"properties":{"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the buyer to uniquely identify the self-billed credit note in their system","example":"ACME-SBCN-2024-0003"},"credit_note_reason_code":{"type":"string","description":"The coded reason for the self-billed credit note. See `GET /resources/credit-reasons` for available values.","example":"DL8.61.1.A"},"credit_note_reason":{"type":"string","description":"The textual reason for the self-billed credit note","example":"Supply was cancelled"},"original_invoice_id":{"type":"string","description":"The DigiTax ID of the original self-billed invoice this credit note relates to","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code. If the credit note references an original invoice, the value should correspond to the original invoice type code (e.g. \"261\" for a self billed credit note referencing a \"389\" self billed invoice). See `GET /resources/invoice-types` for available values.","example":"261"},"issue_date":{"type":"string","format":"date","description":"The date on which the self-billed credit note was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.","example":"2026-07-14"},"issue_time":{"type":"string","description":"The credit note issue time (HH:MM:SS)","example":"09:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"document_currency_code":{"type":"string","description":"The currency code (ISO 4217). See `GET /resources/currencies` for available values.","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document and tax currencies. Required and must be > 0 when `document_currency_code` is not `AED`. When `document_currency_code` is `AED`, must be `1` or omitted. Maximum 6 decimal places.","example":1},"supplier_id":{"type":"string","description":"The DigiTax supplier ID of the supplier from whom the buyer is self-billing","example":"supplier_01HC3J1VVVM05YCTS61G7V3KC6"},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"buyer_reference":{"type":"string","description":"An identifier assigned by the buyer used for internal routing purposes","example":"BR-2024-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the buyer's financial accounts","example":"CAPEX-2024-Q4"},"note":{"type":"string","description":"A free-text note on the self-billed credit note","example":"Credit for cancelled self-billed order"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"Additional supporting document references","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual payment terms","example":"Next 30 days"},"allowance_charges":{"type":"array","description":"Invoice-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment means for this self-billed credit note","items":{"$ref":"#/components/schemas/CreateInvoicePaymentRequest"}},"items":{"type":"array","description":"The self-billed credit note line items","items":{"$ref":"#/components/schemas/CreateInvoiceItemRequest"}},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount","example":0},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["CONTINUOUS_SUPPLY"]},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary for Free Trade Zone supplies. Required when `transaction_types` includes `FREE_TRADE_ZONE`.","example":"123456789098703"},"principle_trn":{"type":"string","description":"The TRN of the principal for Disclosed Agent billing. Required when `transaction_types` includes `AGENT_BILLING`. Must differ from the business's own TRN.","example":"123456789098703"}}},"examples":{"standard_self_billed_credit_note":{"description":"Full-featured self-billed credit note (type 261) reversing a prior self-billed invoice; includes billing reference, order reference, and document- and line-level allowances/charges","summary":"Standard Self-Billed Credit Note","value":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"buyer_reference":"PO-AE-220","credit_note_reason":"Tax was charged in error on the original self-billed invoice","credit_note_reason_code":"DL8.61.1.E","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"261","issue_date":"2026-08-27","issue_time":"15:55:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Buyer Item Identification","gross_price":5,"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Seller Item Identification","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Self Billing Tax Credit invoice","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"original_invoice_id":"invoice_01KMFSMEYVCDV0150T6P4WECVR","originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Will be adjusted against next invoice","supplier_id":"supplier_01HC3J1VVVM05YCTS61G7V3KC6","trader_invoice_number":"AE001-CN-SB-TEST"}},"standard_self_billed_credit_note_minimal":{"description":"Minimal valid self-billed credit note containing only the required fields; useful as a starting point for integration","summary":"Standard Self-Billed Credit Note — Mandatory Fields Only","value":{"credit_note_reason":"Supply was cancelled","credit_note_reason_code":"DL8.61.1.A","document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"261","issue_date":"2026-08-27","items":[{"item_id":"item_01HFXK2VV2M05YCTS61G7SVCS1","price_amount":500,"quantity":1,"tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"EA"}],"original_invoice_id":"invoice_01KMFSMEYVCDV0150T6P4WECVR","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"ACME Trading LLC","payment_means_code":"30"}],"supplier_id":"supplier_01HC3J1VVVM05YCTS61G7V3KC6","trader_invoice_number":"ACME-SBCN-2026-0002"}}}}}},"responses":{"201":{"description":"Created self-billed credit note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/self-billed-credit-notes/{credit_note_id}":{"get":{"tags":["Self-Billed Credit Notes"],"summary":"Get a Self-Billed Credit Note","description":"Retrieves information about a self-billed credit note given its ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"credit_note_id","required":true,"schema":{"type":"string","description":"Self-billed credit note ID on DigiTax","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/detailed-invoices":{"post":{"tags":["Invoices"],"summary":"Create a UAE Invoice with the buyer and items inline","description":"Creates a PINT-AE compliant e-invoice in one request, without creating the buyer or the items first, and submits it to the Peppol network. The buyer is matched on `tax_identification_number` and each line's item on `item_code`, both within the authenticated branch — whatever already exists is reused unchanged, whatever is missing is created. Every rule that `POST /invoices` applies also applies here. Note that the parties and items are created before the invoice is validated, so a rejected invoice can leave them behind.\n\nOmit `peppol_id` for a buyer who isn't on Peppol — the right predefined endpoint is substituted at submission and the document is reported to the FTA instead of delivered.\n","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_party","invoice"],"properties":{"customer_party":{"$ref":"#/components/schemas/PartyTaxpayer"},"invoice":{"$ref":"#/components/schemas/DetailedInvoiceDocument"}}},"examples":{"detailed_commercial_invoice":{"description":"Invoice for a supply outside the scope of UAE VAT (type 480); no VAT collected","summary":"Commercial Invoice (Out of Scope)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"480","issue_date":"2026-08-27","issue_time":"17:38:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":151,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":150,"price_discount":1,"quantity":1000,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"O","tax_rate":0,"unit_of_measure_code":"H87"}],"payment_terms_note":"Cash payment","payments":[{"payment_means_code":"10"}],"trader_invoice_number":"AE-CI-001Test-D"}}},"detailed_continuous_supply":{"description":"Recurring supply of goods and services billed on a continuous basis, spanning a standard-rated and an exempt line item","summary":"Continuous Supply","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"additional_documents":[{"id":"Cabbills"},{"id":"All signed cab bills"}],"allowance_charges":[{"amount":75,"base_amount":5000,"charge_indicator":true,"multiplier_rate":0.015,"reason":"Polyethylene wrap packing","reason_code":"ABU","tax_category_code":"S","tax_rate":0.05}],"contract_document_reference":{"document_description":"AED 1000000","id":"ZXC-CS-03"},"document_currency_code":"AED","due_date":"2026-09-24","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":500,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":500,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"TIP"},{"commodity_code":"G","description":"Stainless steel gate valve for high-pressure pipelines","gross_price":0.5,"hs_code":"84818099","item_code":"VALVE-V200-SS","name":"Stainless Steel Gate Valve V-200","price_amount":0.5,"price_discount":0,"quantity":1455,"standard_item_id":"09501101530010","standard_item_scheme":"0160","tax_category_code":"E","tax_exemption_reason":"Local passenger transport","tax_exemption_reason_code":"DL8.46.4","tax_rate":0,"unit_of_measure_code":"LN"}],"note":"Tax invoice","payable_rounding_amount":0.75,"payment_terms_note":"1 month","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"tax_point_date":"2026-08-19","trader_invoice_number":"AE-001CS-TEST-D","transaction_types":["CONTINUOUS_SUPPLY"]}}},"detailed_deemed_supply":{"description":"Supply of goods or services without consideration (e.g. business assets given away); DEEMED_SUPPLY transaction type","summary":"Deemed Supply","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"additional_documents":[{"id":"Sample-05"},{"id":"Sample-05"}],"allowance_charges":[{"amount":14,"base_amount":280,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"document_currency_code":"AED","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":150,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":140,"price_discount":10,"quantity":2,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payments":[{"payment_means_code":"1"}],"trader_invoice_number":"AE-001DS-Test-D","transaction_types":["DEEMED_SUPPLY"]}}},"detailed_disclosed_agent_billing_invoice":{"description":"Invoice issued by an agent on behalf of a principal under disclosed agent billing; principle_trn is required and must differ from the issuing branch's TRN","summary":"Disclosed Agent Billing Invoice","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":49.97,"base_amount":999.375,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"15:08:00","items":[{"allowance_charges":[{"amount":24.375,"base_amount":975,"charge_indicator":true,"multiplier_rate":0.025,"reason":"Technical Modification","reason_code":"AAC"}],"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":20,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","note":"Inspect the goods","price_amount":19.5,"price_discount":0.5,"quantity":50,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"cash payment","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"principle_trn":"198765432109103","trader_invoice_number":"AE-01DAB-TEST-D","transaction_types":["AGENT_BILLING"]}}},"detailed_document_level_allowance_ae":{"description":"Document-level allowance under the Reverse Charge (AE) VAT category; VAT rate must be exactly 0. Note: submitting this exact example currently fails real-time validation (PINT-AE rule aligned-ibrp-ae-08-ae) due to a defect in that officially published rule, outside our control pending an upstream fix.","summary":"Document-Level Allowance — Reverse Charge (AE)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Discount","reason_code":"95","tax_category_code":"AE","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","item_nature_code":"DL8.48.3.1","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-AE-01-D"}}},"detailed_document_level_allowance_e":{"description":"Document-level allowance under the Exempt (E) VAT category; no VAT rate applies and an exemption reason is required on the line","summary":"Document-Level Allowance — Exempt (E)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Special Rebate","reason_code":"100","tax_category_code":"E","tax_exemption_reason":"Certain financial services","tax_exemption_reason_code":"DL8.46.1","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"E","tax_exemption_reason_code":"DL8.46.1","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Exempt supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-E-01-D"}}},"detailed_document_level_allowance_o":{"description":"Document-level allowance under the Out of Scope (O) VAT category; no VAT rate applies","summary":"Document-Level Allowance — Out of Scope (O)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Discount","reason_code":"95","tax_category_code":"O","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"O","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Not subject to VAT invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-O-01-D"}}},"detailed_document_level_allowance_z":{"description":"Document-level allowance under the Zero Rated (Z) VAT category; VAT rate must be exactly 0","summary":"Document-Level Allowance — Zero Rated (Z)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":100,"charge_indicator":false,"reason":"Discount","reason_code":"95","tax_category_code":"Z","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Zero rated supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-ALLOW-Z-01-D"}}},"detailed_document_level_charge_ae":{"description":"Document-level charge under the Reverse Charge (AE) VAT category; VAT rate must be exactly 0. Note: submitting this exact example currently fails real-time validation (PINT-AE rule aligned-ibrp-ae-08-ae) due to a defect in that officially published rule, outside our control pending an upstream fix.","summary":"Document-Level Charge — Reverse Charge (AE)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"AE","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","item_nature_code":"DL8.48.3.1","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-AE-01-D"}}},"detailed_document_level_charge_e":{"description":"Document-level charge under the Exempt (E) VAT category; no VAT rate applies and an exemption reason is required on the line","summary":"Document-Level Charge — Exempt (E)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Handling fee","reason_code":"AAT","tax_category_code":"E","tax_exemption_reason":"Certain financial services","tax_exemption_reason_code":"DL8.46.1","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"E","tax_exemption_reason_code":"DL8.46.1","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Exempt supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-E-01-D"}}},"detailed_document_level_charge_o":{"description":"Document-level charge under the Out of Scope (O) VAT category; no VAT rate applies","summary":"Document-Level Charge — Out of Scope (O)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Handling fee","reason_code":"AAT","tax_category_code":"O","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"480","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"O","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Not subject to VAT invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-O-01-D"}}},"detailed_document_level_charge_z":{"description":"Document-level charge under the Zero Rated (Z) VAT category; VAT rate must be exactly 0","summary":"Document-Level Charge — Zero Rated (Z)","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"allowance_charges":[{"amount":200,"charge_indicator":true,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"Z","tax_rate":0}],"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":100,"price_discount":0,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Zero rated supply invoice","payment_terms_note":"Net 15 days","payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"current account","payee_financial_institution_bic":"ABORAEADXXX","payment_means_code":"30"}],"tax_point_date":"2026-08-22","trader_invoice_number":"AE-CHARGE-Z-01-D"}}},"detailed_ecommerce":{"description":"B2C sale via online platform; delivery address with subdivision required; Incoterms required","summary":"E-Commerce Supply","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"additional_documents":[{"id":"DR-INV-001"},{"id":"DR-INV-02"}],"allowance_charges":[{"amount":5,"base_amount":100,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Discount","reason_code":"95","tax_category_code":"S","tax_rate":0.05},{"amount":2.5,"base_amount":100,"charge_indicator":true,"multiplier_rate":0.025,"reason":"Technical Modification","reason_code":"AAC","tax_category_code":"S","tax_rate":0.05}],"delivery":{"actual_delivery_date":"2026-08-27","delivery_address":{"additional_street_name":"Additional Street Name","address_line":"Address line 3","city_name":"Abu Dhabi","country_code":"AE","country_subentity":"AUH","postal_zone":"Postal Zone","street_name":"Street Name"},"delivery_location_id":"112345679000003","delivery_location_scheme_id":"0066","delivery_party_name":"Delivery Party Name","delivery_terms_id":"DAP"},"document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"11:35:10","items":[{"allowance_charges":[{"amount":2.5,"base_amount":100,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Discount","reason_code":"95"},{"amount":5,"base_amount":100,"charge_indicator":true,"multiplier_rate":0.05,"reason":"Technical Modification","reason_code":"AAC"}],"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":101,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","note":"Please check the invoice","price_amount":100,"price_discount":1,"quantity":1,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payable_rounding_amount":0,"payment_terms_note":"Instant Payment","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"prepaid_amount":0,"trader_invoice_number":"AE-001-E-Commerce-TEST-D","transaction_types":["SUPPLY_THROUGH_ECOMMERCE"]}}},"detailed_free_trade_zone":{"description":"Supply of goods to a buyer in a UAE Free Trade Zone; beneficiary tax number required; standard-rated with a document- and line-level allowance","summary":"Free Trade Zone Supply","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"additional_documents":[{"id":"Sample-04"},{"id":"Sample-04"}],"allowance_charges":[{"amount":3535,"base_amount":70700,"charge_indicator":false,"multiplier_rate":0.05,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"beneficiary_tax_number":"123456789098703","document_currency_code":"AED","due_date":"2026-09-24","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"allowance_charges":[{"amount":700,"base_amount":70000,"charge_indicator":true,"multiplier_rate":0.01,"reason":"Technical Modification","reason_code":"AAC"}],"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":150,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","note":"Invoice line note","price_amount":140,"price_discount":10,"quantity":500,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"1 month","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"trader_invoice_number":"AE-001FTZ-TEST-D","transaction_types":["FREE_TRADE_ZONE"]}}},"detailed_invoice":{"description":"A standard-rated invoice that creates the buyer and the invoiced item in the same request","summary":"Detailed Invoice","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"10:00:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":500,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"C62"}],"payment_terms_note":"Next 30 days","payments":[{"payment_means_code":"10"}],"trader_invoice_number":"AE-DINV-001"}}},"detailed_invoice_export_foreign_buyer":{"description":"Zero-rated export to a buyer outside the UAE who has their own Peppol address. `peppol_id_scheme` is the EAS code for `peppol_id` — here `0151`, the Australian Business Number. The document is delivered to that address normally.","summary":"Export to a Foreign Buyer on Peppol","value":{"customer_party":{"address":{"city_name":"Sydney","country_code":"AU","country_subentity":"NSW","street_name":"George Street"},"legal_entity":{"registration_name":"Sydney Trading Pty Ltd"},"peppol_id":"51824753556","peppol_id_scheme":"0151","tax_identification_number":"51824753556"},"invoice":{"additional_documents":[{"document_description":"AED 913621.44","document_type_code":"aedtotal-incl-vat","id":"AED"}],"delivery":{"delivery_address":{"city_name":"Sydney","country_code":"AU","country_subentity":"NSW","street_name":"George Street"},"delivery_terms_id":"CIF"},"document_currency_code":"USD","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"17:31:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":50,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":49.75,"price_discount":0.25,"quantity":5000,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"within 1 month","payments":[{"payment_means_code":"1"}],"tax_currency_exchange_rate":3.67285,"trader_invoice_number":"AE-EXP-PEPPOL-01","transaction_types":["EXPORTS"]}}},"detailed_invoice_export_no_peppol_id":{"description":"Zero-rated export to a buyer outside the UAE who has no Peppol address. Omit `peppol_id` and `peppol_id_scheme` — the predefined endpoint `9900000099` is substituted at submission and the document is reported to the FTA without being delivered over Peppol.","summary":"Export to a Foreign Buyer not on Peppol","value":{"customer_party":{"address":{"city_name":"Sydney","country_code":"AU","country_subentity":"NSW","street_name":"George Street"},"legal_entity":{"registration_name":"Sydney Trading Pty Ltd"},"tax_identification_number":"51824753556"},"invoice":{"additional_documents":[{"document_description":"AED 913621.44","document_type_code":"aedtotal-incl-vat","id":"AED"}],"delivery":{"delivery_address":{"city_name":"Sydney","country_code":"AU","country_subentity":"NSW","street_name":"George Street"},"delivery_terms_id":"CIF"},"document_currency_code":"USD","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"17:31:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":50,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":49.75,"price_discount":0.25,"quantity":5000,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"within 1 month","payments":[{"payment_means_code":"1"}],"tax_currency_exchange_rate":3.67285,"trader_invoice_number":"AE-EXP-NOPEPPOL-01","transaction_types":["EXPORTS"]}}},"detailed_invoice_passport_buyer":{"description":"A buyer legally identified by passport rather than a trade licence. `issuing_authority_code` is `PAS` and `issuing_authority_name` carries the passport's issuing country as an ISO 3166-1 alpha-2 code, not an authority name.","summary":"Passport-Identified Buyer","value":{"customer_party":{"address":{"city_name":"Abu Dhabi","country_code":"AE","country_subentity":"AUH","street_name":"Khalifa Street"},"legal_entity":{"issuing_authority_code":"PAS","issuing_authority_name":"IN","registration_name":"Rahul Menon Trading","registration_number":"P1234567890","registration_scheme":"0235"},"tax_identification_number":"1023456789","tax_registration_number":"102345678900003"},"invoice":{"document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"10:00:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":500,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"C62"}],"payment_terms_note":"Next 30 days","payments":[{"payment_means_code":"10"}],"trader_invoice_number":"AE-DINV-PAS-001"}}},"detailed_margin_scheme":{"description":"Second-hand goods sold under profit margin scheme — VAT applies only to the margin; category N","summary":"Profit Margin Scheme Invoice","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"document_currency_code":"AED","due_date":"2026-08-27","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":1000,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","note":"Margin scheme goods","price_amount":1000,"price_discount":0,"quantity":1,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"N","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","payment_terms_note":"Instant Payment","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"trader_invoice_number":"AE-001-Marginscheme-TEST-D","transaction_types":["PROFIT_MARGIN_SCHEME"]}}},"detailed_multiple_tax_categories":{"description":"Invoice spanning S (standard 5%), Z (zero-rated), E (exempt — financial services), and AE (reverse charge) categories across four line items","summary":"Multiple Tax Categories","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":1000,"quantity":5,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"EA"},{"commodity_code":"G","description":"Stainless steel gate valve for high-pressure pipelines","hs_code":"84818099","item_code":"VALVE-V200-SS","name":"Stainless Steel Gate Valve V-200","price_amount":800,"quantity":3,"standard_item_id":"09501101530010","standard_item_scheme":"0160","tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"EA"},{"commodity_code":"G","description":"Replacement mechanical seal kit for centrifugal pumps","hs_code":"84842000","item_code":"SEAL-KIT-9F","name":"Mechanical Seal Kit 9F","price_amount":600,"quantity":2,"standard_item_id":"09501101530027","standard_item_scheme":"0160","tax_category_code":"E","tax_exemption_reason":"Certain financial services","tax_exemption_reason_code":"DL8.46.1","tax_rate":0,"unit_of_measure_code":"EA"},{"commodity_code":"G","description":"Forged carbon steel weld-neck flange, nominal diameter 100mm","hs_code":"73072100","item_code":"FLANGE-DN100","item_nature_code":"DL8.48.8.1","name":"Forged Steel Flange DN100","price_amount":1500,"quantity":4,"standard_item_id":"09501101530034","standard_item_scheme":"0160","tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"EA"}],"payments":[{"payee_account_id":"AE070331234567890123456","payee_account_name":"ACME Trading LLC","payment_means_code":"30"}],"trader_invoice_number":"ACME-INV-2026-0011-D"}}},"detailed_reverse_charge":{"description":"Imported services — VAT liability transferred to buyer under UAE Article 48; buyer self-accounts at 5%; item nature code required for reverse charge","summary":"Reverse Charge","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"additional_documents":[{"id":"DC"},{"id":"Delivery Challans"}],"document_currency_code":"AED","due_date":"2026-09-10","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":100,"hs_code":"84137000","item_code":"PUMP-X500-BLK","item_nature_code":"DL8.48.3.1","name":"Industrial Pump Model X-500","price_amount":99,"price_discount":1,"quantity":30,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"K6"}],"note":"Tax invoice","payment_terms_note":"Within 15 days","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"trader_invoice_number":"AE-01RCTEST-D"}}},"detailed_standard_invoice_minimal":{"description":"Minimal valid tax invoice containing only mandatory fields; useful as a starting point for integration","summary":"Standard Invoice — Mandatory Fields Only","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"document_currency_code":"AED","due_date":"2026-09-03","invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":10,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":10,"price_discount":0,"quantity":100,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"trader_invoice_number":"AE001-Test-D"}}},"detailed_standard_tax_invoice":{"description":"Full-featured B2B VAT invoice with order reference, originator reference, a billing reference to a prior invoice, document- and line-level allowances/charges, and payment terms","summary":"Standard Tax Invoice","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"accounting_cost":"Regular sales","additional_documents":[{"id":"PO-AE-220"},{"id":"PO-AE-220"}],"allowance_charges":[{"amount":262.15,"base_amount":10486,"charge_indicator":false,"multiplier_rate":0.025,"reason":"Special Rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05},{"amount":419.44,"base_amount":10486,"charge_indicator":true,"multiplier_rate":0.04,"reason":"Rush Delivery","reason_code":"AAT","tax_category_code":"S","tax_rate":0.05}],"billing_reference":[{"id":"INV-234-2025","issue_date":"2026-08-27"}],"buyer_reference":"PO-AE-220","despatch_document_reference":{"id":"Memo-1000"},"document_currency_code":"AED","due_date":"2026-09-03","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-21"},"invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"07:54:00","items":[{"allowance_charges":[{"amount":294,"base_amount":9800,"charge_indicator":false,"multiplier_rate":0.03,"reason":"Discount","reason_code":"95"},{"amount":980,"base_amount":9800,"charge_indicator":true,"multiplier_rate":0.1,"reason":"Technical Modification","reason_code":"AAC"}],"buyers_item_id":"Purchase goods","commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":5,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","note":"All items","price_amount":4.9,"price_discount":0.1,"quantity":2000,"sellers_item_id":"Sales Goods","standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"}],"note":"Tax invoice","order_reference":{"purchase_order_id":"PO-AE-220","sales_order_id":"Salesorder-2122"},"originator_document_reference":{"id":"PO-AE-220"},"payable_rounding_amount":0.05,"payment_terms_note":"Within a week","payments":[{"card_holder_name":"Card Holder Name","card_network_id":"VISA","card_primary_account_number":"XXXXXXXXXXXX1234","payment_means_code":"55"}],"project_reference":"Regular work","tax_point_date":"2026-08-20","trader_invoice_number":"AE-01TEST-D"}}},"detailed_summary_tax_invoice":{"description":"Monthly summary invoice for recurring supplies to the same customer in the same calendar month, spanning standard-rated and reverse-charge line items","summary":"Summary Tax Invoice","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"additional_documents":[{"id":"DC"},{"id":"Delivery Challans"}],"allowance_charges":[{"amount":80.16,"base_amount":10687.5,"charge_indicator":false,"multiplier_rate":0.0075,"reason":"Special rebate","reason_code":"100","tax_category_code":"S","tax_rate":0.05}],"document_currency_code":"AED","due_date":"2026-09-10","invoice_period":{"end_date":"2026-08-27","start_date":"2026-08-20"},"invoice_type_code":"380","issue_date":"2026-08-27","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":15,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":14.25,"price_discount":0.75,"quantity":100,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"},{"commodity_code":"G","description":"Stainless steel gate valve for high-pressure pipelines","gross_price":25,"hs_code":"84818099","item_code":"VALVE-V200-SS","name":"Stainless Steel Gate Valve V-200","price_amount":23.75,"price_discount":1.25,"quantity":150,"standard_item_id":"09501101530010","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"},{"commodity_code":"G","description":"Replacement mechanical seal kit for centrifugal pumps","gross_price":30,"hs_code":"84842000","item_code":"SEAL-KIT-9F","name":"Mechanical Seal Kit 9F","price_amount":28.5,"price_discount":1.5,"quantity":200,"standard_item_id":"09501101530027","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"H87"},{"commodity_code":"G","description":"Forged carbon steel weld-neck flange, nominal diameter 100mm","gross_price":100,"hs_code":"73072100","item_code":"FLANGE-DN100","item_nature_code":"DL8.48.3.1","name":"Forged Steel Flange DN100","price_amount":99,"price_discount":1,"quantity":30,"standard_item_id":"09501101530034","standard_item_scheme":"0160","tax_category_code":"AE","tax_rate":0.05,"unit_of_measure_code":"K6"}],"note":"Tax invoice","payable_rounding_amount":0.29,"payment_terms_note":"Within 15 days","payments":[{"payee_account_id":"AE0000000001","payee_account_name":"current account","payee_financial_institution_bic":"236000","payment_means_code":"30"}],"trader_invoice_number":"AE-010TEST-D","transaction_types":["SUMMARY_INVOICE"]}}},"detailed_zero_rated":{"description":"International transport service zero-rated under UAE VAT Article 45","summary":"Zero-Rated Supply","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"invoice":{"document_currency_code":"AED","due_date":"2026-09-11","invoice_type_code":"380","issue_date":"2026-08-27","issue_time":"17:31:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","gross_price":50,"hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":49.75,"price_discount":0.25,"quantity":5000,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"Z","tax_rate":0,"unit_of_measure_code":"H87"}],"note":"Tax invoice","order_reference":{"purchase_order_id":"EXP-09","sales_order_id":"EC-24-25-1001"},"payment_terms_note":"within 15 days","payments":[{"payment_means_code":"1"}],"tax_point_date":"2026-08-20","trader_invoice_number":"AE-001-ZeroRated-TEST-D"}}}}}}},"responses":{"201":{"description":"Invoice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/detailed-credit-notes":{"post":{"tags":["Credit Notes"],"summary":"Create a UAE Credit Note with the buyer and items inline","description":"Creates a credit note in one request, without creating the buyer or the items first. The buyer is matched on `tax_identification_number` and each line's item on `item_code`, both within the authenticated branch — whatever already exists is reused unchanged, whatever is missing is created. Every rule that `POST /credit-notes` applies also applies here. `original_invoice_id` is required unless `credit_note_reason_code` is `VD`, which ibr-055-ae exempts.\n","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_party","credit_note"],"properties":{"customer_party":{"$ref":"#/components/schemas/PartyTaxpayer"},"credit_note":{"$ref":"#/components/schemas/DetailedCreditNoteDocument"}}},"examples":{"detailed_volume_discount_credit_note":{"description":"A volume discount rebate (reason code VD), which has no preceding invoice to reference per ibr-055-ae — the case the inline path exists for","summary":"Detailed Volume Discount Credit Note","value":{"customer_party":{"address":{"city_name":"Dubai","country_code":"AE","country_subentity":"DXB","street_name":"Sheikh Zayed Road"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Global Imports LLC","registration_number":"CN-1234567","registration_scheme":"0235"},"tax_identification_number":"1009876543","tax_registration_number":"100987654300003"},"credit_note":{"credit_note_reason":"Volume discount","credit_note_reason_code":"VD","document_currency_code":"AED","invoice_type_code":"381","issue_date":"2026-08-27","issue_time":"10:00:00","items":[{"commodity_code":"G","description":"High-pressure centrifugal pump for industrial fluid transfer","hs_code":"84137000","item_code":"PUMP-X500-BLK","name":"Industrial Pump Model X-500","price_amount":25,"quantity":10,"standard_item_id":"09501101530003","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"C62"}],"trader_invoice_number":"AE-DCN-001"}}}}}}},"responses":{"201":{"description":"Credit note created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/detailed-self-billed-invoices":{"post":{"tags":["Self-Billed Invoices"],"summary":"Create a UAE Self-Billed Invoice with the supplier and items inline","description":"Creates a self-billed invoice in one request, without creating the supplier or the items first. The supplier is matched on `tax_identification_number` and each line's item on `item_code`, both within the authenticated branch — whatever already exists is reused unchanged, whatever is missing is created. Every rule that `POST /self-billed-invoices` applies also applies here.\n","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["supplier","invoice"],"properties":{"supplier":{"$ref":"#/components/schemas/DetailedSupplier"},"invoice":{"$ref":"#/components/schemas/DetailedInvoiceDocument"}}},"examples":{"detailed_self_billed_invoice":{"description":"A self-billed invoice that creates the supplier and the invoiced item in the same request","summary":"Detailed Self-Billed Invoice","value":{"supplier":{"address":{"city_name":"Abu Dhabi","country_code":"AE","country_subentity":"AUH","street_name":"Al Bateen Street 4"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Desert Logistics LLC","registration_number":"CN-7654321","registration_scheme":"0235"},"tax_identification_number":"1004567890","tax_registration_number":"100456789000003"},"invoice":{"document_currency_code":"AED","due_date":"2026-09-26","invoice_type_code":"389","issue_date":"2026-08-27","issue_time":"10:00:00","items":[{"commodity_code":"S","description":"Inland haulage between Jebel Ali and Abu Dhabi","item_code":"HAUL-JA-AUH","name":"Inland Haulage Service","price_amount":1200,"quantity":4,"service_accounting_code":"SAC-0001","standard_item_id":"09501101530004","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"C62"}],"payments":[{"payment_means_code":"10"}],"trader_invoice_number":"AE-DSBI-001"}}}}}}},"responses":{"201":{"description":"Self-billed invoice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/detailed-self-billed-credit-notes":{"post":{"tags":["Self-Billed Credit Notes"],"summary":"Create a UAE Self-Billed Credit Note with the supplier and items inline","description":"Creates a self-billed credit note in one request, without creating the supplier or the items first. The supplier is matched on `tax_identification_number` and each line's item on `item_code`, both within the authenticated branch — whatever already exists is reused unchanged, whatever is missing is created. Every rule that `POST /self-billed-credit-notes` applies also applies here. `original_invoice_id` is required unless `credit_note_reason_code` is `VD`, which ibr-055-ae exempts.\n","security":[{"apiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["supplier","credit_note"],"properties":{"supplier":{"$ref":"#/components/schemas/DetailedSupplier"},"credit_note":{"$ref":"#/components/schemas/DetailedCreditNoteDocument"}}},"examples":{"detailed_self_billed_volume_discount_credit_note":{"description":"A self-billed volume discount rebate (reason code VD), exempt from the preceding invoice reference per ibr-055-ae","summary":"Detailed Self-Billed Volume Discount Credit Note","value":{"supplier":{"address":{"city_name":"Abu Dhabi","country_code":"AE","country_subentity":"AUH","street_name":"Al Bateen Street 4"},"legal_entity":{"issuing_authority_code":"TL","issuing_authority_name":"Department of Economic Development","registration_name":"Desert Logistics LLC","registration_number":"CN-7654321","registration_scheme":"0235"},"tax_identification_number":"1004567890","tax_registration_number":"100456789000003"},"credit_note":{"credit_note_reason":"Volume discount","credit_note_reason_code":"VD","document_currency_code":"AED","invoice_type_code":"261","issue_date":"2026-08-27","issue_time":"10:00:00","items":[{"commodity_code":"S","description":"Inland haulage between Jebel Ali and Abu Dhabi","item_code":"HAUL-JA-AUH","name":"Inland Haulage Service","price_amount":60,"quantity":4,"service_accounting_code":"SAC-0001","standard_item_id":"09501101530004","standard_item_scheme":"0160","tax_category_code":"S","tax_rate":0.05,"unit_of_measure_code":"C62"}],"trader_invoice_number":"AE-DSBCN-001"}}}}}}},"responses":{"201":{"description":"Self-billed credit note created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/received-invoices":{"get":{"tags":["Received Invoices"],"summary":"Get UAE Received Invoices","description":"Returns a paginated list of invoices received by the business from the Peppol network","security":[{"apiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/PageSize"},{"in":"query","name":"acknowledgement_status","schema":{"type":"string","enum":["ACKNOWLEDGED","UNACKNOWLEDGED"]},"description":"Filter to invoices that have or have not been acknowledged. Omit to return both.","example":"ACKNOWLEDGED"}],"responses":{"200":{"description":"A list of received invoices","content":{"application/json":{"schema":{"type":"object","required":["data","cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReceivedInvoice"}},"cursor":{"$ref":"#/components/schemas/Pagination"}}}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/received-invoices/{received_invoice_id}":{"get":{"tags":["Received Invoices"],"summary":"Get a UAE Received Invoice","description":"Retrieves information about a received invoice given its ID on DigiTax","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"received_invoice_id","required":true,"schema":{"type":"string","description":"Received invoice ID on DigiTax","example":"receivedinvoice_01KMFSMEYVCDV0150T6P4WECVR"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedInvoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}},"/received-invoices/{received_invoice_id}/acknowledge":{"post":{"tags":["Received Invoices"],"summary":"Acknowledge a UAE Received Invoice","description":"Marks a received invoice as acknowledged by the business. This is a business-level record only — it does not affect the Peppol MLS, which is sent automatically and immediately on receipt.","security":[{"apiKeyAuth":[]}],"parameters":[{"in":"path","name":"received_invoice_id","required":true,"schema":{"type":"string","description":"Received invoice ID on DigiTax","example":"receivedinvoice_01KMFSMEYVCDV0150T6P4WECVR"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedInvoice"}}}},"default":{"$ref":"#/components/responses/Error"}}}}},"components":{"schemas":{"CommonCode":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string","description":"The code identifier","example":"S"},"name":{"type":"string","description":"The human-readable name of the code","example":"Standard rate"},"description":{"type":"string","description":"An optional longer description of what this code means","example":"Code specifying the standard rate"}}},"PayeeParty":{"type":"object","description":"The payee (IBG-10), when payment is collected by someone other than the seller.\nPINT AE binds only a name, an optional identifier and an optional legal\nregistration identifier here — a payee has no address, electronic address or tax\nregistration number.\n","required":["party_name"],"properties":{"party_name":{"type":"string","description":"The payee's name. Required whenever a payee is given.","example":"Gulf Factoring FZ-LLC"},"party_identifier":{"type":"string","description":"An identifier for the payee, in the scheme given by `party_identifier_scheme`","example":"1012345678"},"party_identifier_scheme":{"type":"string","description":"The ISO 6523 ICD code for `party_identifier`, required when it is given. See `GET /resources/international-code-designator-schemes`.","example":"0235"},"registration_number":{"type":"string","description":"The payee's legal registration number, such as a trade licence number","example":"CN-1234567"},"registration_scheme":{"type":"string","description":"The ISO 6523 ICD code for `registration_number`, required when it is given","example":"0235"}}},"TaxRepresentativeParty":{"type":"object","description":"The seller's tax representative (IBG-11). PINT AE binds a name, a postal address\nand a VAT registration number here — no electronic address and no legal\nregistration identifier. The tax registration number is mandatory, so a\nrepresentative identified only by a TIN cannot be expressed.\n","required":["party_name","tax_registration_number","address"],"properties":{"party_name":{"type":"string","description":"The tax representative's name","example":"AE Tax Agents LLC"},"tax_registration_number":{"type":"string","description":"The tax representative's UAE Tax Registration Number (TRN)","example":"100987654300003"},"address":{"$ref":"#/components/schemas/Address"}}},"LegalRegistrationType":{"type":"object","description":"A legal registration identifier type. The seller and the buyer accept different sets — `CL` is valid only for a buyer — so each entry states which roles it may be used in.","required":["code","name","valid_for_seller","valid_for_buyer"],"properties":{"code":{"type":"string","description":"The code identifier","example":"TL"},"name":{"type":"string","description":"The human-readable name of the code","example":"Commercial/Trade license"},"valid_for_seller":{"type":"boolean","description":"Whether this type may be used for a seller — a branch or a supplier","example":true},"valid_for_buyer":{"type":"boolean","description":"Whether this type may be used for a buyer — a party","example":true}}},"Country":{"type":"object","description":"Represents a country based on ISO 3166-1 alpha-2","required":["name","alpha2"],"properties":{"name":{"type":"string","description":"The English name of the country","example":"United Arab Emirates"},"alpha2":{"type":"string","description":"The ISO 3166-1 alpha-2 country code","example":"AE"},"name_nb":{"type":"string","description":"The Norwegian Bokmål name of the country","example":"Sverige"},"name_nn":{"type":"string","description":"The Norwegian Nynorsk name of the country","example":"Sverige"}}},"InvoiceType":{"type":"object","description":"Represents a UN/CEFACT document name code (UNCL1001 subset) used as the invoice type","required":["code","name","description","invoice_category","valid_for_regular","valid_for_self_billed"],"properties":{"code":{"type":"string","description":"The UN/CEFACT document name code","example":"380"},"name":{"type":"string","description":"The name of the invoice type","example":"Commercial invoice"},"description":{"type":"string","description":"A description of the invoice type as defined by UN/CEFACT","example":"Document/message claiming payment for goods or services supplied under conditions agreed between seller and buyer."},"invoice_category":{"type":"string","description":"Indicates whether this code represents an invoice or a credit note","enum":["INVOICE","CREDIT_NOTE"],"example":"INVOICE"},"valid_for_regular":{"type":"boolean","description":"Indicates whether this invoice type is valid for regular invoices","example":true},"valid_for_self_billed":{"type":"boolean","description":"Indicates whether this invoice type is valid for self-billed invoices","example":false}}},"TaxCategory":{"type":"object","required":["code","name","description","has_rate","tax_rate"],"properties":{"code":{"type":"string","description":"The code identifier","example":"S"},"name":{"type":"string","description":"The human-readable name of the code","example":"Standard rate"},"description":{"type":"string","description":"An optional longer description of what this code means","example":"Code specifying the standard rate"},"tax_rate":{"type":"number","format":"double","example":0.05,"nullable":true,"description":"The tax rate(between 0 and 1) applied to the category for tax categories that have a defined rate"},"has_rate":{"type":"boolean","example":true,"description":"Indicates whether the tax category has a rate defined"}}},"Address":{"type":"object","description":"Postal address","required":["street_name","city_name","country_subentity","country_code"],"properties":{"street_name":{"type":"string","description":"The main address line (street name, building number)","example":"Sheikh Zayed Road, Tower 1"},"additional_street_name":{"type":"string","description":"An additional address line","example":"Floor 22"},"city_name":{"type":"string","description":"The city of the address","example":"Dubai"},"postal_zone":{"type":"string","description":"The postal zone or postcode","example":"00000"},"country_subentity":{"type":"string","description":"The country subdivision. When `country_code` is `AE` this is the emirate — see `GET /resources/ae-country-subentities` for available values. Free text for any other country.","example":"DXB"},"country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code. See `GET /resources/countries` for available values.","example":"AE"},"address_line":{"type":"string","description":"A free-form address line for additional details","example":"Near Dubai Mall"}}},"LegalEntity":{"type":"object","required":["registration_name","registration_number","registration_scheme","issuing_authority_code"],"properties":{"registration_name":{"type":"string","description":"The full legal name of the entity as registered with the issuing authority","example":"Acme Trading LLC"},"registration_number":{"type":"string","description":"The legal registration number, such as a trade licence or commercial registration number","example":"TL-12345678"},"registration_scheme":{"type":"string","description":"The ISO 6523 ICD code identifying the registration number scheme. See `GET /resources/international-code-designator-schemes` for available values.","example":"0235"},"issuing_authority_code":{"type":"string","description":"For a UAE address (`country_code` `AE`), one of: `TL`, `CL`, `EID`, `PAS`, `CD` — see `GET /resources/legal-registration-types` for available values. For any other country, a free-form registration authority identifier.","example":"TL"},"issuing_authority_name":{"type":"string","description":"The issuing authority name. Required when `issuing_authority_code` is `TL`; when `issuing_authority_code` is `PAS`, this must be a valid ISO 3166-1 alpha-2 country code.","example":"Department of Economic Development"}}},"Taxpayer":{"type":"object","required":["tax_identification_number","legal_entity","address"],"properties":{"tax_identification_number":{"type":"string","description":"The UAE Tax Identification Number (TIN) — the universal 10-digit FTA identity","example":"1009876543"},"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN). Only VAT-registered taxpayers have one","example":"100987654300003"},"legal_entity":{"$ref":"#/components/schemas/LegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The name of the contact person","example":"Sara Mohammed"},"contact_phone":{"type":"string","description":"The contact phone number","example":"+971509876543"},"contact_email":{"type":"string","format":"email","description":"The contact email address","example":"sara@global-imports.ae"}}},"PartyLegalEntity":{"type":"object","description":"A party's legal entity — only `registration_name` is required. The rest are only meaningful (and only format-checked) for a UAE-addressed party; a foreign party isn't expected to hold a UAE trade license.","required":["registration_name"],"properties":{"registration_name":{"type":"string","description":"The full legal name of the entity as registered with the issuing authority","example":"Acme Trading LLC"},"registration_number":{"type":"string","description":"The legal registration number, such as a trade licence or commercial registration number. Required for a UAE-addressed party.","example":"TL-12345678"},"registration_scheme":{"type":"string","description":"The ISO 6523 ICD code identifying the registration number scheme. Required for a UAE-addressed party. See `GET /resources/international-code-designator-schemes` for available values.","example":"0235"},"issuing_authority_code":{"type":"string","description":"The registration type code. Required for a UAE-addressed party, and restricted to one of `TL`, `CL`, `EID`, `PAS`, `CD` for one — see `GET /resources/legal-registration-types`. Free text for a non-UAE party.","example":"TL"},"issuing_authority_name":{"type":"string","description":"The issuing authority name. For a UAE-addressed party, required when `issuing_authority_code` is `TL`; when `issuing_authority_code` is `PAS`, this must be a valid ISO 3166-1 alpha-2 country code.","example":"Department of Economic Development"}}},"PartyTaxpayer":{"type":"object","required":["tax_identification_number","legal_entity","address"],"properties":{"tax_identification_number":{"type":"string","description":"The party's Tax Identification Number (TIN) — required for every party, but only checked against the UAE 10-digit format when `address.country_code` is `AE`","example":"1009876543"},"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN). Only a UAE-addressed party may have one — it specifically marks UAE VAT registration, which doesn't apply abroad","example":"100987654300003"},"legal_entity":{"$ref":"#/components/schemas/PartyLegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The name of the contact person","example":"Sara Mohammed"},"contact_phone":{"type":"string","description":"The contact phone number","example":"+971509876543"},"contact_email":{"type":"string","format":"email","description":"The contact email address","example":"sara@global-imports.ae"},"peppol_id":{"type":"string","description":"The party's Peppol participant identifier","example":"1234567890123"},"peppol_id_scheme":{"type":"string","description":"The Peppol EAS code for `peppol_id`, required when `peppol_id` is given. See `GET /resources/electronic-address-schemes` for available values.","example":"0088"}}},"Branch":{"type":"object","description":"Represents the business details as registered on DigiTax","required":["created_at","updated_at","active","business_id","tax_identification_number","legal_entity","is_test","is_live"],"properties":{"created_at":{"type":"string","format":"date-time","description":"The timestamp when the business was created on DigiTax","example":"2026-07-14T08:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the business was last updated on DigiTax","example":"2026-07-14T14:45:00Z"},"active":{"type":"boolean","description":"Whether the branch is currently active on DigiTax","example":true},"business_id":{"type":"string","description":"The DigiTax business identifier associated with this business.","example":"business_01KMFHKF4YJBGG2MNDQASKHWE9"},"tax_identification_number":{"type":"string","description":"The UAE Tax Identification Number (TIN) of the business — the universal 10-digit FTA identity","example":"1001234567"},"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN). Only VAT-registered taxpayers have one of the business","example":"100123456700003"},"legal_entity":{"$ref":"#/components/schemas/LegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The name of the contact person at the organisation","example":"Ahmed Al-Rashid"},"contact_phone":{"type":"string","description":"The phone number of the contact person","example":"+97141234567"},"contact_email":{"type":"string","format":"email","description":"The email address of the contact person","example":"ahmed@acme-trading.ae"},"is_test":{"type":"boolean","description":"Whether this branch is operating in test mode","example":false},"is_live":{"type":"boolean","description":"Whether this branch has been taken live in DigiTax","example":false}}},"Party":{"type":"object","description":"A party in a UAE e-invoice","required":["id","created_at","updated_at","active","tax_identification_number","legal_entity"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this party","example":"party_01HC3J1VVVM05YCTS61G7V3KC6"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the party was created","example":"2026-07-14T09:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the party was last updated","example":"2026-07-14T11:20:00Z"},"active":{"type":"boolean","description":"Whether the party is currently active on DigiTax","example":true},"tax_identification_number":{"type":"string","description":"The party's Tax Identification Number (TIN) — required for every party, but only in the UAE 10-digit format when `address.country_code` is `AE`","example":"1009876543"},"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN). Only a UAE-addressed party may have one — it specifically marks UAE VAT registration","example":"100987654300003"},"party_name":{"type":"string","description":"The trading name of the party","example":"Global Imports Trading"},"legal_entity":{"$ref":"#/components/schemas/PartyLegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The name of the party's contact person","example":"Sara Mohammed"},"contact_phone":{"type":"string","description":"The party's contact phone number in E.164 format","example":"+971509876543"},"contact_email":{"type":"string","format":"email","description":"The party's contact email address","example":"sara@global-imports.ae"},"peppol_id":{"type":"string","description":"The party's Peppol participant identifier","example":"1234567890123"},"peppol_id_scheme":{"type":"string","description":"The Peppol EAS code for `peppol_id` (e.g. `0088` for GLN). See `GET /resources/electronic-address-schemes` for available values.","example":"0088"}}},"Supplier":{"type":"object","description":"A supplier in a UAE self-billed e-invoice","required":["id","created_at","updated_at","active","tax_identification_number","tax_registration_number","legal_entity"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this supplier","example":"supplier_01HC3J1VVVM05YCTS61G7V3KC6"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the supplier was created","example":"2026-07-14T09:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the supplier was last updated","example":"2026-07-14T11:20:00Z"},"active":{"type":"boolean","description":"Whether the supplier is currently active on DigiTax","example":true},"tax_identification_number":{"type":"string","description":"The UAE Tax Identification Number (TIN) of the supplier — the universal 10-digit FTA identity","example":"1009876543"},"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN) of the supplier. Self-billing requires VAT registration, so every supplier has one.","example":"100987654300003"},"legal_entity":{"$ref":"#/components/schemas/LegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The name of the supplier's contact person","example":"Sara Mohammed"},"contact_phone":{"type":"string","description":"The supplier's contact phone number in E.164 format","example":"+971509876543"},"contact_email":{"type":"string","format":"email","description":"The supplier's contact email address","example":"sara@global-imports.ae"},"peppol_id":{"type":"string","description":"The supplier's Peppol participant identifier","example":"1234567890123"},"peppol_id_scheme":{"type":"string","description":"The Peppol EAS code for `peppol_id` (e.g. `0088` for GLN). See `GET /resources/electronic-address-schemes` for available values.","example":"0088"}}},"ItemProperty":{"type":"object","description":"An additional item attribute as a name/value pair","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the item attribute","example":"Colour"},"value":{"type":"string","description":"The value of the item attribute","example":"Silver"}}},"Item":{"type":"object","description":"Represents an item that can be referenced in UAE e-invoices","required":["id","created_at","updated_at","active","name","description","commodity_code","tax_category_code"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this item","example":"item_01HC3J1VVVM05YCTS61G7V3KC6"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the item was created","example":"2026-07-14T07:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the item was last updated","example":"2026-07-14T14:00:00Z"},"active":{"type":"boolean","description":"Whether the item is currently active on DigiTax","example":true},"name":{"type":"string","description":"The name of the item","example":"Industrial Pump Model X-500"},"description":{"type":"string","description":"A description of the item","example":"High-pressure centrifugal pump for industrial fluid transfer"},"item_code":{"type":"string","description":"A unique code assigned to the item in the user's system. It will be used as the unique product identifier","example":"PUMP-X500-BLK"},"item_number":{"type":"string","description":"The unique item number of the item on DigiTax","example":"ITM26-083-120958611-VGJBR7"},"commodity_code":{"type":"string","description":"The item type/commodity code indicating whether the item is goods, services, or both. See `GET /resources/commodity-codes` for available values.","example":"G"},"hs_code":{"type":"string","description":"The Harmonized System (HS) code for the item. Present when commodity_code is G (goods) or B (both goods and services).","example":"84137000"},"service_accounting_code":{"type":"string","description":"The Service Accounting Code for the item. Present when commodity_code is S (services) or B (both goods and services).","example":"SAC-0001"},"tax_category_code":{"type":"string","description":"The default VAT category code applicable to this item. This can be overridden when creating an invoice if needed. See `GET /resources/tax-categories` for available values.","example":"S"},"standard_item_id":{"type":"string","description":"A standardised item identifier (e.g. GTIN, EAN)","example":"09501101530003"},"standard_item_scheme":{"type":"string","description":"The scheme identifier for the standard item identifier. See `GET /resources/international-code-designator-schemes` for available values.","example":"0160"},"origin_country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 code of the item's country of origin. See `GET /resources/countries` for available values.","example":"DE"},"item_properties":{"type":"array","description":"Additional item attributes","items":{"$ref":"#/components/schemas/ItemProperty"}}}},"OrderReference":{"type":"object","description":"A reference to a purchase and/or sales order","properties":{"purchase_order_id":{"type":"string","description":"An identifier of a referenced purchase order, issued by the Buyer","example":"PO-2024-00123"},"sales_order_id":{"type":"string","description":"An identifier of a referenced sales order, issued by the Seller","example":"SO-2024-00456"}}},"DocumentReference":{"type":"object","description":"A reference to another document (e.g. despatch advice, receipt advice, contract)","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the referenced document","example":"DA-2024-001"},"document_type_code":{"type":"string","description":"The UNCL1001 document type code of the referenced document","example":"916"},"document_description":{"type":"string","description":"A human-readable description of the referenced document","example":"Despatch Advice"},"issue_date":{"type":"string","description":"The issue date of the referenced document (YYYY-MM-DD)","example":"2026-07-14"}}},"InvoicePeriod":{"type":"object","description":"The period to which the invoice relates","properties":{"start_date":{"type":"string","description":"The start date of the invoice period (YYYY-MM-DD)","example":"2026-07-14"},"end_date":{"type":"string","description":"The end date of the invoice period (YYYY-MM-DD)","example":"2026-08-13"},"billing_frequency_code":{"type":"string","description":"The billing frequency code. See `GET /resources/billing-frequencies` for available values.","example":"MTH"}}},"InvoiceDelivery":{"type":"object","description":"Delivery information for the items in the invoice. When `transaction_types` includes `EXPORTS`, `delivery` is required and `delivery_address.country_code` must not be `AE`.","properties":{"actual_delivery_date":{"type":"string","description":"The actual delivery date (YYYY-MM-DD)","example":"2026-07-14"},"delivery_location_id":{"type":"string","description":"The identifier of the delivery location","example":"LOC-JEBEL-ALI-001"},"delivery_location_scheme_id":{"type":"string","description":"The scheme identifier for the delivery location ID. See `GET /resources/delivery-location-schemes` for available values.","example":"0088"},"delivery_address":{"$ref":"#/components/schemas/Address"},"delivery_party_name":{"type":"string","description":"The name of the party receiving the delivery","example":"Global Imports FZE - Warehouse"},"delivery_terms_id":{"type":"string","description":"The Incoterms delivery terms identifier. Required when `transaction_types` includes `EXPORTS` or `SUPPLY_THROUGH_ECOMMERCE`.","example":"DAP"}}},"InvoiceAllowanceCharge":{"type":"object","description":"An allowance or charge at document level","required":["charge_indicator","amount","reason_code","reason","tax_category_code","tax_rate"],"properties":{"charge_indicator":{"type":"boolean","description":"If true, this is a charge; if false, it is an allowance","example":false},"amount":{"type":"number","format":"double","description":"The monetary amount of the allowance or charge","example":50},"base_amount":{"type":"number","format":"double","description":"The base amount on which the allowance or charge percentage is calculated","example":1000},"multiplier_rate":{"type":"number","format":"double","description":"The rate(between 0 to 1) used to calculate the allowance/charge amount","example":0.05,"minimum":0,"maximum":1},"reason_code":{"type":"string","description":"The coded reason for the allowance or charge. See `GET /resources/allowance-reasons` (for allowances) or `GET /resources/charge-reasons` (for charges) for available values.","example":"95"},"reason":{"type":"string","description":"The textual reason for the allowance or charge","example":"Volume discount"},"tax_category_code":{"type":"string","description":"The VAT category code for this allowance/charge. It is required for document-level allowances/charges. See `GET /resources/tax-categories` for available values.","example":"E"},"tax_rate":{"type":"number","format":"double","description":"The VAT rate applicable to this allowance/charge","example":0,"minimum":0,"maximum":1},"tax_exemption_reason_code":{"type":"string","description":"The coded reason for VAT exemption if the allowance/charge is tax exempt. See `GET /resources/tax-exemption-reasons` for available values.","example":"DL8.46.1"},"tax_exemption_reason":{"type":"string","description":"The textual reason for VAT exemption if the allowance/charge is tax exempt","example":"Certain financial services"}}},"InvoiceItemAllowanceCharge":{"type":"object","description":"An allowance or charge at invoice item level","required":["charge_indicator","amount","reason_code","reason"],"properties":{"charge_indicator":{"type":"boolean","description":"If true, this is a charge; if false, it is an allowance","example":false},"amount":{"type":"number","format":"double","description":"The monetary amount of the allowance or charge","example":50},"base_amount":{"type":"number","format":"double","description":"The base amount on which the allowance or charge percentage is calculated","example":1000},"multiplier_rate":{"type":"number","format":"double","description":"The rate(between 0 to 1) used to calculate the allowance/charge amount","example":0.05,"minimum":0,"maximum":1},"reason_code":{"type":"string","description":"The coded reason for the allowance or charge. See `GET /resources/allowance-reasons` (for allowances) or `GET /resources/charge-reasons` (for charges) for available values.","example":"95"},"reason":{"type":"string","description":"The textual reason for the allowance or charge","example":"Volume discount"}}},"InvoicePayment":{"type":"object","description":"Payment means information for the invoice","required":["id","payment_means_code"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this payment record","example":"payment_01KMFHQG90HC0H5CA6D2C1H5MK"},"payment_means_code":{"type":"string","description":"The UNCL4461 code identifying the payment means","example":"30"},"payment_means_code_name":{"type":"string","description":"The name of the payment means code","example":"Credit transfer"},"payment_id":{"type":"string","description":"The payment reference or remittance information","example":"PAY-REF-2024-001"},"payee_account_id":{"type":"string","description":"The payee's bank account number (IBAN)","example":"AE070331234567890123456"},"payee_account_name":{"type":"string","description":"The name of the payee's bank account","example":"Acme Trading LLC - Main Account"},"payee_financial_institution_bic":{"type":"string","description":"The BIC/SWIFT code of the payee's bank","example":"ADCBAEAA"},"card_primary_account_number":{"type":"string","description":"The last few digits of the card used for payment","example":"****1234"},"card_network_id":{"type":"string","description":"The network identifier of the payment card","example":"VISA"},"card_holder_name":{"type":"string","description":"The name of the card holder","example":"Ahmed Al-Rashid"},"payment_mandate_id":{"type":"string","description":"The mandate reference for direct debit","example":"MANDATE-2024-001"},"payment_terms_note":{"type":"string","description":"A textual description of the payment terms","example":"Payment due within 30 days"},"payment_terms_due_date":{"type":"string","description":"The due date for payment (YYYY-MM-DD)","example":"2026-08-13"}}},"TaxBreakdown":{"type":"object","description":"A breakdown of VAT by category","required":["tax_category_code","taxable_amount","tax_amount","currency","tax_rate"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this tax breakdown record","example":"taxbreakdown_01KMFHQG90HC0H5CA6CZ0A93VC"},"tax_category_code":{"type":"string","description":"The VAT category code","example":"S"},"taxable_amount":{"type":"number","format":"double","description":"The net amount subject to this VAT category","example":10000},"tax_amount":{"type":"number","format":"double","description":"The VAT amount for this category","example":500},"currency":{"type":"string","description":"The currency code for the tax amounts","example":"AED"},"tax_rate":{"type":"number","format":"double","description":"The VAT rate(between 0 and 1)","example":0.05,"minimum":0,"maximum":1}}},"InvoiceItem":{"type":"object","description":"A line item within an invoice","required":["id","item_id","quantity","unit_of_measure_code","line_extension_amount","price_amount","tax_category_code","tax_rate"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this invoice line","example":"invoiceitem_01KMFQN8P2CE43QQGH29FH32CT"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the line item was created","example":"2026-07-14T10:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the line item was last updated","example":"2026-07-14T10:00:00Z"},"active":{"type":"boolean","description":"Whether the line item is active","example":true},"item_id":{"type":"string","description":"The DigiTax item ID associated with this line","example":"item_01HC3J1VVVM05YCTS61G7V3KC6"},"line_id":{"type":"integer","description":"The sequential line identifier within the invoice","example":1},"note":{"type":"string","description":"A free-text note on the invoice line","example":"Special handling required"},"quantity":{"type":"number","format":"double","description":"The quantity of items on this line","example":10},"unit_of_measure_code":{"type":"string","description":"The unit of measure code for the quantity and price","example":"C62"},"line_extension_amount":{"type":"number","format":"double","description":"The net amount for this line ((quantity x price amount) - sum of allowances + sum of charges)","example":5000},"tax_amount":{"type":"number","format":"double","description":"The VAT amount for this line","example":250},"price_amount":{"type":"number","format":"double","description":"The net price per unit (excluding VAT)","example":500},"price_discount":{"type":"number","format":"double","description":"The discount applied to the gross price to arrive at the net price","example":25},"gross_price":{"type":"number","format":"double","description":"The gross price per unit before any price discount","example":525},"tax_category_code":{"type":"string","description":"The VAT category code for this line","example":"S"},"tax_rate":{"type":"number","format":"double","description":"The VAT rate for this line, between 0 and 1","example":0.05},"tax_exemption_reason_code":{"type":"string","description":"The coded reason for VAT exemption on this line","example":"DL8.46.1"},"tax_exemption_reason":{"type":"string","description":"The textual reason for VAT exemption on this line","example":"Certain financial services"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CC-OPEX-001"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"buyers_item_id":{"type":"string","description":"The buyer's identifier for this item","example":"BUY-ITEM-9901"},"sellers_item_id":{"type":"string","description":"The seller's identifier for this item","example":"PUMP-X500-BLK"},"allowance_charges":{"type":"array","description":"Line-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceItemAllowanceCharge"}},"allowance_total_amount":{"type":"number","format":"double","description":"The total amount of all line-level allowances","example":25},"charge_total_amount":{"type":"number","format":"double","description":"The total amount of all line-level charges","example":0},"item_nature_code":{"type":"string","description":"The nature code of the item, required when the tax category is reverse charge (AE)","example":"DL8.48.8.2"}}},"Invoice":{"type":"object","description":"Represents a UAE PINT-AE compliant invoice or credit note created on DigiTax","required":["id","created_at","updated_at","active","invoice_type_code","issue_date","document_currency_code","customer_party_id","line_extension_amount","tax_exclusive_amount","tax_inclusive_amount","payable_amount","tax_amount","status","validated_at","submitted_at","reported_at","accepted_at","rejected_at","report_accepted_at","report_rejected_at","withdrawn_at","withdrawal_queued_at","withdrawal_accepted_at","withdrawal_rejected_at"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this invoice","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the invoice was created on DigiTax","example":"2026-07-14T10:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the invoice was last updated on DigiTax","example":"2026-07-14T12:30:00Z"},"active":{"type":"boolean","description":"Whether this invoice record is active on DigiTax","example":true},"invoice_number":{"type":"string","description":"The sequential invoice number assigned by DigiTax","example":"INV-2024-00001"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the invoice","example":"550e8400-e29b-41d4-a716-446655440000"},"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the supplier to uniquely identify the invoice in their system","example":"ACME-INV-2024-0042"},"transaction_type_code":{"type":"string","description":"A binary code that identifies the invoice transaction types that apply to the invoice. Each digit represents a specific transaction type, in the order defined by Peppol","example":"10000001"},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["FREE_TRADE_ZONE","EXPORTS"]},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code","example":"380"},"issue_date":{"type":"string","format":"date","description":"The date the invoice was issued (YYYY-MM-DD)","example":"2026-07-14"},"issue_time":{"type":"string","description":"The time the invoice was issued (HH:MM:SS)","example":"10:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"tax_point_date":{"type":"string","format":"date","description":"The date for tax purposes (VAT point date) (YYYY-MM-DD). Must be strictly before the issue_date.","example":"2026-07-13"},"document_currency_code":{"type":"string","description":"The currency of the invoice amounts","example":"AED"},"tax_currency_code":{"type":"string","description":"The tax accounting currency. It's always AED for UAE e-invoices","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document currency and tax currency","example":1},"buyer_reference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes","example":"BR-2024-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CAPEX-2024-Q4"},"project_reference":{"type":"string","description":"A reference to a project relating to this invoice","example":"PROJ-JEBEL-2024"},"note":{"type":"string","description":"Free-text notes on the invoice","example":"Thank you for your business"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"billing_reference":{"type":"array","description":"References to preceding invoices for credit notes","items":{"$ref":"#/components/schemas/DocumentReference"}},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"References to additional supporting documents","items":{"$ref":"#/components/schemas/DocumentReference"}},"customer_party_id":{"type":"string","description":"The DigiTax party ID of the buyer","example":"party_01HC3J1VVVM05YCTS61G7V3KC6"},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual description of the payment terms","example":"Net 30 days"},"line_extension_amount":{"type":"number","format":"double","description":"The sum of all invoice line net amounts","example":10000},"tax_exclusive_amount":{"type":"number","format":"double","description":"The total amount without VAT (sum of net amounts minus document-level allowances plus document-level charges)","example":9500},"tax_inclusive_amount":{"type":"number","format":"double","description":"The total amount including VAT","example":9975},"payable_amount":{"type":"number","format":"double","description":"The amount due for payment after subtracting any prepaid amount and adding payable rounding amount","example":9975},"allowance_total_amount":{"type":"number","format":"double","description":"The sum of all document-level allowances","example":500},"charge_total_amount":{"type":"number","format":"double","description":"The sum of all document-level charges","example":0},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid to be deducted from the payable amount","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount added to make the payable amount a round number","example":0},"tax_amount":{"type":"number","format":"double","description":"The total VAT amount for the invoice","example":475},"tax_included_indicator":{"type":"boolean","description":"Indicates whether VAT is included in the invoice line amounts","example":false},"tax_amount_in_tax_currency":{"type":"number","format":"double","description":"The VAT amount expressed in the tax currency","example":475},"status":{"type":"string","description":"The current processing status of the invoice on DigiTax","example":"COMPLETED"},"allowance_charges":{"type":"array","description":"Document-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment means for this invoice","items":{"$ref":"#/components/schemas/InvoicePayment"}},"items":{"type":"array","description":"The invoice line items","items":{"$ref":"#/components/schemas/InvoiceItem"}},"taxes":{"type":"array","description":"The VAT breakdown by category","items":{"$ref":"#/components/schemas/TaxBreakdown"}},"credit_note_reason_code":{"type":"string","description":"The code for the reason a credit note was issued","example":"DL8.61.1.A"},"credit_note_reason":{"type":"string","description":"The textual reason a credit note was issued","example":"Supply was cancelled"},"original_invoice_id":{"type":"string","description":"The DigiTax ID of the original invoice this credit note relates to","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary in case of Free Trade Zone supply","example":"100111222300003"},"principle_trn":{"type":"string","description":"The TRN of the principal in case of Disclosed Agent billing","example":"100333444500003"},"reported_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:05:00Z","description":"The date and time when the invoice was sent to C5(FTA)"},"accepted_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:06:00Z","description":"The date and time C3 acknowledged the invoice with a positive Message Level Status"},"rejected_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:06:00Z","description":"The date and time C3 rejected the invoice with a negative Message Level Status"},"rejection_reason":{"type":"string","description":"The reason C3 gave for rejecting the invoice","example":"Document rejected due to 2 validation error(s)"},"report_accepted_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:07:00Z","description":"The date and time C5(FTA) acknowledged the tax report with a positive Message Level Status"},"report_rejected_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:07:00Z","description":"The date and time C5(FTA) rejected the tax report with a negative Message Level Status"},"report_rejection_reason":{"type":"string","description":"The reason C5(FTA) gave for rejecting the tax report","example":"Document rejected due to 1 validation error(s)"},"withdrawn_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:08:00Z","description":"The date and time the withdrawal of the tax report was delivered to C5(FTA)"},"withdrawal_queued_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:08:00Z","description":"The date and time the withdrawal of the tax report was raised, because C3 rejected the invoice or never acknowledged receiving it"},"withdrawal_accepted_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:09:00Z","description":"The date and time C5(FTA) acknowledged the withdrawal with a positive Message Level Status"},"withdrawal_rejected_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:09:00Z","description":"The date and time C5(FTA) rejected the withdrawal with a negative Message Level Status"},"withdrawal_rejection_reason":{"type":"string","description":"The reason C5(FTA) gave for rejecting the withdrawal","example":"Document rejected due to 1 validation error(s)"},"submitted_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:04:00Z","description":"The date and time when the invoice was sent to C3(buyer's Access Point) in the case of billing or C2(supplier's Access Point) in the case of self-billing"},"validated_at":{"type":"string","format":"date-time","nullable":true,"example":"2026-07-14T10:03:00Z","description":"The date and time when the invoice was validated against the PINT-AE rules"},"supplier_id":{"type":"string","description":"The DigiTax supplier ID of the supplier, populated only on self-billed invoices and credit notes","example":"supplier_01HC3J1VVVM05YCTS61G7V3KC6"}}},"ReceivedParty":{"type":"object","description":"A party embedded in a received invoice, extracted from the incoming Peppol document","properties":{"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN) of the party","example":"100987654300003"},"party_name":{"type":"string","description":"The trading name of the party","example":"Global Imports Trading"},"legal_entity":{"$ref":"#/components/schemas/PartyLegalEntity"},"address":{"$ref":"#/components/schemas/Address"},"contact_name":{"type":"string","description":"The name of the contact person","example":"Sara Mohammed"},"contact_phone":{"type":"string","description":"The contact phone number","example":"+971509876543"},"contact_email":{"type":"string","format":"email","description":"The contact email address","example":"sara@global-imports.ae"},"peppol_id":{"type":"string","description":"The party's Peppol participant identifier","example":"1234567890123"},"peppol_id_scheme":{"type":"string","description":"The Peppol EAS code for `peppol_id`","example":"0088"}}},"ReceivedPaymentMeans":{"type":"object","description":"Payment means embedded in a received invoice","properties":{"payment_means_code":{"type":"string","description":"The UNCL4461 code identifying the payment means","example":"30"},"payment_means_code_name":{"type":"string","description":"The name of the payment means code","example":"Credit transfer"},"payment_id":{"type":"string","description":"The payment reference or remittance information","example":"PAY-REF-2024-001"},"payee_account_id":{"type":"string","description":"The payee's bank account number (IBAN)","example":"AE070331234567890123456"},"payee_account_name":{"type":"string","description":"The name of the payee's bank account","example":"Acme Trading LLC - Main Account"},"payee_financial_institution_bic":{"type":"string","description":"The BIC/SWIFT code of the payee's bank","example":"ADCBAEAA"},"card_primary_account_number":{"type":"string","description":"The last few digits of the card used for payment","example":"****1234"},"card_network_id":{"type":"string","description":"The network identifier of the payment card","example":"VISA"},"card_holder_name":{"type":"string","description":"The name of the card holder","example":"Ahmed Al-Rashid"},"payment_mandate_id":{"type":"string","description":"The mandate reference for direct debit","example":"MANDATE-2024-001"}}},"ReceivedInvoiceLine":{"type":"object","description":"A line item embedded in a received invoice","properties":{"line_id":{"type":"integer","description":"The sequential line identifier within the invoice","example":1},"note":{"type":"string","description":"A free-text note on the invoice line","example":"Special handling required"},"name":{"type":"string","description":"The item name","example":"Industrial Pump Model X-500"},"description":{"type":"string","description":"A description of the item","example":"High-pressure centrifugal pump for industrial fluid transfer"},"buyers_item_id":{"type":"string","description":"The buyer's identifier for this item","example":"BUY-ITEM-9901"},"sellers_item_id":{"type":"string","description":"The seller's identifier for this item","example":"PUMP-X500-BLK"},"standard_item_id":{"type":"string","description":"A standardised item identifier (e.g. GTIN, EAN)","example":"09501101530003"},"standard_item_scheme":{"type":"string","description":"The scheme identifier for the standard item identifier","example":"0160"},"origin_country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 code of the item's country of origin","example":"DE"},"hs_code":{"type":"string","description":"The Harmonized System (HS) code for the item","example":"84137000"},"commodity_code":{"type":"string","description":"The commodity type code (G for goods, S for services, B for both)","example":"G"},"service_accounting_code":{"type":"string","description":"The Service Accounting Code for the item","example":"SAC-0001"},"item_properties":{"type":"array","description":"Additional item attributes","items":{"$ref":"#/components/schemas/ItemProperty"}},"quantity":{"type":"number","format":"double","description":"The quantity of items on this line","example":10},"unit_of_measure_code":{"type":"string","description":"The unit of measure code for the quantity and price","example":"C62"},"line_extension_amount":{"type":"number","format":"double","description":"The net amount for this line","example":5000},"tax_amount":{"type":"number","format":"double","description":"The VAT amount for this line","example":250},"price_amount":{"type":"number","format":"double","description":"The net price per unit (excluding VAT)","example":500},"price_discount":{"type":"number","format":"double","description":"The discount applied to the gross price to arrive at the net price","example":25},"gross_price":{"type":"number","format":"double","description":"The gross price per unit before any price discount","example":525},"tax_category_code":{"type":"string","description":"The VAT category code for this line","example":"S"},"tax_rate":{"type":"number","format":"double","description":"The VAT rate for this line, between 0 and 1","example":0.05},"tax_exemption_reason_code":{"type":"string","description":"The coded reason for VAT exemption on this line","example":"DL8.46.1"},"tax_exemption_reason":{"type":"string","description":"The textual reason for VAT exemption on this line","example":"Certain financial services"},"tax_scheme_id":{"type":"string","description":"The tax scheme identifier","example":"VAT"},"item_price_extension_amount":{"type":"number","format":"double","description":"The line total in AED (tax currency)","example":5250},"item_price_extension_tax_amount":{"type":"number","format":"double","description":"The VAT amount for this line in AED (tax currency)","example":262.5},"item_price_extension_tax_currency":{"type":"string","description":"The currency of the item price extension amounts","example":"AED"},"order_line_reference":{"$ref":"#/components/schemas/OrderReference"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CC-OPEX-001"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"allowance_charges":{"type":"array","description":"Line-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceItemAllowanceCharge"}},"allowance_total_amount":{"type":"number","format":"double","description":"The total amount of all line-level allowances","example":25},"charge_total_amount":{"type":"number","format":"double","description":"The total amount of all line-level charges","example":0},"item_nature_code":{"type":"string","description":"The nature code of the item, required when the tax category is reverse charge (AE)","example":"DL8.48.8.2"}}},"ReceivedInvoice":{"type":"object","description":"Represents a UAE PINT-AE compliant invoice or credit note received from the Peppol network","required":["id","created_at","updated_at","active","is_self_billed","received_at","accepted_at","rejected_at","reported_at","status"],"properties":{"id":{"type":"string","description":"The unique DigiTax identifier for this received invoice","example":"receivedinvoice_01KMFSMEYVCDV0150T6P4WECVR"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when this record was created on DigiTax","example":"2026-07-14T10:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when this record was last updated on DigiTax","example":"2026-07-14T12:30:00Z"},"active":{"type":"boolean","description":"Whether this received invoice record is active on DigiTax","example":true},"is_self_billed":{"type":"boolean","description":"Whether this invoice was received via the self-billed channel (C3)","example":false},"invoice_number":{"type":"string","description":"The invoice number as assigned by the supplier","example":"INV-2026-00001"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the invoice","example":"550e8400-e29b-41d4-a716-446655440000"},"transaction_type_code":{"type":"string","description":"A binary code identifying the applicable PINT-AE transaction types","example":"10000001"},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["FREE_TRADE_ZONE","EXPORTS"]},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code","example":"380"},"credit_note_reason_code":{"type":"string","description":"The coded reason for the credit note, present on credit notes","example":"DL8.61.1.A"},"credit_note_reason_description":{"type":"string","description":"The textual description for the credit note reason, present on credit notes","example":"Supply was cancelled"},"issue_date":{"type":"string","format":"date","description":"The date the invoice was issued (YYYY-MM-DD)","example":"2026-07-14"},"issue_time":{"type":"string","description":"The time the invoice was issued (HH:MM:SS)","example":"10:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"tax_point_date":{"type":"string","format":"date","description":"The VAT point date (YYYY-MM-DD). Must be strictly before the issue_date.","example":"2026-07-13"},"document_currency_code":{"type":"string","description":"The currency of the invoice amounts","example":"AED"},"tax_currency_code":{"type":"string","description":"The tax accounting currency (always AED for UAE e-invoices)","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document currency and tax currency","example":1},"buyer_reference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes","example":"BR-2024-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CAPEX-2024-Q4"},"project_reference":{"type":"string","description":"A reference to a project relating to this invoice","example":"PROJ-JEBEL-2024"},"note":{"type":"string","description":"Free-text notes on the invoice","example":"Thank you for your business"},"payment_terms_note":{"type":"string","description":"Textual description of the payment terms","example":"Net 30 days"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"billing_reference":{"type":"array","description":"References to preceding invoices","items":{"$ref":"#/components/schemas/DocumentReference"}},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"References to additional supporting documents","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"allowance_charges":{"type":"array","description":"Document-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"supplier_party":{"$ref":"#/components/schemas/ReceivedParty"},"customer_party":{"$ref":"#/components/schemas/ReceivedParty"},"payee_party":{"$ref":"#/components/schemas/ReceivedParty"},"tax_representative_party":{"$ref":"#/components/schemas/ReceivedParty"},"line_extension_amount":{"type":"number","format":"double","description":"The sum of all invoice line net amounts","example":10000},"tax_exclusive_amount":{"type":"number","format":"double","description":"The total amount without VAT","example":9500},"tax_inclusive_amount":{"type":"number","format":"double","description":"The total amount including VAT","example":9975},"payable_amount":{"type":"number","format":"double","description":"The amount due for payment","example":9975},"allowance_total_amount":{"type":"number","format":"double","description":"The sum of all document-level allowances","example":500},"charge_total_amount":{"type":"number","format":"double","description":"The sum of all document-level charges","example":0},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid to be deducted from the payable amount","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount added to make the payable amount a round number","example":0},"tax_amount":{"type":"number","format":"double","description":"The total VAT amount for the invoice","example":475},"tax_included_indicator":{"type":"boolean","description":"Indicates whether VAT is included in the invoice line amounts","example":false},"tax_amount_in_tax_currency":{"type":"number","format":"double","description":"The VAT amount expressed in the tax currency (AED)","example":475},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary in case of Free Trade Zone supply","example":"100111222300003"},"principle_trn":{"type":"string","description":"The TRN of the principal in case of Disclosed Agent billing","example":"100333444500003"},"status":{"type":"string","description":"The AP workflow status of the received invoice","enum":["RECEIVED","ACCEPTED","REJECTED","REPORTED"],"example":"RECEIVED"},"document_type":{"type":"string","description":"The document classification derived from invoice_type_code at ingest time","enum":["RECEIVED_INVOICE_TYPE_UNSPECIFIED","RECEIVED_INVOICE_TYPE_INVOICE","RECEIVED_INVOICE_TYPE_CREDIT_NOTE"],"example":"RECEIVED_INVOICE_TYPE_INVOICE"},"lines":{"type":"array","description":"The invoice line items","items":{"$ref":"#/components/schemas/ReceivedInvoiceLine"}},"payment_means":{"type":"array","description":"Payment means for this invoice","items":{"$ref":"#/components/schemas/ReceivedPaymentMeans"}},"tax_subtotals":{"type":"array","description":"The VAT breakdown by category","items":{"$ref":"#/components/schemas/TaxBreakdown"}},"received_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp when the document first arrived from the Peppol network","example":"2026-07-14T10:00:00Z"},"accepted_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp when the AP approved this invoice","example":"2026-07-14T10:00:00Z"},"rejected_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp when the AP rejected this invoice","example":null},"reported_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp when this invoice was forwarded to the FTA","example":"2026-07-14T10:00:00Z"},"acknowledged_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp when a human at the business confirmed they've seen this invoice. Business-level only — separate from the automated Peppol MLS.","example":null},"acknowledged_by":{"type":"string","nullable":true,"description":"The actor ID that acknowledged this invoice","example":null}}},"Pagination":{"type":"object","properties":{"next":{"type":"string","description":"Cursor for the next page of results.","example":"<entity>_01HC3J1VVVM05YCTS61G7V3KC6"},"previous":{"type":"string","description":"Cursor for the previous page of results.","example":"<entity>_01HC3J1VVVM05YCTS61G7V3KC6"},"page_size":{"type":"integer","description":"The number of items per page.","example":20}}},"CreateInvoicePaymentRequest":{"type":"object","required":["payment_means_code"],"properties":{"payment_means_code":{"type":"string","description":"The UNCL4461 payment means code. See `GET /resources/payment-means` for available values.","example":"30"},"payment_id":{"type":"string","description":"The payment reference","example":"PAY-REF-2024-001"},"payee_account_id":{"type":"string","description":"The payee IBAN or account number","example":"AE070331234567890123456"},"payee_account_name":{"type":"string","description":"The payee bank account name","example":"Acme Trading LLC - Main Account"},"payee_financial_institution_bic":{"type":"string","description":"The BIC/SWIFT code of the payee's bank","example":"ADCBAEAA"},"card_primary_account_number":{"type":"string","description":"The primary account number of the payment card","example":"66541234"},"card_network_id":{"type":"string","description":"The payment card network identifier","example":"VISA"},"card_holder_name":{"type":"string","description":"The name of the card holder","example":"Ahmed Al-Rashid"},"payment_mandate_id":{"type":"string","description":"The direct debit mandate reference","example":"MANDATE-2024-001"},"payment_terms_note":{"type":"string","description":"A description of the payment terms","example":"Payment due within 30 days"},"payment_terms_due_date":{"type":"string","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"}}},"CreateInvoiceItemRequest":{"type":"object","required":["item_id","quantity","unit_of_measure_code","price_amount","tax_category_code","tax_rate"],"properties":{"item_id":{"type":"string","description":"The DigiTax item ID of the item being invoiced","example":"item_01HC3J1VVVM05YCTS61G7V3KC6"},"quantity":{"type":"number","format":"double","description":"The number of units of the item being invoiced","example":10},"unit_of_measure_code":{"type":"string","description":"The code of the unit of measure used for the invoiced quantity. See `GET /resources/units-of-measure` for available values.","example":"C62"},"price_amount":{"type":"number","format":"double","description":"The net unit price (excluding VAT) for the invoiced item and in the specified unit of measure","example":500},"price_discount":{"type":"number","format":"double","description":"The discount on the gross price to arrive at the net price","example":25},"gross_price":{"type":"number","format":"double","description":"The gross unit price before discount","example":525},"tax_category_code":{"type":"string","description":"The VAT category code for this invoice item. See `GET /resources/tax-categories` for available values.","example":"S"},"tax_rate":{"type":"number","format":"double","description":"The VAT rate(between 0 and 1) percentage","example":0.05,"minimum":0,"maximum":1},"tax_exemption_reason_code":{"type":"string","description":"The coded reason for VAT exemption. See `GET /resources/tax-exemption-reasons` for available values.","example":"DL8.46.1"},"tax_exemption_reason":{"type":"string","description":"The textual reason for VAT exemption","example":"Certain financial services"},"note":{"type":"string","description":"A free-text note on this invoice item","example":"General invoice item details"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CC-OPEX-001"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"buyers_item_id":{"type":"string","description":"The buyer's identifier for this item","example":"BUY-ITEM-9901"},"sellers_item_id":{"type":"string","description":"The seller's identifier for this item","example":"PUMP-X500-BLK"},"order_line_reference":{"$ref":"#/components/schemas/OrderReference"},"allowance_charges":{"type":"array","description":"Invoice item-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceItemAllowanceCharge"}},"item_nature_code":{"type":"string","description":"The item nature code, required when tax category is reverse charge (AE). See `GET /resources/goods-types` for available values.","example":"DL8.48.8.2"}}},"DetailedSupplier":{"description":"The supplier being self-billed. Matched on `tax_identification_number` within the branch — an existing supplier is reused unchanged, otherwise one is created from these fields.","allOf":[{"$ref":"#/components/schemas/Taxpayer"},{"type":"object","required":["tax_registration_number"],"properties":{"tax_registration_number":{"type":"string","description":"The UAE Tax Registration Number (TRN). Self-billing requires the supplier to be VAT-registered, so this is always required.","example":"100987654300003"}}}]},"DetailedInvoiceItemRequest":{"type":"object","description":"An invoice line together with the catalogue item it bills. `item_code` is matched within the branch — an existing item is reused unchanged, otherwise one is created from the catalogue fields. Two lines in the same request may not share an `item_code`.","required":["item_code","name","description","commodity_code","quantity","unit_of_measure_code","price_amount","tax_category_code","tax_rate"],"properties":{"item_code":{"type":"string","description":"A unique code assigned to the item in the user's system. Used to match an existing item, or as the product identifier of a newly created one.","example":"PUMP-X500-BLK"},"name":{"type":"string","description":"The name of the item","example":"Industrial Pump Model X-500"},"description":{"type":"string","description":"A description of the item","example":"High-pressure centrifugal pump for industrial fluid transfer"},"commodity_code":{"type":"string","description":"The commodity type code (G for goods, S for services, B for both). See `GET /resources/commodity-codes` for available values.","example":"G"},"hs_code":{"type":"string","description":"The Harmonized System (HS) code for the item. Required when commodity_code is G (goods) or B (both goods and services)","example":"84137000"},"service_accounting_code":{"type":"string","description":"The Service Accounting Code for the item. Required when commodity_code is S (services) or B (both goods and services)","example":"SAC-0001"},"standard_item_id":{"type":"string","description":"A standardised item identifier","example":"09501101530003"},"standard_item_scheme":{"type":"string","description":"The scheme for the standard item identifier. See `GET /resources/international-code-designator-schemes` for available values.","example":"0160"},"origin_country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 code of the item's country of origin. See `GET /resources/countries` for available values.","example":"DE"},"item_properties":{"type":"array","description":"Additional item attributes","items":{"$ref":"#/components/schemas/ItemProperty"}},"quantity":{"type":"number","format":"double","description":"The number of units of the item being invoiced","example":10},"unit_of_measure_code":{"type":"string","description":"The code of the unit of measure used for the invoiced quantity. See `GET /resources/units-of-measure` for available values.","example":"C62"},"price_amount":{"type":"number","format":"double","description":"The net unit price (excluding VAT) for the invoiced item and in the specified unit of measure","example":500},"gross_price":{"type":"number","format":"double","description":"The gross unit price before discount","example":525},"price_discount":{"type":"number","format":"double","description":"The discount on the gross price to arrive at the net price","example":25},"tax_category_code":{"type":"string","description":"The VAT category code for this invoice item. See `GET /resources/tax-categories` for available values.","example":"S"},"tax_rate":{"type":"number","format":"double","description":"The VAT rate(between 0 and 1) percentage","example":0.05,"minimum":0,"maximum":1},"note":{"type":"string","description":"A free-text note on this invoice item","example":"General invoice item details"},"tax_exemption_reason_code":{"type":"string","description":"The coded reason for VAT exemption. See `GET /resources/tax-exemption-reasons` for available values.","example":"DL8.46.1"},"tax_exemption_reason":{"type":"string","description":"The textual reason for VAT exemption","example":"Certain financial services"},"order_line_reference":{"$ref":"#/components/schemas/OrderReference"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CC-OPEX-001"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"buyers_item_id":{"type":"string","description":"The buyer's identifier for this item","example":"BUY-ITEM-9901"},"sellers_item_id":{"type":"string","description":"The seller's identifier for this item","example":"PUMP-X500-BLK"},"allowance_charges":{"type":"array","description":"Invoice item-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceItemAllowanceCharge"}},"item_nature_code":{"type":"string","description":"The item nature code, required when tax category is reverse charge (AE). See `GET /resources/goods-types` for available values.","example":"DL8.48.8.2"}}},"DetailedInvoiceDocument":{"type":"object","description":"The invoice itself. Identical to the `POST /invoices` body except that the buyer is supplied inline as `customer_party` and each line carries its item's details.","required":["trader_invoice_number","invoice_type_code","issue_date","document_currency_code","items","payments"],"properties":{"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the supplier to uniquely identify the invoice in their system","example":"ACME-INV-2024-0042"},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["FREE_TRADE_ZONE","CONTINUOUS_SUPPLY"]},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code. See `GET /resources/invoice-types` for available values.","example":"380"},"issue_date":{"type":"string","format":"date","description":"The date on which the invoice was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.","example":"2026-07-14"},"issue_time":{"type":"string","description":"The invoice issue time (HH:MM:SS)","example":"10:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"document_currency_code":{"type":"string","description":"A code that specifies the currency in which the invoice is issued. See `GET /resources/currencies` for available values.","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document and tax currencies. Required and must be > 0 when `document_currency_code` is not `AED`. When `document_currency_code` is `AED`, must be `1` or omitted. Maximum 6 decimal places.","example":3.67},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"tax_point_date":{"type":"string","format":"date","description":"The VAT point date (YYYY-MM-DD). Must be strictly before the issue_date.","example":"2026-07-13"},"buyer_reference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes.","example":"BR-2026-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CAPEX-2024-Q4"},"project_reference":{"type":"string","description":"A project reference","example":"PROJ-JEBEL-2024"},"note":{"type":"string","description":"A free-text note on the invoice","example":"General invoice details"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"billing_reference":{"type":"array","description":"References to preceding invoices","items":{"$ref":"#/components/schemas/DocumentReference"}},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"Additional supporting document references","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual payment terms","example":"Next 30 days"},"allowance_charges":{"type":"array","description":"Invoice-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment details for this invoice","items":{"$ref":"#/components/schemas/CreateInvoicePaymentRequest"}},"items":{"type":"array","description":"The invoice line items","items":{"$ref":"#/components/schemas/DetailedInvoiceItemRequest"}},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid, to be deducted from the payable amount","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount","example":0},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary for Free Trade Zone supplies. Required when `transaction_types` includes `FREE_TRADE_ZONE`.","example":"123456789098703"},"principle_trn":{"type":"string","description":"The TRN of the principal for Disclosed Agent billing. Required when `transaction_types` includes `AGENT_BILLING`. Must differ from the business's own TRN.","example":"123456789098703"}}},"DetailedCreditNoteDocument":{"type":"object","description":"The credit note itself. Identical to the `POST /credit-notes` body except that the buyer is supplied inline as `customer_party` and each line carries its item's details. `original_invoice_id` is optional because ibr-055-ae exempts volume discounts, which have no original invoice.","required":["trader_invoice_number","invoice_type_code","credit_note_reason_code","credit_note_reason","issue_date","document_currency_code","items"],"properties":{"trader_invoice_number":{"type":"string","description":"An invoice number assigned by the supplier to uniquely identify the invoice in their system","example":"ACME-CN-2024-0003"},"credit_note_reason_code":{"type":"string","description":"The coded reason for the credit note. See `GET /resources/credit-reasons` for available values.","example":"DL8.61.1.A"},"credit_note_reason":{"type":"string","description":"The textual reason for the credit note","example":"Supply was cancelled"},"original_invoice_id":{"type":"string","description":"The DigiTax ID of the original invoice this credit note relates to","example":"invoice_01KMFSMEYVCDV0150T6P4WECVR"},"invoice_type_code":{"type":"string","description":"The UN/CEFACT document type code. If the credit note references an original invoice, the value should correspond to the original invoice type code (e.g. \"381\" for a standard credit note referencing a \"380\" invoice). See `GET /resources/invoice-types` for available values.","example":"381"},"issue_date":{"type":"string","format":"date","description":"The date on which the credit note was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.","example":"2026-07-14"},"issue_time":{"type":"string","description":"The credit note issue time (HH:MM:SS)","example":"09:00:00"},"due_date":{"type":"string","format":"date","description":"The payment due date (YYYY-MM-DD)","example":"2026-08-13"},"document_currency_code":{"type":"string","description":"The currency code (ISO 4217). See `GET /resources/currencies` for available values.","example":"AED"},"tax_currency_exchange_rate":{"type":"number","format":"double","description":"The exchange rate between document and tax currencies. Required and must be > 0 when `document_currency_code` is not `AED`. When `document_currency_code` is `AED`, must be `1` or omitted. Maximum 6 decimal places.","example":1},"payee_party":{"$ref":"#/components/schemas/PayeeParty"},"tax_representative_party":{"$ref":"#/components/schemas/TaxRepresentativeParty"},"buyer_reference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes","example":"BR-2024-00789"},"accounting_cost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts","example":"CAPEX-2024-Q4"},"note":{"type":"string","description":"A free-text note on the credit note","example":"Credit for cancelled order"},"invoice_period":{"$ref":"#/components/schemas/InvoicePeriod"},"order_reference":{"$ref":"#/components/schemas/OrderReference"},"despatch_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"receipt_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"originator_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"contract_document_reference":{"$ref":"#/components/schemas/DocumentReference"},"additional_documents":{"type":"array","description":"Additional supporting document references","items":{"$ref":"#/components/schemas/DocumentReference"}},"delivery":{"$ref":"#/components/schemas/InvoiceDelivery"},"payment_terms_note":{"type":"string","description":"Textual payment terms","example":"Next 30 days"},"allowance_charges":{"type":"array","description":"Invoice-level allowances and charges","items":{"$ref":"#/components/schemas/InvoiceAllowanceCharge"}},"payments":{"type":"array","description":"Payment means for this credit note","items":{"$ref":"#/components/schemas/CreateInvoicePaymentRequest"}},"items":{"type":"array","description":"The credit note line items","items":{"$ref":"#/components/schemas/DetailedInvoiceItemRequest"}},"prepaid_amount":{"type":"number","format":"double","description":"The amount already paid","example":0},"payable_rounding_amount":{"type":"number","format":"double","description":"The rounding amount","example":0},"transaction_types":{"type":"array","description":"The list of applicable PINT-AE transaction types","items":{"type":"string","enum":["FREE_TRADE_ZONE","DEEMED_SUPPLY","PROFIT_MARGIN_SCHEME","SUMMARY_INVOICE","CONTINUOUS_SUPPLY","AGENT_BILLING","SUPPLY_THROUGH_ECOMMERCE","EXPORTS"]},"example":["EXPORTS","CONTINUOUS_SUPPLY"]},"beneficiary_tax_number":{"type":"string","description":"The TRN or TIN of the beneficiary for Free Trade Zone supplies. Required when `transaction_types` includes `FREE_TRADE_ZONE`.","example":"123456789098703"},"principle_trn":{"type":"string","description":"The TRN of the principal for Disclosed Agent billing. Required when `transaction_types` includes `AGENT_BILLING`. Must differ from the business's own TRN.","example":"123456789098703"}}}},"parameters":{"After":{"in":"query","name":"after","required":false,"schema":{"type":"string","description":"When paginating results, a pointer to an ID after which we want results","example":"<entity>_01HC3J1VVVM05YCTS61G7V3KC6"}},"Before":{"in":"query","name":"before","required":false,"schema":{"type":"string","description":"When paginating results, a pointer to an ID before which we want results","example":"<entity>_01HC3J1VVVM05YCTS61G7V3KC6"}},"PageSize":{"in":"query","name":"page_size","required":false,"schema":{"type":"integer","description":"The maximum number of items to return per page, defaults to 20","maximum":20,"minimum":1,"example":20}}},"responses":{"default":{"$ref":"#/components/responses/Error"},"Error":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"An error occurred"},"code":{"type":"string","example":"400"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}