v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

NotaFiscal

Gera uma nota fiscal, podendo ser vinculada a uma cobrança existente ou avulsa.

Esta API permite que empresas automatizem o processo de emissão de notas fiscais, otimizando o fluxo de trabalho e garantindo a conformidade fiscal.

Existem dois cenários para emissão:

Nota fiscal vinculada a uma cobrança existente:
- Informe CobrancaId e NfServicoId.
- A API processará a cobrança existente e retornará o número da nota fiscal gerada.
Nota fiscal avulsa (não vinculada a cobrança):
- Informe apenas NfServicoId e um modelo de nota fiscal (NfeModel) com os dados do cliente, serviço e valores.
- A API processará os dados do modelo e retornará o número da nota fiscal gerada.

Requisição

Campo	Tipo	Descrição	Obrigatório
CobrancaId	GUID	Id da cobrança, caso a NF seja vinculada	Não
NfServicoId	GUID	Id do serviço da NF	Sim
NfeModel	Objeto	Modelo da NF com cliente, serviço e valores	Condicional*

*Obrigatório apenas se CobrancaId não for informado (emissão avulsa).

post/api/NotaFiscal

Headers

Aeskeystring required

Request body

cobrancaIdstring uuid

nfServicoIdstring uuid

Example request

{
  "exemploVinculado": {
    "cobrancaId": "3a411f21-4479-4c1e-a558-c4172c9fe065",
    "nfServicoId": "b7a60017-b360-4ca7-a8c1-8437e7c3e9ce"
  },
  "exemploAvulso": {
    "nfServicoId": "59367c94-d794-45a1-8d96-aa2930ef3db5",
    "nfeModel": {
      "idExterno": "NF-123456",
      "ambienteEmissao": "producao",
      "enviarPorEmail": true,
      "cliente": {
        "tipoPessoa": "J",
        "nome": "Empresa Exemplo LTDA",
        "email": "financeiro@empresaexemplo.com",
        "cpfCnpj": "12345678000199",
        "inscricaoMunicipal": "12345",
        "inscricaoEstadual": "987654321",
        "telefone": "(11) 98765-4321",
        "endereco": {
          "pais": "Brasil",
          "uf": "SP",
          "cidade": "São Paulo",
          "logradouro": "Av. Paulista",
          "numero": "1000",
          "complemento": "10º andar",
          "bairro": "Bela Vista",
          "cep": "01310000"
        }
      },
      "servico": {
        "descricao": "Prestação de serviços de consultoria",
        "issRetidoFonte": false,
        "valorCofins": 10,
        "valorCsll": 3.5,
        "valorInss": 0,
        "valorIr": 0,
        "valorPis": 2.5
      },
      "valorTotal": 150.75,
      "observacoes": "Nota fiscal avulsa emitida via API."
    }
  }
}

Response

NF gerada com sucesso

Retornostring

DetalhesErrostring

NfeIdstring uuid

Example response

{
  "NfeId": "00000000-0000-0000-0000-000000000000"
}