Notas

Detalhe de uma nota

Busca um documento por id ou por chave de acesso. Devolve mais campos que a listagem (destinatário, natureza da operação, protocolo de autorização, finalidade) e aceita blocos opcionais via incluir=tributos,referencias,etiquetas,duplicatas,cfop.

get/v1/notas/{id}

Request

  • Base URL: https://api.notaguard.com.br
  • URL: https://api.notaguard.com.br/v1/notas/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

id (UUID) devolvido na listagem ou a chave de acesso do documento. Os dois resolvem para o mesmo documento: se o seu sistema já tem a chave, use a chave direto, sem buscar o UUID antes.

Query parameters

incluirstring

Blocos opcionais a incluir na resposta, separados por vírgula: incluir=tributos,etiquetas. Bloco não pedido não aparece na resposta. Valores aceitos: tributos, referencias, etiquetas, duplicatas, cfop.

Response

Documento encontrado.

idstring uuid required

Identificador interno, estável.

chavestring required

Chave de acesso do documento, somente dígitos. O tamanho varia por tipo: 44 em NF-e e NFC-e, 50 na NFS-e do padrão nacional, 26 em alguns municípios.

tipo'NFe' | 'NFCe' | 'NFSe' required
numerointeger nullable required

Número do documento.

seriestring nullable required
vinculo'emissor' | 'receptor' | 'transportador' | 'terceiro' | 'indefinido' required

Vínculo da sua empresa com este documento (mesmo termo do painel). indefinido quando ainda não foi determinado, o que é comum em documentos que só têm resumo; dá para filtrar por ele na listagem.

valornumber nullable required

Valor total. null quando o XML completo ainda não chegou. Nulo significa desconhecido, não zero.

status'autorizada' | 'resumida' | 'cancelada' | 'denegada' | 'desconhecido' required

Situação do documento.

  • autorizada: Documento autorizado, com XML completo disponível.
  • resumida: Só existe o resumo do documento, sem o XML completo: valor e data_emissao geralmente vêm null e xml_completo_disponivel é false (o XML de resumo continua disponível para download). Em nota recebida é um estado transitório, que dura até o documento completo chegar; em nota emitida pela sua empresa é permanente, porque a SEFAZ não devolve pela distribuição o XML da própria emissão. Veja a seção "Documentos que só têm resumo".
  • cancelada: Documento cancelado na SEFAZ.
  • denegada: Emissão denegada pela SEFAZ.
  • desconhecido: A SEFAZ não informou situação reconhecível para o documento.
status_motivostring nullable required

Descrição devolvida pela SEFAZ para o status atual.

manifestacao'ciencia' | 'confirmacao' | 'desconhecimento' | 'nao_realizada' nullable required

Manifestação do destinatário registrada na SEFAZ. Apenas NF-e.

natureza_operacaostring nullable required

Natureza da operação declarada no XML (natOp). Apenas NF-e e NFC-e.

cfopstring[] nullable

Presente apenas com incluir=cfop: CFOPs distintos dos itens do documento, em ordem crescente. Um documento pode ter mais de um (medido em produção: 10% têm; ex.: 5102 e 5405 na mesma nota). null quando o CFOP não é conhecido: documento sem XML completo processado, ou NFS-e (serviço não tem CFOP). O CFOP por item está em GET /v1/notas/{id}/itens.

data_emissaostring date-time nullable required

Data e hora de emissão (ISO 8601, UTC). null em documentos que só têm resumo.

data_competenciastring nullable required

Competência (AAAA-MM-DD). Apenas NFS-e.

data_recebimentostring date-time nullable required

Quando a SEFAZ disponibilizou o documento para a sua empresa (ISO 8601, UTC). Apenas NF-e e NFC-e.

origem'monitored' | 'imported' | 'fisco_facil_rj' | 'sae_sp' required

monitored: capturado automaticamente na SEFAZ. imported: XML enviado manualmente. fisco_facil_rj: NFC-e obtida via Fisco Fácil RJ. sae_sp: NFC-e emitida pela empresa, obtida no serviço de apoio à escrituração da SEFAZ-SP; vem autorizada, com XML e protocolo, mas sem status_codigo (a SEFAZ-SP não devolve o código de status), e ainda sem PDF.

xml_completo_disponivelboolean required

Se true, o XML completo autorizado está disponível e o PDF pode ser gerado. Se false, GET /v1/notas/{id}/xml ainda pode devolver o XML de resumo da SEFAZ, mas GET /v1/notas/{id}/pdf responde 409 xml_indisponivel. Use este campo como filtro (?xml_completo_disponivel=true) em vez de descobrir documento a documento.

criada_emstring date-time required

Quando o documento entrou no NotaGuard (ISO 8601, UTC). Nunca nulo.

atualizada_emstring date-time required

Última alteração no documento (ISO 8601, UTC). Nunca nulo.

Changes

No recorded changes to this operation across all 1 revision of this API.