Tax Documents in the YOM system are the records of invoices, receipts, credit notes and debit notes tied to Orders completed by Commerces. They include the details of their related Products.
GET /api/tax-documents
FILE <fecha>_<hora>_tax-document.csv
| Field | Type | Requirement | Description | Examples |
|---|---|---|---|---|
documentId |
📝 Text | 🟢 Required | Unique identifier of the Document defined by the customer. | “CRED001” |
governmentDocumentId |
📝 Text | 🟢 Required | Unique identifier of the Document issued by the government entity. | "123456789" |
parentDocumentId |
📝 Text | ⚪ Optional | Parent document identifier. | |
*\*Applies to *credit_note and debit_note |
||||
"INV001" |
||||
type |
📝 Text | 🟢 Required | Document type. | |
credit note → Credit note |
||||
invoice → Invoice |
||||
debit note → Debit note |
||||
bill → Receipt |
||||
credit note |
||||
invoice |
||||
debit note |
||||
bill |
||||
wallet |
||||
commerceId |
📝 Text | 🟢 Required | Unique identifier of the Commerce. | "COM001" |
dueDate |
📝 Text | 🟢 Required | Document due date in ISO 8601 format. | "2024-07-15T00:00:00.000Z" |
date |
📝 Text | 🟢 Required | Document creation date in ISO 8601 format. | "2024-07-01T00:00:00.000Z" |
pricing |
🔢 Object → Pricing | 🟢 Required | Total amount of the Document. | 1000.00 |
sellerId |
📝 Text | ⚪ Optional | Unique identifier of the seller associated with the Document. | "SELLER001" |
collectionStatus |
📝 Text | ⚪ Optional | Document status. | |
in_collection → The Document is currently in the collections process. |
||||
collected → The Document was successfully collected in a collections process. |
||||
not_in_collection →The Document is not in an active collections process. |
in_collection |
|||
collected |
||||
not_in_collection |
The pricing object contains the details of the costs associated with the Document to which price calculations are applied**.** It includes the subtotal, discounts, taxes and the total amount.
| Field | Type | Requirement | Description | Examples |
|---|---|---|---|---|
subtotalAmount |
🔢 Number | 🟢 Required | Amount before discounts and taxes are applied. | 1000 |
discountAmount |
🔢 Number | ⚪ Optional | Total amount of the discounts applied. | 100 |
shippingAmount |
🔢 Number | ⚪ Optional | Total amount of the shipping costs applied. | 50 |
taxAmount |
🔢 Number | ⚪ Optional | Total amount of the taxes applied. | 190 |
totalAmount |
🔢 Number | 🟢 Required | Total amount after discounts, taxes and shipping costs are applied. | 1140 |
currentAmount |
🔢 Number | ⚪ Optional | Remaining amount to pay | 500 |
taxes |
🔡 List of Objects → Tax | ⚪ Optional | Details of the taxes applied to the total. | [{"code": "IVACL", "name": "IVA", "rate": 0.19}] |
discounts |
🔡 List of Objects → Discount | ⚪ Optional | Details of the discounts applied to the total. |
Proper management of Tax Documents ensures effective control over the debts and financial obligations of YOM customers.
These fields allow clear, accurate documentation of every outstanding document, making accounts payable management and transparency in YOM financial transactions easier.