post
https://pagamentos.meuk8.com.br/CobrancasAPI/api/NotaFiscal
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(1) |
| nfServicoId | GUID | Id do serviço da NF | Sim |
| nfeModel | Objeto | Modelo da nota fiscal para emissão avulsa, contendo os dados necessários para geração da NF | Não(2) |
| idExterno | Texto | Identificador externo do modelo da NF | Não(3) |
| ambienteEmissao | Texto | Ambiente de emissão (homologacao/producao) | Não(3) |
| enviarPorEmail | Booleano | Indica se deve enviar a NF por e-mail | Não(3) |
| valorTotal | Numérico | Valor total da nota fiscal | Não(3) |
| observacoes | Texto | Observações da nota fiscal | Não(3) |
| cliente | Objeto | Dados do cliente para emissão avulsa, caso a NF não seja vinculada a uma cobrança | Não(3) |
| tipoPessoa | Texto | Tipo de pessoa (fisica/juridica) | Não(3) |
| nome | Texto | Nome do cliente | Não(3) |
| Texto | E-mail do cliente | Não(3) | |
| cpfCnpj | Texto | CPF ou CNPJ do cliente | Não(3) |
| inscricaoMunicipal | Texto | Inscrição municipal do cliente | Não(3) |
| inscricaoEstadual | Texto | Inscrição estadual do cliente | Não(3) |
| telefone | Texto | Telefone do cliente | Não(3) |
| endereco | Objeto | Dados do endereço do cliente | Não(3) |
| pais | Texto | País do endereço do cliente | Não(3) |
| uf | Texto | UF do endereço do cliente | Não(3) |
| cidade | Texto | Cidade do endereço do cliente | Não(3) |
| logradouro | Texto | Logradouro do endereço do cliente | Não(3) |
| numero | Texto | Número do endereço do cliente | Não(3) |
| complemento | Texto | Complemento do endereço do cliente | Não(3) |
| bairro | Texto | Bairro do endereço do cliente | Não(3) |
| cep | Texto | CEP do endereço do cliente | Não(3) |
| servico | Objeto | Dados do serviço para emissão avulsa, caso a NF não seja vinculada a uma cobrança | Não(3) |
| descricao | Texto | Descrição do serviço | Não(3) |
| issRetidoFonte | Booleano | Indica se o ISS é retido na fonte | Não(3) |
| valorCofins | Numérico | Valor do COFINS | Não(3) |
| valorCsll | Numérico | Valor do CSLL | Não(3) |
| valorInss | Numérico | Valor do INSS | Não(3) |
| valorIr | Numérico | Valor do IR | Não(3) |
| valorPis | Numérico | Valor do PIS | Não(3) |
(1) - Obrigatório se nfeModel não for informado (vinculada a cobrança).
(2) - Obrigatório se cobrancaId não for informado (avulsa).
(3) - Obrigatório apenas para emissão avulsa, ou seja, quando cobrancaId não for informado. Para emissão vinculada a cobrança, os dados do cliente, serviço e valores serão obtidos a partir da cobrança informada.
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | Status do retorno (CREATED ou ERROR) |
| DetalhesErro | Array de Texto | Lista de detalhes do erro, quando houver |
| NfeId | Texto | Id da nota fiscal gerada |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…