--- title: "Detalhe de uma nota" method: GET path: "/v1/notas/{id}" tags: ["Notas"] --- # Detalhe de uma nota `GET /v1/notas/{id}` ## Request - Base URL: `https://api.notaguard.com.br` - URL: `https://api.notaguard.com.br/v1/notas/{id}` - Auth: HTTP bearer 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`. ## Path parameters - `id` string, required ## Query parameters - `incluir` string: 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 `200` Documento encontrado. - NotaDetalhe - `id` string, uuid, required: Identificador interno, estável. - `chave` string, 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 - `numero` integer, nullable, required: Número do documento. - `serie` string, nullable, required - `emissor` object, required - `documento` string, nullable, required: CNPJ (14 dígitos) ou CPF (11 dígitos), somente dígitos. O NotaGuard suporta empresa pessoa física, por isso o campo aceita os dois. - `nome` string, nullable, required: Razão social ou nome do emissor. - `destinatario` object, nullable, required: A outra parte do documento: destinatário na NF-e e NFC-e, tomador na NFS-e. `null` quando ainda não conhecido. - `documento` string, nullable, required: CNPJ (14 dígitos) ou CPF (11 dígitos), somente dígitos. O NotaGuard suporta empresa pessoa física, por isso o campo aceita os dois. - `nome` string, nullable, required: Razão social ou nome. Em NF-e depende da extração completa do XML, então pode vir `null` mesmo com o documento presente. - `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. - `valor` number, 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_motivo` string, 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_operacao` string, nullable, required: Natureza da operação declarada no XML (`natOp`). Apenas NF-e e NFC-e. - `cfop` string[], 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_emissao` string, date-time, nullable, required: Data e hora de emissão (ISO 8601, UTC). `null` em documentos que só têm resumo. - `data_competencia` string, nullable, required: Competência (AAAA-MM-DD). Apenas NFS-e. - `data_recebimento` string, 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_disponivel` boolean, 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_em` string, date-time, required: Quando o documento entrou no NotaGuard (ISO 8601, UTC). Nunca nulo. - `atualizada_em` string, date-time, required: Última alteração no documento (ISO 8601, UTC). Nunca nulo. - `nfe` object, nullable, required: Campos específicos de NF-e/NFC-e. `null` em NFS-e. - `finalidade` string, nullable, required: Finalidade de emissão: `normal`, `complementar`, `ajuste` ou `devolucao`. - `tipo_operacao` string, nullable, required: `entrada` ou `saida`, do ponto de vista do emissor. - `emissor_uf` string, nullable, required - `emissor_municipio` string, nullable, required: Código IBGE do município do emissor. - `destinatario_uf` string, nullable, required - `protocolo` object, nullable, required: Protocolo de autorização da SEFAZ. - `numero` string, nullable, required: Número do protocolo de autorização. - `autorizada_em` string, nullable, required: Momento em que a SEFAZ autorizou o documento (ISO 8601, UTC). - `ambiente` string, nullable, required: `producao` ou `homologacao`. - `manifestacao` object, nullable, required: Detalhe da manifestação do destinatário, quando registrada. - `status` string, nullable, required - `protocolo` string, nullable, required - `data` string, nullable, required - `nfse` object, nullable, required: Campos específicos de NFS-e. `null` em NF-e/NFC-e. - `descricao_servico` string, nullable, required: Descrição do serviço prestado. - `codigo_tributacao_nacional` string, nullable, required: Código de tributação nacional do serviço (padrão nacional da NFS-e). - `local_prestacao_codigo` string, nullable, required: Código IBGE do município de prestação. - `inscricao_municipal_prestador` string, nullable, required - `valor_liquido` number, nullable, required: Valor líquido após retenções. - `tributos` union: Presente apenas com `incluir=tributos`. Formato varia por tipo de documento; `null` quando a extração completa do XML não existe. - object - `total_tributos` number, nullable, required: Valor aproximado total de tributos (`vTotTrib`), quando informado. - `icms` number, nullable, required - `icms_st` number, nullable, required - `icms_desonerado` number, nullable, required - `fcp` number, nullable, required - `ipi` number, nullable, required - `pis` number, nullable, required - `cofins` number, nullable, required - `ibs` number, nullable, required: IBS (reforma tributária), quando presente no XML. - `cbs` number, nullable, required: CBS (reforma tributária), quando presente no XML. - `retencoes` object, required - `pis` number, nullable, required - `cofins` number, nullable, required - `csll` number, nullable, required - `irrf` number, nullable, required - `inss` number, nullable, required - object - `iss` number, nullable, required - `iss_retido` number, nullable, required - `total_retencoes` number, nullable, required - `ibs` number, nullable, required - `cbs` number, nullable, required - `retencoes` object, required - `pis` number, nullable, required - `cofins` number, nullable, required - `csll` number, nullable, required - `inss` number, nullable, required - `irrf` number, nullable, required - `referencias` object[]: Presente apenas com `incluir=referencias`. - `sentido` 'referencia' | 'referenciada_por', required: `referencia`: esta nota aponta para a outra. `referenciada_por`: a outra aponta para esta. - `chave` string, required: Chave de acesso do outro documento. - `tipo` string, nullable, required: Tipo do outro documento (ex.: `nfe`, `cte`). - `relacao` string, required: Natureza do vínculo. Valores atuais: `NFref`, `devolucao`, `substituicao_nfse`, `cte_transporta_nf`. - `nota_id` string, uuid, nullable, required: `id` do outro documento quando ele também está no acervo da sua empresa; use em `GET /v1/notas/{id}`. `null` quando o documento referenciado não está no NotaGuard. - `etiquetas` object[]: Presente apenas com `incluir=etiquetas`. - `etiqueta` string, required: Slug da etiqueta (mesmo valor de `/v1/etiquetas`). - `nome` string, required - `tipo` 'single_choice' | 'multi_choice' | 'boolean' | 'number' | 'text' | 'date', required - `valor` unknown - `valor_personalizado` string, nullable, required: Valor livre digitado no painel, quando a etiqueta permite. - `atualizada_em` string, date-time, required: Última alteração desta marcação. - `duplicatas` object[]: Presente apenas com `incluir=duplicatas`. - `parcela` string, nullable, required: Número da duplicata (`nDup`). - `vencimento` string, nullable, required: Data de vencimento (AAAA-MM-DD). - `valor` number, nullable, required - `situacao` string, required: Situação no contas a pagar do NotaGuard: `rascunho`, `pendente`, `paga`, `vencida` ou `cancelada`. - `pago_em` string, nullable, required - `valor_pago` number, nullable, required - `forma_pagamento` string, nullable, required: Forma de pagamento declarada no XML. ## Other responses - `400`: Parâmetro inválido ou cursor corrompido. - `401`: Chave ausente, inválida, revogada ou expirada. - `403`: Escopo insuficiente ou plano sem acesso via API. - `404`: Documento não encontrado nesta empresa. - `429`: Limite de requisições excedido. - `500`: Erro interno. --- [API](https://skmtc.dev/notaguard/apis/api-notaguard.md) · [All operations](https://skmtc.dev/notaguard/apis/api-notaguard/llms.txt) · [OpenAPI document](https://skmtc.dev/notaguard/apis/api-notaguard/revisions/118f819f30d6?raw)