Produtos ·
ConhecimentoTransporteImportação de Conhecimento de Transporte Eletrônico
2consultas
9alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Método para alteração de informações do CT-e de saída.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdCte | número inteiro |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCategoria | texto · até 20 | |
nProjeto | número inteiro | |
nVendedor | número inteiro |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
nIdCte | número inteiro |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarCte", "param": [{"nIdCte": 123456, "cCategoria": "1.01.01", "nVendedor": 0, "nProjeto": 0}]}'import os
import requests
corpo = {'call': 'AlterarCte',
'param': [{'nIdCte': 123456, 'cCategoria': '1.01.01', 'nVendedor': 0, 'nProjeto': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarCte",
"param": [
{
"nIdCte": 123456,
"cCategoria": "1.01.01",
"nVendedor": 0,
"nProjeto": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AlterarCte",
"param": [
{
"nIdCte": 123456,
"cCategoria": "1.01.01",
"nVendedor": 0,
"nProjeto": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "AlterarCte",
"param": [
{
"nIdCte": 123456,
"cCategoria": "1.01.01",
"nVendedor": 0,
"nProjeto": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AlterarCte",
"param": [
{
"nIdCte": 123456,
"cCategoria": "1.01.01",
"nVendedor": 0,
"nProjeto": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarCte"", ""param"": [{""nIdCte"": 123456, ""cCategoria"": ""1.01.01"", ""nVendedor"": 0, ""nProjeto"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRecebe o XML de averbação do XML.
Obrigatórios 6
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
cChaveCte | texto · até 44 | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
cMd5CteAverb | texto · até 32 | MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo. |
cXmlCteAverb | texto | Xml da Averbação do CT-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5CteAverbacao". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveCte | texto | Chave do CT-e Importado. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdCte | número inteiro | ID do CT-e gerado no Omie. |
nIdImportacao | número inteiro | ID da Importação do CT-e. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AverbacaoCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "cChaveCte": "", "cXmlCteAverb": "", "cMd5CteAverb": ""}]}'import os
import requests
corpo = {'call': 'AverbacaoCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'cChaveCte': '',
'cXmlCteAverb': '',
'cMd5CteAverb': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AverbacaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteAverb": "",
"cMd5CteAverb": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AverbacaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteAverb": "",
"cMd5CteAverb": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "AverbacaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteAverb": "",
"cMd5CteAverb": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AverbacaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteAverb": "",
"cMd5CteAverb": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AverbacaoCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""cChaveCte"": """", ""cXmlCteAverb"": """", ""cMd5CteAverb"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosCancela um CT-e.
Obrigatórios 6
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
cChaveCte | texto · até 44 | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
cMd5CteCanc | texto · até 32 | MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo. |
cXmlCteCanc | texto | Xml de Cancelamento do CT-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5CteCanc". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveCte | texto | Chave do CT-e Importado. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdCte | número inteiro | ID do CT-e gerado no Omie. |
nIdImportacao | número inteiro | ID da Importação do CT-e. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "CancelarCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "cChaveCte": "", "cXmlCteCanc": "", "cMd5CteCanc": ""}]}'import os
import requests
corpo = {'call': 'CancelarCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'cChaveCte': '',
'cXmlCteCanc': '',
'cMd5CteCanc': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "CancelarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCanc": "",
"cMd5CteCanc": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "CancelarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCanc": "",
"cMd5CteCanc": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "CancelarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCanc": "",
"cMd5CteCanc": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "CancelarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCanc": "",
"cMd5CteCanc": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""CancelarCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""cChaveCte"": """", ""cXmlCteCanc"": """", ""cMd5CteCanc"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosCarta de Correção da CT-e
Obrigatórios 6
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
cChaveCte | texto · até 44 | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
cMd5CteCC | texto · até 32 | MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo. |
cXmlCteCC | texto | Xml da Carta de Correção do CT-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5CteCC". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveCte | texto | Chave do CT-e Importado. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdCte | número inteiro | ID do CT-e gerado no Omie. |
nIdImportacao | número inteiro | ID da Importação do CT-e. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "CartaCorrecaoCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "cChaveCte": "", "cXmlCteCC": "", "cMd5CteCC": ""}]}'import os
import requests
corpo = {'call': 'CartaCorrecaoCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'cChaveCte': '',
'cXmlCteCC': '',
'cMd5CteCC': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "CartaCorrecaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCC": "",
"cMd5CteCC": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "CartaCorrecaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCC": "",
"cMd5CteCC": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "CartaCorrecaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCC": "",
"cMd5CteCC": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "CartaCorrecaoCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCteCC": "",
"cMd5CteCC": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""CartaCorrecaoCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""cChaveCte"": """", ""cXmlCteCC"": """", ""cMd5CteCC"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosMétodo de exclusão do Conhecimento de Transporte.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdCte | número inteiro |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveCte | texto | |
cCodStatus | texto | |
cDesStatus | texto |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirCTe", "param": [{"nIdCte": 0}]}'import os
import requests
corpo = {'call': 'ExcluirCTe', 'param': [{'nIdCte': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirCTe",
"param": [
{
"nIdCte": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ExcluirCTe",
"param": [
{
"nIdCte": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "ExcluirCTe",
"param": [
{
"nIdCte": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ExcluirCTe",
"param": [
{
"nIdCte": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirCTe"", ""param"": [{""nIdCte"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExclui uma fatura de um grupo de CT-es.
Obrigatórios 4
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
nIdFaturamento | número inteiro | ID do faturamento do grupo de CT-es. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdFaturamento | número inteiro | ID do faturamento do grupo de CT-es. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirFaturaCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "nIdFaturamento": 0}]}'import os
import requests
corpo = {'call': 'ExcluirFaturaCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'nIdFaturamento': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirFaturaCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ExcluirFaturaCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "ExcluirFaturaCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ExcluirFaturaCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirFaturaCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""nIdFaturamento"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosGera uma fatura para um grupo de CT-es.
Obrigatórios 7
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
cCategoria | texto · até 20 | Código da Categoria para geração do título no financeiro. |
dVencimento | texto · até 10 | Data de vencimento da fatura. Formato: dd/mm/aaaa. |
nContaCorrente | número inteiro | Id da Conta Corrente no Omie para a geração do título no financeiro. |
nValorFatura | número | Valor da Fatura. |
Opcionais 5Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
CNPJCliente | texto · até 20 | CNPJ do Cliente. |
cNumeroFatura | texto · até 20 | Número da Fatura. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamentoobrigatório | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
itensFatura | lista de objetos | Itens da Fatura. |
itensFatura[].cChaveCteobrigatório | texto · até 44 | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
itensFatura[].nSeq | número inteiro | Sequencia do Item da Fatura. |
itensFatura[].nValorCte | número | Valor do CT-e. Preechimento obrigatório. |
nCliente | número inteiro | Código do Cliente para geração do título no financeiro. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdFaturamento | número inteiro | ID do faturamento do grupo de CT-es. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "FaturarCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "CNPJCliente": "", "cCategoria": "1.01.02", "nContaCorrente": 0, "dVencimento": "", "nValorFatura": 100, "itensFatura": [{"nSeq": 1, "cChaveCte": "", "nValorCte": 30}, {"nSeq": 2, "cChaveCte": "", "nValorCte": 70}]}]}'import os
import requests
corpo = {'call': 'FaturarCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'CNPJCliente': '',
'cCategoria': '1.01.02',
'nContaCorrente': 0,
'dVencimento': '',
'nValorFatura': 100,
'itensFatura': [{'nSeq': 1, 'cChaveCte': '', 'nValorCte': 30},
{'nSeq': 2, 'cChaveCte': '', 'nValorCte': 70}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "FaturarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"CNPJCliente": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"dVencimento": "",
"nValorFatura": 100,
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "FaturarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"CNPJCliente": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"dVencimento": "",
"nValorFatura": 100,
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "FaturarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"CNPJCliente": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"dVencimento": "",
"nValorFatura": 100,
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "FaturarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"CNPJCliente": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"dVencimento": "",
"nValorFatura": 100,
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""FaturarCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""CNPJCliente"": """", ""cCategoria"": ""1.01.02"", ""nContaCorrente"": 0, ""dVencimento"": """", ""nValorFatura"": 100, ""itensFatura"": [{""nSeq"": 1, ""cChaveCte"": """", ""nValorCte"": 30}, {""nSeq"": 2, ""cChaveCte"": """", ""nValorCte"": 70}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosGera uma fatura por lote para um grupo de CT-es.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
Opcionais 13Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
CNPJCliente | texto · até 20 | CNPJ do Cliente. |
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cCategoria | texto · até 20 | Código da Categoria para geração do título no financeiro. |
cConcluirFatura | texto · até 1 | |
cListaChavesCTes | texto | |
cNumeroFatura | texto · até 20 | Número da Fatura. |
dVencimento | texto · até 10 | Data de vencimento da fatura. Formato: dd/mm/aaaa. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamentoobrigatório | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
itensFaturaLote | lista de objetos | Itens da Fatura. |
itensFaturaLote[].cChaveCteobrigatório | texto · até 44 | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
itensFaturaLote[].nValorCte | número | Valor do CT-e. Preechimento obrigatório. |
nCliente | número inteiro | Código do Cliente para geração do título no financeiro. |
nContaCorrente | número inteiro | Id da Conta Corrente no Omie para a geração do título no financeiro. |
nIdFaturamentoLote | número inteiro | Id do faturamento. Para indicar o início de um novo lote envie 0 (zero) nesse campo. Como resposta você receberá o nIdFaturamento gerado pelo Omie automaticamente. Nos próximos envios informe o nIdFaturamento recebido para adicionar novos CTes ao lote. Para concluir o envio de CTes e gerar a fatura do lote informe "S" na tag cConcluirFatura. Na última chamada desse método você pode enviar apenas a tag cConcluirFatura. Opcionalmente, você pode enviar os CTes restantes. |
nValorFatura | número | Valor da Fatura. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdFaturamentoLote | número inteiro | Id do faturamento. Para indicar o início de um novo lote envie 0 (zero) nesse campo. Como resposta você receberá o nIdFaturamento gerado pelo Omie automaticamente. Nos próximos envios informe o nIdFaturamento recebido para adicionar novos CTes ao lote. Para concluir o envio de CTes e gerar a fatura do lote informe "S" na tag cConcluirFatura. Na última chamada desse método você pode enviar apenas a tag cConcluirFatura. Opcionalmente, você pode enviar os CTes restantes. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "FaturarLoteCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "nIdFaturamento": 0, "CNPJCliente": "", "cConcluirFatura": "N", "itensFatura": [{"nSeq": 1, "cChaveCte": "", "nValorCte": 30}, {"nSeq": 2, "cChaveCte": "", "nValorCte": 70}]}]}'import os
import requests
corpo = {'call': 'FaturarLoteCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'nIdFaturamento': 0,
'CNPJCliente': '',
'cConcluirFatura': 'N',
'itensFatura': [{'nSeq': 1, 'cChaveCte': '', 'nValorCte': 30},
{'nSeq': 2, 'cChaveCte': '', 'nValorCte': 70}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "FaturarLoteCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0,
"CNPJCliente": "",
"cConcluirFatura": "N",
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "FaturarLoteCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0,
"CNPJCliente": "",
"cConcluirFatura": "N",
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "FaturarLoteCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0,
"CNPJCliente": "",
"cConcluirFatura": "N",
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "FaturarLoteCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0,
"CNPJCliente": "",
"cConcluirFatura": "N",
"itensFatura": [
{
"nSeq": 1,
"cChaveCte": "",
"nValorCte": 30
},
{
"nSeq": 2,
"cChaveCte": "",
"nValorCte": 70
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""FaturarLoteCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""nIdFaturamento"": 0, ""CNPJCliente"": """", ""cConcluirFatura"": ""N"", ""itensFatura"": [{""nSeq"": 1, ""cChaveCte"": """", ""nValorCte"": 30}, {""nSeq"": 2, ""cChaveCte"": """", ""nValorCte"": 70}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosImportar o XML de um CT-e.
Obrigatórios 6
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
cChaveCte | texto · até 44 | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
cMd5Cte | texto · até 32 | MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo. |
cXmlCte | texto | Xml do CT-e a ser importado. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5Cte". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
Opcionais 12Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCategoria | texto · até 20 | Código da Categoria para geração do título no financeiro. |
cObs | texto | Observações do CT-e para geração do título no financeiro. |
cofins_aliquota | número | Alíquota do COFINS. |
cofins_cst | texto · até 2 | Código da Situação Tributária do COFINS. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamentoobrigatório | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
lNaoGerarCR | sim/não | Não gerar título de contas a receber para o CT-e. Pode ser: true - inibe a geração do título de Contas a Receber no financeiro. false - Gera o ítulo de Contas a Receber no financeiro. O padrão é false. |
nCliente | número inteiro | Código do Cliente para geração do título no financeiro. |
nContaCorrente | número inteiro | Id da Conta Corrente no Omie para a geração do título no financeiro. |
nProjeto | número inteiro | Código do Projeto para geração do título no financeiro. |
nVendedor | número inteiro | Código do Vendedor para geração do título no financeiro. |
pis_aliquota | número | Alíquota do PIS. |
pis_cst | texto · até 2 | Código da Situação Tributária do PIS. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveCte | texto | Chave do CT-e Importado. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdCte | número inteiro | ID do CT-e gerado no Omie. |
nIdImportacao | número inteiro | ID da Importação do CT-e. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ImportarCTe", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "cChaveCte": "", "cXmlCte": "", "cMd5Cte": "", "cCategoria": "1.01.02", "nContaCorrente": 0}]}'import os
import requests
corpo = {'call': 'ImportarCTe',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'cChaveCte': '',
'cXmlCte': '',
'cMd5Cte': '',
'cCategoria': '1.01.02',
'nContaCorrente': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ImportarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCte": "",
"cMd5Cte": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ImportarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCte": "",
"cMd5Cte": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "ImportarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCte": "",
"cMd5Cte": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ImportarCTe",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"cChaveCte": "",
"cXmlCte": "",
"cMd5Cte": "",
"cCategoria": "1.01.02",
"nContaCorrente": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ImportarCTe"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""cChaveCte"": """", ""cXmlCte"": """", ""cMd5Cte"": """", ""cCategoria"": ""1.01.02"", ""nContaCorrente"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListar as NFes na qual a empresa é mencionada como Transportadora.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
chNFe | texto · até 44 | Chave da nota fiscal. |
dEmiFinal | texto · até 10 | Data de emissão final. |
dEmiInicial | texto · até 10 | Data de emissão inicial. |
hEmiFinal | texto · até 8 | Hora de emissão final. |
hEmiInicial | texto · até 8 | Hora de emissão inicial. |
nPagina | número inteiro | |
nRegPorPagina | número inteiro | |
tpNF | texto · até 1 | Tipo de nota fiscal. Pode ser: 0 - Entrada. 1 - Saída. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | número inteiro | |
nfeEncontradas | lista de objetos | Lista de NF-es encontradas. |
nfeEncontradas[].cXmlNFe | texto | XML da nota fiscal. |
nfeEncontradas[].chNFe | texto | Chave da NF-e. |
nfeEncontradas[].dEmi | texto | Data de emissão da NF-e. |
nfeEncontradas[].destCNPJ | texto | CNPJ do destinário da NF-e. |
nfeEncontradas[].emitCNPJ | texto | CNPJ do emitente da NF-e. |
nfeEncontradas[].hEmi | texto | Hora de emissão da NF-e. |
nfeEncontradas[].nProt | número inteiro | Número do protocolo da NF-e. |
nfeEncontradas[].tpNF | texto | Tipo de nota fiscal. Pode ser: 0 - Entrada. 1 - Saída. |
nfeEncontradas[].vNF | decimal | Valor da nota fiscal. |
nfeEncontradas[].versao | texto | Versão do XML da NF-e. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarNFeTransp", "param": [{"nPagina": 1, "nRegPorPagina": 20}]}'import os
import requests
corpo = {'call': 'ListarNFeTransp', 'param': [{'nPagina': 1, 'nRegPorPagina': 20}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarNFeTransp",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarNFeTransp",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "ListarNFeTransp",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarNFeTransp",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarNFeTransp"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 20}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna o Status da Fatura inclusa.
Obrigatórios 4
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
nIdFaturamento | número inteiro | ID do faturamento do grupo de CT-es. |
Retorno 17O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto | Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina. |
cAppNome | texto | Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e |
cAppVersao | texto | Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01 |
cCategoria | texto | Código da Categoria para geração do título no financeiro. |
cChaveCte | texto | Chave do CT-e a ser importado. Apenas números com 44 digitos. |
cExcluido | texto | Indica se está excluido. |
cStatus | texto | Status da Fatura. |
dEmi | texto | Data de emissão inicial. |
dExclusao | texto | Data de Exclusão. |
dVencimento | texto | Data de vencimento da fatura. |
hEmi | texto | Hora de emissão inicial. |
nCliente | número inteiro | Código do Cliente para geração do título no financeiro. |
nContaCorrente | número inteiro | Id da Conta Corrente no Omie para a geração do título no financeiro. |
nIdFaturamento | número inteiro | ID do faturamento do grupo de CT-es. |
nQtdeCte | número inteiro | Quantidade de CTe importadas |
nValorCte | decimal | Valor do CT-e. |
nVendedor | número inteiro | Código do Vendedor para geração do título no financeiro. |
POST /api/v1/produtos/cte/
curl -s https://app.omie.com.br/api/v1/produtos/cte/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "StatusFatura", "param": [{"cAppNome": "GeradorCTe", "cAppVersao": "1.01.02", "cAppId": "Cte01", "nIdFaturamento": 0}]}'import os
import requests
corpo = {'call': 'StatusFatura',
'param': [{'cAppNome': 'GeradorCTe',
'cAppVersao': '1.01.02',
'cAppId': 'Cte01',
'nIdFaturamento': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cte/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cte/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "StatusFatura",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cte/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "StatusFatura",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cte/")
corpo = <<~'JSON'
{
"call": "StatusFatura",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "StatusFatura",
"param": [
{
"cAppNome": "GeradorCTe",
"cAppVersao": "1.01.02",
"cAppId": "Cte01",
"nIdFaturamento": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cte/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cte/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""StatusFatura"", ""param"": [{""cAppNome"": ""GeradorCTe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""Cte01"", ""nIdFaturamento"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados