Skip to main content
GET
Consultar Nota

Authorizations

Authorization
string
header
required

Authorization: Bearer nx_... com uma Chave de API, ou o JWT de sessão do painel (Supabase Auth). As duas credenciais representam a mesma Conta.

Path Parameters

nota_id
string<uuid>
required

Id da Nota, devolvido na criação.

Response

Successful Response

id
string<uuid>
required

Id da Nota no NotasX.

prestador_id
string<uuid>
required

Prestador que emite.

ambiente
enum<string>
required

Ambiente do Prestador quando a Nota foi criada. Não muda.

Available options:
homologacao,
producao
status
enum<string>
required

pendente → processando → emitida, rejeitada ou falhou (finais). cancelada e substituida são reservados para eventos futuros.

Available options:
pendente,
processando,
emitida,
rejeitada,
falhou,
cancelada,
substituida
chave_idempotencia
string
required

O Idempotency-Key do pedido que criou a Nota.

competencia
string<date>
required

Data de Competência informada na criação.

dados
Servico · object
required

O serviço prestado e o valor.

tomador
Tomador · object | null
required

Quem contratou o serviço. Opcional: a Sefin aceita DPS sem Tomador.

numero_dps
integer | null
required

Número da DPS, reservado no primeiro envio e reaproveitado nas novas tentativas.

chave_acesso
string | null
required

Chave de acesso da NFS-e (50 dígitos). Só existe com emitida.

numero_nfse
string | null
required

Número da NFS-e atribuído pela Sefin.

resultado_codigo
string | null
required

Em rejeitada, os códigos da Sefin (ex.: E0123); em falhou, impedimento ou sem_resposta.

resultado_mensagem
string | null
required

Explicação do resultado, quando houver.

criada_em
string<date-time>
required

Quando a Nota foi criada.

atualizada_em
string<date-time>
required

Última mudança (de status ou de resultado).