Documentos Tributarios

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.

Carpeta y nombre de archivos

Entidad → tax-document

 /<nombre_cliente>
	/production
		/load
			/tax-document
				/all
					20240201_180000_tax-document.csv
					...
				/created
					...
				/updated
					...
	/development
		...

Campos

TaxDocument

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

Pricing

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

Ejemplo

{
  "documentId": "CRED001",
  "governmentDocumentId": "123456789",
  "parentDocumentId": "INV001",
  "type": "credit_note",
  "commerceId": "COM001",
  "dueDate": "2024-07-15T00:00:00.000Z",
  "date": "2024-07-01T00:00:00.000Z",
  "pricing": {
    "subtotalAmount": 1000.00,
    "taxAmount": 190.00,
    "totalAmount": 1160.00,
    "taxes": [
      {
        "code": "IVA",
        "name": "Impuesto al Valor Agregado",
        "rate": 0.19,
        "amount": 190.00
      }
    ]
  },
  "sellerId": "SELLER001",
  "collectionStatus": "in_collection"
}

CSV Aplanado

documentId;governmentDocumentId;parentDocumentId;type;commerceId;dueDate;date;pricing_subtotalAmount;pricing_taxAmount;pricing_totalAmount;pricing_taxes_0_code;pricing_taxes_0_name;pricing_taxes_0_rate;pricing_taxes_0_amount;sellerId;collectionStatus
CRED001;123456789;INV001;credit_note;COM001;2024-07-15T00:00:00.000Z;2024-07-01T00:00:00.000Z;1000.0;190.0;1160.0;IVA;Impuesto al Valor Agregado;0.19;190.0;SELLER001;in_collection

Pasos anteriores

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Pagos

</aside>

Siguientes pasos

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Promociones

</aside>

Tabla de contenidos