Los Documentos Tributarios en el sistema de YOM son los registros de facturas, boletas, notas de crédito y débito relacionadas a Ordenes completadas por los Comercios. Incluye el detalle de sus Productos relacionados.
GET /api/tax-documents
ARCHIVO <fecha>_<hora>_tax-document.csv
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
documentId |
📝 Texto | 🟢 Requerido | Identificador único del Documento definido por el cliente. | “CRED001” |
governmentDocumentId |
📝 Texto | 🟢 Requerido | Identificador único del Documento emitido por la entidad gubernamental. | "123456789" |
parentDocumentId |
📝 Texto | ⚪ Opcional | Identificador del documento padre. | |
*\*Aplica para *credit_note y debit_note |
||||
"INV001" |
||||
type |
📝 Texto | 🟢 Requerido | Tipo de documento. | |
credit note → Nota de crédito |
||||
invoice → Factura |
||||
debit note → Nota de débito |
||||
bill → Boleta |
||||
credit note |
||||
invoice |
||||
debit note |
||||
bill |
||||
wallet |
||||
commerceId |
📝 Texto | 🟢 Requerido | Identificador único del Comercio. | "COM001" |
dueDate |
📝 Texto | 🟢 Requerido | Fecha de vencimiento del documento en formato ISO 8601. | "2024-07-15T00:00:00.000Z" |
date |
📝 Texto | 🟢 Requerido | Fecha de creación del documento en formato ISO 8601. | "2024-07-01T00:00:00.000Z" |
pricing |
🔢 Objeto → Pricing | 🟢 Requerido | Monto total del Documento. | 1000.00 |
sellerId |
📝 Texto | ⚪ Opcional | Identificador único del vendedor asociado al Documento. | "SELLER001" |
collectionStatus |
📝 Texto | ⚪ Opcional | Estado del Documento. | |
in_collection → El Documento está actualmente en proceso de cobranza. |
||||
collected → El Documento fue cobrado exitosamente en un proceso de cobranza. |
||||
not_in_collection →El Documento no está en un proceso de cobranza activo. |
in_collection |
|||
collected |
||||
not_in_collection |
El objeto pricing contiene los detalles de los costos asociados al Documento sobre la cual se apliquen cálculos de precio**.** Incluye el subtotal, descuentos, impuestos y el monto total.
| Campo | Tipo | Caracter | Descripción | Ejemplos |
|---|---|---|---|---|
subtotalAmount |
🔢 Número | 🟢 Requerido | Monto antes de aplicar descuentos e impuestos. | 1000 |
discountAmount |
🔢 Número | ⚪ Opcional | Monto total de los descuentos aplicados. | 100 |
shippingAmount |
🔢 Número | ⚪ Opcional | Monto total de los costos de envío aplicados. | 50 |
taxAmount |
🔢 Número | ⚪ Opcional | Monto total de los impuestos aplicados. | 190 |
totalAmount |
🔢 Número | 🟢 Requerido | Monto total después de aplicar descuentos, impuestos y costos de envío. | 1140 |
currentAmount |
🔢 Número | ⚪ Opcional | Monto restante a pagar | 500 |
taxes |
🔡 Lista de Objetos → Tax | ⚪ Opcional | Detalle de los impuestos aplicados al total. | [{"code": "IVACL", "name": "IVA", "rate": 0.19}] |
discounts |
🔡 Lista de Objetos → Discount | ⚪ Opcional | Detalle de los descuentos aplicados al total. |
La correcta gestión de Documentos Tributarios asegura un control efectivo de las deudas y obligaciones financieras de los clientes de YOM.
Estos campos permiten una documentación clara y precisa de todos los documentos pendientes, facilitando la gestión de cuentas por pagar y la transparencia en las transacciones financieras de YOM.