Faturas

Field Type Description Optional Searchable
order_id ObjectId Identificador único do pedido not required false
order_code string Código interno do pedido not required false
order_external_code string Código externo do pedido not required false
status enum(InvoiceStatusEnum) Status atual da fatura required false
xml string Arquivo XML da fatura not required false
pdf string Arquivo PDF da fatura not required false
billing_address
object Endereço de cobrança not required false
key string Chave da nota fiscal not required false
serie string Série da nota fiscal not required false
number string Número da nota fiscal not required false
value number Valor total da fatura not required false
issued_at date Data de emissão da fatura required false
authorized_at date Data de autorização da fatura not required false
metadata object Informações adicionais da fatura not required false

InvoiceStatusEnum de status

Chaves Valores
DRAFT 'DRAFT'
PENDING_SUBMISSION 'PENDING_SUBMISSION'
PROCESSING 'PROCESSING'
AUTHORIZED 'AUTHORIZED'
REJECTED 'REJECTED'
CANCELED 'CANCELED'
DENIED 'DENIED'
CONTINGENCY 'CONTINGENCY'
VOIDED_RANGE 'VOIDED_RANGE'
SUBMISSION_ERROR 'SUBMISSION_ERROR'
ISSUED 'ISSUED'
EDITING 'EDITING'
PAID 'PAID'
PARTIALLY_PAID 'PARTIALLY_PAID'
OVERDUE 'OVERDUE'
Exemplo em JSON
{   
    "order_id": "64c8b2f9a7d3c5e2b4f0a1c9",
    "order_code": "ORD-001",
    "order_external_code": "EXT-789",
    "status": "DRAFT",
    "xml": "<xml>...</xml>",
    "pdf": "https://example.com/invoice.pdf",
    "billing_address": {
        "zipcode": "12345-678",
        "street": "Rua Exemplo",
        "city": "São Paulo",
        "state": "SP",
        "number": "100",
        "country": "Brasil",
        "complement": "Apto 101",
        "neighborhood": "Centro",
        "coordinates": [-23.55052, -46.633308],
        "contact_name": "João Silva",
        "contact_phone": "+55 11 99999-9999"
    },
    "key": "NFe35180730290856000162550010000000011000000016",
    "serie": "1",
    "number": "1000",
    "value": 1500.75,
    "issued_at": "2025-08-12T10:00:00Z",
    "authorized_at": "2025-08-12T11:00:00Z",
    "metadata": {
        "tipo": "nota fiscal",
        "observacao": "Pagamento à vista"
    }
}

Copyright © 2025 kruzer | All Rights Reserved