Emissão de Nota Fiscal

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
{
  "tipo": "NFS-e",
  "idExterno": "teste_001",
  "ambienteEmissao": "Producao",
  "cliente": {
    "tipoPessoa": "F",
    "nome": "Cliente teste",
    "email": "[email protected]",
    "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
}
{
  "tipo": "NFS-e",
  "idExterno": "test20250213",
  "ambienteEmissao": "Homologacao",
  "numeroRps": "1",
  "serieRps": "5",
  "dataCompetencia": "2025-07-01T08:15:00Z",
  "enviarPorEmail": false,
  "dadosAdicionaisEmail": {
    "outrosDestinatarios": "[email protected]; [email protected]"
  },
  "cliente": {
    "tipoPessoa": "F",
    "nome": "John Doe",
    "email": "[email protected]",
    "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
      }
    ],
    "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.


Path Params
string
required

Identificador único da Empresa relacionada a Nota Fiscal que deseja emitir

Body Params
string

ID de mapeamento com seu sistema. Impedirá duplicidade e poderá ser usado para identificar sua nota.

string

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.

integer

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.

string

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.

boolean
Defaults to false

Indica se a nota fiscal deve ser enviada para o e-mail do cliente após ser emitida.

dadosAdicionaisEmail
object

Permite informar mais de um destinatário de e-mail para receber o PDF da nota fiscal autorizada e cancelada.

cliente
object
endereco
object
servico
object

Objeto contendo dados do serviço prestado

date-time

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

Exemplo: “dataCompetencia": "2019-07-01T08:15:00Z"

Se o campo não for informado, a data da competência será igual a data da criação da NFS-e.

string

Indica qual a natureza da operação/exigibilidade de ISS da NFS-e.
Caso a naturezaOperacao não seja informada, o gateway fará o envio automaticamente, conforme as características da nota fiscal.

string

Informações adicionais ou observações do documento.

construcaoCivil
object

Grupo de informações relativas à obras de construção civil e congêneres

detalhesEvento
object

Grupo de informações relativas a atividades de eventos

comercioExterior
object

Grupo de informações de comércio exterior

beneficioMunicipal
object

Grupo de informações de benefício municipal

percentualAproximadoTributos
object

Grupo de percentual aproximado de tributos

nfseReferenciada
object

Grupo de NFS-e referenciada.

string

Forma de pagamento da fatura.
Exemplo: "Pagamento à vista"

double

Retenções ou valores descontados no valor bruto da nota previsto em lei.

string

Desconto incondicional concedido no ato da emissão da nota fiscal.

double

Desconto condicionado
Importante: Nem todas as cidades suportam o envio do desconto condicionado.

Quando suportado: o valor será enviado e considerado na emissão da NFS-e.
Quando não suportado: o campo será automaticamente ignorado, sem impacto na autorização da nota.

double
required

Valor total da NF

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain