Skip to content

EIFRCN-2131: DCG PUT API- Align Mandatory Fields #1834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
swarooprath396 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

EIFRCN-2131: DCG PUT API- Align Mandatory Fields #1834

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 48 additions & 48 deletions ...i-reference/document-compliance-gateway/V4.document-compliance-gateway.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,64 +253,64 @@ Content-Type: application/json

### <a name="DigitalTaxDocument-Schema"></a>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 |

#### <a name="DocumentData-Schema"></a>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 | - |

@majumdergaurab-coder majumdergaurab-coder Jul 2, 2026 •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing INR, USD, and the open-ended ... could break partners in other countries if they ever onboard. This should be confirmed as intentional.

relevant with this comment

| `exchangeRate` | `number` | - | Exchange Rate according to currency used. | FR, PL | MX |

@majumdergaurab-coder majumdergaurab-coder Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is currency-dependent logic disguised as country-dependent, which is wrong: if an MX partner sends a transaction in USD, exchangeRate would also be required. Please check this point. Its in Discrepancy with Swagger May be.

@tarunkhatri20 tarunkhatri20 Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exchange rate was hence to be considered optional as it is case to case basis for a given country.

| `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 |

@majumdergaurab-coder majumdergaurab-coder Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old markdown had: enum: ["01, 02, 03"], description: "01 (Cash), 02 (Cheque), 03 (Bank Transfer/Digital Wallet)"

New markdown has: enum: [Cash, Credit Card, Digital Wallet]

Two problems:

Cheque was replaced by Credit Card — these are different payment methods, not a rename
Bank Transfer/Digital Wallet was split and only Digital Wallet remains

Is this expected?

| `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 |

#### <a name="vendor-schema"></a> 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 |


#### <a name="buyer-schema"></a> 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 |

#### <a name="lineitem-schema"></a> 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 |