VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/ERP Fiscal, contábil e custos

Notas fiscais emitidas

Lista e consulta as notas fiscais registradas para o seller.

Listar notas

Lê o registro de notas fiscais emitidas em nome do seller, da mais nova para a mais antiga. Esta API só lê: ela não tem rota para emitir nota de seller. A lista pode estar vazia mesmo que você emita NFC-e no PDV, porque a nota do PDV fica ligada à venda (veja Recibo).

GET/api/v1/vendor/erp/fiscal/invoicesSeller

Lista as notas fiscais do seller

Parâmetros de consulta

statusstring
pendingauthorizedcancellederrordenied
Situação. Valor desconhecido devolve lista vazia.
order_iduuid
Só notas deste pedido.
fromstring
Criação a partir de (data ou data e hora).
tostring
Criação até. Data sem hora vale meia-noite do início do dia.
pageintegerpadrão: 1
Página, a partir de 1. Valor inválido ou menor que 1 volta para 1.
per_pageintegerpadrão: 50
Itens por página, de 1 a 200. Fora dessa faixa vale o padrão.

Exemplo de requisição: Listar notas

bash
curl "$BASE_URL/api/v1/vendor/erp/fiscal/invoices?status=authorized" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Listar notas

200Notas
json
{
  "invoices": [
    {
      "id": "3a4b5c6d-7e8f-4091-a2b3-c4d5e6f70819",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "order_id": "87fdfd05-07bf-4031-a468-219fc35e4e39",
      "number": "1043",
      "series": "1",
      "status": "authorized",
      "total_cents": 11980,
      "issued_at": "2026-10-11T14:30:00Z",
      "xml_url": "https://example.com/nfe/1043.xml",
      "pdf_url": "https://example.com/nfe/1043.pdf",
      "created_at": "2026-10-11T14:30:00Z",
      "updated_at": "2026-10-11T14:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

invoicesarray

Notas da página.

iduuid
Id da nota.
vendor_iduuid
Seller dono.
order_iduuid
Pedido relacionado. Ausente em nota avulsa.
numberstring
Número da nota.
seriesstring
Série.
statusstring
pendingauthorizedcancellederrordenied
Situação.
total_centsinteger
Total da nota em centavos.
issued_atdatetime
Emissão. Ausente se ainda não emitida.
xml_urlstring
Link do XML. Vazio se não há.
pdf_urlstring
Link do PDF (DANFE). Vazio se não há.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.
totalinteger
Total que atende ao filtro.

Erros: Listar notas

StatusQuandoCorpo
500Um filtro de id não é um UUID válido (a plataforma devolve 500, não 400).{"error":"failed to list invoices","detail":"o valor \"xyz\" não é um uuid válido. Envie o identificador completo, com os 36 caracteres e os hífens. Corrija o campo e reenvie."}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Consultar nota

GET/api/v1/vendor/erp/fiscal/invoices/{id}Seller

Consulta uma nota fiscal

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da nota.

Exemplo de requisição: Consultar nota

bash
curl "$BASE_URL/api/v1/vendor/erp/fiscal/invoices/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Consultar nota

200Nota
json
{
  "id": "3a4b5c6d-7e8f-4091-a2b3-c4d5e6f70819",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "order_id": "87fdfd05-07bf-4031-a468-219fc35e4e39",
  "number": "1043",
  "series": "1",
  "status": "authorized",
  "total_cents": 11980,
  "issued_at": "2026-10-11T14:30:00Z",
  "xml_url": "https://example.com/nfe/1043.xml",
  "pdf_url": "https://example.com/nfe/1043.pdf",
  "created_at": "2026-10-11T14:30:00Z",
  "updated_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id da nota.
vendor_iduuid
Seller dono.
order_iduuid
Pedido relacionado. Ausente em nota avulsa.
numberstring
Número da nota.
seriesstring
Série.
statusstring
pendingauthorizedcancellederrordenied
Situação.
total_centsinteger
Total da nota em centavos.
issued_atdatetime
Emissão. Ausente se ainda não emitida.
xml_urlstring
Link do XML. Vazio se não há.
pdf_urlstring
Link do PDF (DANFE). Vazio se não há.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Consultar nota

StatusQuandoCorpo
404A nota não existe ou é de outro seller.{"error":"invoice not found"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Veja também

  • Perfil fiscal
Anterior
Perfil fiscal
Próxima
Plano de contas
Nesta página
  • Listar notas
  • Exemplo de requisição: Listar notas
  • Resposta: Listar notas
  • Erros: Listar notas
  • Consultar nota
  • Exemplo de requisição: Consultar nota
  • Resposta: Consultar nota
  • Erros: Consultar nota
  • Veja também