TaxCategory
| Parameter | Data Type | Field Validations | Description |
|---|---|---|---|
| Id | Enum : S,E,Z,O | Mandatory. | This property holds the value of the VAT category S: Standard Rate E: Exempt from Tax Z: Zero Rated Goods O: Services outside the scope of tax or not subject to VAT |
| Percent | decimal | Mandatory | the percentage rate of Value Added Tax (VAT) applied to a product or service. default = 15 |
| TaxSchemeId | string | Mandatory | VAT |
| TaxExemptionReasonCode | string | Optional | This property holds a predefined code that explains the reason for tax exemption or special tax eg: VATEX-SA-33 |
| TaxExemptionReason | string | Optional | Similar to TaxExemptionReasonCode, but its readable reason |
Money Object
Parameter Data Type Field Validations Description CurrencyCode string Mandatory indicates the currency used in the invoice. "SAR" is the default currency. Amount decimal Mandatory Amount.
| Parameter | Data Type | Field Validations | Description |
|---|---|---|---|
| CurrencyCode | string | Mandatory | indicates the currency used in the invoice. "SAR" is the default currency. |
| Amount | decimal | Mandatory | Amount. |
MultilingualData
| Parameter | Data Type | Field Validations | Description |
|---|---|---|---|
| en | string | Mandatory | name in english |
| ar | string | Mandatory | name in arabic |
AllowanceCharge
Parameter Data Type Field Validations Description ChargeIndicator bool Mandatory To distinguish between a charge (additional cost) and a discount (reduction in cost).
True: Object indicates an additional charge to the base price.
False: Object applies a discount to the base price.
AllowanceChargeReason String Mandatory A text field specifying the reason for applying a charge or discount within a transaction. ex : "Discount" Amount Money Object Mandatory discount amount exclusive of vat TaxCategory Object Mandatory at the invoice level and optional at the item level. Defines the VAT rate and conditions applied to an item, including exemptions and specific tax treatments. Covers standard, exempt, zero-rated, and outside scope VAT conditions.
| Parameter | Data Type | Field Validations | Description |
|---|---|---|---|
| ChargeIndicator | bool | Mandatory | To distinguish between a charge (additional cost) and a discount (reduction in cost). True: Object indicates an additional charge to the base price. |
| AllowanceChargeReason | String | Mandatory | A text field specifying the reason for applying a charge or discount within a transaction. ex : "Discount" |
| Amount | Money Object | Mandatory | discount amount exclusive of vat |
| TaxCategory | Object | Mandatory at the invoice level and optional at the item level. | Defines the VAT rate and conditions applied to an item, including exemptions and specific tax treatments. Covers standard, exempt, zero-rated, and outside scope VAT conditions. |
TaxSubtotal Object
| Parameter | Data Type | Field Validations | Description |
|---|---|---|---|
| TaxAmount | Money | Mandatory | The amount of tax applied on this category. |
| TaxableAmount | Money | Mandatory | The total taxable amount in this tax category |
| TaxCategory | TaxCategory | Mandatory | Specify the tax ID, percentage, and tax scheme ID. See the example request. |