Emitente
API para gestão de emitentes
Veja a relação completa dos campos
Ambiente
|
https://api.cloud-dfe.com.br/v1
https://hom.api.cloud-dfe.com.br/v1
|
Comunicação
Clique para ver o exemplo
|
|
Você pode usar nosso SDK feito em PHP para otimizar o processo de integração, assim ira ganhar tempo e mais praticidade
https://github.com/cloud-dfe/sdk-php
Faça o download da coleção do POSTMAN com todos os endpoints já configurados e com exemplos funcionais
As rotas /soft/ requerem o uso do token da softhouse
POST/soft/emitente
Cria um novo emitente
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"nome": 'EMPRESA TESTE',
"razao": 'EMPRESA TESTE',
"cnpj": '47853098000193',
"cpf": '12345678901',
"cnae": '1236987',
"crt": '1', // Regime tributário
"ie": '12369875',
"im": '12369875',
"suframa": '12369875',
"csc": '...', // token para emissão de NFCe
"cscid": '000001',
"tar": 'C9292002912', // tar BPe
"login_prefeitura": null,
"senha_prefeitura": null,
"client_id_prefeitura": null,
"client_secret_prefeitura": null,
"telefone": '46998895532',
"email": 'empresa@teste.com',
"rua": 'TESTE',
"numero": '1',
"complemento": 'NENHUM',
"bairro": 'TESTE',
"municipio": 'CIDADE TESTE', // IBGE
"cmun": '5300108', // IBGE
"uf": 'PR', // IBGE
"cep": '85000100',
"logo": 'useyn56j4mx35m5j6_JSHh734khjd...saasjda', // BASE 64
"plano": 'Emitente',
"documentos": {
"nfe": true,
"nfce": true,
"nfse": true,
"mdfe": true,
"cte": true,
"cteos": true,
"bpe": true,
"dfe_nfe": true,
"dfe_nfse": true,
"dfe_cte": true,
"sintegra": true,
"gnre": true
}
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Sucesso.",
"emitente": "1",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1" // JWT
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/soft/emitente
Lista os emitentes de uma softhouse
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Sucesso.",
"emitentes": [
{
"status": 'ATIVO',
"nome": "EMPRESA DE TESTE",
"razao": "EMPRESA DE TESTE",
"cnpj": "11285089000185",
"cpf": "",
"cnae": "1234567",
"crt": 1,
"ie": "19826478626465",
"im": "45",
"suframa": "",
"csc": "",
"cscid": "000001",
"tar": "",
"telefone": "4499764041",
"email": "teste@gmail.com",
"uf": "PR",
"municipio": "MARINGA",
"cmun": 4108809,
"bairro": "Centro",
"rua": "AV CEL OTAVIO TOSTA",
"numero": "123",
"complemento": "SALA",
"cep": "85980000",
"webhook": "",
"token": "eyJ0eXAiOiJKV1QiLCJhbGc", // JWT
"validade_certificado": "2022-10-05 13:00:01",
"plano": null,
"documentos": {
"nfe": 1,
"nfce": 1,
"cte": 1,
"cteos": 1,
"mdfe": 1,
"bpe": 1,
"nfse": 1,
"gnre": 1,
"dfe_nfe": 0,
"dfe_nfse": 0,
"dfe_cte": 0
}
}
]
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
DELETE/soft/emitente/{cnpj}
Marca o emitente para deleção
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Emitente {cnpj} marcado para deleção com sucesso!"
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/soft/emitente/deletados
Lista os emitentes de uma softhouse que estão marcados com deleção
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Sucesso.",
"emitentes": [
{
"status": 'INATIVO',
"nome": "EMPRESA DE TESTE",
"razao": "EMPRESA DE TESTE",
"cnpj": "11285089000185",
"cpf": "",
"cnae": "1234567",
"crt": 1,
"ie": "19826478626465",
"im": "45",
"suframa": "",
"csc": "",
"cscid": "000001",
"tar": "",
"telefone": "4499764041",
"email": "teste@gmail.com",
"uf": "PR",
"municipio": "MARINGA",
"cmun": 4108809,
"bairro": "Centro",
"rua": "AV CEL OTAVIO TOSTA",
"numero": "123",
"complemento": "SALA",
"cep": "85980000",
"webhook": "",
"token": "eyJ0eXAiOiJKV1QiLCJhbGc", // JWT
"validade_certificado": "2022-10-05 13:00:01",
"plano": null,
"deleted_at": "2019-07-10 18:15:44",
"documentos": {
"nfe": 1,
"nfce": 1,
"cte": 1,
"cteos": 1,
"mdfe": 1,
"bpe": 1,
"nfse": 1,
"gnre": 1,
"dfe_nfe": 0,
"dfe_nfse": 0,
"dfe_cte": 0
}
}
]
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/soft/emitente/{cnpj}
Mostra os dados de um emitente
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Sucesso.",
"emitentes": {
"status": 'ATIVO',
"nome": "EMPRESA DE TESTE",
"razao": "EMPRESA DE TESTE",
"cnpj": "11285089000185",
"cpf": "",
"cnae": "1234567",
"crt": 1,
"ie": "19826478626465",
"im": "45",
"suframa": "",
"csc": "",
"cscid": "000001",
"tar": "",
"telefone": "4499764041",
"email": "teste@gmail.com",
"uf": "PR",
"municipio": "MARINGA",
"cmun": 4108809,
"bairro": "Centro",
"rua": "AV CEL OTAVIO TOSTA",
"numero": "123",
"complemento": "SALA",
"cep": "85980000",
"webhook": "",
"token": "eyJ0eXAiOiJKV1QiLCJhbGc", // JWT
"validade_certificado": "2022-10-05 13:00:01",
"plano": null,
"deleted_at": null,
"documentos": {
"nfe": 1,
"nfce": 1,
"cte": 1,
"cteos": 1,
"mdfe": 1,
"bpe": 1,
"nfse": 1,
"gnre": 1,
"dfe_nfe": 0,
"dfe_nfse": 0,
"dfe_cte": 0
}
}
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
As rotas /emitente requerem o uso do token do emitente
PUT/emitente
Atualiza os dados de um emitente
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"nome": 'EMPRESA TESTE',
"razao": 'EMPRESA TESTE',
"cnae": '1236987',
"crt": '1', // Regime tributário
"ie": '12369875',
"im": '12369875',
"suframa": '12369875',
"csc": '...', // token para emissão de NFCe
"cscid": '000001',
"tar": 'C9292002912', // tar BPe
"login_prefeitura": null,
"senha_prefeitura": null,
"client_id_prefeitura": null,
"client_secret_prefeitura": null,
"telefone": '46998895532',
"email": 'empresa@teste.com',
"rua": 'TESTE',
"numero": '1',
"complemento": 'NENHUM',
"bairro": 'TESTE',
"municipio": 'CIDADE TESTE', // IBGE
"cmun": '5300108', // IBGE
"uf": 'PR', // IBGE
"cep": '85000100',
"logo": 'useyn56j4mx35m5j6_JSHh734khjd...saasjda'
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Dados atualizados com sucesso."
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/emitente/token
Recria o token do solicitante
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 200,
"mensagem": "Token recriado! O token anterior perdeu a sua validade. A partir de agora use esse novo token.",
"token": "MIIj+QIBAzCCI7MGCSqGSI...1PtZO34CAgQA" // JWT
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|