Obter todas as faturas

GET https://.account-name.krzlabs.io/api/v1/invoices

Realiza a leitura de todas as faturas.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Respostas

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
id	ObjectId	Identificador único da fatura	not required	false
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

Exemplo de resposta em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "id": "64c8b2f9a7d3c5e2b4f0a1c9",
        "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"
        }
    }]
}

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema