diff --git a/src/api-reference/document-compliance-gateway/V4.document-compliance-gateway.markdown b/src/api-reference/document-compliance-gateway/V4.document-compliance-gateway.markdown index 6282ffe7c9..872dcaccbf 100644 --- a/src/api-reference/document-compliance-gateway/V4.document-compliance-gateway.markdown +++ b/src/api-reference/document-compliance-gateway/V4.document-compliance-gateway.markdown @@ -253,64 +253,64 @@ Content-Type: application/json ### DigitalTaxDocument Schema -|Name|Type|Format|Description| -|---|---|---|---| -|`status`| `string` | "enum": ["processed, failed"]| **Required** - Status of the compliance document.| -|`documentData` | `object` | [DocumentData Schema ](#DocumentData-Schema) | **Required** - Document details and Tax Token info (Can be null for failed status). | -| `code` | `string` | optional | Response code provided by partner.| -| `description` | `string` | optional| Comment/description provided by partner. | +|Name|Type|Format|Description|Required|Optional| +|---|---|---|---|---|---| +|`status`| `string` | `enum`: [`processed`, `failed`]| Status of the compliance document.| Yes | - | +|`documentData` | `object` | [DocumentData Schema](#DocumentData-Schema) | Document details and Tax Token info (Can be null for failed status). | Yes | - | +| `code` | `string` | - | Response code provided by partner.| - | Yes | +| `description` | `string` | - | Comment/description provided by partner. | - | Yes | #### DocumentData Schema -|Name|Type|Format|Description| -|---|---|---|---| -| `issueDateTime` | `string` | YYYY-MM-DDTHH:mm:ssZ | **Required** - Date and time when the document was created in the local timezone where it was issued.| -| `uuid`| `string` | - |**Required** - Document UUID - field present in compliance document/Government doc unique id.| -| `grossAmount` | `number` | - | **Required** - Sum of amounts before discounts and taxes. | -| `currency` | `string` | "enum": ["INR","MXN","USD",..]| **Required** - Currency used to express amounts (According to the ISO 4217 codes).| -| `exchangeRate` | `string` | - | **Required** - Exchange Rate according to currency used.| -| `netAmount`| `number` | - | **Required** - Gross Amount – Discounts + VAT Taxes – Withholding Taxes.| -| `paymentMethod`| `string` | - | **Required** - Specify the code of payment method - PUE - only one payment, PPD - payment done in partial payments, PIP - Initial payment and partialities.| -| `vendor` | `object` | [Vendor schema ](#vendor-schema) | **Required** - details of the vendor.| -| `formatVersion` | `string` | "enum": ["4.0",..]| Version of the compliance document.| -| `buyer`| `object` | [Buyer schema ](#buyer-schema)| Details of the buyer.| -| `number`| `string` | - | Number/Supplier Document Id of the receipt.| -| `code` | `string` | - | Prefix of receipt, an alphanumeric field that can refer to a physical place (POS, branch, factory, warehouse, office, etc.) or any other criteria (like business, line of product, etc.) | -| `documentPostalCode`| `string` | - | Postal code of place of receipt issue.| -| `paymentType` | `string` | "enum": ["01, 02, 03"] | Means of payment (01 (Cash), 02 (Cheque), 03 (Bank Transfer/Digital Wallet)).| -| `discount` | `number` | - | Total amount of applicable discounts before taxes.| -| `totalSalesTax`| `number` | - | Sum of all sales tax amounts of line items.| -| `totalWithholdingTax`| `number` | - | Sum of all withhold tax amounts of line items.| -| `lineItems` | `array` | [LineItem schema ](#lineitem-schema) | Line items present in the compliance document.| -| `verificationCode` | `string` | - | Company's certificate used to generate digital signature.| -| `comments`| `string` | - | Comment/description.| +|Name|Type|Format|Description|Required|Optional| +|---|---|---|---|---|---| +| `issueDateTime` | `string` | YYYY-MM-DDTHH:mm:ssZ | Date and time when the document was created in the local timezone where it was issued.| Yes | - | +| `uuid`| `string` | - | Document UUID - field present in compliance document/Government doc unique id.| MX, PL | FR | +| `grossAmount` | `number` | - | Sum of amounts before discounts and taxes. | Yes | - | +| `currency` | `string` | `enum`: [`MXN`, `EUR`, `PLN`]| Currency used to express amounts (According to the ISO 4217 codes).| Yes | - | +| `exchangeRate` | `number` | - | Exchange Rate according to currency used. | FR, PL | MX | +| `netAmount`| `number` | - | Gross Amount – Discounts + VAT Taxes – Withholding Taxes.| Yes | - | +| `paymentMethod`| `string` | - | Specify the code of payment method - PUE - only one payment, PPD - payment done in partial payments, PIP - Initial payment and partialities.| - | Yes | +| `vendor` | `object` | [Vendor schema](#vendor-schema) | Details of the vendor.| Yes | - | +| `number`| `string` | - | Number/Supplier Document Id of the receipt.| FR, PL | MX | +| `formatVersion` | `string` | `enum`: [`3.3`, `4.0`]| Version of the compliance document.| - | Yes | +| `buyer`| `object` | [Buyer schema](#buyer-schema)| Details of the buyer.| - | Yes | +| `code` | `string` | - | Prefix of receipt, an alphanumeric field that can refer to a physical place (POS, branch, factory, warehouse, office, etc.) or any other criteria (like business, line of product, etc.) | - | Yes | +| `documentPostalCode`| `string` | - | Postal code of place of receipt issue.| - | Yes | +| `paymentType` | `string` | `enum`: [`Cash`, `Credit Card`, `Digital Wallet`] | Means of payment.| - | Yes | +| `discount` | `number` | - | Total amount of applicable discounts before taxes.| - | Yes | +| `totalSalesTax`| `number` | - | Sum of all sales tax amounts of line items.| - | Yes | +| `totalWithholdingTax`| `number` | - | Sum of all withhold tax amounts of line items.| - | Yes | +| `lineItems` | `array` | [LineItem schema](#lineitem-schema) | Line items present in the compliance document.| - | Yes | +| `verificationCode` | `string` | - | Company's certificate used to generate digital signature.| - | Yes | +| `comments`| `string` | - | Comment/description.| - | Yes | #### Vendor Schema -|Name|Type|Format|Description| -|---|---|---|---| -| `taxNumber`| `string` | - | **Required** - Taxpayer ID of the vendor.| -| `certificateNumber` | `string` | - | Company's certificate used to generate digital signature. | -| `name` | `string` | - | Name of receipt issuer.| -| `city` | `string` | - | City of receipt issuer.| -| `state` | `string` | - | State of receipt issuer. | -| `country` | `string` | - | Country of receipt issuer.| -| `phone`| `string` | - | Phone number of receipt issuer. | -| `addressLine`| `string` | - | AddressLine of receipt issuer. | +|Name|Type|Format|Description|Required|Optional| +|---|---|---|---|---|---| +| `name` | `string` | - | Name of receipt issuer.| Yes | - | +| `country` | `string` | - | Country of receipt issuer.| Yes | - | +| `taxNumber`| `string` | - | Taxpayer ID of the vendor.| PL, FR | MX | +| `certificateNumber` | `string` | - | Company's certificate used to generate digital signature. | - | Yes | +| `city` | `string` | - | City of receipt issuer.| - | Yes | +| `state` | `string` | - | State of receipt issuer. | - | Yes | +| `phone`| `string` | - | Phone number of receipt issuer. | - | Yes | +| `addressLine`| `string` | - | AddressLine of receipt issuer. | - | Yes | #### Buyer Schema -|Name|Type|Format|Description| -|---|---|---|---| -| `taxNumber` | `string` | - | **Required** - Buyer Tax Number.| -| `PostalCode` | `string` | - | Postal code of tax domicile of recipient.| -| `name` | `string` | - | Buyer Name. | +|Name|Type|Format|Description|Required|Optional| +|---|---|---|---|---|---| +| `taxNumber` | `string` | - | Buyer Tax Number.| Yes | - | +| `name` | `string` | - | Buyer Name. | - | Yes | +| `PostalCode` | `string` | - | Postal code of tax domicile of recipient.| - | Yes | #### LineItem Schema -|Name|Type|Format|Description| -|---|---|---|---| -| `amount` | `number` | - | **Required** - Total amount of goods or service. | -| `description`| `string` | - | Product Description.| -| `productCode`| `string` | - | **Required** - Key of product or service covered - 10101502 (Dogs), 10101506 (Horses) (Catalogue: c_ClaveProdServ)| +|Name|Type|Format|Description|Required|Optional| +|---|---|---|---|---|---| +| `amount` | `number` | - | Total amount of goods or service. | Yes | - | +| `description`| `string` | - | Product Description.| Yes | - | +| `productCode`| `string` | - | Key of product or service covered - 10101502 (Dogs), 10101506 (Horses) (Catalogue: c_ClaveProdServ)| - | Yes |