Os Documentos Fiscais no sistema da YOM são os registros de faturas, recibos, notas de crédito e débito relacionadas a Pedidos concluídos pelos Comércios. Inclui o detalhe dos seus Produtos relacionados.
GET /api/tax-documents
ARQUIVO <fecha>_<hora>_tax-document.csv
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplos |
|---|---|---|---|---|
documentId |
📝 Texto | 🟢 Obrigatório | Identificador único do Documento definido pelo cliente. | “CRED001” |
governmentDocumentId |
📝 Texto | 🟢 Obrigatório | Identificador único do Documento emitido pela entidade governamental. | "123456789" |
parentDocumentId |
📝 Texto | ⚪ Opcional | Identificador do documento pai. | |
*\*Aplica-se a *credit_note e debit_note |
||||
"INV001" |
||||
type |
📝 Texto | 🟢 Obrigatório | Tipo de documento. | |
credit note → Nota de crédito |
||||
invoice → Fatura |
||||
debit note → Nota de débito |
||||
bill → Recibo |
||||
credit note |
||||
invoice |
||||
debit note |
||||
bill |
||||
wallet |
||||
commerceId |
📝 Texto | 🟢 Obrigatório | Identificador único do Comércio. | "COM001" |
dueDate |
📝 Texto | 🟢 Obrigatório | Data de vencimento do documento no formato ISO 8601. | "2024-07-15T00:00:00.000Z" |
date |
📝 Texto | 🟢 Obrigatório | Data de criação do documento no formato ISO 8601. | "2024-07-01T00:00:00.000Z" |
pricing |
🔢 Objeto → Pricing | 🟢 Obrigatório | Valor total do Documento. | 1000.00 |
sellerId |
📝 Texto | ⚪ Opcional | Identificador único do vendedor associado ao Documento. | "SELLER001" |
collectionStatus |
📝 Texto | ⚪ Opcional | Estado do Documento. | |
in_collection → O Documento está atualmente em processo de cobrança. |
||||
collected → O Documento foi cobrado com sucesso em um processo de cobrança. |
||||
not_in_collection →O Documento não está em um processo de cobrança ativo. |
in_collection |
|||
collected |
||||
not_in_collection |
O objeto pricing contém os detalhes dos custos associados ao Documento sobre o qual se aplicam cálculos de preço**.** Inclui o subtotal, descontos, impostos e o valor total.
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplos |
|---|---|---|---|---|
subtotalAmount |
🔢 Número | 🟢 Obrigatório | Valor antes de aplicar descontos e impostos. | 1000 |
discountAmount |
🔢 Número | ⚪ Opcional | Valor total dos descontos aplicados. | 100 |
shippingAmount |
🔢 Número | ⚪ Opcional | Valor total dos custos de envio aplicados. | 50 |
taxAmount |
🔢 Número | ⚪ Opcional | Valor total dos impostos aplicados. | 190 |
totalAmount |
🔢 Número | 🟢 Obrigatório | Valor total após aplicar descontos, impostos e custos de envio. | 1140 |
currentAmount |
🔢 Número | ⚪ Opcional | Valor restante a pagar | 500 |
taxes |
🔡 Lista de Objetos → Tax | ⚪ Opcional | Detalhe dos impostos aplicados ao total. | [{"code": "IVACL", "name": "IVA", "rate": 0.19}] |
discounts |
🔡 Lista de Objetos → Discount | ⚪ Opcional | Detalhe dos descontos aplicados ao total. |
A gestão correta dos Documentos Fiscais garante um controle efetivo das dívidas e obrigações financeiras dos clientes da YOM.
Esses campos permitem uma documentação clara e precisa de todos os documentos pendentes, facilitando a gestão de contas a pagar e a transparência nas transações financeiras da YOM.