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(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 |
post/api/NotaFiscal
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/NotaFiscal
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
Headers
Aeskeystring required
Request body
Example request
{
"exemploVinculado": {
"cobrancaId": "49053c15-774b-478f-a9fd-c05a5f83b236",
"nfServicoId": "c7f092ec-3ede-4718-95e0-e3164f76420b",
"issRetidoFonte": false,
"iss": 0
},
"exemploAvulso": {
"nfServicoId": "441b5127-9e7f-436c-857a-699a47d8dcb4",
"issRetidoFonte": false,
"iss": 0,
"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,
"iss": 0,
"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
Example response
{
"NfeId": "00000000-0000-0000-0000-000000000000"
}Changes
No recorded changes to this operation across all 1 revision of this API.