Conhecimento de Transporte Eletronico
API para geração e emissão de CT-e.
Veja a relação completa dos campos
Ambiente
|
https://api.cloud-dfe.com.br/v1
https://hom.api.cloud-dfe.com.br/v1
|
Nota: Este serviço opera em modo Assincrono e requer 2 requisiçõesRequisição 1: Envie a CT-e utilizando o método /cteRequisição 2: Caso no retorno do envio seja devolvido o código 5023 deve ser realizado a consulta da CT-e utilizando o método /cte/{chave} (Esta chave é retornada no uso da requisição 1) |
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
POST/cte
Criação/Envio
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"cfop": "5353",
"natureza_operacao": "PRESTACAO DE SERVIÇO",
"numero": "64",
"serie": "1",
"data_emissao": "2020-11-24T03:00:00-03:00",
"tipo_operacao": "0",
"codigo_municipio_envio": "2408003",
"nome_municipio_envio": "MOSSORO",
"uf_envio": "RN",
"tipo_servico": "0",
"codigo_municipio_inicio": "2408003",
"nome_municipio_inicio": "Mossoró",
"uf_inicio": "RN",
"codigo_municipio_fim": "2408003",
"nome_municipio_fim": "Mossoró",
"uf_fim": "RN",
"retirar_mercadoria": "1",
"detalhes_retirar": null,
"tipo_programacao_entrega": "0",
"sem_hora_tipo_hora_programada": "0",
"remetente": {
"cnpj": "15493526000128",
"inscricao_estadual": "239084510",
"nome": "EMPRESA MODELO",
"razao_social": "MODELO LTDA",
"telefone": "8433163070",
"endereco": {
"logradouro": "AVENIDA TESTE",
"numero": "444",
"bairro": "CENTRO",
"codigo_municipio": "2408003",
"nome_municipio": "MOSSORÓ",
"uf": "RN"
}
},
"valores": {
"valor_total": "0.00",
"valor_receber": "0.00",
"valor_total_carga": "224.50",
"produto_predominante": "SAL",
"quantidades": [
{
"codigo_unidade_medida": "01",
"tipo_medida": "Peso Bruto",
"quantidade": "500.00"
}
]
},
"imposto": {
"icms": {
"situacao_tributaria": "20",
"valor_base_calculo": "0.00",
"aliquota": "12.00",
"valor": "0.00",
"aliquota_reducao_base_calculo": "50.00"
}
},
"nfes": [
{
"chave": "24201001243220000109550010000010611650858974"
}
],
"modal_rodoviario": {
"rntrc": "02033517"
},
"destinatario": {
"cnpj": "15495526000128",
"inscricao_estadual": "212055510",
"nome": "EMPRESA MODELO",
"telefone": "8499995555",
"endereco": {
"logradouro": "AVENIDA TESTE",
"numero": "444",
"bairro": "CENTRO",
"codigo_municipio": "2408003",
"nome_municipio": "Mossoró",
"cep": "59603330",
"uf": "RN",
"codigo_pais": "1058",
"nome_pais": "BRASIL",
"email": "teste@teste.com.br"
}
},
"componentes_valor": [
{
"nome": "teste2",
"valor": "1999.00"
}
],
"tomador": {
"tipo": "3",
"indicador_inscricao_estadual": "1"
},
"observacao": ""
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso do CT-e",
"chave": "50190813188739000110570010000012001581978549",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"data_hora_evento": "2019-08-30 11:25:22",
"protocolo": "150190003925457",
"status": "autorizado", // autorizado ou cancelado
"numero": "1200",
"serie": "1"
}
|
200 |
{
"sucesso": true,
"codigo": 5023,
"mensagem": "Lote em processamento, aguarde e tente novamente mais tarde.",
"chave": "50190813188739000110570010000012001581978549"
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM,
"chave": "50190813188739000110570010000012001581978549"
}
|
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/cte/status
Status do Serviço
Parameters
Name | Description |
---|---|
body 
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "107",
"mensagem": "Servico em Operacao",
"tempo_medio": 1,
"contingencia": false
}
|
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/cte/{chave}
Consulta o documento pela chave de acesso em nosso banco de dados
Parameters
Name | Description |
---|---|
body 
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso do CT-e",
"chave": "50190813188739000110570010000012001581978549",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"data_hora_evento": "2019-08-30 11:25:22",
"protocolo": "150190003925457",
"status": "autorizado", // autorizado ou cancelado
"numero": "1200",
"serie": "1",
"xml_carta_correcao": "PHByb2NFdmVudG9ORmUgeG1sbnM9...b05GZT4=", // BASE 64
"pdf_carta_correcao":"JVBERi0xLjMKMyAwIG9iago8PC9Ue...RU9GCg==", // BASE 64
"numero_carta_correcao": "1"
}
|
200 |
{
"sucesso": true,
"codigo": 5023,
"mensagem": "Lote em processamento, aguarde e tente novamente mais tarde.",
"chave": "50190813188739000110570010000012001581978549"
}
|
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"
}
]
}
|
POST/cte/correcao
Carta de Correção
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110570010000012151581978542",
"correcoes": [
{
"grupo_corrigido": "ide",
"campo_corrigido": "UFIni",
"valor_corrigido": "PR",
"numero_item_grupo_corrigido": '01'
}
]
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "135",
"mensagem": "Evento registrado e vinculado ao CT-e",
"data_hora_evento": "2019-09-16 17:09:02",
"protocolo": "141190000844206",
"xml_carta_correcao": "PHByb2NFdmVudG9ORmUgeG1sbnM9Imh0d...5GZT4=", // BASE 64
"pdf_carta_correcao": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlI...AHCg==", // BASE 64
"numero_carta_correcao": 2
}
|
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"
}
]
}
|
POST/cte/inutiliza
Inutilização
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"serie": "10",
"justificativa": "Teste de inutilizacao de cte",
"numero_inicial": "50",
"numero_final": "50"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "135",
"mensagem": "Inutilizacao de numero homologado",
"protocolo": "141190000844206",
"serie": "10",
"numero_inicial": "50",
"numero_final": "50",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY...bG9wZT4=" // BASE 64
}
|
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"
}
]
}
|
POST/cte/cancela
Cancelamento
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110570010000012151581978542",
"justificativa": "Teste de cancelamento de cte"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "101",
"mensagem": "Homologado o cancelamento do CT-e",
"data_hora_evento": "2019-09-16 17:18:48",
"protocolo": "141190000844226",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY9J2h...cGU+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
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/cte/pdf/{chave}
Gera o DACTe
Parameters
Name | Description |
---|---|
body 
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Sucesso.",
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
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"
}
]
}
|
POST/cte/busca
Busca um CTe
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"numero_inicial": 1210,
"numero_final": 1210,
"serie": 1,
"data_inicial": "2019-12-01", // Autorização
"data_final": "2019-12-31",
"cancel_inicial": "2019-12-01", // Cancelamento
"cancel_final": "2019-12-31"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1000,
"mensagem": "Sucesso. Retornados 1 de 1. (1 de 1 páginas.)",
"pagina": 1,
"total_paginas": 1,
"chaves": [
"50191113188739000110570010000012141581978541"
]
}
|
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"
}
]
}
|
POST/cte/backup
Solicita um backup por email
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"ano": 2019,
"mes": 12
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Backup disponível",
"total_docs": "5",
"download": "aqui fica a url para download por 3 dias",
"disponivel_ate": "2021-04-10"
}
|
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"
}
]
}
|
POST/cte/preview
Gera a pré-visualização do PDF do documento fiscal
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"cfop": "5353",
"natureza_operacao": "PRESTACAO DE SERVIÇO",
"numero": "64",
"serie": "1",
"data_emissao": "2020-11-24T03:00:00-03:00",
"tipo_operacao": "0",
"codigo_municipio_envio": "2408003",
"nome_municipio_envio": "MOSSORO",
"uf_envio": "RN",
"tipo_servico": "0",
"codigo_municipio_inicio": "2408003",
"nome_municipio_inicio": "Mossoró",
"uf_inicio": "RN",
"codigo_municipio_fim": "2408003",
"nome_municipio_fim": "Mossoró",
"uf_fim": "RN",
"retirar_mercadoria": "1",
"detalhes_retirar": null,
"tipo_programacao_entrega": "0",
"sem_hora_tipo_hora_programada": "0",
"remetente": {
"cnpj": "15493526000128",
"inscricao_estadual": "239084510",
"nome": "EMPRESA MODELO",
"razao_social": "MODELO LTDA",
"telefone": "8433163070",
"endereco": {
"logradouro": "AVENIDA TESTE",
"numero": "444",
"bairro": "CENTRO",
"codigo_municipio": "2408003",
"nome_municipio": "MOSSORÓ",
"uf": "RN"
}
},
"valores": {
"valor_total": "0.00",
"valor_receber": "0.00",
"valor_total_carga": "224.50",
"produto_predominante": "SAL",
"quantidades": [
{
"codigo_unidade_medida": "01",
"tipo_medida": "Peso Bruto",
"quantidade": "500.00"
}
]
},
"imposto": {
"icms": {
"situacao_tributaria": "20",
"valor_base_calculo": "0.00",
"aliquota": "12.00",
"valor": "0.00",
"aliquota_reducao_base_calculo": "50.00"
}
},
"nfes": [
{
"chave": "24201001243220000109550010000010611650858974"
}
],
"modal_rodoviario": {
"rntrc": "02033517"
},
"destinatario": {
"cnpj": "15495526000128",
"inscricao_estadual": "212055510",
"nome": "EMPRESA MODELO",
"telefone": "8499995555",
"endereco": {
"logradouro": "AVENIDA TESTE",
"numero": "444",
"bairro": "CENTRO",
"codigo_municipio": "2408003",
"nome_municipio": "Mossoró",
"cep": "59603330",
"uf": "RN",
"codigo_pais": "1058",
"nome_pais": "BRASIL",
"email": "teste@teste.com.br"
}
},
"componentes_valor": [
{
"nome": "teste2",
"valor": "1999.00"
}
],
"tomador": {
"tipo": "3",
"indicador_inscricao_estadual": "1"
},
"observacao": ""
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Sucesso.",
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
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"
}
]
}
|
POST/cte/importa
Importa para a API o documento fiscal
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"xml": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Sucesso. A CT-e chave: 50191213188739000110570010000012151581978542 foi inserida na base de dados."
}
|
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"
}
]
}
|
POST/cte/desacordo
Solicita manifestação de prestação de serviço em desacordo
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110570010000012151581978542",
"justificativa": "CTe em desacordo por x motivo"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "135",
"mensagem": "Evento registrado e vinculado ao CT-e",
"data_hora_evento": "2019-09-16 17:18:48",
"protocolo": "141190000844226",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY9J2h...cGU+" // BASE 64
}
|
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"
}
]
}
|