---
updatedAt: 2026-05-28T19:21:10.000Z
agentTools:
  projectIndex: https://docs.notagateway.com.br/llms.txt
---

# Consultar pelo ID do Gateway

Recupera informações da nota fiscal pelo seu Identificador único na plataforma (paramêtro {id}).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "visão-geral",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.notagateway.com.br"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/empresas/{empresaId}/nfes/{id}": {
      "get": {
        "summary": "Consultar pelo ID do Gateway",
        "description": "Recupera informações da nota fiscal pelo seu Identificador único na plataforma (paramêtro {id}).",
        "operationId": "empresasempresaidnfesnfeid",
        "parameters": [
          {
            "name": "empresaId",
            "in": "path",
            "description": "Identificador único da Empresa relacionada a Nota Fiscal",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "description": "Identificador único da Nota Fiscal que deseja requisitar",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "Accept",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "tipo": "string",
                      "idExterno": "string",
                      "ambienteEmissao": "string",
                      "numeroRps": "string",
                      "serieRps": "string",
                      "dataCompetencia": "string",
                      "enviarPorEmail": "boolean",
                      "dadosAdicionaisEmail": {
                        "outrosDestinatarios": "string"
                      },
                      "cliente": {
                        "tipoPessoa": "string",
                        "nome": "string",
                        "email": "string",
                        "cpfCnpj": "string",
                        "inscricaoMunicipal": "string",
                        "inscricaoEstadual": "string",
                        "telefone": "string",
                        "endereco": {
                          "pais": "string",
                          "uf": "string",
                          "cidade": "string",
                          "cidadeCodigoIBGE": "string",
                          "logradouro": "string",
                          "numero": "string",
                          "complemento": "string",
                          "bairro": "string",
                          "cep": "string"
                        }
                      },
                      "servico": {
                        "descricao": "string",
                        "aliquotaIss": "string",
                        "issRetidoFonte": "boolean",
                        "codigoServicoMunicipio": "string",
                        "itemListaServicoLC116": "string",
                        "cnae": "string",
                        "codigoNBS": "string",
                        "regimeEspecialTributacao": "string",
                        "tipoImunidadeIss": "string",
                        "codigoTributacaoNacional": "string",
                        "ufPrestacaoServico": "string",
                        "municipioPrestacaoServico": "string",
                        "ibsCbs": {
                          "situacaoTributaria": "string",
                          "classificacaoTributaria": "string",
                          "codigoIndicadorOperacao": "string",
                          "tipoOperacao": "string",
                          "indicadorDestinatario": "string",
                          "destinatario": {
                            "tipoPessoa": "string",
                            "nome": "string",
                            "cpfCnpj": "string",
                            "endereco": {
                              "uf": "string",
                              "cidade": "string",
                              "logradouro": "string",
                              "numero": "string",
                              "complemento": "string",
                              "bairro": "string",
                              "cep": "string"
                            }
                          },
                          "imovel": {
                            "inscricaoImobiliariaFiscal": "string",
                            "codigoCIB": "string|null",
                            "endereco": {
                              "uf": "string",
                              "cidade": "string",
                              "logradouro": "string",
                              "numero": "string",
                              "complemento": "string|null",
                              "bairro": "string",
                              "cep": "string"
                            }
                          },
                          "operacaoGovernamental": {
                            "tipoEnteGovernamental": "string",
                            "tipoOperacao": "string"
                          }
                        },
                        "pisCofinsApuracaoPropria": {
                          "baseCalculo": "number",
                          "aliquotaPis": "number",
                          "valorPis": "number",
                          "aliquotaCofins": "number",
                          "valorCofins": "number"
                        },
                        "situacaoTributariaPisCofins": "string",
                        "tipoRetencaoPisCofins": "string",
                        "valorPis": "number",
                        "valorCofins": "number",
                        "valorCsll": "number",
                        "valorInss": "number",
                        "valorIr": "number"
                      },
                      "construcaoCivil": {
                        "inscricaoImobiliariaFiscal": "string",
                        "codigoObra": "string",
                        "codigoCIB": "string",
                        "cei": "string",
                        "enderecoObra": {
                          "logradouro": "string",
                          "numero": "string",
                          "complemento": "string",
                          "bairro": "string",
                          "cep": "string"
                        }
                      },
                      "detalhesEvento": {
                        "identificador": "string",
                        "nome": "string",
                        "dataInicio": "string",
                        "dataFim": "string",
                        "endereco": {
                          "logradouro": "string",
                          "numero": "string",
                          "complemento": "string",
                          "bairro": "string",
                          "cep": "string"
                        }
                      },
                      "comercioExterior": {
                        "modalidadePrestacaoServico": "string",
                        "vinculoPrestador": "string",
                        "moeda": "string",
                        "valorServicoMoeda": "number",
                        "codigoMecanismoApoioPrestador": "string",
                        "codigoMecanismoApoioTomador": "string",
                        "movimentacaoTemporariaBens": "string",
                        "numeroDeclaracaoImportacao": "string",
                        "numeroRegistroExportacao": "string",
                        "comparilharNFSeComMDIC": "boolean"
                      },
                      "beneficioMunicipal": {
                        "codigo": "string",
                        "percentualReducaoBaseCalculo": "number"
                      },
                      "percentualAproximadoTributos": {
                        "detalhado": {
                          "percentualFederal": "number",
                          "percentualEstadual": "number",
                          "percentualMunicipal": "number"
                        }
                      },
                      "nfseReferenciada": [
                        {
                          "chaveAcesso": "string"
                        }
                      ],
                      "formaPagamentoFatura": null,
                      "deducoes": "string",
                      "descontos": "string",
                      "descontoCondicionado": "string",
                      "valorTotal": "number",
                      "naturezaOperacao": "string",
                      "observacoes": "string"
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "string",
                      "description": "ID da nota fiscal (gerado pela API da Nota Gateway)"
                    },
                    "tipo": {
                      "type": "string",
                      "example": "NFS-e",
                      "description": "Indica o tipo de documento fiscal que está sendo emitido."
                    },
                    "idExterno": {
                      "type": "string",
                      "example": "string",
                      "description": "ID externo da NFS-e."
                    },
                    "status": {
                      "type": "string",
                      "example": "string",
                      "description": "Indica o estado atual do processo de emissão da nota fiscal."
                    },
                    "motivoStatus": {
                      "description": "Os motivos do status. Geralmente é preenchido quando a nota fiscal é negada pela Autoridade Fiscal e contém a mensagem de erro que eles fornecem.",
                      "type": "string"
                    },
                    "ambienteEmissao": {
                      "type": "string",
                      "example": "Homologacao",
                      "description": "Indica se a nota foi emitida em \"Homologacao\" ou \"Producao\". "
                    },
                    "enviadaPorEmail": {
                      "type": "boolean",
                      "example": true,
                      "default": true,
                      "description": "Indica se a nota fiscal foi enviada para o e-mail do tomador;"
                    },
                    "dataCriacao": {
                      "type": "string",
                      "example": "2017-10-18T17:32:17Z",
                      "description": "Data da criação ",
                      "format": "date-time"
                    },
                    "dataUltimaAlteracao": {
                      "type": "string",
                      "example": "2017-10-18T18:14:41Z",
                      "description": "Data da última alteração ",
                      "format": "date-time"
                    },
                    "cliente": {
                      "type": "object",
                      "properties": {
                        "tipoPessoa": {
                          "type": "string",
                          "example": "F",
                          "description": "Tipo de pessoa do cliente"
                        },
                        "nome": {
                          "type": "string",
                          "example": "string",
                          "description": "Nome do cliente"
                        },
                        "email": {
                          "type": "string",
                          "example": "string",
                          "description": "E-mail do cliente"
                        },
                        "cpfCnpj": {
                          "type": "string",
                          "example": "string",
                          "description": "CPF ou CNPJ do cliente"
                        },
                        "inscricaoMunicipal": {
                          "description": "Inscrição municipal do cliente",
                          "type": "string"
                        },
                        "inscricaoEstadual": {
                          "type": "string",
                          "description": "Inscrição estadual do cliente"
                        },
                        "telefone": {
                          "description": "Telefone do cliente",
                          "type": "string"
                        },
                        "endereco": {
                          "type": "object",
                          "properties": {
                            "pais": {
                              "type": "string",
                              "description": "País do endereço"
                            },
                            "uf": {
                              "type": "string",
                              "example": "string",
                              "description": "Sigla do estado do endereço"
                            },
                            "cidade": {
                              "type": "string",
                              "example": "string",
                              "description": "Nome ou código IBGE da cidade"
                            },
                            "logradouro": {
                              "type": "string",
                              "example": "string",
                              "description": "Nome da rua"
                            },
                            "numero": {
                              "type": "string",
                              "example": "string",
                              "description": "Número da rua"
                            },
                            "complemento": {
                              "type": "string",
                              "example": "string",
                              "description": "Complemento do endereço"
                            },
                            "bairro": {
                              "type": "string",
                              "example": "string",
                              "description": "Bairro"
                            },
                            "cep": {
                              "type": "string",
                              "example": "string",
                              "description": "Código postal"
                            }
                          }
                        }
                      },
                      "description": "Identifica o cliente da nota fiscal. "
                    },
                    "numero": {
                      "type": "string",
                      "example": "string",
                      "description": "O número da nota fiscal na Autoridade Fiscal. É preenchido somente após a emissão da nota fiscal."
                    },
                    "codigoVerificacao": {
                      "type": "string",
                      "example": "string",
                      "description": "Código de verificação da NFS-e"
                    },
                    "chaveAcesso": {
                      "description": "Chave de acesso da NFS-e",
                      "type": "string"
                    },
                    "dataAutorizacao": {
                      "type": "string",
                      "example": "2017-10-18T17:32:41Z",
                      "description": "Data da autorização da NFS-e",
                      "format": "date-time"
                    },
                    "dataCancelamento": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Data do cancelamento da NFS-e. "
                    },
                    "linkDownloadPDF": {
                      "type": "string",
                      "example": "string",
                      "description": "O link direto para baixar o arquivo PDF da nota fiscal. É preenchido somente após a emissão da nota fiscal."
                    },
                    "linkDownloadXML": {
                      "type": "string",
                      "example": "string",
                      "description": "O link direto para baixar o arquivo XML da nota fiscal. É preenchido somente após a emissão da nota fiscal."
                    },
                    "numeroRps": {
                      "type": "number",
                      "example": 0,
                      "default": 0,
                      "description": "Indica o número do RPS da nota fiscal."
                    },
                    "serieRps": {
                      "type": "number",
                      "example": "string",
                      "description": "Indica a série do RPS da nota fiscal."
                    },
                    "dataCompetenciaRps": {
                      "type": "string",
                      "example": "2017-10-18T17:32:17Z",
                      "description": "Indica a data de competência que foi utilizada na NFS-e.",
                      "format": "date-time"
                    },
                    "rpsGerenciado": {
                      "type": "boolean",
                      "description": "Indica se o RPS/Série foi ou não gerenciado automaticamente pela API.",
                      "default": ""
                    },
                    "servico": {
                      "type": "object",
                      "properties": {
                        "descricao": {
                          "type": "string",
                          "example": "Discriminação do Serviço prestado",
                          "description": "Descrição do serviço "
                        },
                        "aliquotaIss": {
                          "type": "number",
                          "example": 0,
                          "default": 0,
                          "description": "Alíquota de ISS"
                        },
                        "issRetidoFonte": {
                          "type": "boolean",
                          "example": false,
                          "default": true,
                          "description": "Indica a retenção do imposto na fonte"
                        },
                        "codigoServicoMunicipio": {
                          "type": "string",
                          "example": "string",
                          "description": "Código de serviço do município"
                        },
                        "itemListaServicoLC116": {
                          "type": "string",
                          "example": "string",
                          "description": "Item da lista do serviço."
                        },
                        "cnae": {
                          "description": "CNAE",
                          "type": "string"
                        },
                        "codigoNBS": {
                          "type": "string",
                          "description": "Código NBS (Nomenclatura Brasileira de Serviços)"
                        },
                        "tipoImunidadeIss": {
                          "type": "string",
                          "description": "Identificação da Imunidade do ISSQN – somente para o caso de Imunidade."
                        },
                        "codigoTributacaoNacional": {
                          "type": "string",
                          "description": "Indica o código de tributação nacional."
                        },
                        "ufPrestacaoServico": {
                          "type": "string",
                          "description": "Sigla do estado em que o serviço foi prestado."
                        },
                        "municipioPrestacaoServico": {
                          "type": "integer",
                          "example": 0,
                          "default": 0,
                          "description": "Nome da cidade ou Código IBGE do município em que o serviço foi prestado."
                        },
                        "exportacao": {
                          "type": "boolean",
                          "description": "Indica se a NFS-e é de exportação de serviço. "
                        },
                        "ibsCbs": {
                          "type": "object",
                          "properties": {
                            "situacaoTributaria": {
                              "type": "string",
                              "description": "Código de Situação Tributária (CST) do IBS e CBS."
                            },
                            "classificacaoTributaria": {
                              "type": "string",
                              "description": "Código de Classificação Tributária do IBS e CBS."
                            },
                            "codigoIndicadorOperacao": {
                              "type": "string",
                              "description": "Código Indicador da Operação de Consumo"
                            },
                            "tipoOperacao": {
                              "type": "string",
                              "description": "Indica o tipo de operação."
                            },
                            "indicadorDestinatario": {
                              "type": "string",
                              "description": "Indica se o destinatário é diferente do tomador. \nOpcões: “Tomador” ou “Outros” "
                            },
                            "destinatario": {
                              "type": "object",
                              "properties": {
                                "tipoPessoa": {
                                  "type": "string",
                                  "description": "Tipo de pessoa do destinatário"
                                },
                                "nome": {
                                  "type": "string",
                                  "description": "Nome do destinatário."
                                },
                                "email": {
                                  "type": "string",
                                  "description": "E-mail do destinatário"
                                },
                                "telefone": {
                                  "type": "string",
                                  "description": "Telefone do destinatário"
                                },
                                "cpfCnpj": {
                                  "type": "string",
                                  "description": "CPF, CNPJ ou NIF (Número de identificação fiscal)"
                                },
                                "endereco": {
                                  "type": "object",
                                  "properties": {
                                    "pais": {
                                      "type": "string",
                                      "description": "País do destinatário"
                                    },
                                    "uf": {
                                      "type": "string",
                                      "description": "Sigla do estado do endereço"
                                    },
                                    "cidade": {
                                      "type": "string",
                                      "description": "Cidade do endereço"
                                    },
                                    "logradouro": {
                                      "type": "string",
                                      "description": "Nome da rua"
                                    },
                                    "numero": {
                                      "type": "string",
                                      "description": "Número da rua"
                                    },
                                    "complemento": {
                                      "type": "string",
                                      "description": "Complemento do endereço"
                                    },
                                    "bairro": {
                                      "type": "string",
                                      "description": "Bairro"
                                    },
                                    "cep": {
                                      "type": "string",
                                      "description": "Código postal do endereço"
                                    }
                                  },
                                  "description": "Endereço do destinatário"
                                }
                              },
                              "description": "Dados do destinatário do serviço"
                            },
                            "imovel": {
                              "type": "object",
                              "properties": {
                                "inscricaoImobiliariaFiscal": {
                                  "type": "string",
                                  "description": "Inscrição imobiliária fiscal\n(código fornecido pela prefeitura para a identificação da obra ou para fins de recolhimento do IPTU)"
                                },
                                "codigoCIB": {
                                  "type": "string",
                                  "description": "Código do Cadastro Imobiliário Brasileiro - CIB"
                                },
                                "endereco": {
                                  "type": "object",
                                  "properties": {
                                    "pais": {
                                      "type": "string",
                                      "description": "País"
                                    },
                                    "uf": {
                                      "type": "string",
                                      "description": "Sigla do estado do endereço"
                                    },
                                    "cidade": {
                                      "type": "string",
                                      "description": "Nome da cidade"
                                    },
                                    "logradouro": {
                                      "type": "string",
                                      "description": "Nome da rua."
                                    },
                                    "numero": {
                                      "type": "string",
                                      "description": "Número da rua"
                                    },
                                    "complemento": {
                                      "type": "string",
                                      "description": "Complemento do endereço"
                                    },
                                    "bairro": {
                                      "type": "string",
                                      "description": "Bairro"
                                    },
                                    "cep": {
                                      "type": "string",
                                      "description": "Código postal"
                                    }
                                  }
                                }
                              },
                              "description": "Dados do imóvel"
                            },
                            "operacaoGovernamental": {
                              "type": "object",
                              "properties": {
                                "tipoEnteGovernamental": {
                                  "type": "string",
                                  "description": "Tipo de Ente Governamental"
                                }
                              },
                              "description": "Grupo de Informações de Operação Governamental"
                            }
                          },
                          "description": "Grupo de informações relacionadas ao IBS e CBS"
                        },
                        "pisCofinsApuracaoPropria": {
                          "type": "object",
                          "properties": {
                            "baseCalculo": {
                              "type": "number",
                              "description": "Base de Cálculo do PIS e COFINS de Apuração Própria"
                            },
                            "aliquotaPis": {
                              "type": "number",
                              "description": "Alíquota do PIS de Apuração Própria"
                            },
                            "valorPis": {
                              "type": "number",
                              "description": "Valor do PIS de Apuração Própria"
                            },
                            "aliquotaCofins": {
                              "type": "number",
                              "description": "Alíquota do COFINS de Apuração Própria"
                            },
                            "valorCofins": {
                              "type": "number",
                              "description": "Valor do COFINS de Apuração Própria"
                            }
                          },
                          "description": "PIS/COFINS de Apuração Própria"
                        },
                        "situacaoTributariaPisCofins": {
                          "type": "string",
                          "description": "Indica o Código de Situação Tributária (CST) aplicado ao PIS e COFINS na operação"
                        },
                        "tipoRetencaoPisCofins": {
                          "type": "string",
                          "description": "Indica o tipo de retenção dos impostos federais"
                        }
                      },
                      "description": "Dados do serviço"
                    },
                    "naturezaOperacao": {
                      "type": "string",
                      "example": "1"
                    },
                    "valorCofins": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    },
                    "valorCsll": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    },
                    "valorInss": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    },
                    "valorIr": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    },
                    "valorPis": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    },
                    "deducoes": {
                      "type": "number",
                      "description": "Retenções ou valores descontados no valor bruto da nota previsto em lei."
                    },
                    "descontos": {
                      "type": "number",
                      "description": "Desconto incondicional concedido no ato da emissão da nota fiscal."
                    },
                    "descontoCondicionado": {
                      "type": "number",
                      "description": "Desconto condicionado"
                    },
                    "valorIss": {
                      "type": "number",
                      "description": "Valor do ISS"
                    },
                    "observacoes": {
                      "type": "string",
                      "description": "Informações adicionais ou observações do documento."
                    },
                    "construcaoCivil": {
                      "type": "object",
                      "description": "Grupo de informações relativas à obras de construção civil e congêneres",
                      "properties": {
                        "inscricaoImobiliariaFiscal": {
                          "type": "string",
                          "description": "Inscrição imobiliária fiscal (código fornecido pela prefeitura para identificação da obra ou para fins de recolhimento do IPTU)"
                        },
                        "art": {
                          "type": "string",
                          "description": "Código ART (anotação de responsabilidade técnica)"
                        },
                        "codigoObra": {
                          "type": "string",
                          "description": "Número de identificação da obra na prefeitura"
                        },
                        "codigoCIB": {
                          "type": "string",
                          "description": "Código do cadastro imobiliário brasileiro"
                        },
                        "cei": {
                          "type": "string",
                          "description": "Número de identificação da obra. Cadastro Nacional de Obras (CNO) ou Cadastro Específico do INSS (CEI)"
                        },
                        "enderecoObra": {
                          "type": "object",
                          "properties": {
                            "logradouro": {
                              "type": "string",
                              "description": "Logradouro do endereço da obra"
                            },
                            "numero": {
                              "type": "string",
                              "description": "Número do endereço da obra"
                            },
                            "complemento": {
                              "type": "string",
                              "description": "Complemento do do endereço da obra"
                            },
                            "bairro": {
                              "type": "string",
                              "description": "Bairro do endereço da obra"
                            },
                            "cep": {
                              "type": "string",
                              "description": "Código postal do endereço da obra"
                            }
                          },
                          "description": "Grupo de informações do endereço da obra"
                        }
                      }
                    },
                    "detalhesEvento": {
                      "type": "object",
                      "properties": {
                        "identificador": {
                          "type": "string",
                          "description": "Identificação da atividade de evento (código identificador de evento determinado pela Administração Tributária Municipal)"
                        },
                        "nome": {
                          "type": "string",
                          "description": "Nome do evento"
                        },
                        "dataInicio": {
                          "type": "string",
                          "format": "date",
                          "description": "Data de início da atividade de evento."
                        },
                        "dataFim": {
                          "type": "string",
                          "format": "date",
                          "description": "Data de fim da atividade de evento."
                        },
                        "endereco": {
                          "type": "object",
                          "properties": {
                            "uf": {
                              "type": "string",
                              "description": "Sigla do estado do endereço"
                            },
                            "cidade": {
                              "type": "string",
                              "description": "Nome da cidade"
                            },
                            "logradouro": {
                              "type": "string",
                              "description": "Logradouro do evento"
                            },
                            "numero": {
                              "type": "string",
                              "description": "Número do endereço do evento"
                            },
                            "complemento": {
                              "type": "string",
                              "description": "Complemento do endereço do evento"
                            },
                            "bairro": {
                              "type": "string",
                              "description": "Bairro do endereço do evento"
                            },
                            "cep": {
                              "type": "string",
                              "description": "Código postal do endereço do evento"
                            }
                          },
                          "description": "Endereço do evento"
                        }
                      },
                      "description": "Grupo de informações relativas a atividades de eventos"
                    },
                    "comercioExterior": {
                      "type": "object",
                      "properties": {
                        "modalidadePrestacaoServico": {
                          "type": "string",
                          "description": "Modo de prestação"
                        },
                        "vinculoPrestador": {
                          "type": "string",
                          "description": "Vínculo entre as partes no negócio"
                        },
                        "moeda": {
                          "type": "string",
                          "description": "Código da moeda da transação comercial"
                        },
                        "valorServicoMoeda": {
                          "type": "number",
                          "description": "Valor do serviço prestado expresso em moeda estrangeira"
                        },
                        "codigoMecanismoApoioPrestador": {
                          "type": "string",
                          "description": "Indica o mecanismo de apoio/fomento ao comércio exterior utilizado pelo prestador do serviço"
                        },
                        "codigoMecanismoApoioTomador": {
                          "type": "string",
                          "description": "Indica o mecanismo de apoio/fomento ao comércio exterior utilizado pelo tomador do serviço"
                        },
                        "movimentacaoTemporariaBens": {
                          "type": "string",
                          "description": "Indica o vínculo da operação à movimentação temporária de bens"
                        },
                        "numeroDeclaracaoImportacao": {
                          "type": "string",
                          "description": "Número da Declaração de Importação averbado"
                        },
                        "numeroRegistroExportacao": {
                          "type": "string",
                          "description": "Número do Registro de Exportação averbado"
                        },
                        "compartilharNFSeComMDIC": {
                          "type": "boolean",
                          "description": "Indica se a NFS-e deverá ser disponibilizada ao MDIC (Ministério do Desenvolvimento, Indústria e Comércio Exterior)"
                        }
                      },
                      "description": "Grupo de informações de comércio exterior"
                    },
                    "beneficioMunicipal": {
                      "type": "object",
                      "properties": {
                        "codigo": {
                          "type": "string",
                          "description": "Código do benefício municipal"
                        },
                        "percentualReducaoBaseCalculo": {
                          "type": "number",
                          "format": "double",
                          "description": "Percentual de redução da base de cálculo"
                        },
                        "valorReducaoBaseCalculo": {
                          "type": "string",
                          "description": "Valor de redução da base de cálculo"
                        }
                      },
                      "description": "Grupo de informações de benefício municipal"
                    },
                    "percentualAproximadoTributos": {
                      "type": "object",
                      "properties": {
                        "detalhado": {
                          "type": "object",
                          "properties": {
                            "percentualFederal": {
                              "type": "number",
                              "description": "Percentual federal dos tributos"
                            },
                            "percentualEstadual": {
                              "type": "number",
                              "description": "Percentual estadual dos tributos"
                            },
                            "percentualMunicipal": {
                              "type": "number",
                              "description": "Percentual municipal dos tributos"
                            }
                          },
                          "description": "Grupo de percentual aproximado de tributos no modelo detalhado"
                        },
                        "simplesNacional": {
                          "type": "object",
                          "properties": {
                            "aliquota": {
                              "type": "number",
                              "description": "Indica a alíquota do simples nacional"
                            }
                          },
                          "description": "Grupo de percentual aproximado de tributos de empresas optantes pelo simples nacional"
                        }
                      },
                      "description": "Grupo de percentual aproximado de tributos"
                    },
                    "nfseReferenciada": {
                      "type": "object",
                      "description": "Grupo de NFS-e referenciada. \n\nA NFS-e deve ser referenciada quando tipoOperacao = RecebimentoDoPagamentoComFornecimentoJaRealizado\nOU\ntipoOperacao =  FornecimentoComPagamentoJaRealizado\n",
                      "properties": {
                        "chaveAcesso": {
                          "type": "string",
                          "description": "Chave de acesso da NFS-e de origem"
                        }
                      }
                    },
                    "formaPagamentoFatura": {
                      "type": "string",
                      "description": "Forma de pagamento da Fatura. "
                    },
                    "valorTotal": {
                      "type": "number",
                      "example": 10,
                      "default": 0,
                      "description": "Valor total da NFS-e"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"Message\": \"The request is invalid.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "Message": {
                      "type": "string",
                      "example": "The request is invalid."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n    {\n        \"codigo\": \"AUT002\",\n        \"mensagem\": \"Acesso negado. APIKey invalida, por favor verifique se setou o header do request corretamente com uma APIKey válida, por exemplo: \\\"Authorization: Basic {your-APIKey-here}\\\".\"\n    }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "codigo": {
                        "type": "string",
                        "example": "AUT002"
                      },
                      "mensagem": {
                        "type": "string",
                        "example": "Acesso negado. APIKey invalida, por favor verifique se setou o header do request corretamente com uma APIKey válida, por exemplo: \"Authorization: Basic {your-APIKey-here}\"."
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n    {\n        \"codigo\": \"AUT001\",\n        \"mensagem\": \"Acesso negado. APIKey invalida, por favor verifique se ela está correta.\"\n    }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "codigo": {
                        "type": "string",
                        "example": "AUT001"
                      },
                      "mensagem": {
                        "type": "string",
                        "example": "Acesso negado. APIKey invalida, por favor verifique se ela está correta."
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "500",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "Erro interno do servidor"
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "csharp",
              "code": "public string ConsultarNFAsync(Guid empresaId, Guid nfeId)\n{\n  try\n  {\n    using (var httpClient = new HttpClient())\n    {\n      httpClient.DefaultRequestHeaders.Clear();\n      httpClient.DefaultRequestHeaders.Add(\"Authorization\", \"Basic {Sua-ApiKey-Aqui}\");\n      httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(\"application/json\"));\n\n      using (var request = new HttpRequestMessage(HttpMethod.Get, string.Format(\"https://api.enotasgw.com.br/v1/empresas/{0}/nfes/{1}\", empresaId, nfeId)))\n      {\n        using (var response = httpClient.SendAsync(request).Result)\n        {\n          var resultContent = response.Content.ReadAsStringAsync().Result;\n\n          if (response.IsSuccessStatusCode)\n          {\n            return resultContent;\n          }\n          else\n          {\n            throw new Exception(((int)response.StatusCode) + \" - \" + response.ReasonPhrase);\n          }\n        }\n      }\n    }\n  }\n  catch (Exception)\n  {\n    throw;\n  }\n}",
              "name": "Exemplo C#"
            },
            {
              "language": "php",
              "code": "<?php\n\theader('Content-Type: text/html; charset=utf-8');\t\n\t\n\trequire('../src/eNotasGW.php');\n\t\n\tuse eNotasGW\\Api\\Exceptions as Exceptions;\n\n\teNotasGW::configure(array(\n\t\t'apiKey' => '<api key>'\n\t));\n\t\n\t$empresaId = 'a9f9d282-fdb9-4259-a7b8-2f19be4da06d';\n\t\n\ttry\n\t{\n\t\t$nfeId = 'ab765f39-a2e0-4c4b-88b4-4b6b4a2baace';\n\t\t$dadosNFe = eNotasGW::$NFeApi->consultar($empresaId, $nfeId);\n\t\t\n\t\techo 'Dados da nota (consulta por id único): </br>';\n\t\techo json_encode($dadosNFe);\n\t}\n\tcatch(Exceptions\\invalidApiKeyException $ex) {\n\t\techo 'Erro de autenticação: </br></br>';\n\t\techo $ex->getMessage();\n\t}\n\tcatch(Exceptions\\unauthorizedException $ex) {\n\t\techo 'Acesso negado: </br></br>';\n\t\techo $ex->getMessage();\n\t}\n\tcatch(Exceptions\\apiException $ex) {\n\t\techo 'Erro de validação: </br></br>';\n\t\techo $ex->getMessage();\n\t}\n\tcatch(Exceptions\\requestException $ex) {\n\t\techo 'Erro na requisição web: </br></br>';\n\t\t\n\t\techo 'Requested url: ' . $ex->requestedUrl;\n\t\techo '</br>';\n\t\techo 'Response Code: ' . $ex->getCode();\n\t\techo '</br>';\n\t\techo 'Message: ' . $ex->getMessage();\n\t\techo '</br>';\n\t\techo 'Response Body: ' . $ex->responseBody;\n\t}\n?>",
              "name": "Exemplo PHP"
            }
          ],
          "samples-languages": [
            "csharp",
            "php"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```