--- updatedAt: 2026-08-17T16:17:27.000Z agentTools: projectIndex: https://docs.notagateway.com.br/llms.txt --- # Emissão de Nota Fiscal ```json JSON - Simplificado { "tipo": "NFS-e", "idExterno": "teste_001", "ambienteEmissao": "Producao", "cliente": { "tipoPessoa": "F", "nome": "Cliente teste", "email": "teste@teste.com.br", "cpfCnpj": "38618699772", "inscricaoMunicipal": null, "inscricaoEstadual": null, "telefone": "3132223333", "endereco": { "pais": "Brasil", "uf": "MG", "cidade": "Belo Horizonte", "logradouro": "Rua Sergipe", "numero": "1014", "complemento": "7o Andar", "bairro": "Savassi", "cep": "30130174" } }, "servico": { "descricao": "Teste webservice", "issRetidoFonte": false, "ibsCbs": { "classificacaoTributaria": "000001", "codigoIndicadorOperacao": "030101" }, "valorCofins": 0, "valorCsll": 0, "valorInss": 0, "valorIr": 0, "valorPis": 0 }, "valorTotal": 1 } ``` ```json JSON - Completo { "tipo": "NFS-e", "idExterno": "test20250213", "ambienteEmissao": "Homologacao", "numeroRps": "1", "serieRps": "5", "dataCompetencia": "2025-07-01T08:15:00Z", "enviarPorEmail": false, "dadosAdicionaisEmail": { "outrosDestinatarios": "email01@mail.com; email02@mail.com" }, "cliente": { "tipoPessoa": "F", "nome": "John Doe", "email": "teste@teste.com", "cpfCnpj": "12143946635", "inscricaoMunicipal": null, "inscricaoEstadual": null, "telefone": "3132223333", "endereco": { "pais": "Brasil", "uf": "MG", "cidade": "Belo Horizonte", "cidadeCodigoIBGE": "3106200", "logradouro": "Rua Sergipe", "numero": "00", "complemento": "Savassi", "bairro": "Funcionarios", "cep": "30130160" } }, "servico": { "descricao": "Platform Service Fee", "aliquotaIss": "2.00", "issRetidoFonte": false, "codigoServicoMunicipio": "010700188", "itemListaServicoLC116": "1.03", "cnae": "115090000", "codigoNBS": "115013000", "exportacao": false, "regimeEspecialTributacao": "0", "tipoImunidadeIss": "1", "codigoTributacaoNacional": "01.03.01", "paisPrestacaoServico": "Brasil", "ufPrestacaoServico": "MG", "municipioPrestacaoServico": "3106200", "exigibilidadeSuspensa": { "tipo": "string", "numeroProcesso": "string" }, "ibsCbs": { "situacaoTributaria": "000", "classificacaoTributaria": "000001", "codigoIndicadorOperacao": "030101", "tipoOperacao": "FornecimentoComPagamentoPosterior", "indicadorDestinatario": "Outros", "destinatario": { "tipoPessoa": "F", "nome": "Jane Doe", "cpfCnpj": "60321232003", "endereco": { "uf": "MG", "cidade": "Uberlândia", "logradouro": "Rua dos Andradas", "numero": "450", "complemento": "Bloco B, Apto 302", "bairro": "Centro", "cep": "38400018" } }, "imovel": { "inscricaoImobiliariaFiscal": "12345565654433", "codigoCIB": null, "endereco": { "uf": "MG", "cidade": "Uberlândia", "logradouro": "Rua dos Andradas", "numero": "450", "complemento": null, "bairro": "Centro", "cep": "38400018" } }, "operacaoGovernamental": { "tipoEnteGovernamental": "Uniao", "tipoOperacao": "FornecimentoComPagamentoPosterior" }, "reembolsoRepasseRessarcimento": [ { "tipo": "99", "descricao": "MULTA DE TRANSITO", "documento": { "docNaoFiscalOutro": { "numero": "1", "descricao": "DAE DOCUMENTO MULTA" }, "fornecedor": { "tipoPessoa": "J", "nome": "DETRAN MG", "cpfCnpj": "64566951000105" }, "dataEmissao": "2026-06-01T03:00:00Z", "dataCompetencia": "2026-06-01T03:00:00Z" }, "valor": 70 }, { "tipo": "99", "descricao": "MULTA DE TRANSITO", "documento": { "docNaoFiscalOutro": { "numero": "2", "descricao": "DAE DOCUMENTO MULTA" }, "fornecedor": { "tipoPessoa": "J", "nome": "DETRAN MG", "cpfCnpj": "64566951000105" }, "dataEmissao": "2026-06-01T03:00:00Z", "dataCompetencia": "2026-06-01T03:00:00Z" }, "valor": 120 } ], "tributacaoRegular": { "classificacaoTributaria": "000001" } }, "pisCofinsApuracaoPropria": { "baseCalculo": 100, "aliquotaPis": 0.65, "valorPis": 0.65, "aliquotaCofins": 3, "valorCofins": 3 }, "situacaoTributariaPisCofins": "00", "tipoRetencaoPisCofins": "PisCofinsNaoRetido", "valorPis": 0, "valorCofins": 0, "valorCsll": 0, "valorInss": 0, "valorIr": 0 }, "construcaoCivil": { "inscricaoImobiliariaFiscal": "12345565654433", "codigoObra": null, "codigoCIB": null, "cei": null, "enderecoObra": { "logradouro": "Rua dos Andradas", "numero": "450", "complemento": null, "bairro": "Centro", "cep": "38400018" } }, "detalhesEvento": { "identificador": "EVT20251007254180", "nome": "Festival de MPB", "dataInicio": "2025-10-12", "dataFim": "2025-10-14", "endereco": { "logradouro": "Rua dos Andradas", "numero": "450", "complemento": null, "bairro": "Centro", "cep": "38400018" } }, "comercioExterior": { "modalidadePrestacaoServico": "Desconhecido", "vinculoPrestador": "SemVinculoComTomador", "moeda": "BRL", "valorServicoMoeda": 10.5, "codigoMecanismoApoioPrestador": "01", "codigoMecanismoApoioTomador": "01", "movimentacaoTemporariaBens": "Nao", "numeroDeclaracaoImportacao": null, "numeroRegistroExportacao": null, "comparilharNFSeComMDIC": false }, "beneficioMunicipal": { "codigo": "41069020200013", "percentualReducaoBaseCalculo": 3 }, "percentualAproximadoTributos": { "detalhado": { "percentualFederal": 5, "percentualEstadual": 9, "percentualMunicipal": 0 }, "simplesNacional": { "aliquota": 6 } }, "nfseReferenciada": [ { "chaveAcesso": "326460112108057490001600000000000088546021772456046" } ], "formaPagamentoFatura": null, "deducoes": null, "descontos": null, "descontoCondicionado": null, "valorTotal": 10.5, "naturezaOperacao": "1", "observacoes": "Teste 1234" } ``` ### Atributos gerenciados pelo Gateway Por possuirem comportamentos variáveis (por município), atributos como Natureza da Operação, Número e Série de RPS, são gerenciados automaticamente pelo Gateway. Se desejar você também pode sobrescrever nossos valores. # 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": { "post": { "summary": "Emissão de Nota Fiscal", "description": "", "operationId": "emissao-de-nota-fiscal", "parameters": [ { "name": "empresaId", "in": "path", "description": "Identificador único da Empresa relacionada a Nota Fiscal que deseja emitir", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "valorTotal" ], "properties": { "idExterno": { "type": "string", "description": "ID de mapeamento com seu sistema. Impedirá duplicidade e poderá ser usado para identificar sua nota." }, "ambienteEmissao": { "type": "string", "description": "O ambiente onde a NF-e é emitida. A Autoridade Fiscal pode fornecer o ambiente de \"Homologacao\" ou \"Producao\". O primeiro corresponde ao ambiente de Homologação (Stage) e o segundo significa o ambiente de Produção." }, "numeroRps": { "type": "integer", "description": "Indica o número do RPS utilizado na NFS-e. Caso o campo não seja preenchido, a API irá gerenciar a sequência automaticamente considerando a configuração no cadastro da empresa." }, "serieRps": { "type": "string", "description": "Indica a série do RPS utilizado na NFS-e. Caso o campo não seja preenchido, a API irá gerenciar a sequência automaticamente considerando a configuração no cadastro da empresa." }, "enviarPorEmail": { "type": "boolean", "description": "Indica se a nota fiscal deve ser enviada para o e-mail do cliente após ser emitida.", "default": "false" }, "dadosAdicionaisEmail": { "type": "object", "properties": { "outrosDestinatarios": { "type": "string", "description": "Indica o e-mail adicional para o qual a NFS-e deverá ser enviada" } }, "description": "Permite informar mais de um destinatário de e-mail para receber o PDF da nota fiscal autorizada e cancelada." }, "cliente": { "properties": { "tipoPessoa": { "type": "string", "description": "Tipo de pessoa do cliente. Valores: \"F\" (Pessoa Física), \"J\" (Pessoa Jurídica).\nEm caso de clientes do exterior deve ser passado como “F”, visto que não são entidades jurídicas no Brasil." }, "nome": { "type": "string", "description": "Nome do cliente" }, "email": { "type": "string", "description": "E-mail do cliente" }, "telefone": { "type": "string", "description": "Telefone do cliente" }, "cpfCnpj": { "type": "string", "description": "CPF ou CNPJ do cliente" }, "inscricaoMunicipal": { "type": "string", "description": "Inscrição municipal do cliente" }, "inscricaoEstadual": { "type": "string", "description": "Inscrição estadual do cliente" } }, "required": [ "nome" ], "type": "object" }, "endereco": { "properties": { "pais": { "type": "string", "description": "País. É possível enviar o nome do país por extenso ou código do país, conforme a tabela do BACEN\nObrigatório se o cliente for do exterior." }, "uf": { "type": "string", "description": "Sigla do Estado (MG, RJ, etc.)" }, "cidade": { "type": "string", "description": "Nome da cidade ou seu código IBGE" }, "logradouro": { "type": "string", "description": "Endereço do cliente" }, "numero": { "type": "string", "description": "Número do endereço" }, "complemento": { "type": "string", "description": "Complemento do endereço" }, "bairro": { "type": "string", "description": "Nome do bairro" }, "cep": { "type": "string", "description": "Número do CEP" } }, "type": "object" }, "servico": { "type": "object", "description": "Objeto contendo dados do serviço prestado", "required": [ "descricao" ], "properties": { "descricao": { "type": "string", "description": "Descrição do serviço prestado. Exemplo: “Consultoria de imagem”" }, "aliquotaIss": { "type": "number", "description": "Alíquota de ISS", "format": "double" }, "issRetidoFonte": { "type": "boolean", "description": "Indica se o ISS será retido na fonte ou não", "default": "false" }, "codigoServicoMunicipio": { "type": "string", "description": "Código do serviço prestado (Fornecido pela prefeitura)" }, "itemListaServicoLC116": { "type": "string", "description": "Item da lista de serviço (LC 116)" }, "cnae": { "type": "string", "description": "Código CNAE" }, "codigoNBS": { "type": "string", "description": "Código NBS (Nomenclatura Brasileira sobre Serviços)" }, "exportacao": { "type": "boolean", "description": "Indica se a operação refere-se a exportação de serviço" }, "regimeEspecialTributacao": { "type": "string", "description": "Permite que o regime especial de tributação seja informado no momento da emissão da NFS-e.\nExemplo: ”9”\n\nA recomendação é que o campo só seja informado quando houver a necessidade de personalizar o regime de acordo com as características da NFS-e." }, "tipoImunidadeIss": { "type": "string", "description": "Identificação da Imunidade do ISSQN – somente para o caso de Imunidade.\n\nCaso a natureza de operação seja enviada como imunidade e o tipo de imunidade não seja informado, a API irá setar o valor padrão = “1” (Patrimônio, renda ou serviços, uns dos outros (CF88, Art 150, VI, a);)" }, "codigoTributacaoNacional": { "type": "string", "description": "Indica o código de tributação nacional." }, "paisPrestacaoServico": { "type": "string", "description": "Nome do país em que o serviço foi prestado. " }, "ufPrestacaoServico": { "type": "string", "description": "Sigla do estado em que o serviço foi prestado." }, "municipioPrestacaoServico": { "type": "string", "description": "Nome da cidade ou Código IBGE do município em que o serviço foi prestado." }, "ibsCbs": { "type": "object", "properties": { "situacaoTributaria": { "type": "string", "description": "Código de Situação Tributária (CST) do IBS e CBS. Caso o campo não seja informado, o CST será definido automaticamente com base na classificaoTributaria." }, "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.\n\nCampo deve ser informado para as seguintes situações previstas na LC 214/2025:\n\n- Aquisição de serviços pela administração pública direta, por autarquias e por fundações públicas: Art. 10 §2º (Qualquer serviço);\n- Cessão onerosa de bem imóvel: Art. 254 III (Serviço 25.05 da LC 116/2003);\n- Arrendamento de bem imóvel: Art. 254 III (Serviço 15.09 da LC 116/2003);\n- Administração de bem imóvel: Art. 254 IV (Serviço 17.12 da LC 116/2003);\n- Intermediação de bem imóvel: Art. 254 IV (Serviço 10.05 da LC 116/2003)." }, "indicadorDestinatario": { "type": "string", "description": "Indica se o destinatário é diferente do tomador. Opcões: “Tomador” ou “Outros” Valor padrão: “Tomador”\n\nCaso o destinatário do serviço seja um terceiro, é necessário enviar o campo preenchido conforme o exemplo abaixo:\n\"indicadorDestinatario\": \"Outros\"" }, "destinatario": { "type": "object", "properties": { "tipoPessoa": { "type": "string", "description": "Tipo de pessoa do destinatário.\nValores: \"F\" (Pessoa Física), \"J\" (Pessoa Jurídica).\nEm caso de clientes do exterior deve ser passado como “F”, visto que não são entidades jurídicas no Brasil." }, "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. É possível enviar o nome do país por extenso ou código do país, conforme a tabela do BACEN\nObrigatório se for do exterior." }, "uf": { "type": "string", "description": "Sigla do estado do endereço" }, "cidade": { "type": "string", "description": "Nome ou código IBGE da cidade. Exemplo: “Campinas” ou “3509502”" }, "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": "Indica os dados do destinatário do serviço.\nEste grupo deve ser informado apenas quando o destinatário da nota for um terceiro, diferente do tomador." }, "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", "description": "Endereço do Imóvel", "properties": { "pais": { "type": "string", "description": "País. É possível enviar o nome do país por extenso ou código do país, conforme a tabela do BACEN\nObrigatório se for do exterior." }, "uf": { "type": "string", "description": "Sigla do estado do endereço" }, "cidade": { "type": "string", "description": "Nome ou código IBGE da cidade. Exemplo: “Campinas” ou “3509502" }, "logradouro": { "type": "string" }, "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": "Grupo de informações de operações relacionadas a bens imóveis, exceto obras." }, "operacaoGovernamental": { "type": "object", "properties": { "tipoEnteGovernamental": { "type": "string", "description": "Tipo de Ente Governamental\n\nValores possíveis:\n● \"Uniao\"\n● \"Estado\"\n● \"DistritoFederal\"\n● \"Municipio\"" } }, "description": "Grupo de Informações de Operação Governamental", "required": [ "tipoEnteGovernamental" ] }, "reembolsoRepasseRessarcimento": { "type": "array", "items": { "properties": { "tipo": { "type": "string", "description": "Código do tipo de valor incluído no documento. " }, "descricao": { "type": "string", "description": "Descrição do item de reembolso, repasse ou ressarcimento." }, "documento": { "type": "object", "description": "Dados do documento relacionado ao item.", "properties": { "docNaoFiscalOutro": { "type": "object", "description": "Dados do documento não fiscal ou de outro tipo", "properties": { "numero": { "type": "string", "description": "Número de identificação do documento." }, "descricao": { "type": "string", "description": "Descrição do documento não fiscal ou de outro tipo." } } }, "fornecedor": { "type": "object", "description": "Dados do fornecedor relacionado ao documento.", "properties": { "tipoPessoa": { "type": "string", "description": "Tipo de pessoa do Fornecedor\n\"J\" = Pessoa Jurídica \n\"F\" = Pessoa Física" }, "nome": { "type": "string", "description": "Nome ou razão social do Fornecedor" }, "cpfCnpj": { "type": "string", "description": "CPF ou CNPJ do Fornecedor" } } }, "dataEmissao": { "type": "string", "format": "date-time", "description": "Data e hora de emissão do documento" }, "dataCompetencia": { "type": "string", "format": "date-time", "description": "Data e hora de competência do documento" } } }, "valor": { "type": "number", "description": "Valor do reembolso, repasse ou ressarcimento" } }, "type": "object" }, "description": "Grupo de informações de reembolso/repasse/ressarcimento" }, "tributacaoRegular": { "type": "object", "description": "Grupo de informações de tributação regular de IBS e CBS \n", "properties": { "classificacaoTributaria": { "type": "string", "description": "Classificação tributária de tributação regular do IBS e CBS" } } } }, "description": "Grupo de informações relacionadas ao IBS e CBS" }, "pisCofinsApuracaoPropria": { "type": "object", "properties": { "baseCalculo": { "type": "number", "format": "double", "description": "Base de Cálculo do PIS e COFINS de Apuração Própria. (Opcional)\nCaso o campo não seja informado, será considerado automaticamente o valor total da NFS-e." }, "aliquotaPis": { "type": "number", "format": "double", "description": "Alíquota do PIS de Apuração Própria\nCaso a alíquota não seja informada, ela será deduzida" }, "valorPis": { "type": "number", "format": "double", "description": "Valor do PIS de Apuração Própria" }, "aliquotaCofins": { "type": "string", "description": "Alíquota do COFINS de Apuração Própria\nCaso a alíquota não seja informada, ela será deduzida." }, "valorCofins": { "type": "string", "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. Caso o valorPis e valorCofins sejam enviados no JSON e a situacaoTributariaPisCofins não for informada, iremos preenchê-la automaticamente como 01 = Operacão Tributável com Alíquota Básica." }, "tipoRetencaoPisCofins": { "type": "string", "description": "Indica o tipo de retenção dos impostos federais. Caso o valorPis e valorCofins sejam enviados no JSON e o tipoRetencaoPisCofins não for informado, iremos preenchê-lo automaticamente como PisCofinsRetido." }, "valorPis": { "type": "number", "description": "Valor do PIS Retido", "format": "double" }, "valorCofins": { "type": "number", "description": "Valor do COFINS Retido", "format": "double" }, "valorCsll": { "type": "number", "description": "Valor do CSLL", "format": "double" }, "valorInss": { "type": "number", "description": "Valor do INSS (Contribuição Previdenciária)", "format": "double" }, "valorIr": { "type": "number", "description": "Valor do IR", "format": "double" }, "exigibilidadeSuspensa": { "type": "object", "description": "Indica se a emissão de NFS-e tem suspensão de exigibilidade do ISSQN. ", "properties": { "tipo": { "type": "string", "description": "Tipo da suspensão: \n\n\"1\" = Exigibilidade do ISSQN Suspensa por Decisão Judicial;\n\"2\" = Exigibilidade do ISSQN Suspensa por Processo Administrativo;" }, "numeroProcesso": { "type": "string", "description": "Número do processo de suspensão" } } } } }, "dataCompetencia": { "type": "string", "format": "date-time", "description": "Data de competência da NFS-e. A padronização do atributo de data de competência segue o formato ISO 8601 e UTC, que é representado pela seguinte configuração: YYYY-MM-DDThh:MM:ssZ\n\nExemplo: “dataCompetencia\": \"2019-07-01T08:15:00Z\"\n\nSe o campo não for informado, a data da competência será igual a data da criação da NFS-e. " }, "naturezaOperacao": { "type": "string", "description": "Indica qual a natureza da operação/exigibilidade de ISS da NFS-e.\nCaso a naturezaOperacao não seja informada, o gateway fará o envio automaticamente, conforme as características da nota fiscal." }, "observacoes": { "type": "string", "description": "Informações adicionais ou observações do documento." }, "construcaoCivil": { "type": "object", "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" } }, "description": "Grupo de informações relativas à obras de construção civil e congêneres" }, "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", "description": "Data de fim da atividade de evento", "format": "date" }, "endereco": { "type": "object", "description": "Endereço do evento", "properties": { "uf": { "type": "string", "description": "Sigla do estado do endereço" }, "cidade": { "type": "string", "description": "Nome ou código IBGE 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": "Grupo de informações relativas a atividades de eventos", "required": [ "identificador", "nome", "dataInicio" ] }, "comercioExterior": { "type": "object", "description": "Grupo de informações de comércio exterior", "properties": { "modalidadePrestacaoServico": { "type": "string", "description": "Indica o modo de prestação.\n\nValores possíveis:\n“0” ou \"Desconhecido\"\n“1” ou \"Transfronteirico\"\n“2” ou \"ConsumoNoBrasil\"\n“3” ou \"MovimentoTemporarioDePessoasFisicas\"\n“4” ou \"ConsumoNoExterior\"" }, "vinculoPrestador": { "type": "string", "description": "Vínculo entre as partes no negócio:\n\nValores possíveis:\n\n“SemVinculoComTomador” (Valor padrão)\n“Controlada”\n“Controladora”\n“Coligada”\n“Matriz”\n“FilialOuSucursal”\n“OutroVinculo”" }, "moeda": { "type": "string", "description": "Identifica o código da moeda da transação comercial.\nPode ser informado o código ou sigla da moeda de acordo com a tabela do BACEN.\nCaso o campo não seja informado, a moeda considerada será o real brasileiro (BRL). Exemplo: “BRL”" }, "valorServicoMoeda": { "type": "number", "description": "Valor do serviço prestado expresso em moeda estrangeira.Nesse campo deve ser preenchido com a cotação da moeda em relação ao real no dia da emissão da nota.\nCaso o campo não seja informado, o valor total da nota fiscal será informado em real brasileiro (BRL).", "format": "double" }, "codigoMecanismoApoioPrestador": { "type": "string", "description": "Indica o mecanismo de apoio/fomento ao comércio exterior utilizado pelo prestador do serviço.\n\nValores possíveis:\n“01” - Nenhum (Valor padrão)\n“02“ - ACC - Adiantamento sobre Contrato de Câmbio – Redução a Zero do IR e do IOF\n“03“ - ACE – Adiantamento sobre Cambiais Entregues - Redução a Zero do IR e do IOF\n“04“ - BNDES-Exim Pós-Embarque – Serviços\n“05“ - BNDES-Exim Pré-Embarque - Serviços\n“06“ - FGE - Fundo de Garantia à Exportação\n“07“ - PROEX - Equalização\n“08“ - PROEX - Financiamento" }, "codigoMecanismoApoioTomador": { "type": "string", "description": "Indica o mecanismo de apoio/fomento ao comércio exterior utilizado pelo tomador do serviço.\n\n“01” - Nenhum (Valor padrão)\n“02” - Adm.Pública e Repr.Internacional\n“03” - Alugueis e Arrend.Mercantil de maquinas, equip., embarc.e aeronaves\n“04” - Arrendamento Mercantil de aeronave para empresa de transporte aéreo público\n“05” - Comissão a agentes externos na exportação\n“06” - Despesas de armazenagem, mov.e transporte de carga no exterior\n“07” - Eventos FIFA(subsidiária)\n“08” - Eventos FIFA\n“09” - Fretes, arrendamentos de embarcações ou aeronaves e outros\n“10” - Material Aeronáutico\n“11” - Promoção de Bens no Exterior\n“12” - Promoção de Dest.Turísticos Brasileiros\n“13” - Promoção do Brasil no Exterior\n“14” - Promoção Serviços no Exterior\n“15” - RECINE\n“16” - RECOPA\n“17” - Registro e Manutenção de marcas, patentes e cultivares\n“18” - REICOMP\n“19” - REIDI\n“20” - REPENEC\n“21” - REPES\n“22” - RETAERO\n“23” - RETID\n“24” - Royalties, Assistência Técnica, Científica e Assemelhados\n“25” - Serviços de avaliação da conformidade vinculados aos Acordos da OMC\n“26” - ZPE" }, "movimentacaoTemporariaBens": { "type": "string", "description": "Indica o vínculo da operação à movimentação temporária de bens.\n\nValores possíveis:\n“Nao” (Valor padrão)\n“VinculadaDeclaracaoImportacao”\n“VinculadaDeclaracaoExportacao”", "default": "“Nao”" }, "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", "default": "false", "description": "Indica se a NFS-e deverá ser disponibilizada ao MDIC (Ministério do Desenvolvimento, Indústria e Comércio Exterior)" } } }, "beneficioMunicipal": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Indica o código do benefício municipal" }, "percentualReducaoBaseCalculo": { "type": "string", "description": "Indica o percentual de redução da base de cálculo. Não pode ser informado em conjunto com o campo “valorReducaoBaseCalculo”" }, "valorReducaoBaseCalculo": { "type": "string", "description": "Indica o valor de redução da base de cálculo. Não pode ser informado em conjunto com o campo “percentualReducaoBaseCalculo”" } }, "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", "format": "double" }, "percentualEstadual": { "type": "number", "description": "Percentual estadual dos tributos", "format": "double" }, "percentualMunicipal": { "type": "number", "description": "Percentual municipal dos tributos", "format": "double" } }, "description": "Grupo de percentual aproximado de tributos no modelo detalhado" }, "simplesNacional": { "type": "object", "description": "Grupo de percentual aproximado de tributos de empresas optantes pelo simples nacional", "properties": { "aliquota": { "type": "number", "description": "Indica a alíquota do simples nacional", "format": "double" } } } }, "description": "Grupo de percentual aproximado de tributos" }, "nfseReferenciada": { "type": "object", "description": "Grupo de NFS-e referenciada.", "properties": { "chaveAcesso": { "type": "string", "description": "Chave de acesso da NFS-e de origem" } } }, "formaPagamentoFatura": { "type": "string", "description": "Forma de pagamento da fatura.\nExemplo: \"Pagamento à vista\" " }, "deducoes": { "type": "number", "format": "double", "description": "Retenções ou valores descontados no valor bruto da nota previsto em lei." }, "descontos": { "type": "string", "description": "Desconto incondicional concedido no ato da emissão da nota fiscal." }, "descontoCondicionado": { "type": "number", "description": "Desconto condicionado\nImportante: Nem todas as cidades suportam o envio do desconto condicionado.\n\nQuando suportado: o valor será enviado e considerado na emissão da NFS-e.\nQuando não suportado: o campo será automaticamente ignorado, sem impacto na autorização da nota.", "format": "double" }, "valorTotal": { "type": "number", "description": "Valor total da NF", "format": "double" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"nfeId\": \"string\"\n}" } }, "schema": { "type": "object", "properties": { "nfeId": { "type": "string", "example": "string" } } } } } }, "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 EmitirNFAsync(Guid empresaId, NFe nfe)\n{\n try\n {\n var strJson = JsonConvert.SerializeObject(nfe);\n var strContent = new StringContent(strJson, Encoding.UTF8, \"application/json\");\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.Post, string.Format(\"https://api.enotasgw.com.br/v1/empresas/{0}/nfes\", empresaId)))\n {\n request.Content = strContent;\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": " ''\n\t));\n\t\n\t$empresaId = '{empresa id}';\n\t$idExterno = '{id de mapeamento no sistema de origem}';\n\t\n\ttry\n\t{\n\t\t$nfeId = eNotasGW::$NFeApi->emitir($empresaId, array(\n\t\t\t'tipo' => 'NFS-e',\n\t\t\t'idExterno' => $idExterno,\n\t\t\t'ambienteEmissao' => 'Homologacao', //'Homologacao' ou 'Producao'\t\t\n\t\t\t'cliente' => array(\n\t\t\t\t'nome' => 'Fulano de Tal',\n\t\t\t\t'email' => 'fulano@mail.com',\n\t\t\t\t'cpfCnpj' => '23857396237',\n\t\t\t\t'endereco' => array(\n\t\t\t\t\t'uf' => 'MG', \n\t\t\t\t\t'cidade' => 'Belo Horizonte',\n\t\t\t\t\t'logradouro' => 'Rua 01',\n\t\t\t\t\t'numero' => '112',\n\t\t\t\t\t'complemento' => 'AP 402',\n\t\t\t\t\t'bairro' => 'Savassi',\n\t\t\t\t\t'cep' => '32323111'\n\t\t\t\t)\n\t\t\t),\n\t\t\t'servico' => array(\n\t\t\t\t'descricao' => 'Discriminação do Serviço prestado'\n\t\t\t),\n\t\t\t'valorTotal' => 10.05\n\t\t));\n\t\t\n\t\techo 'Sucesso!
';\n\t\techo \"ID da NFe: {$nfeId}\";\n\t}\n\tcatch(Exceptions\\invalidApiKeyException $ex) {\n\t\techo 'Erro de autenticação:

';\n\t\techo $ex->getMessage();\n\t}\n\tcatch(Exceptions\\unauthorizedException $ex) {\n\t\techo 'Acesso negado:

';\n\t\techo $ex->getMessage();\n\t}\n\tcatch(Exceptions\\apiException $ex) {\n\t\techo 'Erro de validação:

';\n\t\techo $ex->getMessage();\n\t}\n\tcatch(Exceptions\\requestException $ex) {\n\t\techo 'Erro na requisição web:

';\n\t\t\n\t\techo 'Requested url: ' . $ex->requestedUrl;\n\t\techo '
';\n\t\techo 'Response Code: ' . $ex->getCode();\n\t\techo '
';\n\t\techo 'Message: ' . $ex->getMessage();\n\t\techo '
';\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 } ```