---
updatedAt: 2026-07-30T14:51:22.000Z
agentTools:
projectIndex: https://doc.focusnfe.com.br/llms.txt
---
# Consultar por chave
Este endpoint possibilita a consulta individual de notas já recebidas, informando sua chave de acesso. Como retorno você receberá os campos descritos nos exemplos abaixo, de acordo com o status da nota.
# OpenAPI definition
```json
{
"openapi": "3.0.3",
"info": {
"title": "NFe Recebidas",
"version": "2.0.0",
"contact": {
"name": "Focus NFe Suporte",
"email": "suporte@focusnfe.com.br"
},
"license": {
"name": "Proprietary",
"url": "https://focusnfe.com.br"
}
},
"servers": [
{
"url": "https://api.focusnfe.com.br/v2",
"description": "Servidor de Produção"
},
{
"url": "https://homologacao.focusnfe.com.br/v2",
"description": "Servidor de Homologação"
}
],
"security": [
{
"BasicAuth": []
}
],
"tags": [
{
"name": "NFe Recebidas",
"description": "Operações relacionadas às NFe recebidas e manifestação do destinatário (MDe)."
}
],
"paths": {
"/nfes_recebidas/{chave}": {
"get": {
"tags": [
"NFe Recebidas"
],
"summary": "Consultar por chave",
"description": "Este endpoint possibilita a consulta individual de notas já recebidas, informando sua chave de acesso. Como retorno você receberá os campos descritos nos exemplos abaixo, de acordo com o status da nota.\n",
"operationId": "consultar_nfe_recebida_individual",
"parameters": [
{
"name": "chave",
"in": "path",
"required": true,
"description": "Chave de acesso da NFe",
"schema": {
"type": "string",
"example": "35122225222278000855550010000002821510931504"
}
},
{
"name": "cnpj",
"in": "query",
"required": false,
"description": "CNPJ da empresa recebedora, utilizado para desambiguar em caso de múltiplas empresas com a mesma chave",
"schema": {
"type": "string",
"example": "12345678000123"
}
},
{
"name": "completa",
"in": "query",
"required": false,
"description": "Se informado o valor 1, retorna os dados completos da nota, caso esses estejam disponíveis. Caso contrário, retorna apenas os dados resumidos.",
"schema": {
"type": "string",
"enum": [
1,
0
],
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Requisição processada com sucesso",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NfeRecebidaResumo"
},
{
"$ref": "#/components/schemas/NfeRecebidaCompleta"
}
]
},
"examples": {
"NFe Resumida": {
"$ref": "#/components/examples/NfeRecebidaResumo"
},
"NFe Completa": {
"$ref": "#/components/examples/NfeRecebidaCompleta"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AccessDenied"
},
"404": {
"$ref": "#/components/responses/NfeRecebidaNaoEncontrada"
}
}
}
}
},
"components": {
"securitySchemes": {
"BasicAuth": {
"type": "http",
"scheme": "basic",
"description": "Autenticação com usuário e senha (HTTP Basic). O usuário é o token da API e a senha deve ser deixada em branco."
}
},
"responses": {
"NfeRecebidaNaoEncontrada": {
"description": "Recurso não encontrado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"codigo": "nao_encontrada",
"mensagem": "Documento fiscal não encontrado"
}
}
}
},
"AccessDenied": {
"description": "Não autorizado",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "HTTP Basic: Access denied"
}
}
}
}
},
"schemas": {
"NfeRecebidaResumo": {
"title": "NFe recebida resumo",
"type": "object",
"properties": {
"nome_emitente": {
"type": "string",
"description": "Nome do emitente da nota fiscal",
"example": "EMPRESA FORNECEDORA LTDA"
},
"documento_emitente": {
"type": "string",
"description": "CNPJ ou CPF do emitente da nota fiscal",
"example": "123456780001233"
},
"cnpj_destinatario": {
"type": "string",
"description": "CNPJ do destinatário da nota fiscal (o CNPJ de sua empresa)",
"example": "123456780001234"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe",
"example": "35122225222278000855550010000002821510931504"
},
"valor_total": {
"type": "string",
"description": "Valor total da NFe",
"example": "100.00"
},
"data_emissao": {
"type": "string",
"format": "date-time",
"description": "Data e hora de emissão da NFe",
"example": "2024-01-15T10:00:00-03:00"
},
"situacao": {
"type": "string",
"description": "Situação da NFe",
"enum": [
"autorizada",
"cancelada",
"denegada"
],
"example": "autorizada"
},
"manifestacao_destinatario": {
"type": "string",
"description": "Situação atual da manifestação do destinatário:\n- **nulo**: Se não houve manifestação ainda\n- **ciencia**: Se foi confirmada a ciência da operação\n- **confirmacao**: Se foi manifestado confirmação da operação\n- **desconhecimento**: Se foi manifestado desconhecimento da operação\n- **nao_realizada**: Se foi manifestado que operação é conhecida, porém por algum motivo não foi realizada\n",
"enum": [
"nulo",
"ciencia",
"confirmacao",
"desconhecimento",
"nao_realizada"
],
"example": "ciencia"
},
"nfe_completa": {
"type": "string",
"description": "Se verdadeiro, indica que temos o XML completo da nota, caso contrário o sistema possui apenas o cabeçalho da nota",
"example": "12345678000123"
},
"tipo_nfe": {
"type": "string",
"description": "Tipo da NFe:\n- 1: Saída\n- 0: Entrada\n",
"enum": [
"1",
"0"
],
"example": "1"
},
"versao": {
"type": "number",
"description": "Versão da nota fiscal. Este número irá mudar apenas se a nota fiscal for alterada de alguma forma",
"example": 73
},
"digest_value": {
"type": "string",
"description": "Valor do resumo digital do XML da nota",
"example": "/C5IuK5fCNVQV2rbwV0d8W12zsk="
},
"numero_carta_correcao": {
"type": "string",
"description": "Número sequencial da carta de correção, caso tenha sido emitida alguma",
"example": "1"
},
"carta_correcao": {
"type": "string",
"description": "Texto da carta de correção, caso tenha sido emitida alguma",
"example": "Campo valor informado incorretamente. Onde lê-se R$ 100.00, deve ler-se R$ 100000,00."
},
"data_carta_correcao": {
"type": "string",
"format": "date-time",
"description": "Data da carta de correção, caso tenha sido emitida alguma",
"example": "2024-01-15T10:00:00-03:00"
},
"data_cancelamento": {
"type": "string",
"format": "date-time",
"description": "Data de cancelamento da nota fiscal, caso ela tenha sido cancelada",
"example": "2024-01-15T10:00:00-03:00"
},
"justificativa_cancelamento": {
"type": "string",
"description": "Justificativa de cancelamento da nota fiscal, caso ela tenha sido cancelada",
"example": "Venda cancelada"
}
}
},
"NfeRecebidaCompleta": {
"title": "NFe recebida completa",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/NfeRecebidaResumo"
},
{
"type": "object"
}
],
"properties": {
"nome_emitente": {
"type": "string",
"description": "Nome/Razão Social do emitente da NFe",
"example": "EMPRESA FORNECEDORA LTDA"
},
"documento_emitente": {
"type": "string",
"description": "CNPJ do emitente (somente números)",
"example": "12345678000123"
},
"chave_nfe": {
"type": "string",
"description": "Chave de acesso da NFe",
"example": "41250528738804000292550020000263001893479140"
},
"valor_total": {
"type": "string",
"description": "Valor total da NFe",
"example": "2607.40"
},
"data_emissao": {
"type": "string",
"format": "date-time",
"description": "Data e hora de emissão da NFe",
"example": "2025-05-28T16:49:12-03:00"
},
"situacao": {
"type": "string",
"description": "Situação atual da NFe",
"enum": [
"autorizada",
"cancelada",
"denegada",
"pendente"
],
"example": "autorizada"
},
"nfe_completa": {
"type": "boolean",
"description": "Indica se a NFe está completa com todos os dados",
"example": true
},
"tipo_nfe": {
"type": "string",
"description": "Tipo da NFe (0=Entrada, 1=Saída)",
"enum": [
"0",
"1"
],
"example": "1"
},
"versao": {
"type": "integer",
"description": "Versão da NFe",
"example": 373
},
"digest_value": {
"type": "string",
"description": "Valor do digest (hash) da NFe",
"example": "GaCC7D23PZ+TkemSUF+bT14FTtc="
},
"cnpj_destinatario": {
"type": "string",
"description": "CNPJ do destinatário",
"example": "12345678000123"
},
"cpf_destinatario": {
"type": "string",
"description": "CPF do destinatário (se aplicável)",
"example": ""
},
"requisicao_nota_fiscal": {
"$ref": "#/components/schemas/RequisicaoNotaFiscal"
},
"protocolo_nota_fiscal": {
"$ref": "#/components/schemas/ProtocoloNotaFiscal"
},
"requisicao_carta_correcao": {
"$ref": "#/components/schemas/RequisicaoCartaCorrecao"
},
"protocolo_carta_correcao": {
"$ref": "#/components/schemas/ProtocoloCartaCorrecao"
},
"requisicao_cancelamento": {
"$ref": "#/components/schemas/RequisicaoCancelamento"
},
"protocolo_cancelamento": {
"$ref": "#/components/schemas/ProtocoloCancelamento"
}
}
},
"RequisicaoNotaFiscal": {
"title": "Requisição Nota Fiscal",
"type": "object",
"properties": {
"versao": {
"type": "string",
"description": "Versão da requisição",
"example": "4.00"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe na requisição",
"example": "NFe41250528738804000292550020000263001893479140"
},
"uf": {
"type": "string",
"description": "UF da requisição",
"example": "41"
},
"codigo_unico": {
"type": "string",
"description": "Código único da requisição",
"example": "89347914"
},
"natureza_operacao": {
"type": "string",
"description": "Natureza da operação",
"example": "Venda de mercadorias"
},
"modelo": {
"type": "string",
"description": "Modelo da NFe",
"example": "55"
},
"serie": {
"type": "string",
"description": "Série da NFe",
"example": "2"
},
"numero": {
"type": "string",
"description": "Número da NFe",
"example": "26300"
},
"data_emissao": {
"type": "string",
"format": "date-time",
"description": "Data de emissão da NFe",
"example": "2025-05-28T16:49:12-03:00"
},
"data_entrada_saida": {
"type": "string",
"format": "date-time",
"description": "Data de entrada/saída da NFe",
"example": "2025-05-29T00:00:00-03:00"
},
"tipo_documento": {
"type": "string",
"description": "Tipo do documento",
"example": "1"
},
"local_destino": {
"type": "string",
"description": "Local de destino",
"example": "1"
},
"municipio": {
"type": "string",
"description": "Código do município",
"example": "4119152"
},
"formato_impressao": {
"type": "string",
"description": "Formato de impressão",
"example": "1"
},
"forma_emissao": {
"type": "string",
"description": "Forma de emissão",
"example": "1"
},
"digito_verificador": {
"type": "string",
"description": "Dígito verificador",
"example": "0"
},
"ambiente": {
"type": "string",
"description": "Ambiente da NFe (1=Produção, 2=Homologação)",
"example": "1"
},
"finalidade_emissao": {
"type": "string",
"description": "Finalidade da emissão",
"example": "1"
},
"consumidor_final": {
"type": "string",
"description": "Indica se é consumidor final (0=Não, 1=Sim)",
"example": "0"
},
"presenca_comprador": {
"type": "string",
"description": "Presença do comprador",
"example": "0"
},
"indicador_intermediario": {
"type": "string",
"nullable": true,
"description": "Indicador de intermediário",
"example": null
},
"processo_emissao": {
"type": "string",
"description": "Processo de emissão",
"example": "0"
},
"versao_aplicativo": {
"type": "string",
"description": "Versão do aplicativo",
"example": "Bling 1.1"
},
"notas_referenciadas": {
"type": "array",
"description": "Notas referenciadas",
"items": {
"type": "string"
}
},
"chaves_nfe_antecipacao_pagamento": {
"type": "array",
"description": "Chaves de NFe de antecipação de pagamento",
"items": {
"type": "string"
}
},
"cnpj_emitente": {
"type": "string",
"description": "CNPJ do emitente",
"example": "12345678000123"
},
"nome_emitente": {
"type": "string",
"description": "Nome do emitente",
"example": "EMPRESA FORNECEDORA LTDA"
},
"nome_fantasia_emitente": {
"type": "string",
"description": "Nome fantasia do emitente",
"example": "EMPRESA FORNECEDORA LTDA"
},
"logradouro_emitente": {
"type": "string",
"description": "Logradouro do emitente",
"example": "Rua das Flores"
},
"numero_emitente": {
"type": "string",
"description": "Número do emitente",
"example": "307"
},
"complemento_emitente": {
"type": "string",
"description": "Complemento do emitente",
"example": "Fabrica"
},
"bairro_emitente": {
"type": "string",
"description": "Bairro do emitente",
"example": "Centro"
},
"codigo_municipio_emitente": {
"type": "string",
"description": "Código do município do emitente",
"example": "4119152"
},
"municipio_emitente": {
"type": "string",
"description": "Município do emitente",
"example": "Pinhais"
},
"uf_emitente": {
"type": "string",
"description": "UF do emitente",
"example": "PR"
},
"cep_emitente": {
"type": "string",
"description": "CEP do emitente",
"example": "83325070"
},
"codigo_pais_emitente": {
"type": "string",
"description": "Código do país do emitente",
"example": "1058"
},
"pais_emitente": {
"type": "string",
"description": "País do emitente",
"example": "Brasil"
},
"telefone_emitente": {
"type": "string",
"description": "Telefone do emitente",
"example": "11999999999"
},
"inscricao_estadual_emitente": {
"type": "string",
"description": "Inscrição estadual do emitente",
"example": "123456789"
},
"inscricao_municipal_emitente": {
"type": "string",
"description": "Inscrição municipal do emitente",
"example": "12345678"
},
"cnae_fiscal_emitente": {
"type": "string",
"description": "CNAE fiscal do emitente",
"example": "4637199"
},
"regime_tributario_emitente": {
"type": "string",
"description": "Regime tributário do emitente",
"example": "3"
},
"cnpj_destinatario": {
"type": "string",
"description": "CNPJ do destinatário",
"example": "12345678000123"
},
"nome_destinatario": {
"type": "string",
"description": "Nome do destinatário",
"example": "EMPRESA DESTINATARIA LTDA"
},
"logradouro_destinatario": {
"type": "string",
"description": "Logradouro do destinatário",
"example": "Rua das Palmeiras"
},
"numero_destinatario": {
"type": "string",
"description": "Número do destinatário",
"example": "1698"
},
"bairro_destinatario": {
"type": "string",
"description": "Bairro do destinatário",
"example": "Centro"
},
"codigo_municipio_destinatario": {
"type": "string",
"description": "Código do município do destinatário",
"example": "4125506"
},
"municipio_destinatario": {
"type": "string",
"description": "Município do destinatário",
"example": "Sao Jose dos Pinhais"
},
"uf_destinatario": {
"type": "string",
"description": "UF do destinatário",
"example": "PR"
},
"cep_destinatario": {
"type": "string",
"description": "CEP do destinatário",
"example": "83005420"
},
"codigo_pais_destinatario": {
"type": "string",
"description": "Código do país do destinatário",
"example": "1058"
},
"pais_destinatario": {
"type": "string",
"description": "País do destinatário",
"example": "Brasil"
},
"telefone_destinatario": {
"type": "string",
"description": "Telefone do destinatário",
"example": "11988888888"
},
"indicador_inscricao_estadual_destinatario": {
"type": "string",
"description": "Indicador de inscrição estadual do destinatário",
"example": "1"
},
"inscricao_estadual_destinatario": {
"type": "string",
"description": "Inscrição estadual do destinatário",
"example": "987654321"
},
"email_destinatario": {
"type": "string",
"description": "Email do destinatário",
"example": "example@email.com"
},
"pessoas_autorizadas": {
"type": "array",
"description": "Pessoas autorizadas",
"items": {
"type": "object"
}
},
"itens": {
"type": "array",
"description": "Lista de itens da NFe",
"items": {
"$ref": "#/components/schemas/ItemNfe"
}
},
"icms_base_calculo": {
"type": "string",
"description": "Base de cálculo total do ICMS",
"example": "2607.40"
},
"icms_valor_total": {
"type": "string",
"description": "Valor total do ICMS",
"example": "252.92"
},
"icms_valor_total_desonerado": {
"type": "string",
"description": "Valor total desonerado do ICMS",
"example": "0.00"
},
"fcp_valor_total": {
"type": "string",
"description": "Valor total do FCP",
"example": "0.00"
},
"icms_base_calculo_st": {
"type": "string",
"description": "Base de cálculo total do ICMS ST",
"example": "0.00"
},
"icms_valor_total_st": {
"type": "string",
"description": "Valor total do ICMS ST",
"example": "0.00"
},
"fcp_valor_total_st": {
"type": "string",
"description": "Valor total do FCP ST",
"example": "0.00"
},
"fcp_valor_total_retido_st": {
"type": "string",
"description": "Valor total do FCP retido ST",
"example": "0.00"
},
"valor_produtos": {
"type": "string",
"description": "Valor total dos produtos",
"example": "2587.40"
},
"valor_frete": {
"type": "string",
"description": "Valor total do frete",
"example": "20.00"
},
"valor_seguro": {
"type": "string",
"description": "Valor total do seguro",
"example": "0.00"
},
"valor_desconto": {
"type": "string",
"description": "Valor total do desconto",
"example": "0.00"
},
"valor_total_ii": {
"type": "string",
"description": "Valor total do II",
"example": "0.00"
},
"valor_ipi": {
"type": "string",
"description": "Valor total do IPI",
"example": "0.00"
},
"valor_ipi_devolvido": {
"type": "string",
"description": "Valor total do IPI devolvido",
"example": "0.00"
},
"valor_pis": {
"type": "string",
"description": "Valor total do PIS",
"example": "20.45"
},
"valor_cofins": {
"type": "string",
"description": "Valor total do COFINS",
"example": "94.19"
},
"valor_outras_despesas": {
"type": "string",
"description": "Valor total de outras despesas",
"example": "0.00"
},
"valor_total_tributos": {
"type": "string",
"description": "Valor total dos tributos",
"example": "685.44"
},
"ibs_cbs_is_valor_total": {
"type": "string",
"nullable": true,
"description": "Valor total IBS/CBS/IS",
"example": null
},
"modalidade_frete": {
"type": "string",
"description": "Modalidade do frete",
"example": "0"
},
"reboques": {
"type": "array",
"description": "Lista de reboques",
"items": {
"type": "object"
}
},
"volumes": {
"type": "array",
"description": "Lista de volumes",
"items": {
"$ref": "#/components/schemas/Volume"
}
},
"numero_fatura": {
"type": "string",
"description": "Número da fatura",
"example": "026300"
},
"valor_original_fatura": {
"type": "string",
"description": "Valor original da fatura",
"example": "2607.40"
},
"valor_desconto_fatura": {
"type": "string",
"description": "Valor do desconto da fatura",
"example": "0"
},
"valor_liquido_fatura": {
"type": "string",
"description": "Valor líquido da fatura",
"example": "2607.40"
},
"duplicatas": {
"type": "array",
"description": "Lista de duplicatas",
"items": {
"$ref": "#/components/schemas/Duplicata"
}
},
"formas_pagamento": {
"type": "array",
"description": "Lista de formas de pagamento",
"items": {
"$ref": "#/components/schemas/FormaPagamento"
}
},
"informacoes_adicionais_fisco": {
"type": "string",
"description": "Informações adicionais para o fisco",
"example": "Imposto diferido em 38,46%, conforme inciso I, do art. 28, do anexo VIII, Decreto 7871/2017 RICMS/PR.ICMS calculado sobre base de calculo reduzida, conforme o Item 9 do Anexo VI do RICMS/PR."
},
"informacoes_adicionais_contribuinte": {
"type": "string",
"description": "Informações adicionais para o contribuinte",
"example": "Total aproximado de tributos: R$ 685,44 (26,29%) Federais R$ 350,69 (13,45%) Estaduais R$ 334,72 (12,84%) . Fonte IBPT.
Valor base de diferimento: 1.408,20, Valor diferimento: 105,61
ICMS calculado sobre base de calculo reduzida, conforme o Item 9 do Anexo VI do RICMS/PR."
},
"observacoes_contribuinte": {
"type": "array",
"description": "Observações do contribuinte",
"items": {
"type": "string"
}
},
"observacoes_fisco": {
"type": "array",
"description": "Observações do fisco",
"items": {
"type": "string"
}
},
"processos_referenciados": {
"type": "array",
"description": "Processos referenciados",
"items": {
"type": "object"
}
},
"cnpj_responsavel_tecnico": {
"type": "string",
"description": "CNPJ do responsável técnico",
"example": "12345678000123"
},
"contato_responsavel_tecnico": {
"type": "string",
"description": "Contato do responsável técnico",
"example": "EMPRESA LTDA"
},
"email_responsavel_tecnico": {
"type": "string",
"description": "Email do responsável técnico",
"example": "example@email.com"
},
"telefone_responsavel_tecnico": {
"type": "string",
"description": "Telefone do responsável técnico",
"example": "11977777777"
}
}
},
"ItemNfe": {
"title": "Item",
"type": "object",
"properties": {
"numero_item": {
"type": "string",
"description": "Número sequencial do item",
"example": "1"
},
"codigo_produto": {
"type": "string",
"description": "Código do produto",
"example": "88888"
},
"codigo_barras_comercial": {
"type": "string",
"description": "Código de barras comercial do produto",
"example": "7903873281046"
},
"descricao": {
"type": "string",
"description": "Descrição do produto",
"example": "Produto Genérico"
},
"codigo_ncm": {
"type": "string",
"description": "Código NCM do produto",
"example": "18061000"
},
"nves": {
"type": "array",
"description": "Lista de NVEs",
"items": {
"type": "string"
}
},
"cest": {
"type": "string",
"description": "Código CEST do produto",
"example": "1700601"
},
"escala_relevante": {
"type": "string",
"description": "Indica se o produto é de escala relevante",
"example": "S"
},
"codigo_beneficio_fiscal": {
"type": "string",
"description": "Código do benefício fiscal",
"example": "PR830001"
},
"infos_credito_presumido": {
"type": "array",
"description": "Informações de crédito presumido",
"items": {
"type": "object"
}
},
"cfop": {
"type": "string",
"description": "CFOP do item",
"example": "5102"
},
"unidade_comercial": {
"type": "string",
"description": "Unidade comercial",
"example": "un"
},
"quantidade_comercial": {
"type": "string",
"description": "Quantidade comercial do produto",
"example": "1.0000"
},
"valor_unitario_comercial": {
"type": "string",
"description": "Valor unitário comercial do produto",
"example": "189.0000000000"
},
"valor_bruto": {
"type": "string",
"description": "Valor bruto do item",
"example": "189.00"
},
"codigo_barras_tributavel": {
"type": "string",
"description": "Código de barras tributável do produto",
"example": "7903873281046"
},
"unidade_tributavel": {
"type": "string",
"description": "Unidade tributável do produto",
"example": "un"
},
"quantidade_tributavel": {
"type": "string",
"description": "Quantidade tributável do produto",
"example": "1.0000"
},
"valor_unitario_tributavel": {
"type": "string",
"description": "Valor unitário tributável do produto",
"example": "189.0000000000"
},
"valor_frete": {
"type": "string",
"description": "Valor do frete do item",
"example": "1.46"
},
"inclui_no_total": {
"type": "string",
"description": "Indica se o valor está incluído no total",
"example": "1"
},
"documentos_importacao": {
"type": "array",
"description": "Documentos de importação",
"items": {
"type": "object"
}
},
"detalhes_exportacao": {
"type": "array",
"description": "Detalhes de exportação",
"items": {
"type": "object"
}
},
"numero_item_pedido_compra": {
"type": "string",
"description": "Número do item no pedido de compra",
"example": "1"
},
"rastros": {
"type": "array",
"description": "Rastros do produto",
"items": {
"type": "object"
}
},
"origens_combustivel": {
"type": "array",
"description": "Origens do combustível",
"items": {
"type": "object"
}
},
"valor_total_tributos": {
"type": "string",
"description": "Valor total dos tributos do item",
"example": "38.95"
},
"icms_percentual_partilha": {
"type": "string",
"description": "Percentual de partilha do ICMS",
"example": "100.0000"
},
"observacoes_contribuinte": {
"type": "array",
"description": "Observações do contribuinte",
"items": {
"type": "string"
}
},
"icms_origem": {
"type": "string",
"description": "Origem do ICMS",
"example": "0"
},
"icms_situacao_tributaria": {
"type": "string",
"description": "Situação tributária do ICMS",
"example": "51"
},
"icms_modalidade_base_calculo": {
"type": "string",
"description": "Modalidade de base de cálculo do ICMS",
"example": "3"
},
"icms_reducao_base_calculo": {
"type": "string",
"description": "Redução da base de cálculo do ICMS",
"example": "0.00"
},
"icms_base_calculo": {
"type": "string",
"description": "Base de cálculo do ICMS do item",
"example": "190.46"
},
"icms_aliquota": {
"type": "string",
"description": "Alíquota do ICMS",
"example": "19.5000"
},
"icms_valor_operacao": {
"type": "string",
"description": "Valor da operação do ICMS",
"example": "37.14"
},
"icms_percentual_diferimento": {
"type": "string",
"description": "Percentual de diferimento do ICMS",
"example": "38.4600"
},
"icms_valor_diferido": {
"type": "string",
"description": "Valor diferido do ICMS",
"example": "14.28"
},
"icms_valor": {
"type": "string",
"description": "Valor do ICMS do item",
"example": "22.86"
},
"pis_situacao_tributaria": {
"type": "string",
"description": "Situação tributária do PIS",
"example": "01"
},
"pis_base_calculo": {
"type": "string",
"description": "Base de cálculo do PIS",
"example": "167.60"
},
"pis_aliquota_porcentual": {
"type": "string",
"description": "Alíquota percentual do PIS",
"example": "1.65"
},
"pis_valor": {
"type": "string",
"description": "Valor do PIS",
"example": "2.77"
},
"cofins_situacao_tributaria": {
"type": "string",
"description": "Situação tributária do COFINS",
"example": "01"
},
"cofins_base_calculo": {
"type": "string",
"description": "Base de cálculo do COFINS",
"example": "167.60"
},
"cofins_aliquota_porcentual": {
"type": "string",
"description": "Alíquota percentual do COFINS",
"example": "7.60"
},
"cofins_valor": {
"type": "string",
"description": "Valor do COFINS",
"example": "12.74"
}
}
},
"Volume": {
"type": "object",
"properties": {
"quantidade": {
"type": "string",
"description": "Quantidade de volumes",
"example": "7"
},
"peso_liquido": {
"type": "string",
"description": "Peso líquido dos volumes",
"example": "0.000"
},
"peso_bruto": {
"type": "string",
"description": "Peso bruto dos volumes",
"example": "44.800"
},
"lacres": {
"type": "array",
"description": "Lista de lacres",
"items": {
"type": "object"
}
}
}
},
"Duplicata": {
"type": "object",
"properties": {
"numero": {
"type": "string",
"description": "Número da duplicata",
"example": "001"
},
"data_vencimento": {
"type": "string",
"description": "Data de vencimento da duplicata",
"example": "2025-06-17"
},
"valor": {
"type": "string",
"description": "Valor da duplicata",
"example": "1303.70"
}
}
},
"FormaPagamento": {
"title": "Forma de pagamento",
"type": "object",
"properties": {
"indicador_pagamento": {
"type": "string",
"description": "Indicador de pagamento",
"example": "1"
},
"forma_pagamento": {
"type": "string",
"description": "Forma de pagamento",
"example": "15"
},
"valor_pagamento": {
"type": "string",
"description": "Valor do pagamento",
"example": "1303.70"
},
"tipo_integracao": {
"type": "string",
"nullable": true,
"description": "Tipo de integração",
"example": null
}
}
},
"ProtocoloNotaFiscal": {
"title": "Protocolo Nota Fiscal",
"type": "object",
"properties": {
"versao": {
"type": "string",
"description": "Versão do protocolo",
"example": "4.00"
},
"ambiente": {
"type": "string",
"description": "Ambiente do protocolo (1=Produção, 2=Homologação)",
"example": "1"
},
"versao_aplicativo": {
"type": "string",
"description": "Versão do aplicativo",
"example": "PR-v4_9_2"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe no protocolo",
"example": "41250528738804000292550020000263001893479140"
},
"data_recebimento": {
"type": "string",
"format": "date-time",
"description": "Data de recebimento do protocolo",
"example": "2025-05-28T16:49:13-03:00"
},
"numero_protocolo": {
"type": "string",
"description": "Número do protocolo",
"example": "141250170769198"
},
"digest_value": {
"type": "string",
"description": "Valor do digest do protocolo",
"example": "GaCC7D23PZ+TkemSUF+bT14FTtc="
},
"status": {
"type": "string",
"description": "Status do protocolo",
"example": "100"
},
"motivo": {
"type": "string",
"description": "Motivo do protocolo",
"example": "Autorizado o uso da NF-e"
}
}
},
"RequisicaoCartaCorrecao": {
"title": "Requisição Carta de Correção",
"type": "object",
"properties": {
"versao": {
"type": "string",
"description": "Versão da carta de correção",
"example": "1.00"
},
"id_tag": {
"type": "string",
"description": "Identificador único da tag da carta de correção",
"example": "ID1101103524013450258000013755001000000446135298182101"
},
"codigo_orgao": {
"type": "string",
"description": "Código do órgão responsável pela autorização",
"example": "35"
},
"ambiente": {
"type": "string",
"description": "Ambiente da carta de correção (1=Produção, 2=Homologação)",
"example": "1"
},
"cnpj": {
"type": "string",
"description": "CNPJ do emitente da carta de correção",
"example": "12345678000123"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe que está sendo corrigida",
"example": "35240134502580000137550010000004461352981821"
},
"data_evento": {
"type": "string",
"format": "date-time",
"description": "Data e hora do evento da carta de correção",
"example": "2024-01-18T15:29:28-03:00"
},
"tipo_evento": {
"type": "string",
"description": "Tipo do evento (código da carta de correção)",
"example": "110110"
},
"numero_sequencial_evento": {
"type": "string",
"description": "Número sequencial do evento",
"example": "1"
},
"versao_evento": {
"type": "string",
"description": "Versão do evento",
"example": "1.00"
},
"descricao_evento": {
"type": "string",
"description": "Descrição do tipo de evento",
"example": "Carta de Correcao"
},
"correcao": {
"type": "string",
"description": "Texto descritivo da correção realizada",
"example": "ONDE SE LE QUANTIDADE DE VOLUMES 4, VALOR CORRETO E 1 VOLUME"
},
"condicoes_uso": {
"type": "string",
"description": "Condições de uso da carta de correção conforme legislação",
"example": "A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida."
}
}
},
"ProtocoloCartaCorrecao": {
"title": "Protocolo Carta Correção",
"type": "object",
"properties": {
"versao": {
"type": "string",
"description": "Versão do protocolo da carta de correção",
"example": "1.00"
},
"ambiente": {
"type": "string",
"description": "Ambiente do protocolo (1=Produção, 2=Homologação)",
"example": "1"
},
"versao_aplicativo": {
"type": "string",
"description": "Versão do aplicativo que processou a carta de correção",
"example": "SP_EVENTOS_PL_100"
},
"codigo_orgao": {
"type": "string",
"description": "Código do órgão responsável pela autorização",
"example": "35"
},
"status": {
"type": "string",
"description": "Status do protocolo da carta de correção",
"example": "135"
},
"motivo": {
"type": "string",
"description": "Motivo/descrição do status do protocolo",
"example": "Evento registrado e vinculado a NF-e"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe que foi corrigida",
"example": "35240134502580000137550010000004461352981821"
},
"tipo_evento": {
"type": "string",
"description": "Tipo do evento (código da carta de correção)",
"example": "110110"
},
"descricao_evento": {
"type": "string",
"description": "Descrição do tipo de evento",
"example": "Carta de Correção registrada"
},
"cnpj": {
"type": "string",
"description": "CNPJ do emitente da carta de correção",
"example": "12345678000123"
},
"data_evento": {
"type": "string",
"format": "date-time",
"description": "Data e hora do evento da carta de correção",
"example": "2024-01-18T15:30:29-03:00"
},
"numero_protocolo": {
"type": "string",
"description": "Número do protocolo de autorização da carta de correção",
"example": "135240131193072"
}
}
},
"RequisicaoCancelamento": {
"title": "Requisição Cancelamento",
"type": "object",
"properties": {
"versao": {
"type": "string",
"description": "Versão do protocolo de cancelamento",
"example": "1.00"
},
"id_tag": {
"type": "string",
"description": "Identificador único da tag do cancelamento",
"example": "ID1101112124020528303100070655001000111521174748475001"
},
"codigo_orgao": {
"type": "string",
"description": "Código do órgão responsável pela autorização",
"example": "21"
},
"ambiente": {
"type": "string",
"description": "Ambiente do protocolo (1=Produção, 2=Homologação)",
"example": "1"
},
"cnpj": {
"type": "string",
"description": "CNPJ do emitente do cancelamento",
"example": "12345678000123"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe que foi cancelada",
"example": "21240205283031000706550010001115211747484750"
},
"data_evento": {
"type": "string",
"format": "date-time",
"description": "Data e hora do evento de cancelamento",
"example": "2024-02-26T14:59:17-03:00"
},
"tipo_evento": {
"type": "string",
"description": "Tipo do evento (código do cancelamento)",
"example": "110111"
},
"numero_sequencial_evento": {
"type": "string",
"description": "Número sequencial do evento",
"example": "1"
},
"versao_evento": {
"type": "string",
"description": "Versão do evento",
"example": "1.00"
},
"descricao_evento": {
"type": "string",
"description": "Descrição do tipo de evento",
"example": "Cancelamento"
},
"protocolo": {
"type": "string",
"description": "Número do protocolo de autorização do cancelamento",
"example": "421240006388714"
},
"justificativa": {
"type": "string",
"description": "Justificativa para o cancelamento da NFe",
"example": "Cancelamento de nota fiscal eletronica por emissao indevida"
}
}
},
"ProtocoloCancelamento": {
"title": "Protocolo Cancelamento",
"type": "object",
"properties": {
"versao": {
"type": "string",
"description": "Versão do protocolo de cancelamento",
"example": "1.00"
},
"id_tag": {
"type": "string",
"description": "Identificador único da tag do protocolo de cancelamento",
"example": "ID421240006397963"
},
"ambiente": {
"type": "string",
"description": "Ambiente do protocolo (1=Produção, 2=Homologação)",
"example": "1"
},
"versao_aplicativo": {
"type": "string",
"description": "Versão do aplicativo que processou o cancelamento",
"example": "1.0.0"
},
"codigo_orgao": {
"type": "string",
"description": "Código do órgão responsável pela autorização",
"example": "21"
},
"status": {
"type": "string",
"description": "Status do protocolo de cancelamento",
"example": "135"
},
"motivo": {
"type": "string",
"description": "Motivo/descrição do status do protocolo",
"example": "Evento registrado e vinculado a NF-e"
},
"chave_nfe": {
"type": "string",
"description": "Chave da NFe que foi cancelada",
"example": "21240205283031000706550010001115211747484750"
},
"tipo_evento": {
"type": "string",
"description": "Tipo do evento (código do cancelamento)",
"example": "110111"
},
"email": {
"type": "string",
"description": "Lista de emails separados por ponto e vírgula que receberam notificação do cancelamento",
"example": "example@email.com"
},
"data_evento": {
"type": "string",
"format": "date-time",
"description": "Data e hora do evento de cancelamento",
"example": "2024-02-26T14:59:17-03:00"
},
"numero_protocolo": {
"type": "string",
"description": "Número do protocolo de autorização do cancelamento",
"example": "421240006397963"
}
}
},
"ErrorResponse": {
"title": "Erro",
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código do erro"
},
"mensagem": {
"type": "string",
"description": "Mensagem do erro"
}
}
}
},
"examples": {
"NfeRecebidaResumo": {
"value": {
"nome_emitente": "Empresa emitente Ltda.",
"documento_emitente": "12345678000123",
"chave_nfe": "41171179060190000182550010000002661875685069",
"valor_total": "24560.00",
"data_emissao": "2017-11-07T01:00:00-02:00",
"situacao": "autorizada",
"manifestacao_destinatario": "ciencia",
"nfe_completa": true,
"tipo_nfe": "1",
"versao": 73,
"digest_value": "/C5IuK5fCNVQV2rbwV0d8W12zsk=",
"numero_carta_correcao": "1",
"carta_correcao": "Algum texto da carta de correção.",
"data_carta_correcao": "2017-11-07T14:31:48-02:00",
"data_cancelamento": "2017-11-07T14:45:14-02:00",
"justificativa_cancelamento": "Nota cancelada por algum motivo"
}
},
"NfeRecebidaCompleta": {
"value": {
"nome_emitente": "EMPRESA FORNECEDORA LTDA",
"documento_emitente": "12345678000123",
"chave_nfe": "41250512345678000123550020000263001893479140",
"valor_total": "2607.40",
"data_emissao": "2025-05-28T16:49:12-03:00",
"situacao": "autorizada",
"nfe_completa": true,
"tipo_nfe": "1",
"versao": 373,
"digest_value": "GaCC7D23PZ+TkemSUF+bT14FTtc=",
"cnpj_destinatario": "12345678000123",
"cpf_destinatario": "",
"requisicao_nota_fiscal": {
"versao": "4.00",
"chave_nfe": "NFe41250528738804000292550020000263001893479140",
"uf": "41",
"codigo_unico": "89347914",
"natureza_operacao": "Venda de mercadorias",
"modelo": "55",
"serie": "2",
"numero": "26300",
"data_emissao": "2025-05-28T16:49:12-03:00",
"data_entrada_saida": "2025-05-29T00:00:00-03:00",
"tipo_documento": "1",
"local_destino": "1",
"municipio": "4119152",
"formato_impressao": "1",
"forma_emissao": "1",
"digito_verificador": "0",
"ambiente": "1",
"finalidade_emissao": "1",
"consumidor_final": "0",
"presenca_comprador": "0",
"indicador_intermediario": null,
"processo_emissao": "0",
"versao_aplicativo": "Bling 1.1",
"notas_referenciadas": [],
"chaves_nfe_antecipacao_pagamento": [],
"cnpj_emitente": "12345678000123",
"nome_emitente": "EMPRESA FORNECEDORA LTDA",
"nome_fantasia_emitente": "EMPRESA FORNECEDORA LTDA",
"logradouro_emitente": "Rua das Flores",
"numero_emitente": "123",
"complemento_emitente": "Sala 1",
"bairro_emitente": "Centro",
"codigo_municipio_emitente": "3550308",
"municipio_emitente": "São Paulo",
"uf_emitente": "SP",
"cep_emitente": "01234-567",
"codigo_pais_emitente": "1058",
"pais_emitente": "Brasil",
"telefone_emitente": "11999999999",
"inscricao_estadual_emitente": "123456789",
"inscricao_municipal_emitente": "12345678",
"cnae_fiscal_emitente": "4637199",
"regime_tributario_emitente": "3",
"cnpj_destinatario": "12345678000123",
"nome_destinatario": "EMPRESA DESTINATARIA LTDA",
"logradouro_destinatario": "Rua das Palmeiras",
"numero_destinatario": "456",
"bairro_destinatario": "Centro",
"codigo_municipio_destinatario": "3304557",
"municipio_destinatario": "Rio de Janeiro",
"uf_destinatario": "RJ",
"cep_destinatario": "20000-000",
"codigo_pais_destinatario": "1058",
"pais_destinatario": "Brasil",
"telefone_destinatario": "11988888888",
"indicador_inscricao_estadual_destinatario": "1",
"inscricao_estadual_destinatario": "987654321",
"email_destinatario": "example@email.com",
"pessoas_autorizadas": [],
"itens": [
{
"numero_item": "1",
"codigo_produto": "88888",
"codigo_barras_comercial": "7903873281046",
"descricao": "Produto Genérico",
"codigo_ncm": "18061000",
"nves": [],
"cest": "1700601",
"escala_relevante": "S",
"codigo_beneficio_fiscal": "PR830001",
"infos_credito_presumido": [],
"cfop": "5102",
"unidade_comercial": "un",
"quantidade_comercial": "1.0000",
"valor_unitario_comercial": "189.0000000000",
"valor_bruto": "189.00",
"codigo_barras_tributavel": "7903873281046",
"unidade_tributavel": "un",
"quantidade_tributavel": "1.0000",
"valor_unitario_tributavel": "189.0000000000",
"valor_frete": "1.46",
"inclui_no_total": "1",
"documentos_importacao": [],
"detalhes_exportacao": [],
"numero_item_pedido_compra": "1",
"rastros": [],
"origens_combustivel": [],
"valor_total_tributos": "38.95",
"icms_percentual_partilha": "100.0000",
"observacoes_contribuinte": [],
"icms_origem": "0",
"icms_situacao_tributaria": "51",
"icms_modalidade_base_calculo": "3",
"icms_reducao_base_calculo": "0.00",
"icms_base_calculo": "190.46",
"icms_aliquota": "19.5000",
"icms_valor_operacao": "37.14",
"icms_percentual_diferimento": "38.4600",
"icms_valor_diferido": "14.28",
"icms_valor": "22.86",
"pis_situacao_tributaria": "01",
"pis_base_calculo": "167.60",
"pis_aliquota_porcentual": "1.65",
"pis_valor": "2.77",
"cofins_situacao_tributaria": "01",
"cofins_base_calculo": "167.60",
"cofins_aliquota_porcentual": "7.60",
"cofins_valor": "12.74"
}
],
"icms_base_calculo": "2607.40",
"icms_valor_total": "252.92",
"icms_valor_total_desonerado": "0.00",
"fcp_valor_total": "0.00",
"icms_base_calculo_st": "0.00",
"icms_valor_total_st": "0.00",
"fcp_valor_total_st": "0.00",
"fcp_valor_total_retido_st": "0.00",
"valor_produtos": "2587.40",
"valor_frete": "20.00",
"valor_seguro": "0.00",
"valor_desconto": "0.00",
"valor_total_ii": "0.00",
"valor_ipi": "0.00",
"valor_ipi_devolvido": "0.00",
"valor_pis": "20.45",
"valor_cofins": "94.19",
"valor_outras_despesas": "0.00",
"valor_total": "2607.40",
"valor_total_tributos": "685.44",
"ibs_cbs_is_valor_total": null,
"modalidade_frete": "0",
"reboques": [],
"volumes": [
{
"quantidade": "7",
"peso_liquido": "0.000",
"peso_bruto": "44.800",
"lacres": []
}
],
"numero_fatura": "026300",
"valor_original_fatura": "2607.40",
"valor_desconto_fatura": "0",
"valor_liquido_fatura": "2607.40",
"duplicatas": [
{
"numero": "001",
"data_vencimento": "2025-06-17",
"valor": "1303.70"
},
{
"numero": "002",
"data_vencimento": "2025-06-25",
"valor": "1303.70"
}
],
"formas_pagamento": [
{
"indicador_pagamento": "1",
"forma_pagamento": "15",
"valor_pagamento": "1303.70",
"tipo_integracao": null
},
{
"indicador_pagamento": "1",
"forma_pagamento": "15",
"valor_pagamento": "1303.70",
"tipo_integracao": null
}
],
"informacoes_adicionais_fisco": "Imposto diferido em 38,46%, conforme inciso I, do art. 28, do anexo VIII, Decreto 7871/2017 RICMS/PR.ICMS calculado sobre base de calculo reduzida, conforme o Item 9 do Anexo VI do RICMS/PR.",
"informacoes_adicionais_contribuinte": "Total aproximado de tributos: R$ 685,44 (26,29%) Federais R$ 350,69 (13,45%) Estaduais R$ 334,72 (12,84%) . Fonte IBPT.
Valor base de diferimento: 1.408,20, Valor diferimento: 105,61
ICMS calculado sobre base de calculo reduzida, conforme o Item 9 do Anexo VI do RICMS/PR.",
"observacoes_contribuinte": [],
"observacoes_fisco": [],
"processos_referenciados": [],
"cnpj_responsavel_tecnico": "12345678000123",
"contato_responsavel_tecnico": "EMPRESA TECNICA LTDA",
"email_responsavel_tecnico": "example@email.com",
"telefone_responsavel_tecnico": "11977777777"
},
"protocolo_nota_fiscal": {
"versao": "4.00",
"ambiente": "1",
"versao_aplicativo": "PR-v4_9_2",
"chave_nfe": "41250512345678000123550020000263001893479140",
"data_recebimento": "2025-05-28T16:49:13-03:00",
"numero_protocolo": "141250170769198",
"digest_value": "GaCC7D23PZ+TkemSUF+bT14FTtc=",
"status": "100",
"motivo": "Autorizado o uso da NF-e"
}
}
}
}
}
}
```