Produtos ·
PedidoVendaProdutoPedido de Vendas de Produtos
4consultas
6alterações
Claude 10 de 10 · ChatGPT 4 de 10 · MCP 10 de 10pelos assistentes de IA
JSON · XMLformato
Alteração dos dados de um pedido faturado.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 7Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
codigo_rastreio | texto · até 500 | Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
link_rastreio | texto · até 300 | Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'. |
numero_pedido | texto · até 15 | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
obs_venda | texto | Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda. |
previsao_entrega | texto · até 10 | Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
codigo_status | texto | Código do Status do Pedido de Venda. |
descricao_status | texto | Descrição do status. |
numero_pedido | texto | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarPedFaturado", "param": [{"codigo_pedido": 0, "codigo_pedido_integracao": "", "codigo_rastreio": "", "previsao_entrega": "", "obs_venda": ""}]}'import os
import requests
corpo = {'call': 'AlterarPedFaturado',
'param': [{'codigo_pedido': 0,
'codigo_pedido_integracao': '',
'codigo_rastreio': '',
'previsao_entrega': '',
'obs_venda': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarPedFaturado",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"codigo_rastreio": "",
"previsao_entrega": "",
"obs_venda": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "AlterarPedFaturado",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"codigo_rastreio": "",
"previsao_entrega": "",
"obs_venda": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "AlterarPedFaturado",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"codigo_rastreio": "",
"previsao_entrega": "",
"obs_venda": ""
}
]
}
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": "AlterarPedFaturado",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"codigo_rastreio": "",
"previsao_entrega": "",
"obs_venda": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarPedFaturado"", ""param"": [{""codigo_pedido"": 0, ""codigo_pedido_integracao"": """", ""codigo_rastreio"": """", ""previsao_entrega"": """", ""obs_venda"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosAlteração do Pedido de Venda
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 13Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
agropecuario | objeto | |
agropecuario.cCpfResponsavel | texto · até 14 | CPF do responsá¡vel técnico legalmente habilitado |
agropecuario.cNumReceita | texto · até 20 | Número da receita ou receituário do agrotóxico/defensivo agrícola |
agropecuario.cSerieGuia | texto · até 9 | Número de série da guia |
agropecuario.cUFGuia | texto · até 2 | UF de emissão da Guia |
agropecuario.nNumGuia | número inteiro | Número da guia |
agropecuario.nTipoGuia | número inteiro | Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG) |
cabecalho | objeto | Informações do cabeçalho do pedido. |
cabecalho.bloqueado | texto · até 1 | Pedido Bloqueado pela API. |
cabecalho.codigo_cenario_impostos | número inteiro | Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão. |
cabecalho.codigo_cliente | número inteiro | Código do cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. |
cabecalho.codigo_cliente_integracao | texto · até 60 | Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
cabecalho.codigo_empresadescontinuado | número inteiro | DEPRECATED |
cabecalho.codigo_empresa_integracaodescontinuado | texto · até 20 | DEPRECATED |
cabecalho.codigo_parcela | texto · até 3 | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Consultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'. |
cabecalho.codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
cabecalho.codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
cabecalho.data_previsao | texto · até 10 | Data de Previsão de Faturamento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. |
cabecalho.enc_data | texto · até 10 | Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.enc_hora | texto · até 8 | Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.enc_motivo | texto · até 100 | Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.enc_user | texto · até 10 | Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.encerrado | texto · até 1 | Indica que o pedido foi encerrado (S/N).
Tag utilizada apenas nos métodos de listagem e consulta.Ex.: S, N |
cabecalho.etapa | texto · até 2 | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
cabecalho.importado_api | texto · até 1 | Pedido de venda de produto importada pela API. |
cabecalho.nao_gerar_boleto | texto · até 1 | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
cabecalho.numero_pedido | texto · até 15 | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
cabecalho.origem_pedido | texto · até 3 | Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda. |
cabecalho.perc_desconto_pedido | número | Percentual do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
cabecalho.qtde_parcelas | número inteiro | Quantidade de parcelas. Valores permitidos de 1 a 999. |
cabecalho.quantidade_itens | número inteiro | Quantidade de Itens. |
cabecalho.sequencial | texto · até 4 | Número sequencial do pedido de venda parcial. Esse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela. |
cabecalho.tipo_desconto_pedido | texto · até 1 | Tipo de desconto para o pedido. Pode ser: V - Valor P - Percentual Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
cabecalho.valor_desconto_pedido | número | Valor do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. - Se o desconto for superior ao valor do pedido ele não será aplicado. |
departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
departamentos[].cCodDepto | texto · até 40 | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
departamentos[].nPerc | número | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
departamentos[].nValor | número | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
departamentos[].nValorFixo | texto · até 1 | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
det | lista de objetos | Dados da Aba "Itens da Venda" do Pedido de Venda. |
det[].combustivel | objeto | Detalhamento específico de Combustível. |
det[].combustivel.cCODIF | texto · até 21 | Registro do CODIF. |
det[].combustivel.cCodigoANP | texto · até 9 | Código de Produto da ANP. |
det[].combustivel.cDescrANP | texto · até 95 | Descrição do Produto conforme ANP. |
det[].combustivel.cUFConsumoComb | texto · até 2 | UF de Consumo. |
det[].combustivel.nAliquota_CIDE | número | Valor da Alíquota em Reais da CIDE. |
det[].combustivel.nBC_CIDE | número | Base de Cálculo (em quantidade) da CIDE. |
det[].combustivel.nBC_UFDest | número | Base de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
det[].combustivel.nBC_UFRem | número | Base de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária. |
det[].combustivel.nPercGLP | número | Percentual de GLP Derivado do Petróleo. |
det[].combustivel.nPercGasImportado | número | Percentual de Gás Natural Importado. |
det[].combustivel.nPercGasNacional | número | Percentual de Gás Natural Nacional. |
det[].combustivel.nQtdeFatTempAmb | número | Quantidade Faturada à Temperatura Ambiente. |
det[].combustivel.nValorPartida | número | Valor de Partida. |
det[].combustivel.nValorUFDest | número | Valor da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
det[].combustivel.nValorUFRem | número | Valor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária. |
det[].combustivel.nValor_CIDE | número | Valor da CIDE. |
det[].ide | objeto | Identificação do Item do Pedido de Vendas. |
det[].ide.acao_item | texto · até 1 | Ação para o item. Pode ser: "E" - para excluir um item. |
det[].ide.codigo_item | número inteiro | ID do Item do Pedido. |
det[].ide.codigo_item_integracao | texto · até 30 | Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199. |
det[].ide.id_ordem_producao | número inteiro | Id da Ordem de Produção. Campo disponível apenas para consulta. Não deve ser informado na Inclusão ou Alteração. |
det[].ide.regra_impostosdescontinuado | número inteiro | DEPRECATED |
det[].ide.simples_nacional | texto · até 1 | Indica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N". |
det[].imposto | objeto | Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados. |
det[].imposto.cbs | objeto | |
det[].imposto.cbs.aliquota_cbs | número | Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.perc_dif_cbs | número | Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.perc_red_cbs | número | Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.valor_cbs | número | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.valor_dif_cbs | número | Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cofins_padrao | objeto | COFINS. |
det[].imposto.cofins_padrao.aliq_cofins | número | |
det[].imposto.cofins_padrao.base_cofins | número | |
det[].imposto.cofins_padrao.cod_sit_trib_cofins | texto · até 2 | |
det[].imposto.cofins_padrao.qtde_unid_trib_cofins | número | |
det[].imposto.cofins_padrao.tipo_calculo_cofins | texto · até 1 | |
det[].imposto.cofins_padrao.valor_cofins | número | |
det[].imposto.cofins_padrao.valor_unid_trib_cofins | número | |
det[].imposto.cofins_st | objeto | COFINS - Substituição Tributária. |
det[].imposto.cofins_st.aliq_cofins_st | número | |
det[].imposto.cofins_st.base_cofins_st | número | |
det[].imposto.cofins_st.cod_sit_trib_cofins_st | texto · até 2 | |
det[].imposto.cofins_st.margem_cofins_st | número | |
det[].imposto.cofins_st.qtde_unid_trib_cofins_st | número | |
det[].imposto.cofins_st.tipo_calculo_cofins_st | texto · até 1 | |
det[].imposto.cofins_st.valor_cofins_st | número | |
det[].imposto.cofins_st.valor_unid_trib_cofins_st | número | |
det[].imposto.csll | objeto | CSLL. |
det[].imposto.csll.aliq_csll | número | |
det[].imposto.csll.valor_csll | número | |
det[].imposto.ibs | objeto | |
det[].imposto.ibs.aliquota_ibs_mu | número | Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.aliquota_ibs_uf | número | Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_dif_ibs_mu | número | Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_dif_ibs_uf | número | Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_red_ibs_mu | número | Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_red_ibs_uf | número | Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal. |
det[].imposto.ibs.valor_dif_ibs_mu | número | Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_dif_ibs_uf | número | Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_ibs | número | Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_ibs_mu | número | Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_ibs_uf | número | Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs_cbs | objeto | |
det[].imposto.ibs_cbs.base_ibs_cbs | número | Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs_cbs.class_trib | texto · até 6 | Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs_cbs.cst_ibs_cbs | texto · até 3 | Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.icms | objeto | ICMS |
det[].imposto.icms.aliq_icms | número | |
det[].imposto.icms.base_fcp_icms | número | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS. |
det[].imposto.icms.base_icms | número | |
det[].imposto.icms.cod_sit_trib_icms | texto · até 2 | |
det[].imposto.icms.modalidade_icms | texto · até 1 | |
det[].imposto.icms.origem_icms | texto · até 1 | |
det[].imposto.icms.perc_fcp_icms | número | Percentual do FCP - Fundo de Combate a Pobreza do ICMS. |
det[].imposto.icms.perc_red_base_icms | número | |
det[].imposto.icms.valor_fcp_icms | número | Valor do FCP - Fundo de Combate a Pobreza do ICMS. |
det[].imposto.icms.valor_icms | número | |
det[].imposto.icms_efet | objeto | ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem |
det[].imposto.icms_efet.aliq_icms_efet | número | |
det[].imposto.icms_efet.base_icms_efet | número | |
det[].imposto.icms_efet.cod_sit_trib_icms_efet | texto · até 2 | |
det[].imposto.icms_efet.modalidade_icms_efet | texto · até 1 | |
det[].imposto.icms_efet.origem_icms_efet | texto · até 1 | |
det[].imposto.icms_efet.perc_red_base_icms_efet | número | |
det[].imposto.icms_efet.valor_icms_efet | número | |
det[].imposto.icms_ie | objeto | ICMS Interestadual. |
det[].imposto.icms_ie.aliq_icms_FCP | número | Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino |
det[].imposto.icms_ie.aliq_interestadual | número | Alíquota Interestadual das UFs Envolvidas |
det[].imposto.icms_ie.aliq_interna_uf_destino | número | Alíquota Interna da UF de Destino |
det[].imposto.icms_ie.aliq_partilha_icms | número | Percentual Provisório de Partilha do ICMS Interestadual |
det[].imposto.icms_ie.base_icms_uf_destino | número | BC do ICMS na UF de Destino |
det[].imposto.icms_ie.valor_fcp_icms_inter | número | Valor do fundo de combate a pobreza. |
det[].imposto.icms_ie.valor_icms_uf_dest | número | Valor do ICMS - UF Destino |
det[].imposto.icms_ie.valor_icms_uf_remet | número | Valor do ICMS - UF Remetente |
det[].imposto.icms_sn | objeto | ICMS - Simples Nacional. |
det[].imposto.icms_sn.aliq_icms_sn | número | |
det[].imposto.icms_sn.base_icms_sn | número | |
det[].imposto.icms_sn.cod_sit_trib_icms_sn | texto · até 3 | |
det[].imposto.icms_sn.origem_icms_sn | texto · até 1 | |
det[].imposto.icms_sn.valor_credito_icms_sn | número | |
det[].imposto.icms_sn.valor_icms_sn | número | |
det[].imposto.icms_st | objeto | ICMS - Substituição Tributária. |
det[].imposto.icms_st.aliq_icms_opprop | número | Alíquota de ICMS Operação Própria. |
det[].imposto.icms_st.aliq_icms_st | número | |
det[].imposto.icms_st.base_fcp_icms_st | número | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det[].imposto.icms_st.base_icms_st | número | |
det[].imposto.icms_st.cest | texto · até 9 | CEST - Código Especificador da Substituíção Tributária. |
det[].imposto.icms_st.cod_sit_trib_icms_st | texto · até 2 | |
det[].imposto.icms_st.margem_icms_st | número | |
det[].imposto.icms_st.modalidade_icms_st | texto · até 1 | |
det[].imposto.icms_st.perc_fcp_icms_st | número | Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det[].imposto.icms_st.perc_red_base_icms_op | número | Percentual de redução de base de cálculo de Icms Operação Própria. |
det[].imposto.icms_st.perc_red_base_icms_st | número | |
det[].imposto.icms_st.valor_fcp_icms_st | número | Valor do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det[].imposto.icms_st.valor_icms_st | número | |
det[].imposto.inss | objeto | INSS. |
det[].imposto.inss.aliq_inss | número | |
det[].imposto.inss.valor_inss | número | |
det[].imposto.ipi | objeto | IPI. |
det[].imposto.ipi.aliq_ipi | número | |
det[].imposto.ipi.base_ipi | número | |
det[].imposto.ipi.cod_sit_trib_ipi | texto · até 2 | |
det[].imposto.ipi.enquadramento_ipi | texto | Enquadramento do IPI |
det[].imposto.ipi.qtde_unid_trib_ipi | número | |
det[].imposto.ipi.tipo_calculo_ipi | texto · até 1 | |
det[].imposto.ipi.valor_ipi | número | |
det[].imposto.ipi.valor_unid_trib_ipi | número | |
det[].imposto.irrf | objeto | IRRF. |
det[].imposto.irrf.aliq_irrf | número | |
det[].imposto.irrf.valor_irrf | número | |
det[].imposto.iss | objeto | ISS. |
det[].imposto.iss.aliq_iss | número | |
det[].imposto.iss.base_iss | número | |
det[].imposto.iss.retem_iss | texto · até 1 | |
det[].imposto.iss.valor_iss | número | |
det[].imposto.pis_padrao | objeto | PIS. |
det[].imposto.pis_padrao.aliq_pis | número | |
det[].imposto.pis_padrao.base_pis | número | |
det[].imposto.pis_padrao.cod_sit_trib_pis | texto · até 2 | |
det[].imposto.pis_padrao.qtde_unid_trib_pis | número | |
det[].imposto.pis_padrao.tipo_calculo_pis | texto · até 1 | |
det[].imposto.pis_padrao.valor_pis | número | |
det[].imposto.pis_padrao.valor_unid_trib_pis | número | |
det[].imposto.pis_st | objeto | PIS - Substituíção Tributária. |
det[].imposto.pis_st.aliq_pis_st | número | |
det[].imposto.pis_st.base_pis_st | número | |
det[].imposto.pis_st.cod_sit_trib_pis_st | texto · até 2 | |
det[].imposto.pis_st.margem_pis_st | número | |
det[].imposto.pis_st.qtde_unid_trib_pis_st | número | |
det[].imposto.pis_st.tipo_calculo_pis_st | texto · até 1 | |
det[].imposto.pis_st.valor_pis_st | número | |
det[].imposto.pis_st.valor_unid_trib_pis_st | número | |
det[].imposto.trib_reg | objeto | |
det[].imposto.trib_reg.aliquota_reg_cbs | número | Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.aliquota_reg_ibs_mu | número | Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.aliquota_reg_ibs_uf | número | Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.class_trib_reg | texto · até 6 | Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.cst_reg_ibs_cst | texto · até 3 | Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.valor_reg_cbs | número | Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.valor_reg_ibs_mu | número | Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.valor_reg_ibs_uf | número | Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].inf_adic | objeto | Dados da aba "Informações Adicionais" do Item do Pedido de Vendas. |
det[].inf_adic.codigo_beneficio_fiscal | texto · até 10 | Código do Benefício Fiscal. |
det[].inf_adic.codigo_categoria_item | texto · até 20 | Código da Categoria do item. |
det[].inf_adic.codigo_cenario_impostos_item | número inteiro | Código do Cenário de Impostos. |
det[].inf_adic.codigo_local_estoque | número inteiro | Código do Local do Estoque. |
det[].inf_adic.dados_adicionais_item | texto | Informações para a Nota Fiscal. |
det[].inf_adic.item_pedido_compra | número inteiro | Item do Pedido de Compra. |
det[].inf_adic.nao_gerar_financeiro | texto · até 1 | Não gerar conta a receber para este item. Informar "S" ou "N". (Informe "S" para ativar essa opção). |
det[].inf_adic.nao_movimentar_estoque | texto · até 1 | Não gerar a saída de estoque deste item ao emitir NF-e. Informar "S" ou "N". (informe "S" para ativar essa opção). |
det[].inf_adic.nao_somar_total | texto · até 1 | Não somar este item no total da NF-e |
det[].inf_adic.numero_fci | texto · até 36 | Número da FCI (Ficha de Conteúdo de Importação) |
det[].inf_adic.numero_pedido_compra | texto · até 15 | Número do Pedido de Compra. |
det[].inf_adic.numero_recopi | texto · até 20 | Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune). |
det[].inf_adic.peso_bruto | número | Peso Bruto (Kg). |
det[].inf_adic.peso_liquido | número | Peso Líquido (Kg). |
det[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
det[].lote_validade[].nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
det[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
det[].observacao | objeto | Dados da aba "Observações" do Item do Pedido de Vendas. |
det[].observacao.obs_item | texto | Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal). Informação localizada na Aba "Observações" do Item do Pedido de Venda. |
det[].produto | objeto | Identificação do Produto do Item do Pedido de Vendas. |
det[].produto.cfop | texto · até 10 | CFOP - Código Fiscal de Operações e Prestações. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
det[].produto.cnpj_fabricante | texto · até 20 | CNPJ do Fabricante da Mercadoria. |
det[].produto.codigo | texto · até 60 | Código do Produto exibido na tela do Pedido de Vendas. |
det[].produto.codigo_item_kit | número inteiro | ID do Item do kit (pai) que o componente pertence |
det[].produto.codigo_produto | número inteiro | ID do Produto. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag "codigo_produto" do método "ListarProdutos" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação. |
det[].produto.codigo_produto_integracao | texto · até 60 | Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "codigo_produto". |
det[].produto.codigo_tabela_preco | número inteiro | Código da tabela de preço. (Interno, utilizado apenas na integração via API, não é exibido na tela). Deve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie. |
det[].produto.componente_kit | texto · até 1 | Indica se o produto é um componente de um kit |
det[].produto.descricao | texto · até 120 | Descrição do Produto. |
det[].produto.ean | texto · até 14 | EAN - European Article Number |
det[].produto.indicador_escala | texto · até 1 | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
det[].produto.kit | texto · até 1 | Indica se o produto é um kit |
det[].produto.motivo_icms_desonerado | texto · até 2 | Código do Motivo de desoneração do ICMS Códigos válidos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco |
det[].produto.ncm | texto · até 13 | NCM - Nomenclatura Comum do Mercosul Utilize a tag "cCodigo" do método "ListarNCM" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação. |
det[].produto.percentual_desconto | número | Percentual de Desconto. |
det[].produto.quantidade | número | Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto. |
det[].produto.reservado | texto · até 1 | (S/N) Indica se o estoque do produto será reservado.Ex.: S, N |
det[].produto.tipo_desconto | texto · até 1 | Tipo de Desconto. |
det[].produto.unidade | texto · até 6 | Unidade. Utilize a tag "codigo" do método "ListarUnidades" da API http://app.omie.com.br/api/v1/geral/unidade/ para obter essa informação. |
det[].produto.valor_deducao | número | Valor da Dedução |
det[].produto.valor_desconto | número | Valor do Desconto |
det[].produto.valor_icms_desonerado | número | Valor do ICMS desonerado |
det[].produto.valor_mercadoria | número | Valor da Mercadoria |
det[].produto.valor_total | número | Valor Total. |
det[].produto.valor_unitario | número | Valor Únitário |
det[].rastreabilidade | objeto | Dados da rastreabilidade do produto. |
det[].rastreabilidade.codigoAgregacaoLote | texto · até 20 | Código de Agregação |
det[].rastreabilidade.dataFabricacaoLote | texto · até 10 | Data de Fabricação/Produção |
det[].rastreabilidade.dataValidadeLote | texto · até 10 | Data de Validade |
det[].rastreabilidade.numeroLote | texto · até 20 | Número do Lote |
det[].rastreabilidade.qtdeProdutoLote | número | Quantidade de Produto |
det[].tributavel | objeto | Unidade, Quantidade, Valor e EAN tributáveis do item do pedido. |
det[].tributavel.cEanTrib | texto · até 14 | código EAN tributável do item. |
det[].tributavel.cUnidTrib | texto · até 6 | Unidade tributável do Item. |
det[].tributavel.nQuantTrib | número | Quantidade tributável do item. |
det[].tributavel.nValorTrib | número | Valor tributável do item. |
exportacao | objeto | Dados da exportacao |
exportacao.local_despacho | texto · até 60 | Local de Despacho |
exportacao.local_embarque | texto · até 60 | Local de Embarque (ou de transposição de fronteira) |
exportacao.nao_exportacao | texto · até 1 | O cliente é estrangeiro, mas na verdade não se trata de uma exportação |
exportacao.uf_embarque | texto · até 2 | UF do Local de Embarque |
frete | objeto | Dados da Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.codigo_rastreio | texto · até 500 | Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.codigo_tipo_entrega | número inteiro | Código do tipo de entrega. |
frete.codigo_transportadora | número inteiro | ID da transportadora. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras. |
frete.codigo_transportadora_integracao | texto · até 60 | Código Integração da Transportadora. Esse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
frete.especie_volumes | texto · até 60 | Espécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido | objeto | Dados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.cCfopTr | texto · até 10 | CFOP. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
frete.icms_retido.cCidadeTr | texto · até 40 | Cidade de Ocorrência do Fato Gerador do ICMS. Utilize o formato: CIDADE (UF), como no exemplos: "SAO PAULO (SP)" "RIO DE JANEIRO (RJ)" "FLORIANOPOLIS (SC)" Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
frete.icms_retido.vAliquotaRetencaoTr | número | Percentual de Alíquota de Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.vBCRetencaoTr | número | Base de Cálculo da Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.vIcmsRetidoTr | número | Valor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.vServicoTr | número | Valor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.link_rastreio | texto · até 300 | Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'. |
frete.marca_volumes | texto · até 60 | Marca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.modalidade | texto · até 1 | Tipo de Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Valores disponíveis: "0" - Contratação do Frete por conta do Remetente (CIF) "1" - Contratação do Frete por conta do Destinatário (FOB) "2" - Contratação do Frete por conta de Terceiros "3" - Transporte Próprio por conta do Remetente "4" - Transporte Próprio por conta do Destinatário "9" - Sem frete. |
frete.numeracao_volumes | texto · até 60 | Numeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.numero_lacre | texto · até 60 | Número do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.outras_despesas | número | Outras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.peso_bruto | número | Peso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.peso_liquido | número | Peso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.placa | texto · até 7 | Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.placa_estado | texto · até 2 | Estado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.previsao_entrega | texto · até 10 | Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.quantidade_volumes | número inteiro | Quantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.registro_transportador | texto · até 20 | RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.valor_frete | número | Valor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.valor_seguro | número | Valor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.veiculo_proprio | texto · até 1 | O transporte será realizado com veículo próprio. Informar "S" ou "N". Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
infoCadastro | objeto | Informações complementares do pedido. |
infoCadastro.autorizado | texto · até 1 | Indica se o pedido foi autorizado. |
infoCadastro.cImpAPI | texto · até 1 | Importado pela API. |
infoCadastro.cancelado | texto · até 1 | Indica se o pedido foi cancelado. |
infoCadastro.dAlt | texto · até 10 | Data da Alteração. |
infoCadastro.dCan | texto · até 10 | Data da Cancelamento. |
infoCadastro.dFat | texto · até 10 | Data de Faturamento. |
infoCadastro.dInc | texto · até 10 | Data da Inclusão. |
infoCadastro.denegado | texto · até 1 | Indica se o pedido foi denegado. |
infoCadastro.devolvido | texto · até 1 | Indica se o pedido foi devolvido. |
infoCadastro.devolvido_parcial | texto · até 1 | Indica se o pedido foi devolvido parcialmente. |
infoCadastro.faturado | texto · até 1 | Indica se o pedido está faturado. |
infoCadastro.hAlt | texto · até 8 | Hora da Alteração. |
infoCadastro.hCan | texto · até 8 | Hora da Cancelamento. |
infoCadastro.hFat | texto · até 8 | Hora de faturamento. |
infoCadastro.hInc | texto · até 8 | Hora da Inclusão. |
infoCadastro.uAlt | texto · até 10 | Usuário da Alteração. |
infoCadastro.uCan | texto · até 10 | Usuário da Cancelamento. |
infoCadastro.uFat | texto · até 10 | Usuário que realizou o faturamento. |
infoCadastro.uInc | texto · até 10 | Usuário da Inclusão. |
informacoes_adicionais | objeto | Dados da Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.codProj | número inteiro | Código do Projeto. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação. |
informacoes_adicionais.codVend | número inteiro | Código do Vendedor. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação. |
informacoes_adicionais.codigo_categoria | texto · até 20 | Código da categoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. |
informacoes_adicionais.codigo_conta_corrente | número inteiro | Código da Conta Corrente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
informacoes_adicionais.consumidor_final | texto · até 1 | Nota Fiscal para Consumo Final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.contato | texto · até 100 | Contato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.dados_adicionais_nf | texto | Dados adicionais para a Nota Fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
informacoes_adicionais.enviar_email | texto · até 1 | Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
informacoes_adicionais.enviar_pix | texto · até 1 | Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
informacoes_adicionais.impostos_embutidosdescontinuado | texto · até 1 | DEPRECATED |
informacoes_adicionais.meio_pagamento | texto · até 100 | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
informacoes_adicionais.nfRelacionada | objeto | Detalhes da NF referenciada. |
informacoes_adicionais.nfRelacionada.InscrEstPR | texto · até 20 | Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.cChaveRef | texto · até 44 | Chave da NF-e (ou NFC-e ou SAT) Relacionada. |
informacoes_adicionais.nfRelacionada.cSeriePR | texto · até 3 | Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.cSerieRef | texto · até 3 | Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.cSigNFRef | texto · até 1 | Manter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N" |
informacoes_adicionais.nfRelacionada.cUfPR | texto · até 2 | Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.cUfRef | texto · até 2 | Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.cnpjEmitRef | texto · até 20 | CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.cnpjIntermediario | texto · até 20 | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.cnpjPR | texto · até 20 | CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.dtEmissaoPR | texto · até 10 | Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.dtEmissaoRef | texto · até 10 | Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.identIntermediario | texto · até 60 | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.indIntermediario | texto · até 1 | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.indPresenca | texto · até 1 | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.nCOORef | texto · até 6 | Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado |
informacoes_adicionais.nfRelacionada.nECFRef | texto · até 3 | Número de Ordem Sequencial do ECF. |
informacoes_adicionais.nfRelacionada.nNFRef | texto · até 9 | Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.nNfPR | texto · até 9 | Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.nrCupomFiscal | lista de objetos | Outros cupons fiscais relacionados |
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrCOO | texto · até 6 | Contador de Ordem de Operação (COO) |
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECF | texto · até 3 | Número do ECF |
informacoes_adicionais.nfRelacionada.nrModelo1_1A | lista de objetos | Outras notas modelo 1/1A relacionadas |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrCnpjCpf | texto · até 20 | CNPJ/CPF do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissao | texto · até 10 | Data de emissão da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumero | texto · até 9 | Número da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerie | texto · até 3 | Série da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUF | texto · até 2 | Unidade federativa do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrNF | lista de objetos | Outras NF-e, NFC-e ou SAT relacionadas |
informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrNF[].nrChave | texto · até 44 | Chave da NF-e, NFC-e ou SAT relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural | lista de objetos | Outras notas de produtor rural relacionadas |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrCnpjCpf | texto · até 20 | CNPJ/CPF do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissao | texto · até 10 | Data de emissão da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIE | texto · até 20 | Inscrição Estadual do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumero | texto · até 9 | Número da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerie | texto · até 3 | Série da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUF | texto · até 2 | Unidade federativa do emitente da NF relacionada |
informacoes_adicionais.nsu | texto · até 100 | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
informacoes_adicionais.numero_contrato | texto · até 20 | Número do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.numero_pedido_cliente | texto · até 30 | Número do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes | objeto | Outros detalhes da NF-e. |
informacoes_adicionais.outros_detalhes.cBairroOd | texto · até 60 | Bairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cBairroOdRet | texto · até 60 | Bairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCEPOd | texto · até 10 | CEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCEPOdRet | texto · até 10 | CEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCidadeOd | texto · até 40 | Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
informacoes_adicionais.outros_detalhes.cCidadeOdRet | texto · até 40 | Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
informacoes_adicionais.outros_detalhes.cCnpjCpfOd | texto · até 20 | CNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCnpjCpfOdRet | texto · até 20 | CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCnpjIntOd | texto · até 20 | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cComplementoOd | texto · até 60 | Complemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cComplementoOdRet | texto · até 60 | Complemento do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEnderecoOd | texto · até 60 | Endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEnderecoOdRet | texto · até 60 | Endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEstadoOd | texto · até 2 | Estado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEstadoOdRet | texto · até 2 | Estado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cHoraSaidaOd | texto · até 8 | Hora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cIdentificadorIntOd | texto · até 60 | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cIndicadorIntOd | texto · até 1 | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cIndicadorOd | texto · até 1 | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cInscrEstadualOd | texto · até 20 | Inscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cInscrEstadualOdRet | texto · até 20 | Inscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNatOperacaoOd | texto · até 60 | Natureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNomeOd | texto · até 60 | Nome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNomeOdRet | texto · até 60 | Nome / Razão Social (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNumeroOd | texto · até 10 | Número do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNumeroOdRet | texto · até 10 | Número do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cSepararEnderecoOd | texto · até 1 | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
informacoes_adicionais.outros_detalhes.cSepararEnderecoOdRet | texto · até 1 | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
informacoes_adicionais.outros_detalhes.cTelefoneOd | texto · até 15 | Telefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cTelefoneOdRet | texto · até 15 | Telefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.dDataSaidaOd | texto · até 10 | Data de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.tipo_documento | texto · até 5 | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
informacoes_adicionais.utilizar_emails | texto | Utilizar os seguintes endereços de e-mail. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. |
lancamentos | lista de objetos | Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros). |
lancamentos[].cCategoria | texto · até 20 | Código da Categoria. |
lancamentos[].cNaturezaDocumento | texto · até 1 | Natureza do Documento. Pode ser: P - Pagar R - Receber Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].cObs | texto | Observações. |
lancamentos[].cOrigem | texto · até 3 | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].cTipoDocumento | texto · até 5 | Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].dDataDocumento | texto · até 10 | Data do documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].nContaCorrente | número inteiro | Id da Conta Corrente. |
lancamentos[].nProjeto | número inteiro | Id do projeto. |
lancamentos[].nSequencia | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
lancamentos[].nValorDocumento | número | Valor do Documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].nVendedor | número inteiro | Id do Vendedor. |
lista_parcelas | objeto | Dados da Aba "Parcelas" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura. |
lista_parcelas.parcela | lista de objetos | Dados da parcela. |
lista_parcelas.parcela[].bandeira | texto · até 2 | Código da Bandeira da operadora de cartão. |
lista_parcelas.parcela[].categoria_adiantamento | texto · até 20 | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].cnpj_fin | texto · até 20 | Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. |
lista_parcelas.parcela[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].data_vencimento | texto · até 10 | Data de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
lista_parcelas.parcela[].meio_pagamento | texto · até 100 | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
lista_parcelas.parcela[].nao_gerar_boleto | texto · até 1 | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].nsu | texto · até 100 | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
lista_parcelas.parcela[].numero_parcela | número inteiro | Número da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].parcela_adiantamento | texto · até 1 | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].percentual | número | Percentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].quantidade_dias | número inteiro | Quantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].tipo_documento | texto · até 5 | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
lista_parcelas.parcela[].valor | número | Valor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
market_place | objeto | Dados para o Market Place. |
market_place.nEnvio | número | Valor do envio do Market Place. |
market_place.nTaxa | número | Valor da taxa do Market Place. |
observacoes | objeto | Dados da Aba "Observações" do Pedido de Venda. |
observacoes.obs_venda | texto | Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda. |
total_pedido | objeto | Valores totais do pedido. |
total_pedido.base_calculo_icms | número | Base de Cálculo do ICMS. |
total_pedido.base_calculo_st | número | Base de cálculo da substituição tributária. |
total_pedido.base_ibs_cbs | número | Valor total da base de cálculo do IBS e da CBS. |
total_pedido.valor_IPI | número | Valor do IPI. |
total_pedido.valor_cbs | número | Valor total da CBS. |
total_pedido.valor_cofins | número | Valor do cofins. |
total_pedido.valor_csll | número | Valor da CSLL. |
total_pedido.valor_deducoes | número | Valor das deduções. |
total_pedido.valor_descontos | número | Valor dos descontos. |
total_pedido.valor_dif_cbs | número | Valor total do diferimento da CBS. |
total_pedido.valor_dif_ibs_mu | número | Valor total do diferimento do IBS do município. |
total_pedido.valor_dif_ibs_uf | número | Valor total do diferimento do IBS UF. |
total_pedido.valor_ibs | número | Valor total do IBS. |
total_pedido.valor_ibs_mu | número | Valor total do IBS do município. |
total_pedido.valor_ibs_uf | número | Valor total do IBS da UF. |
total_pedido.valor_icms | número | Valor total do ICMS. |
total_pedido.valor_inss | número | Valor do INSS. |
total_pedido.valor_ir | número | Valor do IR. .Preenchimento automático - Não informar. |
total_pedido.valor_iss | número | Valor do ISS. |
total_pedido.valor_mercadorias | número | valor das mercadorias. |
total_pedido.valor_pis | número | Valor do PIS. |
total_pedido.valor_st | número | Valor total da ST. |
total_pedido.valor_tot_ibs_cbs_is | número | Total da NF-e com IBS/CBS/IS. |
total_pedido.valor_total_pedido | número | Valor total do pedido. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | Código do Pedido de Venda de Produto |
codigo_pedido_integracao | texto | Código de Integração do Pedido de Venda de Produto |
codigo_status | texto | Código do Status do Pedido de Venda. |
descricao_status | texto | Descrição do status. |
numero_pedido | texto | Número do pedido - Visualizado pelo cliente. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarPedidoVenda", "param": [{"cabecalho": {"bloqueado": "N", "codigo_cliente": 3792227, "codigo_pedido_integracao": "1790776577", "data_previsao": "30/09/2026", "etapa": "50", "quantidade_itens": 1}, "det": [{"ide": {"codigo_item_integracao": "4422421", "simples_nacional": "S"}, "imposto": {"cofins_padrao": {"aliq_cofins": 3, "base_cofins": 400, "cod_sit_trib_cofins": "01", "tipo_calculo_cofins": "B", "valor_cofins": 12}, "icms_sn": {"aliq_icms_sn": 1.25, "cod_sit_trib_icms_sn": 101, "origem_icms_sn": 0, "valor_credito_icms_sn": 5}, "ipi": {"cod_sit_trib_ipi": 51}, "pis_padrao": {"aliq_pis": 0.65, "base_pis": 400, "cod_sit_trib_pis": "01", "tipo_calculo_pis": "B", "valor_pis": 2.6}}, "inf_adic": {"peso_bruto": 150, "peso_liquido": 150}, "produto": {"cfop": "5.102", "codigo_produto": "4422421", "descricao": "Telefone Celular X", "ncm": "9403.30.00", "quantidade": 1, "tipo_desconto": "V", "unidade": "UN", "valor_desconto": 0, "valor_mercadoria": 200, "valor_total": 200, "valor_unitario": 200}}], "informacoes_adicionais": {"codigo_categoria": "1.01.03", "codigo_conta_corrente": 11850365, "consumidor_final": "S", "enviar_email": "N"}, "agropecuario": {"cNumReceita": "", "cCpfResponsavel": "", "nTipoGuia": 1, "cUFGuia": "", "cSerieGuia": "", "nNumGuia": 1}, "lista_parcelas": {"parcela": [{"data_vencimento": "01/10/2026", "numero_parcela": 1, "percentual": 50, "valor": 100}, {"data_vencimento": "12/12/2026", "numero_parcela": 2, "percentual": 50, "valor": 100}]}, "total_pedido": {"base_calculo_icms": 200, "valor_mercadorias": 200, "valor_total_pedido": 200}}]}'import os
import requests
corpo = {'call': 'AlterarPedidoVenda',
'param': [{'cabecalho': {'bloqueado': 'N',
'codigo_cliente': 3792227,
'codigo_pedido_integracao': '1790776577',
'data_previsao': '30/09/2026',
'etapa': '50',
'quantidade_itens': 1},
'det': [{'ide': {'codigo_item_integracao': '4422421',
'simples_nacional': 'S'},
'imposto': {'cofins_padrao': {'aliq_cofins': 3,
'base_cofins': 400,
'cod_sit_trib_cofins': '01',
'tipo_calculo_cofins': 'B',
'valor_cofins': 12},
'icms_sn': {'aliq_icms_sn': 1.25,
'cod_sit_trib_icms_sn': 101,
'origem_icms_sn': 0,
'valor_credito_icms_sn': 5},
'ipi': {'cod_sit_trib_ipi': 51},
'pis_padrao': {'aliq_pis': 0.65,
'base_pis': 400,
'cod_sit_trib_pis': '01',
'tipo_calculo_pis': 'B',
'valor_pis': 2.6}},
'inf_adic': {'peso_bruto': 150, 'peso_liquido': 150},
'produto': {'cfop': '5.102',
'codigo_produto': '4422421',
'descricao': 'Telefone Celular X',
'ncm': '9403.30.00',
'quantidade': 1,
'tipo_desconto': 'V',
'unidade': 'UN',
'valor_desconto': 0,
'valor_mercadoria': 200,
'valor_total': 200,
'valor_unitario': 200}}],
'informacoes_adicionais': {'codigo_categoria': '1.01.03',
'codigo_conta_corrente': 11850365,
'consumidor_final': 'S',
'enviar_email': 'N'},
'agropecuario': {'cNumReceita': '',
'cCpfResponsavel': '',
'nTipoGuia': 1,
'cUFGuia': '',
'cSerieGuia': '',
'nNumGuia': 1},
'lista_parcelas': {'parcela': [{'data_vencimento': '01/10/2026',
'numero_parcela': 1,
'percentual': 50,
'valor': 100},
{'data_vencimento': '12/12/2026',
'numero_parcela': 2,
'percentual': 50,
'valor': 100}]},
'total_pedido': {'base_calculo_icms': 200,
'valor_mercadorias': 200,
'valor_total_pedido': 200}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarPedidoVenda",
"param": [
{
"cabecalho": {
"bloqueado": "N",
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "50",
"quantidade_itens": 1
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421",
"simples_nacional": "S"
},
"imposto": {
"cofins_padrao": {
"aliq_cofins": 3,
"base_cofins": 400,
"cod_sit_trib_cofins": "01",
"tipo_calculo_cofins": "B",
"valor_cofins": 12
},
"icms_sn": {
"aliq_icms_sn": 1.25,
"cod_sit_trib_icms_sn": 101,
"origem_icms_sn": 0,
"valor_credito_icms_sn": 5
},
"ipi": {
"cod_sit_trib_ipi": 51
},
"pis_padrao": {
"aliq_pis": 0.65,
"base_pis": 400,
"cod_sit_trib_pis": "01",
"tipo_calculo_pis": "B",
"valor_pis": 2.6
}
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_mercadoria": 200,
"valor_total": 200,
"valor_unitario": 200
}
}
],
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "12/12/2026",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
},
"total_pedido": {
"base_calculo_icms": 200,
"valor_mercadorias": 200,
"valor_total_pedido": 200
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "AlterarPedidoVenda",
"param": [
{
"cabecalho": {
"bloqueado": "N",
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "50",
"quantidade_itens": 1
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421",
"simples_nacional": "S"
},
"imposto": {
"cofins_padrao": {
"aliq_cofins": 3,
"base_cofins": 400,
"cod_sit_trib_cofins": "01",
"tipo_calculo_cofins": "B",
"valor_cofins": 12
},
"icms_sn": {
"aliq_icms_sn": 1.25,
"cod_sit_trib_icms_sn": 101,
"origem_icms_sn": 0,
"valor_credito_icms_sn": 5
},
"ipi": {
"cod_sit_trib_ipi": 51
},
"pis_padrao": {
"aliq_pis": 0.65,
"base_pis": 400,
"cod_sit_trib_pis": "01",
"tipo_calculo_pis": "B",
"valor_pis": 2.6
}
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_mercadoria": 200,
"valor_total": 200,
"valor_unitario": 200
}
}
],
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "12/12/2026",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
},
"total_pedido": {
"base_calculo_icms": 200,
"valor_mercadorias": 200,
"valor_total_pedido": 200
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "AlterarPedidoVenda",
"param": [
{
"cabecalho": {
"bloqueado": "N",
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "50",
"quantidade_itens": 1
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421",
"simples_nacional": "S"
},
"imposto": {
"cofins_padrao": {
"aliq_cofins": 3,
"base_cofins": 400,
"cod_sit_trib_cofins": "01",
"tipo_calculo_cofins": "B",
"valor_cofins": 12
},
"icms_sn": {
"aliq_icms_sn": 1.25,
"cod_sit_trib_icms_sn": 101,
"origem_icms_sn": 0,
"valor_credito_icms_sn": 5
},
"ipi": {
"cod_sit_trib_ipi": 51
},
"pis_padrao": {
"aliq_pis": 0.65,
"base_pis": 400,
"cod_sit_trib_pis": "01",
"tipo_calculo_pis": "B",
"valor_pis": 2.6
}
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_mercadoria": 200,
"valor_total": 200,
"valor_unitario": 200
}
}
],
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "12/12/2026",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
},
"total_pedido": {
"base_calculo_icms": 200,
"valor_mercadorias": 200,
"valor_total_pedido": 200
}
}
]
}
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": "AlterarPedidoVenda",
"param": [
{
"cabecalho": {
"bloqueado": "N",
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "50",
"quantidade_itens": 1
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421",
"simples_nacional": "S"
},
"imposto": {
"cofins_padrao": {
"aliq_cofins": 3,
"base_cofins": 400,
"cod_sit_trib_cofins": "01",
"tipo_calculo_cofins": "B",
"valor_cofins": 12
},
"icms_sn": {
"aliq_icms_sn": 1.25,
"cod_sit_trib_icms_sn": 101,
"origem_icms_sn": 0,
"valor_credito_icms_sn": 5
},
"ipi": {
"cod_sit_trib_ipi": 51
},
"pis_padrao": {
"aliq_pis": 0.65,
"base_pis": 400,
"cod_sit_trib_pis": "01",
"tipo_calculo_pis": "B",
"valor_pis": 2.6
}
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_mercadoria": 200,
"valor_total": 200,
"valor_unitario": 200
}
}
],
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "12/12/2026",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
},
"total_pedido": {
"base_calculo_icms": 200,
"valor_mercadorias": 200,
"valor_total_pedido": 200
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarPedidoVenda"", ""param"": [{""cabecalho"": {""bloqueado"": ""N"", ""codigo_cliente"": 3792227, ""codigo_pedido_integracao"": ""1790776577"", ""data_previsao"": ""30/09/2026"", ""etapa"": ""50"", ""quantidade_itens"": 1}, ""det"": [{""ide"": {""codigo_item_integracao"": ""4422421"", ""simples_nacional"": ""S""}, ""imposto"": {""cofins_padrao"": {""aliq_cofins"": 3, ""base_cofins"": 400, ""cod_sit_trib_cofins"": ""01"", ""tipo_calculo_cofins"": ""B"", ""valor_cofins"": 12}, ""icms_sn"": {""aliq_icms_sn"": 1.25, ""cod_sit_trib_icms_sn"": 101, ""origem_icms_sn"": 0, ""valor_credito_icms_sn"": 5}, ""ipi"": {""cod_sit_trib_ipi"": 51}, ""pis_padrao"": {""aliq_pis"": 0.65, ""base_pis"": 400, ""cod_sit_trib_pis"": ""01"", ""tipo_calculo_pis"": ""B"", ""valor_pis"": 2.6}}, ""inf_adic"": {""peso_bruto"": 150, ""peso_liquido"": 150}, ""produto"": {""cfop"": ""5.102"", ""codigo_produto"": ""4422421"", ""descricao"": ""Telefone Celular X"", ""ncm"": ""9403.30.00"", ""quantidade"": 1, ""tipo_desconto"": ""V"", ""unidade"": ""UN"", ""valor_desconto"": 0, ""valor_mercadoria"": 200, ""valor_total"": 200, ""valor_unitario"": 200}}], ""informacoes_adicionais"": {""codigo_categoria"": ""1.01.03"", ""codigo_conta_corrente"": 11850365, ""consumidor_final"": ""S"", ""enviar_email"": ""N""}, ""agropecuario"": {""cNumReceita"": """", ""cCpfResponsavel"": """", ""nTipoGuia"": 1, ""cUFGuia"": """", ""cSerieGuia"": """", ""nNumGuia"": 1}, ""lista_parcelas"": {""parcela"": [{""data_vencimento"": ""01/10/2026"", ""numero_parcela"": 1, ""percentual"": 50, ""valor"": 100}, {""data_vencimento"": ""12/12/2026"", ""numero_parcela"": 2, ""percentual"": 50, ""valor"": 100}]}, ""total_pedido"": {""base_calculo_icms"": 200, ""valor_mercadorias"": 200, ""valor_total_pedido"": 200}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta de Pedido de Venda de Produto
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
numero_pedido | texto · até 15 | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
Retorno 1O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
pedido_venda_produto | objeto | Cadastro de Pedido de Venda |
pedido_venda_produto.agropecuario | objeto | |
pedido_venda_produto.agropecuario.cCpfResponsavel | texto | CPF do responsá¡vel técnico legalmente habilitado |
pedido_venda_produto.agropecuario.cNumReceita | texto | Número da receita ou receituário do agrotóxico/defensivo agrícola |
pedido_venda_produto.agropecuario.cSerieGuia | texto | Número de série da guia |
pedido_venda_produto.agropecuario.cUFGuia | texto | UF de emissão da Guia |
pedido_venda_produto.agropecuario.nNumGuia | número inteiro | Número da guia |
pedido_venda_produto.agropecuario.nTipoGuia | número inteiro | Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG) |
pedido_venda_produto.cabecalho | objeto | Informações do cabeçalho do pedido. |
pedido_venda_produto.cabecalho.bloqueado | texto | Pedido Bloqueado pela API. |
pedido_venda_produto.cabecalho.codigo_cenario_impostos | número inteiro | Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão. |
pedido_venda_produto.cabecalho.codigo_cliente | número inteiro | Código do cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. |
pedido_venda_produto.cabecalho.codigo_cliente_integracao | texto | Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
pedido_venda_produto.cabecalho.codigo_empresa | número inteiro | DEPRECATED |
pedido_venda_produto.cabecalho.codigo_empresa_integracao | texto | DEPRECATED |
pedido_venda_produto.cabecalho.codigo_parcela | texto | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Consultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'. |
pedido_venda_produto.cabecalho.codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
pedido_venda_produto.cabecalho.codigo_pedido_integracao | texto | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
pedido_venda_produto.cabecalho.data_previsao | texto | Data de Previsão de Faturamento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. |
pedido_venda_produto.cabecalho.enc_data | texto | Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto.cabecalho.enc_hora | texto | Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto.cabecalho.enc_motivo | texto | Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto.cabecalho.enc_user | texto | Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto.cabecalho.encerrado | texto | Indica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto.cabecalho.etapa | texto | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
pedido_venda_produto.cabecalho.importado_api | texto | Pedido de venda de produto importada pela API. |
pedido_venda_produto.cabecalho.nao_gerar_boleto | texto | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.cabecalho.numero_pedido | texto | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
pedido_venda_produto.cabecalho.origem_pedido | texto | Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda. |
pedido_venda_produto.cabecalho.perc_desconto_pedido | decimal | Percentual do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
pedido_venda_produto.cabecalho.qtde_parcelas | número inteiro | Quantidade de parcelas. Valores permitidos de 1 a 999. |
pedido_venda_produto.cabecalho.quantidade_itens | número inteiro | Quantidade de Itens. |
pedido_venda_produto.cabecalho.sequencial | texto | Número sequencial do pedido de venda parcial. Esse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela. |
pedido_venda_produto.cabecalho.tipo_desconto_pedido | texto | Tipo de desconto para o pedido. Pode ser: V - Valor P - Percentual Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
pedido_venda_produto.cabecalho.valor_desconto_pedido | decimal | Valor do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. - Se o desconto for superior ao valor do pedido ele não será aplicado. |
pedido_venda_produto.departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto.departamentos[].cCodDepto | texto | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
pedido_venda_produto.departamentos[].nPerc | decimal | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto.departamentos[].nValor | decimal | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto.departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto.det | lista de objetos | Dados da Aba "Itens da Venda" do Pedido de Venda. |
pedido_venda_produto.det[].combustivel | objeto | Detalhamento específico de Combustível. |
pedido_venda_produto.det[].combustivel.cCODIF | texto | Registro do CODIF. |
pedido_venda_produto.det[].combustivel.cCodigoANP | texto | Código de Produto da ANP. |
pedido_venda_produto.det[].combustivel.cDescrANP | texto | Descrição do Produto conforme ANP. |
pedido_venda_produto.det[].combustivel.cUFConsumoComb | texto | UF de Consumo. |
pedido_venda_produto.det[].combustivel.nAliquota_CIDE | decimal | Valor da Alíquota em Reais da CIDE. |
pedido_venda_produto.det[].combustivel.nBC_CIDE | decimal | Base de Cálculo (em quantidade) da CIDE. |
pedido_venda_produto.det[].combustivel.nBC_UFDest | decimal | Base de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
pedido_venda_produto.det[].combustivel.nBC_UFRem | decimal | Base de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária. |
pedido_venda_produto.det[].combustivel.nPercGLP | decimal | Percentual de GLP Derivado do Petróleo. |
pedido_venda_produto.det[].combustivel.nPercGasImportado | decimal | Percentual de Gás Natural Importado. |
pedido_venda_produto.det[].combustivel.nPercGasNacional | decimal | Percentual de Gás Natural Nacional. |
pedido_venda_produto.det[].combustivel.nQtdeFatTempAmb | decimal | Quantidade Faturada à Temperatura Ambiente. |
pedido_venda_produto.det[].combustivel.nValorPartida | decimal | Valor de Partida. |
pedido_venda_produto.det[].combustivel.nValorUFDest | decimal | Valor da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
pedido_venda_produto.det[].combustivel.nValorUFRem | decimal | Valor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária. |
pedido_venda_produto.det[].combustivel.nValor_CIDE | decimal | Valor da CIDE. |
pedido_venda_produto.det[].ide | objeto | Identificação do Item do Pedido de Vendas. |
pedido_venda_produto.det[].ide.acao_item | texto | Ação para o item. Pode ser: "E" - para excluir um item. |
pedido_venda_produto.det[].ide.codigo_item | número inteiro | ID do Item do Pedido. |
pedido_venda_produto.det[].ide.codigo_item_integracao | texto | Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199. |
pedido_venda_produto.det[].ide.id_ordem_producao | número inteiro | Id da Ordem de Produção. Campo disponível apenas para consulta. Não deve ser informado na Inclusão ou Alteração. |
pedido_venda_produto.det[].ide.regra_impostos | número inteiro | DEPRECATED |
pedido_venda_produto.det[].ide.simples_nacional | texto | Indica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N". |
pedido_venda_produto.det[].imposto | objeto | Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados. |
pedido_venda_produto.det[].imposto.cbs | objeto | |
pedido_venda_produto.det[].imposto.cbs.aliquota_cbs | decimal | Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.cbs.perc_dif_cbs | decimal | Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.cbs.perc_red_cbs | decimal | Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.cbs.valor_cbs | decimal | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.cbs.valor_dif_cbs | decimal | Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.cofins_padrao | objeto | COFINS. |
pedido_venda_produto.det[].imposto.cofins_padrao.aliq_cofins | decimal | |
pedido_venda_produto.det[].imposto.cofins_padrao.base_cofins | decimal | |
pedido_venda_produto.det[].imposto.cofins_padrao.cod_sit_trib_cofins | texto | |
pedido_venda_produto.det[].imposto.cofins_padrao.qtde_unid_trib_cofins | decimal | |
pedido_venda_produto.det[].imposto.cofins_padrao.tipo_calculo_cofins | texto | |
pedido_venda_produto.det[].imposto.cofins_padrao.valor_cofins | decimal | |
pedido_venda_produto.det[].imposto.cofins_padrao.valor_unid_trib_cofins | decimal | |
pedido_venda_produto.det[].imposto.cofins_st | objeto | COFINS - Substituição Tributária. |
pedido_venda_produto.det[].imposto.cofins_st.aliq_cofins_st | decimal | |
pedido_venda_produto.det[].imposto.cofins_st.base_cofins_st | decimal | |
pedido_venda_produto.det[].imposto.cofins_st.cod_sit_trib_cofins_st | texto | |
pedido_venda_produto.det[].imposto.cofins_st.margem_cofins_st | decimal | |
pedido_venda_produto.det[].imposto.cofins_st.qtde_unid_trib_cofins_st | decimal | |
pedido_venda_produto.det[].imposto.cofins_st.tipo_calculo_cofins_st | texto | |
pedido_venda_produto.det[].imposto.cofins_st.valor_cofins_st | decimal | |
pedido_venda_produto.det[].imposto.cofins_st.valor_unid_trib_cofins_st | decimal | |
pedido_venda_produto.det[].imposto.csll | objeto | CSLL. |
pedido_venda_produto.det[].imposto.csll.aliq_csll | decimal | |
pedido_venda_produto.det[].imposto.csll.valor_csll | decimal | |
pedido_venda_produto.det[].imposto.ibs | objeto | |
pedido_venda_produto.det[].imposto.ibs.aliquota_ibs_mu | decimal | Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.aliquota_ibs_uf | decimal | Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.perc_dif_ibs_mu | decimal | Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.perc_dif_ibs_uf | decimal | Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.perc_red_ibs_mu | decimal | Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.perc_red_ibs_uf | decimal | Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal. |
pedido_venda_produto.det[].imposto.ibs.valor_dif_ibs_mu | decimal | Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.valor_dif_ibs_uf | decimal | Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.valor_ibs | decimal | Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.valor_ibs_mu | decimal | Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs.valor_ibs_uf | decimal | Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs_cbs | objeto | |
pedido_venda_produto.det[].imposto.ibs_cbs.base_ibs_cbs | decimal | Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs_cbs.class_trib | texto | Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.ibs_cbs.cst_ibs_cbs | texto | Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.icms | objeto | ICMS |
pedido_venda_produto.det[].imposto.icms.aliq_icms | decimal | |
pedido_venda_produto.det[].imposto.icms.base_fcp_icms | decimal | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS. |
pedido_venda_produto.det[].imposto.icms.base_icms | decimal | |
pedido_venda_produto.det[].imposto.icms.cod_sit_trib_icms | texto | |
pedido_venda_produto.det[].imposto.icms.modalidade_icms | texto | |
pedido_venda_produto.det[].imposto.icms.origem_icms | texto | |
pedido_venda_produto.det[].imposto.icms.perc_fcp_icms | decimal | Percentual do FCP - Fundo de Combate a Pobreza do ICMS. |
pedido_venda_produto.det[].imposto.icms.perc_red_base_icms | decimal | |
pedido_venda_produto.det[].imposto.icms.valor_fcp_icms | decimal | Valor do FCP - Fundo de Combate a Pobreza do ICMS. |
pedido_venda_produto.det[].imposto.icms.valor_icms | decimal | |
pedido_venda_produto.det[].imposto.icms_efet | objeto | ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem |
pedido_venda_produto.det[].imposto.icms_efet.aliq_icms_efet | decimal | |
pedido_venda_produto.det[].imposto.icms_efet.base_icms_efet | decimal | |
pedido_venda_produto.det[].imposto.icms_efet.cod_sit_trib_icms_efet | texto | |
pedido_venda_produto.det[].imposto.icms_efet.modalidade_icms_efet | texto | |
pedido_venda_produto.det[].imposto.icms_efet.origem_icms_efet | texto | |
pedido_venda_produto.det[].imposto.icms_efet.perc_red_base_icms_efet | decimal | |
pedido_venda_produto.det[].imposto.icms_efet.valor_icms_efet | decimal | |
pedido_venda_produto.det[].imposto.icms_ie | objeto | ICMS Interestadual. |
pedido_venda_produto.det[].imposto.icms_ie.aliq_icms_FCP | decimal | Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino |
pedido_venda_produto.det[].imposto.icms_ie.aliq_interestadual | decimal | Alíquota Interestadual das UFs Envolvidas |
pedido_venda_produto.det[].imposto.icms_ie.aliq_interna_uf_destino | decimal | Alíquota Interna da UF de Destino |
pedido_venda_produto.det[].imposto.icms_ie.aliq_partilha_icms | decimal | Percentual Provisório de Partilha do ICMS Interestadual |
pedido_venda_produto.det[].imposto.icms_ie.base_icms_uf_destino | decimal | BC do ICMS na UF de Destino |
pedido_venda_produto.det[].imposto.icms_ie.valor_fcp_icms_inter | decimal | Valor do fundo de combate a pobreza. |
pedido_venda_produto.det[].imposto.icms_ie.valor_icms_uf_dest | decimal | Valor do ICMS - UF Destino |
pedido_venda_produto.det[].imposto.icms_ie.valor_icms_uf_remet | decimal | Valor do ICMS - UF Remetente |
pedido_venda_produto.det[].imposto.icms_sn | objeto | ICMS - Simples Nacional. |
pedido_venda_produto.det[].imposto.icms_sn.aliq_icms_sn | decimal | |
pedido_venda_produto.det[].imposto.icms_sn.base_icms_sn | decimal | |
pedido_venda_produto.det[].imposto.icms_sn.cod_sit_trib_icms_sn | texto | |
pedido_venda_produto.det[].imposto.icms_sn.origem_icms_sn | texto | |
pedido_venda_produto.det[].imposto.icms_sn.valor_credito_icms_sn | decimal | |
pedido_venda_produto.det[].imposto.icms_sn.valor_icms_sn | decimal | |
pedido_venda_produto.det[].imposto.icms_st | objeto | ICMS - Substituição Tributária. |
pedido_venda_produto.det[].imposto.icms_st.aliq_icms_opprop | decimal | Alíquota de ICMS Operação Própria. |
pedido_venda_produto.det[].imposto.icms_st.aliq_icms_st | decimal | |
pedido_venda_produto.det[].imposto.icms_st.base_fcp_icms_st | decimal | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST. |
pedido_venda_produto.det[].imposto.icms_st.base_icms_st | decimal | |
pedido_venda_produto.det[].imposto.icms_st.cest | texto | CEST - Código Especificador da Substituíção Tributária. |
pedido_venda_produto.det[].imposto.icms_st.cod_sit_trib_icms_st | texto | |
pedido_venda_produto.det[].imposto.icms_st.margem_icms_st | decimal | |
pedido_venda_produto.det[].imposto.icms_st.modalidade_icms_st | texto | |
pedido_venda_produto.det[].imposto.icms_st.perc_fcp_icms_st | decimal | Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST. |
pedido_venda_produto.det[].imposto.icms_st.perc_red_base_icms_op | decimal | Percentual de redução de base de cálculo de Icms Operação Própria. |
pedido_venda_produto.det[].imposto.icms_st.perc_red_base_icms_st | decimal | |
pedido_venda_produto.det[].imposto.icms_st.valor_fcp_icms_st | decimal | Valor do FCP - Fundo de Combate a Pobreza do ICMS ST. |
pedido_venda_produto.det[].imposto.icms_st.valor_icms_st | decimal | |
pedido_venda_produto.det[].imposto.inss | objeto | INSS. |
pedido_venda_produto.det[].imposto.inss.aliq_inss | decimal | |
pedido_venda_produto.det[].imposto.inss.valor_inss | decimal | |
pedido_venda_produto.det[].imposto.ipi | objeto | IPI. |
pedido_venda_produto.det[].imposto.ipi.aliq_ipi | decimal | |
pedido_venda_produto.det[].imposto.ipi.base_ipi | decimal | |
pedido_venda_produto.det[].imposto.ipi.cod_sit_trib_ipi | texto | |
pedido_venda_produto.det[].imposto.ipi.enquadramento_ipi | texto | Enquadramento do IPI |
pedido_venda_produto.det[].imposto.ipi.qtde_unid_trib_ipi | decimal | |
pedido_venda_produto.det[].imposto.ipi.tipo_calculo_ipi | texto | |
pedido_venda_produto.det[].imposto.ipi.valor_ipi | decimal | |
pedido_venda_produto.det[].imposto.ipi.valor_unid_trib_ipi | decimal | |
pedido_venda_produto.det[].imposto.irrf | objeto | IRRF. |
pedido_venda_produto.det[].imposto.irrf.aliq_irrf | decimal | |
pedido_venda_produto.det[].imposto.irrf.valor_irrf | decimal | |
pedido_venda_produto.det[].imposto.iss | objeto | ISS. |
pedido_venda_produto.det[].imposto.iss.aliq_iss | decimal | |
pedido_venda_produto.det[].imposto.iss.base_iss | decimal | |
pedido_venda_produto.det[].imposto.iss.retem_iss | texto | |
pedido_venda_produto.det[].imposto.iss.valor_iss | decimal | |
pedido_venda_produto.det[].imposto.pis_padrao | objeto | PIS. |
pedido_venda_produto.det[].imposto.pis_padrao.aliq_pis | decimal | |
pedido_venda_produto.det[].imposto.pis_padrao.base_pis | decimal | |
pedido_venda_produto.det[].imposto.pis_padrao.cod_sit_trib_pis | texto | |
pedido_venda_produto.det[].imposto.pis_padrao.qtde_unid_trib_pis | decimal | |
pedido_venda_produto.det[].imposto.pis_padrao.tipo_calculo_pis | texto | |
pedido_venda_produto.det[].imposto.pis_padrao.valor_pis | decimal | |
pedido_venda_produto.det[].imposto.pis_padrao.valor_unid_trib_pis | decimal | |
pedido_venda_produto.det[].imposto.pis_st | objeto | PIS - Substituíção Tributária. |
pedido_venda_produto.det[].imposto.pis_st.aliq_pis_st | decimal | |
pedido_venda_produto.det[].imposto.pis_st.base_pis_st | decimal | |
pedido_venda_produto.det[].imposto.pis_st.cod_sit_trib_pis_st | texto | |
pedido_venda_produto.det[].imposto.pis_st.margem_pis_st | decimal | |
pedido_venda_produto.det[].imposto.pis_st.qtde_unid_trib_pis_st | decimal | |
pedido_venda_produto.det[].imposto.pis_st.tipo_calculo_pis_st | texto | |
pedido_venda_produto.det[].imposto.pis_st.valor_pis_st | decimal | |
pedido_venda_produto.det[].imposto.pis_st.valor_unid_trib_pis_st | decimal | |
pedido_venda_produto.det[].imposto.trib_reg | objeto | |
pedido_venda_produto.det[].imposto.trib_reg.aliquota_reg_cbs | decimal | Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.aliquota_reg_ibs_mu | decimal | Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.aliquota_reg_ibs_uf | decimal | Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.class_trib_reg | texto | Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.cst_reg_ibs_cst | texto | Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.valor_reg_cbs | decimal | Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.valor_reg_ibs_mu | decimal | Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].imposto.trib_reg.valor_reg_ibs_uf | decimal | Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto.det[].inf_adic | objeto | Dados da aba "Informações Adicionais" do Item do Pedido de Vendas. |
pedido_venda_produto.det[].inf_adic.codigo_beneficio_fiscal | texto | Código do Benefício Fiscal. |
pedido_venda_produto.det[].inf_adic.codigo_categoria_item | texto | Código da Categoria do item. |
pedido_venda_produto.det[].inf_adic.codigo_cenario_impostos_item | número inteiro | Código do Cenário de Impostos. |
pedido_venda_produto.det[].inf_adic.codigo_local_estoque | número inteiro | Código do Local do Estoque. |
pedido_venda_produto.det[].inf_adic.dados_adicionais_item | texto | Informações para a Nota Fiscal. |
pedido_venda_produto.det[].inf_adic.item_pedido_compra | número inteiro | Item do Pedido de Compra. |
pedido_venda_produto.det[].inf_adic.nao_gerar_financeiro | texto | Não gerar conta a receber para este item. Informar "S" ou "N". (Informe "S" para ativar essa opção). |
pedido_venda_produto.det[].inf_adic.nao_movimentar_estoque | texto | Não gerar a saída de estoque deste item ao emitir NF-e. Informar "S" ou "N". (informe "S" para ativar essa opção). |
pedido_venda_produto.det[].inf_adic.nao_somar_total | texto | Não somar este item no total da NF-e |
pedido_venda_produto.det[].inf_adic.numero_fci | texto | Número da FCI (Ficha de Conteúdo de Importação) |
pedido_venda_produto.det[].inf_adic.numero_pedido_compra | texto | Número do Pedido de Compra. |
pedido_venda_produto.det[].inf_adic.numero_recopi | texto | Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune). |
pedido_venda_produto.det[].inf_adic.peso_bruto | decimal | Peso Bruto (Kg). |
pedido_venda_produto.det[].inf_adic.peso_liquido | decimal | Peso Líquido (Kg). |
pedido_venda_produto.det[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
pedido_venda_produto.det[].lote_validade[].nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
pedido_venda_produto.det[].lote_validade[].nQtdLote | decimal | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
pedido_venda_produto.det[].observacao | objeto | Dados da aba "Observações" do Item do Pedido de Vendas. |
pedido_venda_produto.det[].observacao.obs_item | texto | Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal). Informação localizada na Aba "Observações" do Item do Pedido de Venda. |
pedido_venda_produto.det[].produto | objeto | Identificação do Produto do Item do Pedido de Vendas. |
pedido_venda_produto.det[].produto.cfop | texto | CFOP - Código Fiscal de Operações e Prestações. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
pedido_venda_produto.det[].produto.cnpj_fabricante | texto | CNPJ do Fabricante da Mercadoria. |
pedido_venda_produto.det[].produto.codigo | texto | Código do Produto exibido na tela do Pedido de Vendas. |
pedido_venda_produto.det[].produto.codigo_item_kit | número inteiro | ID do Item do kit (pai) que o componente pertence |
pedido_venda_produto.det[].produto.codigo_produto | número inteiro | ID do Produto. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag "codigo_produto" do método "ListarProdutos" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação. |
pedido_venda_produto.det[].produto.codigo_produto_integracao | texto | Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "codigo_produto". |
pedido_venda_produto.det[].produto.codigo_tabela_preco | número inteiro | Código da tabela de preço. (Interno, utilizado apenas na integração via API, não é exibido na tela). Deve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie. |
pedido_venda_produto.det[].produto.componente_kit | texto | Indica se o produto é um componente de um kit |
pedido_venda_produto.det[].produto.descricao | texto | Descrição do Produto. |
pedido_venda_produto.det[].produto.ean | texto | EAN - European Article Number |
pedido_venda_produto.det[].produto.indicador_escala | texto | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
pedido_venda_produto.det[].produto.kit | texto | Indica se o produto é um kit |
pedido_venda_produto.det[].produto.motivo_icms_desonerado | texto | Código do Motivo de desoneração do ICMS Códigos válidos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco |
pedido_venda_produto.det[].produto.ncm | texto | NCM - Nomenclatura Comum do Mercosul Utilize a tag "cCodigo" do método "ListarNCM" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação. |
pedido_venda_produto.det[].produto.percentual_desconto | decimal | Percentual de Desconto. |
pedido_venda_produto.det[].produto.quantidade | decimal | Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto. |
pedido_venda_produto.det[].produto.reservado | texto | (S/N) Indica se o estoque do produto será reservado. |
pedido_venda_produto.det[].produto.tipo_desconto | texto | Tipo de Desconto. |
pedido_venda_produto.det[].produto.unidade | texto | Unidade. Utilize a tag "codigo" do método "ListarUnidades" da API http://app.omie.com.br/api/v1/geral/unidade/ para obter essa informação. |
pedido_venda_produto.det[].produto.valor_deducao | decimal | Valor da Dedução |
pedido_venda_produto.det[].produto.valor_desconto | decimal | Valor do Desconto |
pedido_venda_produto.det[].produto.valor_icms_desonerado | decimal | Valor do ICMS desonerado |
pedido_venda_produto.det[].produto.valor_mercadoria | decimal | Valor da Mercadoria |
pedido_venda_produto.det[].produto.valor_total | decimal | Valor Total. |
pedido_venda_produto.det[].produto.valor_unitario | decimal | Valor Únitário |
pedido_venda_produto.det[].rastreabilidade | objeto | Dados da rastreabilidade do produto. |
pedido_venda_produto.det[].rastreabilidade.codigoAgregacaoLote | texto | Código de Agregação |
pedido_venda_produto.det[].rastreabilidade.dataFabricacaoLote | texto | Data de Fabricação/Produção |
pedido_venda_produto.det[].rastreabilidade.dataValidadeLote | texto | Data de Validade |
pedido_venda_produto.det[].rastreabilidade.numeroLote | texto | Número do Lote |
pedido_venda_produto.det[].rastreabilidade.qtdeProdutoLote | decimal | Quantidade de Produto |
pedido_venda_produto.det[].tributavel | objeto | Unidade, Quantidade, Valor e EAN tributáveis do item do pedido. |
pedido_venda_produto.det[].tributavel.cEanTrib | texto | código EAN tributável do item. |
pedido_venda_produto.det[].tributavel.cUnidTrib | texto | Unidade tributável do Item. |
pedido_venda_produto.det[].tributavel.nQuantTrib | decimal | Quantidade tributável do item. |
pedido_venda_produto.det[].tributavel.nValorTrib | decimal | Valor tributável do item. |
pedido_venda_produto.exportacao | objeto | Dados da exportacao |
pedido_venda_produto.exportacao.local_despacho | texto | Local de Despacho |
pedido_venda_produto.exportacao.local_embarque | texto | Local de Embarque (ou de transposição de fronteira) |
pedido_venda_produto.exportacao.nao_exportacao | texto | O cliente é estrangeiro, mas na verdade não se trata de uma exportação |
pedido_venda_produto.exportacao.uf_embarque | texto | UF do Local de Embarque |
pedido_venda_produto.frete | objeto | Dados da Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.codigo_rastreio | texto | Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.codigo_tipo_entrega | número inteiro | Código do tipo de entrega. |
pedido_venda_produto.frete.codigo_transportadora | número inteiro | ID da transportadora. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras. |
pedido_venda_produto.frete.codigo_transportadora_integracao | texto | Código Integração da Transportadora. Esse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
pedido_venda_produto.frete.especie_volumes | texto | Espécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.icms_retido | objeto | Dados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.icms_retido.cCfopTr | texto | CFOP. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
pedido_venda_produto.frete.icms_retido.cCidadeTr | texto | Cidade de Ocorrência do Fato Gerador do ICMS. Utilize o formato: CIDADE (UF), como no exemplos: "SAO PAULO (SP)" "RIO DE JANEIRO (RJ)" "FLORIANOPOLIS (SC)" Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
pedido_venda_produto.frete.icms_retido.vAliquotaRetencaoTr | decimal | Percentual de Alíquota de Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.icms_retido.vBCRetencaoTr | decimal | Base de Cálculo da Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.icms_retido.vIcmsRetidoTr | decimal | Valor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.icms_retido.vServicoTr | decimal | Valor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.link_rastreio | texto | Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'. |
pedido_venda_produto.frete.marca_volumes | texto | Marca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.modalidade | texto | Tipo de Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Valores disponíveis: "0" - Contratação do Frete por conta do Remetente (CIF) "1" - Contratação do Frete por conta do Destinatário (FOB) "2" - Contratação do Frete por conta de Terceiros "3" - Transporte Próprio por conta do Remetente "4" - Transporte Próprio por conta do Destinatário "9" - Sem frete. |
pedido_venda_produto.frete.numeracao_volumes | texto | Numeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.numero_lacre | texto | Número do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.outras_despesas | decimal | Outras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.peso_bruto | decimal | Peso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.peso_liquido | decimal | Peso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.placa | texto | Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.placa_estado | texto | Estado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.previsao_entrega | texto | Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.quantidade_volumes | número inteiro | Quantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.registro_transportador | texto | RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.valor_frete | decimal | Valor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.valor_seguro | decimal | Valor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.frete.veiculo_proprio | texto | O transporte será realizado com veículo próprio. Informar "S" ou "N". Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto.infoCadastro | objeto | Informações complementares do pedido. |
pedido_venda_produto.infoCadastro.autorizado | texto | Indica se o pedido foi autorizado. |
pedido_venda_produto.infoCadastro.cImpAPI | texto | Importado pela API. |
pedido_venda_produto.infoCadastro.cancelado | texto | Indica se o pedido foi cancelado. |
pedido_venda_produto.infoCadastro.dAlt | texto | Data da Alteração. |
pedido_venda_produto.infoCadastro.dCan | texto | Data da Cancelamento. |
pedido_venda_produto.infoCadastro.dFat | texto | Data de Faturamento. |
pedido_venda_produto.infoCadastro.dInc | texto | Data da Inclusão. |
pedido_venda_produto.infoCadastro.denegado | texto | Indica se o pedido foi denegado. |
pedido_venda_produto.infoCadastro.devolvido | texto | Indica se o pedido foi devolvido. |
pedido_venda_produto.infoCadastro.devolvido_parcial | texto | Indica se o pedido foi devolvido parcialmente. |
pedido_venda_produto.infoCadastro.faturado | texto | Indica se o pedido está faturado. |
pedido_venda_produto.infoCadastro.hAlt | texto | Hora da Alteração. |
pedido_venda_produto.infoCadastro.hCan | texto | Hora da Cancelamento. |
pedido_venda_produto.infoCadastro.hFat | texto | Hora de faturamento. |
pedido_venda_produto.infoCadastro.hInc | texto | Hora da Inclusão. |
pedido_venda_produto.infoCadastro.uAlt | texto | Usuário da Alteração. |
pedido_venda_produto.infoCadastro.uCan | texto | Usuário da Cancelamento. |
pedido_venda_produto.infoCadastro.uFat | texto | Usuário que realizou o faturamento. |
pedido_venda_produto.infoCadastro.uInc | texto | Usuário da Inclusão. |
pedido_venda_produto.informacoes_adicionais | objeto | Dados da Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.codProj | número inteiro | Código do Projeto. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação. |
pedido_venda_produto.informacoes_adicionais.codVend | número inteiro | Código do Vendedor. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação. |
pedido_venda_produto.informacoes_adicionais.codigo_categoria | texto | Código da categoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. |
pedido_venda_produto.informacoes_adicionais.codigo_conta_corrente | número inteiro | Código da Conta Corrente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
pedido_venda_produto.informacoes_adicionais.consumidor_final | texto | Nota Fiscal para Consumo Final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.contato | texto | Contato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.dados_adicionais_nf | texto | Dados adicionais para a Nota Fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto.informacoes_adicionais.enviar_email | texto | Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
pedido_venda_produto.informacoes_adicionais.enviar_pix | texto | Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
pedido_venda_produto.informacoes_adicionais.impostos_embutidos | texto | DEPRECATED |
pedido_venda_produto.informacoes_adicionais.meio_pagamento | texto | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
pedido_venda_produto.informacoes_adicionais.nfRelacionada | objeto | Detalhes da NF referenciada. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.InscrEstPR | texto | Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cChaveRef | texto | Chave da NF-e (ou NFC-e ou SAT) Relacionada. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cSeriePR | texto | Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cSerieRef | texto | Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cSigNFRef | texto | Manter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N" |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cUfPR | texto | Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cUfRef | texto | Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cnpjEmitRef | texto | CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cnpjIntermediario | texto | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cnpjPR | texto | CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.dtEmissaoPR | texto | Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.dtEmissaoRef | texto | Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.identIntermediario | texto | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.indIntermediario | texto | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.indPresenca | texto | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nCOORef | texto | Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nECFRef | texto | Número de Ordem Sequencial do ECF. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nNFRef | texto | Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nNfPR | texto | Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscal | lista de objetos | Outros cupons fiscais relacionados |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrCOO | texto | Contador de Ordem de Operação (COO) |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECF | texto | Número do ECF |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A | lista de objetos | Outras notas modelo 1/1A relacionadas |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrCnpjCpf | texto | CNPJ/CPF do emitente da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissao | texto | Data de emissão da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumero | texto | Número da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerie | texto | Série da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUF | texto | Unidade federativa do emitente da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrNF | lista de objetos | Outras NF-e, NFC-e ou SAT relacionadas |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrNF[].nrChave | texto | Chave da NF-e, NFC-e ou SAT relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural | lista de objetos | Outras notas de produtor rural relacionadas |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrCnpjCpf | texto | CNPJ/CPF do emitente da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissao | texto | Data de emissão da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIE | texto | Inscrição Estadual do emitente da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumero | texto | Número da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerie | texto | Série da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUF | texto | Unidade federativa do emitente da NF relacionada |
pedido_venda_produto.informacoes_adicionais.nsu | texto | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto.informacoes_adicionais.numero_contrato | texto | Número do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.numero_pedido_cliente | texto | Número do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes | objeto | Outros detalhes da NF-e. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cBairroOd | texto | Bairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cBairroOdRet | texto | Bairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCEPOd | texto | CEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCEPOdRet | texto | CEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCidadeOd | texto | Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCidadeOdRet | texto | Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCnpjCpfOd | texto | CNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCnpjCpfOdRet | texto | CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCnpjIntOd | texto | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cComplementoOd | texto | Complemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cComplementoOdRet | texto | Complemento do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEnderecoOd | texto | Endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEnderecoOdRet | texto | Endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEstadoOd | texto | Estado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEstadoOdRet | texto | Estado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cHoraSaidaOd | texto | Hora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cIdentificadorIntOd | texto | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cIndicadorIntOd | texto | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cIndicadorOd | texto | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cInscrEstadualOd | texto | Inscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cInscrEstadualOdRet | texto | Inscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNatOperacaoOd | texto | Natureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNomeOd | texto | Nome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNomeOdRet | texto | Nome / Razão Social (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNumeroOd | texto | Número do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNumeroOdRet | texto | Número do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cSepararEnderecoOd | texto | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cSepararEnderecoOdRet | texto | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cTelefoneOd | texto | Telefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cTelefoneOdRet | texto | Telefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.outros_detalhes.dDataSaidaOd | texto | Data de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto.informacoes_adicionais.tipo_documento | texto | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
pedido_venda_produto.informacoes_adicionais.utilizar_emails | texto | Utilizar os seguintes endereços de e-mail. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. |
pedido_venda_produto.lancamentos | lista de objetos | Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros). |
pedido_venda_produto.lancamentos[].cCategoria | texto | Código da Categoria. |
pedido_venda_produto.lancamentos[].cNaturezaDocumento | texto | Natureza do Documento. Pode ser: P - Pagar R - Receber Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto.lancamentos[].cObs | texto | Observações. |
pedido_venda_produto.lancamentos[].cOrigem | texto | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto.lancamentos[].cTipoDocumento | texto | Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto.lancamentos[].dDataDocumento | texto | Data do documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto.lancamentos[].nContaCorrente | número inteiro | Id da Conta Corrente. |
pedido_venda_produto.lancamentos[].nProjeto | número inteiro | Id do projeto. |
pedido_venda_produto.lancamentos[].nSequencia | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
pedido_venda_produto.lancamentos[].nValorDocumento | decimal | Valor do Documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto.lancamentos[].nVendedor | número inteiro | Id do Vendedor. |
pedido_venda_produto.lista_parcelas | objeto | Dados da Aba "Parcelas" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura. |
pedido_venda_produto.lista_parcelas.parcela | lista de objetos | Dados da parcela. |
pedido_venda_produto.lista_parcelas.parcela[].bandeira | texto | Código da Bandeira da operadora de cartão. |
pedido_venda_produto.lista_parcelas.parcela[].categoria_adiantamento | texto | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].cnpj_fin | texto | Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. |
pedido_venda_produto.lista_parcelas.parcela[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].data_vencimento | texto | Data de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto.lista_parcelas.parcela[].meio_pagamento | texto | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
pedido_venda_produto.lista_parcelas.parcela[].nao_gerar_boleto | texto | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].nsu | texto | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto.lista_parcelas.parcela[].numero_parcela | número inteiro | Número da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].parcela_adiantamento | texto | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].percentual | decimal | Percentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].quantidade_dias | número inteiro | Quantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.lista_parcelas.parcela[].tipo_documento | texto | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
pedido_venda_produto.lista_parcelas.parcela[].valor | decimal | Valor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto.market_place | objeto | Dados para o Market Place. |
pedido_venda_produto.market_place.nEnvio | decimal | Valor do envio do Market Place. |
pedido_venda_produto.market_place.nTaxa | decimal | Valor da taxa do Market Place. |
pedido_venda_produto.observacoes | objeto | Dados da Aba "Observações" do Pedido de Venda. |
pedido_venda_produto.observacoes.obs_venda | texto | Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda. |
pedido_venda_produto.total_pedido | objeto | Valores totais do pedido. |
pedido_venda_produto.total_pedido.base_calculo_icms | decimal | Base de Cálculo do ICMS. |
pedido_venda_produto.total_pedido.base_calculo_st | decimal | Base de cálculo da substituição tributária. |
pedido_venda_produto.total_pedido.base_ibs_cbs | decimal | Valor total da base de cálculo do IBS e da CBS. |
pedido_venda_produto.total_pedido.valor_IPI | decimal | Valor do IPI. |
pedido_venda_produto.total_pedido.valor_cbs | decimal | Valor total da CBS. |
pedido_venda_produto.total_pedido.valor_cofins | decimal | Valor do cofins. |
pedido_venda_produto.total_pedido.valor_csll | decimal | Valor da CSLL. |
pedido_venda_produto.total_pedido.valor_deducoes | decimal | Valor das deduções. |
pedido_venda_produto.total_pedido.valor_descontos | decimal | Valor dos descontos. |
pedido_venda_produto.total_pedido.valor_dif_cbs | decimal | Valor total do diferimento da CBS. |
pedido_venda_produto.total_pedido.valor_dif_ibs_mu | decimal | Valor total do diferimento do IBS do município. |
pedido_venda_produto.total_pedido.valor_dif_ibs_uf | decimal | Valor total do diferimento do IBS UF. |
pedido_venda_produto.total_pedido.valor_ibs | decimal | Valor total do IBS. |
pedido_venda_produto.total_pedido.valor_ibs_mu | decimal | Valor total do IBS do município. |
pedido_venda_produto.total_pedido.valor_ibs_uf | decimal | Valor total do IBS da UF. |
pedido_venda_produto.total_pedido.valor_icms | decimal | Valor total do ICMS. |
pedido_venda_produto.total_pedido.valor_inss | decimal | Valor do INSS. |
pedido_venda_produto.total_pedido.valor_ir | decimal | Valor do IR. .Preenchimento automático - Não informar. |
pedido_venda_produto.total_pedido.valor_iss | decimal | Valor do ISS. |
pedido_venda_produto.total_pedido.valor_mercadorias | decimal | valor das mercadorias. |
pedido_venda_produto.total_pedido.valor_pis | decimal | Valor do PIS. |
pedido_venda_produto.total_pedido.valor_st | decimal | Valor total da ST. |
pedido_venda_produto.total_pedido.valor_tot_ibs_cbs_is | decimal | Total da NF-e com IBS/CBS/IS. |
pedido_venda_produto.total_pedido.valor_total_pedido | decimal | Valor total do pedido. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarPedido", "param": [{"codigo_pedido": 25953530}]}'import os
import requests
corpo = {'call': 'ConsultarPedido', 'param': [{'codigo_pedido': 25953530}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarPedido",
"param": [
{
"codigo_pedido": 25953530
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "ConsultarPedido",
"param": [
{
"codigo_pedido": 25953530
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "ConsultarPedido",
"param": [
{
"codigo_pedido": 25953530
}
]
}
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": "ConsultarPedido",
"param": [
{
"codigo_pedido": 25953530
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarPedido"", ""param"": [{""codigo_pedido"": 25953530}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosMétodo para efetuar a devolução de um pedido.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
itens | objeto | Informações dos itens que serão devolvidos. Caso essa tag não seja preenchida será realizado a devolução integral de todos os itens do pedido. |
itens.codigo_produtoobrigatório | número inteiro | Id do produto. |
itens.quantidade | número | Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto. |
nIdMotivDevol | número inteiro | ID do motivo da devolução. Opcional no registro da devolução, porém exigido no faturamento. Se não for informado aqui, o motivo terá que ser preenchido na tela antes de chamar o FaturarDevolucao. A lista de motivos disponíveis está em: /api/v1/geral/motivodevolucao/ |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
cNumeroDevolucao | texto | Número do documento da devolução gerada, como aparece na tela. |
nIdDevolucao | número inteiro | ID da devolução. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "DevolverPedido", "param": [{"codigo_pedido": 0, "codigo_pedido_integracao": "", "itens": [{"codigo_produto": 0, "quantidade": 0}]}]}'import os
import requests
corpo = {'call': 'DevolverPedido',
'param': [{'codigo_pedido': 0,
'codigo_pedido_integracao': '',
'itens': [{'codigo_produto': 0, 'quantidade': 0}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "DevolverPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"itens": [
{
"codigo_produto": 0,
"quantidade": 0
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "DevolverPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"itens": [
{
"codigo_produto": 0,
"quantidade": 0
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "DevolverPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"itens": [
{
"codigo_produto": 0,
"quantidade": 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": "DevolverPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"itens": [
{
"codigo_produto": 0,
"quantidade": 0
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""DevolverPedido"", ""param"": [{""codigo_pedido"": 0, ""codigo_pedido_integracao"": """", ""itens"": [{""codigo_produto"": 0, ""quantidade"": 0}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExcluir pedido de venda de produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Codigo do Pedido Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
codigo_status | texto | Código do Status do Pedido de Venda. |
descricao_status | texto | Descrição do status. |
numero_pedido | texto | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirPedido", "param": [{"codigo_pedido": 0, "codigo_pedido_integracao": ""}]}'import os
import requests
corpo = {'call': 'ExcluirPedido',
'param': [{'codigo_pedido': 0, 'codigo_pedido_integracao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "ExcluirPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "ExcluirPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}
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": "ExcluirPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirPedido"", ""param"": [{""codigo_pedido"": 0, ""codigo_pedido_integracao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclui um pedido de venda de produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 13Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
agropecuario | objeto | |
agropecuario.cCpfResponsavel | texto · até 14 | CPF do responsá¡vel técnico legalmente habilitado |
agropecuario.cNumReceita | texto · até 20 | Número da receita ou receituário do agrotóxico/defensivo agrícola |
agropecuario.cSerieGuia | texto · até 9 | Número de série da guia |
agropecuario.cUFGuia | texto · até 2 | UF de emissão da Guia |
agropecuario.nNumGuia | número inteiro | Número da guia |
agropecuario.nTipoGuia | número inteiro | Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG) |
cabecalho | objeto | Informações do cabeçalho do pedido. |
cabecalho.bloqueado | texto · até 1 | Pedido Bloqueado pela API. |
cabecalho.codigo_cenario_impostos | número inteiro | Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão. |
cabecalho.codigo_cliente | número inteiro | Código do cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. |
cabecalho.codigo_cliente_integracao | texto · até 60 | Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
cabecalho.codigo_empresadescontinuado | número inteiro | DEPRECATED |
cabecalho.codigo_empresa_integracaodescontinuado | texto · até 20 | DEPRECATED |
cabecalho.codigo_parcela | texto · até 3 | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Consultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'. |
cabecalho.codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
cabecalho.codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
cabecalho.data_previsao | texto · até 10 | Data de Previsão de Faturamento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. |
cabecalho.enc_data | texto · até 10 | Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.enc_hora | texto · até 8 | Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.enc_motivo | texto · até 100 | Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.enc_user | texto · até 10 | Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
cabecalho.encerrado | texto · até 1 | Indica que o pedido foi encerrado (S/N).
Tag utilizada apenas nos métodos de listagem e consulta.Ex.: S, N |
cabecalho.etapa | texto · até 2 | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
cabecalho.importado_api | texto · até 1 | Pedido de venda de produto importada pela API. |
cabecalho.nao_gerar_boleto | texto · até 1 | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
cabecalho.numero_pedido | texto · até 15 | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
cabecalho.origem_pedido | texto · até 3 | Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda. |
cabecalho.perc_desconto_pedido | número | Percentual do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
cabecalho.qtde_parcelas | número inteiro | Quantidade de parcelas. Valores permitidos de 1 a 999. |
cabecalho.quantidade_itens | número inteiro | Quantidade de Itens. |
cabecalho.sequencial | texto · até 4 | Número sequencial do pedido de venda parcial. Esse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela. |
cabecalho.tipo_desconto_pedido | texto · até 1 | Tipo de desconto para o pedido. Pode ser: V - Valor P - Percentual Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
cabecalho.valor_desconto_pedido | número | Valor do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. - Se o desconto for superior ao valor do pedido ele não será aplicado. |
departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
departamentos[].cCodDepto | texto · até 40 | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
departamentos[].nPerc | número | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
departamentos[].nValor | número | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
departamentos[].nValorFixo | texto · até 1 | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
det | lista de objetos | Dados da Aba "Itens da Venda" do Pedido de Venda. |
det[].combustivel | objeto | Detalhamento específico de Combustível. |
det[].combustivel.cCODIF | texto · até 21 | Registro do CODIF. |
det[].combustivel.cCodigoANP | texto · até 9 | Código de Produto da ANP. |
det[].combustivel.cDescrANP | texto · até 95 | Descrição do Produto conforme ANP. |
det[].combustivel.cUFConsumoComb | texto · até 2 | UF de Consumo. |
det[].combustivel.nAliquota_CIDE | número | Valor da Alíquota em Reais da CIDE. |
det[].combustivel.nBC_CIDE | número | Base de Cálculo (em quantidade) da CIDE. |
det[].combustivel.nBC_UFDest | número | Base de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
det[].combustivel.nBC_UFRem | número | Base de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária. |
det[].combustivel.nPercGLP | número | Percentual de GLP Derivado do Petróleo. |
det[].combustivel.nPercGasImportado | número | Percentual de Gás Natural Importado. |
det[].combustivel.nPercGasNacional | número | Percentual de Gás Natural Nacional. |
det[].combustivel.nQtdeFatTempAmb | número | Quantidade Faturada à Temperatura Ambiente. |
det[].combustivel.nValorPartida | número | Valor de Partida. |
det[].combustivel.nValorUFDest | número | Valor da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
det[].combustivel.nValorUFRem | número | Valor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária. |
det[].combustivel.nValor_CIDE | número | Valor da CIDE. |
det[].ide | objeto | Identificação do Item do Pedido de Vendas. |
det[].ide.acao_item | texto · até 1 | Ação para o item. Pode ser: "E" - para excluir um item. |
det[].ide.codigo_item | número inteiro | ID do Item do Pedido. |
det[].ide.codigo_item_integracao | texto · até 30 | Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199. |
det[].ide.id_ordem_producao | número inteiro | Id da Ordem de Produção. Campo disponível apenas para consulta. Não deve ser informado na Inclusão ou Alteração. |
det[].ide.regra_impostosdescontinuado | número inteiro | DEPRECATED |
det[].ide.simples_nacional | texto · até 1 | Indica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N". |
det[].imposto | objeto | Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados. |
det[].imposto.cbs | objeto | |
det[].imposto.cbs.aliquota_cbs | número | Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.perc_dif_cbs | número | Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.perc_red_cbs | número | Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.valor_cbs | número | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cbs.valor_dif_cbs | número | Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.cofins_padrao | objeto | COFINS. |
det[].imposto.cofins_padrao.aliq_cofins | número | |
det[].imposto.cofins_padrao.base_cofins | número | |
det[].imposto.cofins_padrao.cod_sit_trib_cofins | texto · até 2 | |
det[].imposto.cofins_padrao.qtde_unid_trib_cofins | número | |
det[].imposto.cofins_padrao.tipo_calculo_cofins | texto · até 1 | |
det[].imposto.cofins_padrao.valor_cofins | número | |
det[].imposto.cofins_padrao.valor_unid_trib_cofins | número | |
det[].imposto.cofins_st | objeto | COFINS - Substituição Tributária. |
det[].imposto.cofins_st.aliq_cofins_st | número | |
det[].imposto.cofins_st.base_cofins_st | número | |
det[].imposto.cofins_st.cod_sit_trib_cofins_st | texto · até 2 | |
det[].imposto.cofins_st.margem_cofins_st | número | |
det[].imposto.cofins_st.qtde_unid_trib_cofins_st | número | |
det[].imposto.cofins_st.tipo_calculo_cofins_st | texto · até 1 | |
det[].imposto.cofins_st.valor_cofins_st | número | |
det[].imposto.cofins_st.valor_unid_trib_cofins_st | número | |
det[].imposto.csll | objeto | CSLL. |
det[].imposto.csll.aliq_csll | número | |
det[].imposto.csll.valor_csll | número | |
det[].imposto.ibs | objeto | |
det[].imposto.ibs.aliquota_ibs_mu | número | Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.aliquota_ibs_uf | número | Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_dif_ibs_mu | número | Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_dif_ibs_uf | número | Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_red_ibs_mu | número | Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.perc_red_ibs_uf | número | Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal. |
det[].imposto.ibs.valor_dif_ibs_mu | número | Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_dif_ibs_uf | número | Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_ibs | número | Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_ibs_mu | número | Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs.valor_ibs_uf | número | Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs_cbs | objeto | |
det[].imposto.ibs_cbs.base_ibs_cbs | número | Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs_cbs.class_trib | texto · até 6 | Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.ibs_cbs.cst_ibs_cbs | texto · até 3 | Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.icms | objeto | ICMS |
det[].imposto.icms.aliq_icms | número | |
det[].imposto.icms.base_fcp_icms | número | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS. |
det[].imposto.icms.base_icms | número | |
det[].imposto.icms.cod_sit_trib_icms | texto · até 2 | |
det[].imposto.icms.modalidade_icms | texto · até 1 | |
det[].imposto.icms.origem_icms | texto · até 1 | |
det[].imposto.icms.perc_fcp_icms | número | Percentual do FCP - Fundo de Combate a Pobreza do ICMS. |
det[].imposto.icms.perc_red_base_icms | número | |
det[].imposto.icms.valor_fcp_icms | número | Valor do FCP - Fundo de Combate a Pobreza do ICMS. |
det[].imposto.icms.valor_icms | número | |
det[].imposto.icms_efet | objeto | ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem |
det[].imposto.icms_efet.aliq_icms_efet | número | |
det[].imposto.icms_efet.base_icms_efet | número | |
det[].imposto.icms_efet.cod_sit_trib_icms_efet | texto · até 2 | |
det[].imposto.icms_efet.modalidade_icms_efet | texto · até 1 | |
det[].imposto.icms_efet.origem_icms_efet | texto · até 1 | |
det[].imposto.icms_efet.perc_red_base_icms_efet | número | |
det[].imposto.icms_efet.valor_icms_efet | número | |
det[].imposto.icms_ie | objeto | ICMS Interestadual. |
det[].imposto.icms_ie.aliq_icms_FCP | número | Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino |
det[].imposto.icms_ie.aliq_interestadual | número | Alíquota Interestadual das UFs Envolvidas |
det[].imposto.icms_ie.aliq_interna_uf_destino | número | Alíquota Interna da UF de Destino |
det[].imposto.icms_ie.aliq_partilha_icms | número | Percentual Provisório de Partilha do ICMS Interestadual |
det[].imposto.icms_ie.base_icms_uf_destino | número | BC do ICMS na UF de Destino |
det[].imposto.icms_ie.valor_fcp_icms_inter | número | Valor do fundo de combate a pobreza. |
det[].imposto.icms_ie.valor_icms_uf_dest | número | Valor do ICMS - UF Destino |
det[].imposto.icms_ie.valor_icms_uf_remet | número | Valor do ICMS - UF Remetente |
det[].imposto.icms_sn | objeto | ICMS - Simples Nacional. |
det[].imposto.icms_sn.aliq_icms_sn | número | |
det[].imposto.icms_sn.base_icms_sn | número | |
det[].imposto.icms_sn.cod_sit_trib_icms_sn | texto · até 3 | |
det[].imposto.icms_sn.origem_icms_sn | texto · até 1 | |
det[].imposto.icms_sn.valor_credito_icms_sn | número | |
det[].imposto.icms_sn.valor_icms_sn | número | |
det[].imposto.icms_st | objeto | ICMS - Substituição Tributária. |
det[].imposto.icms_st.aliq_icms_opprop | número | Alíquota de ICMS Operação Própria. |
det[].imposto.icms_st.aliq_icms_st | número | |
det[].imposto.icms_st.base_fcp_icms_st | número | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det[].imposto.icms_st.base_icms_st | número | |
det[].imposto.icms_st.cest | texto · até 9 | CEST - Código Especificador da Substituíção Tributária. |
det[].imposto.icms_st.cod_sit_trib_icms_st | texto · até 2 | |
det[].imposto.icms_st.margem_icms_st | número | |
det[].imposto.icms_st.modalidade_icms_st | texto · até 1 | |
det[].imposto.icms_st.perc_fcp_icms_st | número | Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det[].imposto.icms_st.perc_red_base_icms_op | número | Percentual de redução de base de cálculo de Icms Operação Própria. |
det[].imposto.icms_st.perc_red_base_icms_st | número | |
det[].imposto.icms_st.valor_fcp_icms_st | número | Valor do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det[].imposto.icms_st.valor_icms_st | número | |
det[].imposto.inss | objeto | INSS. |
det[].imposto.inss.aliq_inss | número | |
det[].imposto.inss.valor_inss | número | |
det[].imposto.ipi | objeto | IPI. |
det[].imposto.ipi.aliq_ipi | número | |
det[].imposto.ipi.base_ipi | número | |
det[].imposto.ipi.cod_sit_trib_ipi | texto · até 2 | |
det[].imposto.ipi.enquadramento_ipi | texto | Enquadramento do IPI |
det[].imposto.ipi.qtde_unid_trib_ipi | número | |
det[].imposto.ipi.tipo_calculo_ipi | texto · até 1 | |
det[].imposto.ipi.valor_ipi | número | |
det[].imposto.ipi.valor_unid_trib_ipi | número | |
det[].imposto.irrf | objeto | IRRF. |
det[].imposto.irrf.aliq_irrf | número | |
det[].imposto.irrf.valor_irrf | número | |
det[].imposto.iss | objeto | ISS. |
det[].imposto.iss.aliq_iss | número | |
det[].imposto.iss.base_iss | número | |
det[].imposto.iss.retem_iss | texto · até 1 | |
det[].imposto.iss.valor_iss | número | |
det[].imposto.pis_padrao | objeto | PIS. |
det[].imposto.pis_padrao.aliq_pis | número | |
det[].imposto.pis_padrao.base_pis | número | |
det[].imposto.pis_padrao.cod_sit_trib_pis | texto · até 2 | |
det[].imposto.pis_padrao.qtde_unid_trib_pis | número | |
det[].imposto.pis_padrao.tipo_calculo_pis | texto · até 1 | |
det[].imposto.pis_padrao.valor_pis | número | |
det[].imposto.pis_padrao.valor_unid_trib_pis | número | |
det[].imposto.pis_st | objeto | PIS - Substituíção Tributária. |
det[].imposto.pis_st.aliq_pis_st | número | |
det[].imposto.pis_st.base_pis_st | número | |
det[].imposto.pis_st.cod_sit_trib_pis_st | texto · até 2 | |
det[].imposto.pis_st.margem_pis_st | número | |
det[].imposto.pis_st.qtde_unid_trib_pis_st | número | |
det[].imposto.pis_st.tipo_calculo_pis_st | texto · até 1 | |
det[].imposto.pis_st.valor_pis_st | número | |
det[].imposto.pis_st.valor_unid_trib_pis_st | número | |
det[].imposto.trib_reg | objeto | |
det[].imposto.trib_reg.aliquota_reg_cbs | número | Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.aliquota_reg_ibs_mu | número | Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.aliquota_reg_ibs_uf | número | Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.class_trib_reg | texto · até 6 | Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.cst_reg_ibs_cst | texto · até 3 | Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.valor_reg_cbs | número | Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.valor_reg_ibs_mu | número | Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].imposto.trib_reg.valor_reg_ibs_uf | número | Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det[].inf_adic | objeto | Dados da aba "Informações Adicionais" do Item do Pedido de Vendas. |
det[].inf_adic.codigo_beneficio_fiscal | texto · até 10 | Código do Benefício Fiscal. |
det[].inf_adic.codigo_categoria_item | texto · até 20 | Código da Categoria do item. |
det[].inf_adic.codigo_cenario_impostos_item | número inteiro | Código do Cenário de Impostos. |
det[].inf_adic.codigo_local_estoque | número inteiro | Código do Local do Estoque. |
det[].inf_adic.dados_adicionais_item | texto | Informações para a Nota Fiscal. |
det[].inf_adic.item_pedido_compra | número inteiro | Item do Pedido de Compra. |
det[].inf_adic.nao_gerar_financeiro | texto · até 1 | Não gerar conta a receber para este item. Informar "S" ou "N". (Informe "S" para ativar essa opção). |
det[].inf_adic.nao_movimentar_estoque | texto · até 1 | Não gerar a saída de estoque deste item ao emitir NF-e. Informar "S" ou "N". (informe "S" para ativar essa opção). |
det[].inf_adic.nao_somar_total | texto · até 1 | Não somar este item no total da NF-e |
det[].inf_adic.numero_fci | texto · até 36 | Número da FCI (Ficha de Conteúdo de Importação) |
det[].inf_adic.numero_pedido_compra | texto · até 15 | Número do Pedido de Compra. |
det[].inf_adic.numero_recopi | texto · até 20 | Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune). |
det[].inf_adic.peso_bruto | número | Peso Bruto (Kg). |
det[].inf_adic.peso_liquido | número | Peso Líquido (Kg). |
det[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
det[].lote_validade[].nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
det[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
det[].observacao | objeto | Dados da aba "Observações" do Item do Pedido de Vendas. |
det[].observacao.obs_item | texto | Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal). Informação localizada na Aba "Observações" do Item do Pedido de Venda. |
det[].produto | objeto | Identificação do Produto do Item do Pedido de Vendas. |
det[].produto.cfop | texto · até 10 | CFOP - Código Fiscal de Operações e Prestações. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
det[].produto.cnpj_fabricante | texto · até 20 | CNPJ do Fabricante da Mercadoria. |
det[].produto.codigo | texto · até 60 | Código do Produto exibido na tela do Pedido de Vendas. |
det[].produto.codigo_item_kit | número inteiro | ID do Item do kit (pai) que o componente pertence |
det[].produto.codigo_produto | número inteiro | ID do Produto. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag "codigo_produto" do método "ListarProdutos" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação. |
det[].produto.codigo_produto_integracao | texto · até 60 | Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "codigo_produto". |
det[].produto.codigo_tabela_preco | número inteiro | Código da tabela de preço. (Interno, utilizado apenas na integração via API, não é exibido na tela). Deve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie. |
det[].produto.componente_kit | texto · até 1 | Indica se o produto é um componente de um kit |
det[].produto.descricao | texto · até 120 | Descrição do Produto. |
det[].produto.ean | texto · até 14 | EAN - European Article Number |
det[].produto.indicador_escala | texto · até 1 | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
det[].produto.kit | texto · até 1 | Indica se o produto é um kit |
det[].produto.motivo_icms_desonerado | texto · até 2 | Código do Motivo de desoneração do ICMS Códigos válidos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco |
det[].produto.ncm | texto · até 13 | NCM - Nomenclatura Comum do Mercosul Utilize a tag "cCodigo" do método "ListarNCM" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação. |
det[].produto.percentual_desconto | número | Percentual de Desconto. |
det[].produto.quantidade | número | Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto. |
det[].produto.reservado | texto · até 1 | (S/N) Indica se o estoque do produto será reservado.Ex.: S, N |
det[].produto.tipo_desconto | texto · até 1 | Tipo de Desconto. |
det[].produto.unidade | texto · até 6 | Unidade. Utilize a tag "codigo" do método "ListarUnidades" da API http://app.omie.com.br/api/v1/geral/unidade/ para obter essa informação. |
det[].produto.valor_deducao | número | Valor da Dedução |
det[].produto.valor_desconto | número | Valor do Desconto |
det[].produto.valor_icms_desonerado | número | Valor do ICMS desonerado |
det[].produto.valor_mercadoria | número | Valor da Mercadoria |
det[].produto.valor_total | número | Valor Total. |
det[].produto.valor_unitario | número | Valor Únitário |
det[].rastreabilidade | objeto | Dados da rastreabilidade do produto. |
det[].rastreabilidade.codigoAgregacaoLote | texto · até 20 | Código de Agregação |
det[].rastreabilidade.dataFabricacaoLote | texto · até 10 | Data de Fabricação/Produção |
det[].rastreabilidade.dataValidadeLote | texto · até 10 | Data de Validade |
det[].rastreabilidade.numeroLote | texto · até 20 | Número do Lote |
det[].rastreabilidade.qtdeProdutoLote | número | Quantidade de Produto |
det[].tributavel | objeto | Unidade, Quantidade, Valor e EAN tributáveis do item do pedido. |
det[].tributavel.cEanTrib | texto · até 14 | código EAN tributável do item. |
det[].tributavel.cUnidTrib | texto · até 6 | Unidade tributável do Item. |
det[].tributavel.nQuantTrib | número | Quantidade tributável do item. |
det[].tributavel.nValorTrib | número | Valor tributável do item. |
exportacao | objeto | Dados da exportacao |
exportacao.local_despacho | texto · até 60 | Local de Despacho |
exportacao.local_embarque | texto · até 60 | Local de Embarque (ou de transposição de fronteira) |
exportacao.nao_exportacao | texto · até 1 | O cliente é estrangeiro, mas na verdade não se trata de uma exportação |
exportacao.uf_embarque | texto · até 2 | UF do Local de Embarque |
frete | objeto | Dados da Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.codigo_rastreio | texto · até 500 | Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.codigo_tipo_entrega | número inteiro | Código do tipo de entrega. |
frete.codigo_transportadora | número inteiro | ID da transportadora. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras. |
frete.codigo_transportadora_integracao | texto · até 60 | Código Integração da Transportadora. Esse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
frete.especie_volumes | texto · até 60 | Espécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido | objeto | Dados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.cCfopTr | texto · até 10 | CFOP. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
frete.icms_retido.cCidadeTr | texto · até 40 | Cidade de Ocorrência do Fato Gerador do ICMS. Utilize o formato: CIDADE (UF), como no exemplos: "SAO PAULO (SP)" "RIO DE JANEIRO (RJ)" "FLORIANOPOLIS (SC)" Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
frete.icms_retido.vAliquotaRetencaoTr | número | Percentual de Alíquota de Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.vBCRetencaoTr | número | Base de Cálculo da Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.vIcmsRetidoTr | número | Valor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.icms_retido.vServicoTr | número | Valor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.link_rastreio | texto · até 300 | Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'. |
frete.marca_volumes | texto · até 60 | Marca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.modalidade | texto · até 1 | Tipo de Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Valores disponíveis: "0" - Contratação do Frete por conta do Remetente (CIF) "1" - Contratação do Frete por conta do Destinatário (FOB) "2" - Contratação do Frete por conta de Terceiros "3" - Transporte Próprio por conta do Remetente "4" - Transporte Próprio por conta do Destinatário "9" - Sem frete. |
frete.numeracao_volumes | texto · até 60 | Numeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.numero_lacre | texto · até 60 | Número do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.outras_despesas | número | Outras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.peso_bruto | número | Peso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.peso_liquido | número | Peso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.placa | texto · até 7 | Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.placa_estado | texto · até 2 | Estado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.previsao_entrega | texto · até 10 | Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.quantidade_volumes | número inteiro | Quantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.registro_transportador | texto · até 20 | RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.valor_frete | número | Valor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.valor_seguro | número | Valor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
frete.veiculo_proprio | texto · até 1 | O transporte será realizado com veículo próprio. Informar "S" ou "N". Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
infoCadastro | objeto | Informações complementares do pedido. |
infoCadastro.autorizado | texto · até 1 | Indica se o pedido foi autorizado. |
infoCadastro.cImpAPI | texto · até 1 | Importado pela API. |
infoCadastro.cancelado | texto · até 1 | Indica se o pedido foi cancelado. |
infoCadastro.dAlt | texto · até 10 | Data da Alteração. |
infoCadastro.dCan | texto · até 10 | Data da Cancelamento. |
infoCadastro.dFat | texto · até 10 | Data de Faturamento. |
infoCadastro.dInc | texto · até 10 | Data da Inclusão. |
infoCadastro.denegado | texto · até 1 | Indica se o pedido foi denegado. |
infoCadastro.devolvido | texto · até 1 | Indica se o pedido foi devolvido. |
infoCadastro.devolvido_parcial | texto · até 1 | Indica se o pedido foi devolvido parcialmente. |
infoCadastro.faturado | texto · até 1 | Indica se o pedido está faturado. |
infoCadastro.hAlt | texto · até 8 | Hora da Alteração. |
infoCadastro.hCan | texto · até 8 | Hora da Cancelamento. |
infoCadastro.hFat | texto · até 8 | Hora de faturamento. |
infoCadastro.hInc | texto · até 8 | Hora da Inclusão. |
infoCadastro.uAlt | texto · até 10 | Usuário da Alteração. |
infoCadastro.uCan | texto · até 10 | Usuário da Cancelamento. |
infoCadastro.uFat | texto · até 10 | Usuário que realizou o faturamento. |
infoCadastro.uInc | texto · até 10 | Usuário da Inclusão. |
informacoes_adicionais | objeto | Dados da Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.codProj | número inteiro | Código do Projeto. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação. |
informacoes_adicionais.codVend | número inteiro | Código do Vendedor. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação. |
informacoes_adicionais.codigo_categoria | texto · até 20 | Código da categoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. |
informacoes_adicionais.codigo_conta_corrente | número inteiro | Código da Conta Corrente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
informacoes_adicionais.consumidor_final | texto · até 1 | Nota Fiscal para Consumo Final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.contato | texto · até 100 | Contato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.dados_adicionais_nf | texto | Dados adicionais para a Nota Fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
informacoes_adicionais.enviar_email | texto · até 1 | Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
informacoes_adicionais.enviar_pix | texto · até 1 | Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
informacoes_adicionais.impostos_embutidosdescontinuado | texto · até 1 | DEPRECATED |
informacoes_adicionais.meio_pagamento | texto · até 100 | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
informacoes_adicionais.nfRelacionada | objeto | Detalhes da NF referenciada. |
informacoes_adicionais.nfRelacionada.InscrEstPR | texto · até 20 | Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.cChaveRef | texto · até 44 | Chave da NF-e (ou NFC-e ou SAT) Relacionada. |
informacoes_adicionais.nfRelacionada.cSeriePR | texto · até 3 | Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.cSerieRef | texto · até 3 | Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.cSigNFRef | texto · até 1 | Manter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N" |
informacoes_adicionais.nfRelacionada.cUfPR | texto · até 2 | Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.cUfRef | texto · até 2 | Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.cnpjEmitRef | texto · até 20 | CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.cnpjIntermediario | texto · até 20 | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.cnpjPR | texto · até 20 | CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.dtEmissaoPR | texto · até 10 | Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.dtEmissaoRef | texto · até 10 | Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.identIntermediario | texto · até 60 | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.indIntermediario | texto · até 1 | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.indPresenca | texto · até 1 | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.nfRelacionada.nCOORef | texto · até 6 | Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado |
informacoes_adicionais.nfRelacionada.nECFRef | texto · até 3 | Número de Ordem Sequencial do ECF. |
informacoes_adicionais.nfRelacionada.nNFRef | texto · até 9 | Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A |
informacoes_adicionais.nfRelacionada.nNfPR | texto · até 9 | Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
informacoes_adicionais.nfRelacionada.nrCupomFiscal | lista de objetos | Outros cupons fiscais relacionados |
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrCOO | texto · até 6 | Contador de Ordem de Operação (COO) |
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECF | texto · até 3 | Número do ECF |
informacoes_adicionais.nfRelacionada.nrModelo1_1A | lista de objetos | Outras notas modelo 1/1A relacionadas |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrCnpjCpf | texto · até 20 | CNPJ/CPF do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissao | texto · até 10 | Data de emissão da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumero | texto · até 9 | Número da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerie | texto · até 3 | Série da NF relacionada |
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUF | texto · até 2 | Unidade federativa do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrNF | lista de objetos | Outras NF-e, NFC-e ou SAT relacionadas |
informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrNF[].nrChave | texto · até 44 | Chave da NF-e, NFC-e ou SAT relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural | lista de objetos | Outras notas de produtor rural relacionadas |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItem | texto · até 1 | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrCnpjCpf | texto · até 20 | CNPJ/CPF do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissao | texto · até 10 | Data de emissão da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIE | texto · até 20 | Inscrição Estadual do emitente da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumero | texto · até 9 | Número da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerie | texto · até 3 | Série da NF relacionada |
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUF | texto · até 2 | Unidade federativa do emitente da NF relacionada |
informacoes_adicionais.nsu | texto · até 100 | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
informacoes_adicionais.numero_contrato | texto · até 20 | Número do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.numero_pedido_cliente | texto · até 30 | Número do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes | objeto | Outros detalhes da NF-e. |
informacoes_adicionais.outros_detalhes.cBairroOd | texto · até 60 | Bairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cBairroOdRet | texto · até 60 | Bairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCEPOd | texto · até 10 | CEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCEPOdRet | texto · até 10 | CEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCidadeOd | texto · até 40 | Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
informacoes_adicionais.outros_detalhes.cCidadeOdRet | texto · até 40 | Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
informacoes_adicionais.outros_detalhes.cCnpjCpfOd | texto · até 20 | CNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCnpjCpfOdRet | texto · até 20 | CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cCnpjIntOd | texto · até 20 | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cComplementoOd | texto · até 60 | Complemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cComplementoOdRet | texto · até 60 | Complemento do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEnderecoOd | texto · até 60 | Endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEnderecoOdRet | texto · até 60 | Endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEstadoOd | texto · até 2 | Estado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cEstadoOdRet | texto · até 2 | Estado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cHoraSaidaOd | texto · até 8 | Hora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cIdentificadorIntOd | texto · até 60 | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cIndicadorIntOd | texto · até 1 | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cIndicadorOd | texto · até 1 | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cInscrEstadualOd | texto · até 20 | Inscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cInscrEstadualOdRet | texto · até 20 | Inscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNatOperacaoOd | texto · até 60 | Natureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNomeOd | texto · até 60 | Nome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNomeOdRet | texto · até 60 | Nome / Razão Social (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNumeroOd | texto · até 10 | Número do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cNumeroOdRet | texto · até 10 | Número do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cSepararEnderecoOd | texto · até 1 | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
informacoes_adicionais.outros_detalhes.cSepararEnderecoOdRet | texto · até 1 | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
informacoes_adicionais.outros_detalhes.cTelefoneOd | texto · até 15 | Telefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.cTelefoneOdRet | texto · até 15 | Telefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.outros_detalhes.dDataSaidaOd | texto · até 10 | Data de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
informacoes_adicionais.tipo_documento | texto · até 5 | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
informacoes_adicionais.utilizar_emails | texto | Utilizar os seguintes endereços de e-mail. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. |
lancamentos | lista de objetos | Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros). |
lancamentos[].cCategoria | texto · até 20 | Código da Categoria. |
lancamentos[].cNaturezaDocumento | texto · até 1 | Natureza do Documento. Pode ser: P - Pagar R - Receber Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].cObs | texto | Observações. |
lancamentos[].cOrigem | texto · até 3 | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].cTipoDocumento | texto · até 5 | Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].dDataDocumento | texto · até 10 | Data do documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].nContaCorrente | número inteiro | Id da Conta Corrente. |
lancamentos[].nProjeto | número inteiro | Id do projeto. |
lancamentos[].nSequencia | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
lancamentos[].nValorDocumento | número | Valor do Documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
lancamentos[].nVendedor | número inteiro | Id do Vendedor. |
lista_parcelas | objeto | Dados da Aba "Parcelas" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura. |
lista_parcelas.parcela | lista de objetos | Dados da parcela. |
lista_parcelas.parcela[].bandeira | texto · até 2 | Código da Bandeira da operadora de cartão. |
lista_parcelas.parcela[].categoria_adiantamento | texto · até 20 | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].cnpj_fin | texto · até 20 | Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. |
lista_parcelas.parcela[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].data_vencimento | texto · até 10 | Data de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
lista_parcelas.parcela[].meio_pagamento | texto · até 100 | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
lista_parcelas.parcela[].nao_gerar_boleto | texto · até 1 | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].nsu | texto · até 100 | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
lista_parcelas.parcela[].numero_parcela | número inteiro | Número da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].parcela_adiantamento | texto · até 1 | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].percentual | número | Percentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].quantidade_dias | número inteiro | Quantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
lista_parcelas.parcela[].tipo_documento | texto · até 5 | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
lista_parcelas.parcela[].valor | número | Valor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
market_place | objeto | Dados para o Market Place. |
market_place.nEnvio | número | Valor do envio do Market Place. |
market_place.nTaxa | número | Valor da taxa do Market Place. |
observacoes | objeto | Dados da Aba "Observações" do Pedido de Venda. |
observacoes.obs_venda | texto | Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda. |
total_pedido | objeto | Valores totais do pedido. |
total_pedido.base_calculo_icms | número | Base de Cálculo do ICMS. |
total_pedido.base_calculo_st | número | Base de cálculo da substituição tributária. |
total_pedido.base_ibs_cbs | número | Valor total da base de cálculo do IBS e da CBS. |
total_pedido.valor_IPI | número | Valor do IPI. |
total_pedido.valor_cbs | número | Valor total da CBS. |
total_pedido.valor_cofins | número | Valor do cofins. |
total_pedido.valor_csll | número | Valor da CSLL. |
total_pedido.valor_deducoes | número | Valor das deduções. |
total_pedido.valor_descontos | número | Valor dos descontos. |
total_pedido.valor_dif_cbs | número | Valor total do diferimento da CBS. |
total_pedido.valor_dif_ibs_mu | número | Valor total do diferimento do IBS do município. |
total_pedido.valor_dif_ibs_uf | número | Valor total do diferimento do IBS UF. |
total_pedido.valor_ibs | número | Valor total do IBS. |
total_pedido.valor_ibs_mu | número | Valor total do IBS do município. |
total_pedido.valor_ibs_uf | número | Valor total do IBS da UF. |
total_pedido.valor_icms | número | Valor total do ICMS. |
total_pedido.valor_inss | número | Valor do INSS. |
total_pedido.valor_ir | número | Valor do IR. .Preenchimento automático - Não informar. |
total_pedido.valor_iss | número | Valor do ISS. |
total_pedido.valor_mercadorias | número | valor das mercadorias. |
total_pedido.valor_pis | número | Valor do PIS. |
total_pedido.valor_st | número | Valor total da ST. |
total_pedido.valor_tot_ibs_cbs_is | número | Total da NF-e com IBS/CBS/IS. |
total_pedido.valor_total_pedido | número | Valor total do pedido. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | Código do Pedido de Venda de Produto |
codigo_pedido_integracao | texto | Código de Integração do Pedido de Venda de Produto |
codigo_status | texto | Código do Status do Pedido de Venda. |
descricao_status | texto | Descrição do status. |
numero_pedido | texto | Número do pedido - Visualizado pelo cliente. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirPedido", "param": [{"cabecalho": {"codigo_cliente": 3792227, "codigo_pedido_integracao": "1790776577", "data_previsao": "30/09/2026", "etapa": "10", "numero_pedido": "40451", "codigo_parcela": "999", "quantidade_itens": 2}, "det": [{"ide": {"codigo_item_integracao": "4422421"}, "inf_adic": {"peso_bruto": 150, "peso_liquido": 150}, "produto": {"cfop": "5.102", "codigo_produto": "4422421", "descricao": "Telefone Celular X", "ncm": "9403.30.00", "quantidade": 1, "tipo_desconto": "V", "unidade": "UN", "valor_desconto": 0, "valor_unitario": 200}}], "frete": {"modalidade": "9"}, "informacoes_adicionais": {"codigo_categoria": "1.01.03", "codigo_conta_corrente": 11850365, "consumidor_final": "S", "enviar_email": "N"}, "agropecuario": {"cNumReceita": "", "cCpfResponsavel": "", "nTipoGuia": 1, "cUFGuia": "", "cSerieGuia": "", "nNumGuia": 1}, "lista_parcelas": {"parcela": [{"data_vencimento": "01/10/2026", "numero_parcela": 1, "percentual": 50, "valor": 100}, {"data_vencimento": "04/03/2027", "numero_parcela": 2, "percentual": 50, "valor": 100}]}}]}'import os
import requests
corpo = {'call': 'IncluirPedido',
'param': [{'cabecalho': {'codigo_cliente': 3792227,
'codigo_pedido_integracao': '1790776577',
'data_previsao': '30/09/2026',
'etapa': '10',
'numero_pedido': '40451',
'codigo_parcela': '999',
'quantidade_itens': 2},
'det': [{'ide': {'codigo_item_integracao': '4422421'},
'inf_adic': {'peso_bruto': 150, 'peso_liquido': 150},
'produto': {'cfop': '5.102',
'codigo_produto': '4422421',
'descricao': 'Telefone Celular X',
'ncm': '9403.30.00',
'quantidade': 1,
'tipo_desconto': 'V',
'unidade': 'UN',
'valor_desconto': 0,
'valor_unitario': 200}}],
'frete': {'modalidade': '9'},
'informacoes_adicionais': {'codigo_categoria': '1.01.03',
'codigo_conta_corrente': 11850365,
'consumidor_final': 'S',
'enviar_email': 'N'},
'agropecuario': {'cNumReceita': '',
'cCpfResponsavel': '',
'nTipoGuia': 1,
'cUFGuia': '',
'cSerieGuia': '',
'nNumGuia': 1},
'lista_parcelas': {'parcela': [{'data_vencimento': '01/10/2026',
'numero_parcela': 1,
'percentual': 50,
'valor': 100},
{'data_vencimento': '04/03/2027',
'numero_parcela': 2,
'percentual': 50,
'valor': 100}]}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirPedido",
"param": [
{
"cabecalho": {
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "10",
"numero_pedido": "40451",
"codigo_parcela": "999",
"quantidade_itens": 2
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421"
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "04/03/2027",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "IncluirPedido",
"param": [
{
"cabecalho": {
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "10",
"numero_pedido": "40451",
"codigo_parcela": "999",
"quantidade_itens": 2
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421"
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "04/03/2027",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "IncluirPedido",
"param": [
{
"cabecalho": {
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "10",
"numero_pedido": "40451",
"codigo_parcela": "999",
"quantidade_itens": 2
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421"
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "04/03/2027",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
}
}
]
}
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": "IncluirPedido",
"param": [
{
"cabecalho": {
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1790776577",
"data_previsao": "30/09/2026",
"etapa": "10",
"numero_pedido": "40451",
"codigo_parcela": "999",
"quantidade_itens": 2
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421"
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"agropecuario": {
"cNumReceita": "",
"cCpfResponsavel": "",
"nTipoGuia": 1,
"cUFGuia": "",
"cSerieGuia": "",
"nNumGuia": 1
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "01/10/2026",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "04/03/2027",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirPedido"", ""param"": [{""cabecalho"": {""codigo_cliente"": 3792227, ""codigo_pedido_integracao"": ""1790776577"", ""data_previsao"": ""30/09/2026"", ""etapa"": ""10"", ""numero_pedido"": ""40451"", ""codigo_parcela"": ""999"", ""quantidade_itens"": 2}, ""det"": [{""ide"": {""codigo_item_integracao"": ""4422421""}, ""inf_adic"": {""peso_bruto"": 150, ""peso_liquido"": 150}, ""produto"": {""cfop"": ""5.102"", ""codigo_produto"": ""4422421"", ""descricao"": ""Telefone Celular X"", ""ncm"": ""9403.30.00"", ""quantidade"": 1, ""tipo_desconto"": ""V"", ""unidade"": ""UN"", ""valor_desconto"": 0, ""valor_unitario"": 200}}], ""frete"": {""modalidade"": ""9""}, ""informacoes_adicionais"": {""codigo_categoria"": ""1.01.03"", ""codigo_conta_corrente"": 11850365, ""consumidor_final"": ""S"", ""enviar_email"": ""N""}, ""agropecuario"": {""cNumReceita"": """", ""cCpfResponsavel"": """", ""nTipoGuia"": 1, ""cUFGuia"": """", ""cSerieGuia"": """", ""nNumGuia"": 1}, ""lista_parcelas"": {""parcela"": [{""data_vencimento"": ""01/10/2026"", ""numero_parcela"": 1, ""percentual"": 50, ""valor"": 100}, {""data_vencimento"": ""04/03/2027"", ""numero_parcela"": 2, ""percentual"": 50, ""valor"": 100}]}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListar os pedidos de venda de produto
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 24Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | |
apenas_resumo | texto · até 1 | Exibir apenas o resumo do pedido de vendas. Preencher com "S" ou "N". |
data_cancelamento_ate | texto · até 10 | Data de Cancelamento final. |
data_cancelamento_de | texto · até 10 | Data de Cancelamento inicial. |
data_faturamento_ate | texto · até 10 | Data de Faturamento final. |
data_faturamento_de | texto · até 10 | Data de Faturamento inicial. |
data_previsao_ate | texto · até 10 | Data de Previsão do faturamento final. |
data_previsao_de | texto · até 10 | Data de Previsão do faturamento inicio. |
etapa | texto · até 2 | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
filtrar_apenas_alteracao | texto · até 1 | |
filtrar_apenas_inclusao | texto · até 1 | |
filtrar_por_cliente | número inteiro | Filtra os registros do cliente específicado. |
filtrar_por_data_ate | texto · até 10 | |
filtrar_por_data_de | texto · até 10 | |
filtrar_por_hora_ate | texto · até 8 | Filtra os registros até a hora específicada. |
filtrar_por_hora_de | texto · até 8 | Filtra os registros a partir da hora específicada. |
filtrar_por_projeto | número inteiro | Filtra os registros do projeto específicado. |
filtrar_por_vendedor | número inteiro | Filtra os registros do vendedor específicado. |
numero_pedido_ate | número inteiro | Filtra os registros até o número do pedido específicado. |
numero_pedido_de | número inteiro | Filtra os registros a partir do número do pedido específicado. |
ordenar_por | texto · até 100 | Ordem de exibição dos dados. Padrão: Código. |
pagina | número inteiro | |
registros_por_pagina | número inteiro | |
status_pedido | texto · até 100 | Status do Pedido. FATURADO CANCELADO AUTORIZADO DENEGADO DEVOLVIDO |
Descontinuados 3Ainda aceitos, fora do fluxo principal
| Campo | Tipo | Descrição |
|---|---|---|
data_emissao_atedescontinuado | texto · até 10 | DEPRECATED |
data_emissao_dedescontinuado | texto · até 10 | DEPRECATED |
ordem_descrescentedescontinuado | texto · até 1 | DEPRECATED |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
pagina | número inteiro | |
pedido_venda_produto | lista de objetos | Cadastro de Pedido de Venda |
pedido_venda_produto[].agropecuario | objeto | |
pedido_venda_produto[].agropecuario.cCpfResponsavel | texto | CPF do responsá¡vel técnico legalmente habilitado |
pedido_venda_produto[].agropecuario.cNumReceita | texto | Número da receita ou receituário do agrotóxico/defensivo agrícola |
pedido_venda_produto[].agropecuario.cSerieGuia | texto | Número de série da guia |
pedido_venda_produto[].agropecuario.cUFGuia | texto | UF de emissão da Guia |
pedido_venda_produto[].agropecuario.nNumGuia | número inteiro | Número da guia |
pedido_venda_produto[].agropecuario.nTipoGuia | número inteiro | Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG) |
pedido_venda_produto[].cabecalho | objeto | Informações do cabeçalho do pedido. |
pedido_venda_produto[].cabecalho.bloqueado | texto | Pedido Bloqueado pela API. |
pedido_venda_produto[].cabecalho.codigo_cenario_impostos | número inteiro | Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão. |
pedido_venda_produto[].cabecalho.codigo_cliente | número inteiro | Código do cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. |
pedido_venda_produto[].cabecalho.codigo_cliente_integracao | texto | Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
pedido_venda_produto[].cabecalho.codigo_empresa | número inteiro | DEPRECATED |
pedido_venda_produto[].cabecalho.codigo_empresa_integracao | texto | DEPRECATED |
pedido_venda_produto[].cabecalho.codigo_parcela | texto | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Consultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'. |
pedido_venda_produto[].cabecalho.codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
pedido_venda_produto[].cabecalho.codigo_pedido_integracao | texto | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
pedido_venda_produto[].cabecalho.data_previsao | texto | Data de Previsão de Faturamento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. |
pedido_venda_produto[].cabecalho.enc_data | texto | Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto[].cabecalho.enc_hora | texto | Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto[].cabecalho.enc_motivo | texto | Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto[].cabecalho.enc_user | texto | Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto[].cabecalho.encerrado | texto | Indica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta. |
pedido_venda_produto[].cabecalho.etapa | texto | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
pedido_venda_produto[].cabecalho.importado_api | texto | Pedido de venda de produto importada pela API. |
pedido_venda_produto[].cabecalho.nao_gerar_boleto | texto | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].cabecalho.numero_pedido | texto | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
pedido_venda_produto[].cabecalho.origem_pedido | texto | Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda. |
pedido_venda_produto[].cabecalho.perc_desconto_pedido | decimal | Percentual do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
pedido_venda_produto[].cabecalho.qtde_parcelas | número inteiro | Quantidade de parcelas. Valores permitidos de 1 a 999. |
pedido_venda_produto[].cabecalho.quantidade_itens | número inteiro | Quantidade de Itens. |
pedido_venda_produto[].cabecalho.sequencial | texto | Número sequencial do pedido de venda parcial. Esse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela. |
pedido_venda_produto[].cabecalho.tipo_desconto_pedido | texto | Tipo de desconto para o pedido. Pode ser: V - Valor P - Percentual Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. |
pedido_venda_produto[].cabecalho.valor_desconto_pedido | decimal | Valor do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. - Se o desconto for superior ao valor do pedido ele não será aplicado. |
pedido_venda_produto[].departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto[].departamentos[].cCodDepto | texto | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
pedido_venda_produto[].departamentos[].nPerc | decimal | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto[].departamentos[].nValor | decimal | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto[].departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
pedido_venda_produto[].det | lista de objetos | Dados da Aba "Itens da Venda" do Pedido de Venda. |
pedido_venda_produto[].det[].combustivel | objeto | Detalhamento específico de Combustível. |
pedido_venda_produto[].det[].combustivel.cCODIF | texto | Registro do CODIF. |
pedido_venda_produto[].det[].combustivel.cCodigoANP | texto | Código de Produto da ANP. |
pedido_venda_produto[].det[].combustivel.cDescrANP | texto | Descrição do Produto conforme ANP. |
pedido_venda_produto[].det[].combustivel.cUFConsumoComb | texto | UF de Consumo. |
pedido_venda_produto[].det[].combustivel.nAliquota_CIDE | decimal | Valor da Alíquota em Reais da CIDE. |
pedido_venda_produto[].det[].combustivel.nBC_CIDE | decimal | Base de Cálculo (em quantidade) da CIDE. |
pedido_venda_produto[].det[].combustivel.nBC_UFDest | decimal | Base de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
pedido_venda_produto[].det[].combustivel.nBC_UFRem | decimal | Base de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária. |
pedido_venda_produto[].det[].combustivel.nPercGLP | decimal | Percentual de GLP Derivado do Petróleo. |
pedido_venda_produto[].det[].combustivel.nPercGasImportado | decimal | Percentual de Gás Natural Importado. |
pedido_venda_produto[].det[].combustivel.nPercGasNacional | decimal | Percentual de Gás Natural Nacional. |
pedido_venda_produto[].det[].combustivel.nQtdeFatTempAmb | decimal | Quantidade Faturada à Temperatura Ambiente. |
pedido_venda_produto[].det[].combustivel.nValorPartida | decimal | Valor de Partida. |
pedido_venda_produto[].det[].combustivel.nValorUFDest | decimal | Valor da UF Destino. Base de Cálculo do ICMS ST da UF Destino. |
pedido_venda_produto[].det[].combustivel.nValorUFRem | decimal | Valor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária. |
pedido_venda_produto[].det[].combustivel.nValor_CIDE | decimal | Valor da CIDE. |
pedido_venda_produto[].det[].ide | objeto | Identificação do Item do Pedido de Vendas. |
pedido_venda_produto[].det[].ide.acao_item | texto | Ação para o item. Pode ser: "E" - para excluir um item. |
pedido_venda_produto[].det[].ide.codigo_item | número inteiro | ID do Item do Pedido. |
pedido_venda_produto[].det[].ide.codigo_item_integracao | texto | Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199. |
pedido_venda_produto[].det[].ide.id_ordem_producao | número inteiro | Id da Ordem de Produção. Campo disponível apenas para consulta. Não deve ser informado na Inclusão ou Alteração. |
pedido_venda_produto[].det[].ide.regra_impostos | número inteiro | DEPRECATED |
pedido_venda_produto[].det[].ide.simples_nacional | texto | Indica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N". |
pedido_venda_produto[].det[].imposto | objeto | Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados. |
pedido_venda_produto[].det[].imposto.cbs | objeto | |
pedido_venda_produto[].det[].imposto.cbs.aliquota_cbs | decimal | Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.cbs.perc_dif_cbs | decimal | Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.cbs.perc_red_cbs | decimal | Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.cbs.valor_cbs | decimal | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.cbs.valor_dif_cbs | decimal | Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.cofins_padrao | objeto | COFINS. |
pedido_venda_produto[].det[].imposto.cofins_padrao.aliq_cofins | decimal | |
pedido_venda_produto[].det[].imposto.cofins_padrao.base_cofins | decimal | |
pedido_venda_produto[].det[].imposto.cofins_padrao.cod_sit_trib_cofins | texto | |
pedido_venda_produto[].det[].imposto.cofins_padrao.qtde_unid_trib_cofins | decimal | |
pedido_venda_produto[].det[].imposto.cofins_padrao.tipo_calculo_cofins | texto | |
pedido_venda_produto[].det[].imposto.cofins_padrao.valor_cofins | decimal | |
pedido_venda_produto[].det[].imposto.cofins_padrao.valor_unid_trib_cofins | decimal | |
pedido_venda_produto[].det[].imposto.cofins_st | objeto | COFINS - Substituição Tributária. |
pedido_venda_produto[].det[].imposto.cofins_st.aliq_cofins_st | decimal | |
pedido_venda_produto[].det[].imposto.cofins_st.base_cofins_st | decimal | |
pedido_venda_produto[].det[].imposto.cofins_st.cod_sit_trib_cofins_st | texto | |
pedido_venda_produto[].det[].imposto.cofins_st.margem_cofins_st | decimal | |
pedido_venda_produto[].det[].imposto.cofins_st.qtde_unid_trib_cofins_st | decimal | |
pedido_venda_produto[].det[].imposto.cofins_st.tipo_calculo_cofins_st | texto | |
pedido_venda_produto[].det[].imposto.cofins_st.valor_cofins_st | decimal | |
pedido_venda_produto[].det[].imposto.cofins_st.valor_unid_trib_cofins_st | decimal | |
pedido_venda_produto[].det[].imposto.csll | objeto | CSLL. |
pedido_venda_produto[].det[].imposto.csll.aliq_csll | decimal | |
pedido_venda_produto[].det[].imposto.csll.valor_csll | decimal | |
pedido_venda_produto[].det[].imposto.ibs | objeto | |
pedido_venda_produto[].det[].imposto.ibs.aliquota_ibs_mu | decimal | Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.aliquota_ibs_uf | decimal | Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.perc_dif_ibs_mu | decimal | Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.perc_dif_ibs_uf | decimal | Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.perc_red_ibs_mu | decimal | Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.perc_red_ibs_uf | decimal | Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal. |
pedido_venda_produto[].det[].imposto.ibs.valor_dif_ibs_mu | decimal | Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.valor_dif_ibs_uf | decimal | Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.valor_ibs | decimal | Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.valor_ibs_mu | decimal | Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs.valor_ibs_uf | decimal | Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs_cbs | objeto | |
pedido_venda_produto[].det[].imposto.ibs_cbs.base_ibs_cbs | decimal | Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs_cbs.class_trib | texto | Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.ibs_cbs.cst_ibs_cbs | texto | Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.icms | objeto | ICMS |
pedido_venda_produto[].det[].imposto.icms.aliq_icms | decimal | |
pedido_venda_produto[].det[].imposto.icms.base_fcp_icms | decimal | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS. |
pedido_venda_produto[].det[].imposto.icms.base_icms | decimal | |
pedido_venda_produto[].det[].imposto.icms.cod_sit_trib_icms | texto | |
pedido_venda_produto[].det[].imposto.icms.modalidade_icms | texto | |
pedido_venda_produto[].det[].imposto.icms.origem_icms | texto | |
pedido_venda_produto[].det[].imposto.icms.perc_fcp_icms | decimal | Percentual do FCP - Fundo de Combate a Pobreza do ICMS. |
pedido_venda_produto[].det[].imposto.icms.perc_red_base_icms | decimal | |
pedido_venda_produto[].det[].imposto.icms.valor_fcp_icms | decimal | Valor do FCP - Fundo de Combate a Pobreza do ICMS. |
pedido_venda_produto[].det[].imposto.icms.valor_icms | decimal | |
pedido_venda_produto[].det[].imposto.icms_efet | objeto | ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem |
pedido_venda_produto[].det[].imposto.icms_efet.aliq_icms_efet | decimal | |
pedido_venda_produto[].det[].imposto.icms_efet.base_icms_efet | decimal | |
pedido_venda_produto[].det[].imposto.icms_efet.cod_sit_trib_icms_efet | texto | |
pedido_venda_produto[].det[].imposto.icms_efet.modalidade_icms_efet | texto | |
pedido_venda_produto[].det[].imposto.icms_efet.origem_icms_efet | texto | |
pedido_venda_produto[].det[].imposto.icms_efet.perc_red_base_icms_efet | decimal | |
pedido_venda_produto[].det[].imposto.icms_efet.valor_icms_efet | decimal | |
pedido_venda_produto[].det[].imposto.icms_ie | objeto | ICMS Interestadual. |
pedido_venda_produto[].det[].imposto.icms_ie.aliq_icms_FCP | decimal | Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino |
pedido_venda_produto[].det[].imposto.icms_ie.aliq_interestadual | decimal | Alíquota Interestadual das UFs Envolvidas |
pedido_venda_produto[].det[].imposto.icms_ie.aliq_interna_uf_destino | decimal | Alíquota Interna da UF de Destino |
pedido_venda_produto[].det[].imposto.icms_ie.aliq_partilha_icms | decimal | Percentual Provisório de Partilha do ICMS Interestadual |
pedido_venda_produto[].det[].imposto.icms_ie.base_icms_uf_destino | decimal | BC do ICMS na UF de Destino |
pedido_venda_produto[].det[].imposto.icms_ie.valor_fcp_icms_inter | decimal | Valor do fundo de combate a pobreza. |
pedido_venda_produto[].det[].imposto.icms_ie.valor_icms_uf_dest | decimal | Valor do ICMS - UF Destino |
pedido_venda_produto[].det[].imposto.icms_ie.valor_icms_uf_remet | decimal | Valor do ICMS - UF Remetente |
pedido_venda_produto[].det[].imposto.icms_sn | objeto | ICMS - Simples Nacional. |
pedido_venda_produto[].det[].imposto.icms_sn.aliq_icms_sn | decimal | |
pedido_venda_produto[].det[].imposto.icms_sn.base_icms_sn | decimal | |
pedido_venda_produto[].det[].imposto.icms_sn.cod_sit_trib_icms_sn | texto | |
pedido_venda_produto[].det[].imposto.icms_sn.origem_icms_sn | texto | |
pedido_venda_produto[].det[].imposto.icms_sn.valor_credito_icms_sn | decimal | |
pedido_venda_produto[].det[].imposto.icms_sn.valor_icms_sn | decimal | |
pedido_venda_produto[].det[].imposto.icms_st | objeto | ICMS - Substituição Tributária. |
pedido_venda_produto[].det[].imposto.icms_st.aliq_icms_opprop | decimal | Alíquota de ICMS Operação Própria. |
pedido_venda_produto[].det[].imposto.icms_st.aliq_icms_st | decimal | |
pedido_venda_produto[].det[].imposto.icms_st.base_fcp_icms_st | decimal | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST. |
pedido_venda_produto[].det[].imposto.icms_st.base_icms_st | decimal | |
pedido_venda_produto[].det[].imposto.icms_st.cest | texto | CEST - Código Especificador da Substituíção Tributária. |
pedido_venda_produto[].det[].imposto.icms_st.cod_sit_trib_icms_st | texto | |
pedido_venda_produto[].det[].imposto.icms_st.margem_icms_st | decimal | |
pedido_venda_produto[].det[].imposto.icms_st.modalidade_icms_st | texto | |
pedido_venda_produto[].det[].imposto.icms_st.perc_fcp_icms_st | decimal | Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST. |
pedido_venda_produto[].det[].imposto.icms_st.perc_red_base_icms_op | decimal | Percentual de redução de base de cálculo de Icms Operação Própria. |
pedido_venda_produto[].det[].imposto.icms_st.perc_red_base_icms_st | decimal | |
pedido_venda_produto[].det[].imposto.icms_st.valor_fcp_icms_st | decimal | Valor do FCP - Fundo de Combate a Pobreza do ICMS ST. |
pedido_venda_produto[].det[].imposto.icms_st.valor_icms_st | decimal | |
pedido_venda_produto[].det[].imposto.inss | objeto | INSS. |
pedido_venda_produto[].det[].imposto.inss.aliq_inss | decimal | |
pedido_venda_produto[].det[].imposto.inss.valor_inss | decimal | |
pedido_venda_produto[].det[].imposto.ipi | objeto | IPI. |
pedido_venda_produto[].det[].imposto.ipi.aliq_ipi | decimal | |
pedido_venda_produto[].det[].imposto.ipi.base_ipi | decimal | |
pedido_venda_produto[].det[].imposto.ipi.cod_sit_trib_ipi | texto | |
pedido_venda_produto[].det[].imposto.ipi.enquadramento_ipi | texto | Enquadramento do IPI |
pedido_venda_produto[].det[].imposto.ipi.qtde_unid_trib_ipi | decimal | |
pedido_venda_produto[].det[].imposto.ipi.tipo_calculo_ipi | texto | |
pedido_venda_produto[].det[].imposto.ipi.valor_ipi | decimal | |
pedido_venda_produto[].det[].imposto.ipi.valor_unid_trib_ipi | decimal | |
pedido_venda_produto[].det[].imposto.irrf | objeto | IRRF. |
pedido_venda_produto[].det[].imposto.irrf.aliq_irrf | decimal | |
pedido_venda_produto[].det[].imposto.irrf.valor_irrf | decimal | |
pedido_venda_produto[].det[].imposto.iss | objeto | ISS. |
pedido_venda_produto[].det[].imposto.iss.aliq_iss | decimal | |
pedido_venda_produto[].det[].imposto.iss.base_iss | decimal | |
pedido_venda_produto[].det[].imposto.iss.retem_iss | texto | |
pedido_venda_produto[].det[].imposto.iss.valor_iss | decimal | |
pedido_venda_produto[].det[].imposto.pis_padrao | objeto | PIS. |
pedido_venda_produto[].det[].imposto.pis_padrao.aliq_pis | decimal | |
pedido_venda_produto[].det[].imposto.pis_padrao.base_pis | decimal | |
pedido_venda_produto[].det[].imposto.pis_padrao.cod_sit_trib_pis | texto | |
pedido_venda_produto[].det[].imposto.pis_padrao.qtde_unid_trib_pis | decimal | |
pedido_venda_produto[].det[].imposto.pis_padrao.tipo_calculo_pis | texto | |
pedido_venda_produto[].det[].imposto.pis_padrao.valor_pis | decimal | |
pedido_venda_produto[].det[].imposto.pis_padrao.valor_unid_trib_pis | decimal | |
pedido_venda_produto[].det[].imposto.pis_st | objeto | PIS - Substituíção Tributária. |
pedido_venda_produto[].det[].imposto.pis_st.aliq_pis_st | decimal | |
pedido_venda_produto[].det[].imposto.pis_st.base_pis_st | decimal | |
pedido_venda_produto[].det[].imposto.pis_st.cod_sit_trib_pis_st | texto | |
pedido_venda_produto[].det[].imposto.pis_st.margem_pis_st | decimal | |
pedido_venda_produto[].det[].imposto.pis_st.qtde_unid_trib_pis_st | decimal | |
pedido_venda_produto[].det[].imposto.pis_st.tipo_calculo_pis_st | texto | |
pedido_venda_produto[].det[].imposto.pis_st.valor_pis_st | decimal | |
pedido_venda_produto[].det[].imposto.pis_st.valor_unid_trib_pis_st | decimal | |
pedido_venda_produto[].det[].imposto.trib_reg | objeto | |
pedido_venda_produto[].det[].imposto.trib_reg.aliquota_reg_cbs | decimal | Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.aliquota_reg_ibs_mu | decimal | Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.aliquota_reg_ibs_uf | decimal | Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.class_trib_reg | texto | Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.cst_reg_ibs_cst | texto | Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.valor_reg_cbs | decimal | Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.valor_reg_ibs_mu | decimal | Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].imposto.trib_reg.valor_reg_ibs_uf | decimal | Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
pedido_venda_produto[].det[].inf_adic | objeto | Dados da aba "Informações Adicionais" do Item do Pedido de Vendas. |
pedido_venda_produto[].det[].inf_adic.codigo_beneficio_fiscal | texto | Código do Benefício Fiscal. |
pedido_venda_produto[].det[].inf_adic.codigo_categoria_item | texto | Código da Categoria do item. |
pedido_venda_produto[].det[].inf_adic.codigo_cenario_impostos_item | número inteiro | Código do Cenário de Impostos. |
pedido_venda_produto[].det[].inf_adic.codigo_local_estoque | número inteiro | Código do Local do Estoque. |
pedido_venda_produto[].det[].inf_adic.dados_adicionais_item | texto | Informações para a Nota Fiscal. |
pedido_venda_produto[].det[].inf_adic.item_pedido_compra | número inteiro | Item do Pedido de Compra. |
pedido_venda_produto[].det[].inf_adic.nao_gerar_financeiro | texto | Não gerar conta a receber para este item. Informar "S" ou "N". (Informe "S" para ativar essa opção). |
pedido_venda_produto[].det[].inf_adic.nao_movimentar_estoque | texto | Não gerar a saída de estoque deste item ao emitir NF-e. Informar "S" ou "N". (informe "S" para ativar essa opção). |
pedido_venda_produto[].det[].inf_adic.nao_somar_total | texto | Não somar este item no total da NF-e |
pedido_venda_produto[].det[].inf_adic.numero_fci | texto | Número da FCI (Ficha de Conteúdo de Importação) |
pedido_venda_produto[].det[].inf_adic.numero_pedido_compra | texto | Número do Pedido de Compra. |
pedido_venda_produto[].det[].inf_adic.numero_recopi | texto | Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune). |
pedido_venda_produto[].det[].inf_adic.peso_bruto | decimal | Peso Bruto (Kg). |
pedido_venda_produto[].det[].inf_adic.peso_liquido | decimal | Peso Líquido (Kg). |
pedido_venda_produto[].det[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
pedido_venda_produto[].det[].lote_validade[].nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
pedido_venda_produto[].det[].lote_validade[].nQtdLote | decimal | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
pedido_venda_produto[].det[].observacao | objeto | Dados da aba "Observações" do Item do Pedido de Vendas. |
pedido_venda_produto[].det[].observacao.obs_item | texto | Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal). Informação localizada na Aba "Observações" do Item do Pedido de Venda. |
pedido_venda_produto[].det[].produto | objeto | Identificação do Produto do Item do Pedido de Vendas. |
pedido_venda_produto[].det[].produto.cfop | texto | CFOP - Código Fiscal de Operações e Prestações. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
pedido_venda_produto[].det[].produto.cnpj_fabricante | texto | CNPJ do Fabricante da Mercadoria. |
pedido_venda_produto[].det[].produto.codigo | texto | Código do Produto exibido na tela do Pedido de Vendas. |
pedido_venda_produto[].det[].produto.codigo_item_kit | número inteiro | ID do Item do kit (pai) que o componente pertence |
pedido_venda_produto[].det[].produto.codigo_produto | número inteiro | ID do Produto. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag "codigo_produto" do método "ListarProdutos" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação. |
pedido_venda_produto[].det[].produto.codigo_produto_integracao | texto | Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "codigo_produto". |
pedido_venda_produto[].det[].produto.codigo_tabela_preco | número inteiro | Código da tabela de preço. (Interno, utilizado apenas na integração via API, não é exibido na tela). Deve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie. |
pedido_venda_produto[].det[].produto.componente_kit | texto | Indica se o produto é um componente de um kit |
pedido_venda_produto[].det[].produto.descricao | texto | Descrição do Produto. |
pedido_venda_produto[].det[].produto.ean | texto | EAN - European Article Number |
pedido_venda_produto[].det[].produto.indicador_escala | texto | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
pedido_venda_produto[].det[].produto.kit | texto | Indica se o produto é um kit |
pedido_venda_produto[].det[].produto.motivo_icms_desonerado | texto | Código do Motivo de desoneração do ICMS Códigos válidos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco |
pedido_venda_produto[].det[].produto.ncm | texto | NCM - Nomenclatura Comum do Mercosul Utilize a tag "cCodigo" do método "ListarNCM" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação. |
pedido_venda_produto[].det[].produto.percentual_desconto | decimal | Percentual de Desconto. |
pedido_venda_produto[].det[].produto.quantidade | decimal | Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto. |
pedido_venda_produto[].det[].produto.reservado | texto | (S/N) Indica se o estoque do produto será reservado. |
pedido_venda_produto[].det[].produto.tipo_desconto | texto | Tipo de Desconto. |
pedido_venda_produto[].det[].produto.unidade | texto | Unidade. Utilize a tag "codigo" do método "ListarUnidades" da API http://app.omie.com.br/api/v1/geral/unidade/ para obter essa informação. |
pedido_venda_produto[].det[].produto.valor_deducao | decimal | Valor da Dedução |
pedido_venda_produto[].det[].produto.valor_desconto | decimal | Valor do Desconto |
pedido_venda_produto[].det[].produto.valor_icms_desonerado | decimal | Valor do ICMS desonerado |
pedido_venda_produto[].det[].produto.valor_mercadoria | decimal | Valor da Mercadoria |
pedido_venda_produto[].det[].produto.valor_total | decimal | Valor Total. |
pedido_venda_produto[].det[].produto.valor_unitario | decimal | Valor Únitário |
pedido_venda_produto[].det[].rastreabilidade | objeto | Dados da rastreabilidade do produto. |
pedido_venda_produto[].det[].rastreabilidade.codigoAgregacaoLote | texto | Código de Agregação |
pedido_venda_produto[].det[].rastreabilidade.dataFabricacaoLote | texto | Data de Fabricação/Produção |
pedido_venda_produto[].det[].rastreabilidade.dataValidadeLote | texto | Data de Validade |
pedido_venda_produto[].det[].rastreabilidade.numeroLote | texto | Número do Lote |
pedido_venda_produto[].det[].rastreabilidade.qtdeProdutoLote | decimal | Quantidade de Produto |
pedido_venda_produto[].det[].tributavel | objeto | Unidade, Quantidade, Valor e EAN tributáveis do item do pedido. |
pedido_venda_produto[].det[].tributavel.cEanTrib | texto | código EAN tributável do item. |
pedido_venda_produto[].det[].tributavel.cUnidTrib | texto | Unidade tributável do Item. |
pedido_venda_produto[].det[].tributavel.nQuantTrib | decimal | Quantidade tributável do item. |
pedido_venda_produto[].det[].tributavel.nValorTrib | decimal | Valor tributável do item. |
pedido_venda_produto[].exportacao | objeto | Dados da exportacao |
pedido_venda_produto[].exportacao.local_despacho | texto | Local de Despacho |
pedido_venda_produto[].exportacao.local_embarque | texto | Local de Embarque (ou de transposição de fronteira) |
pedido_venda_produto[].exportacao.nao_exportacao | texto | O cliente é estrangeiro, mas na verdade não se trata de uma exportação |
pedido_venda_produto[].exportacao.uf_embarque | texto | UF do Local de Embarque |
pedido_venda_produto[].frete | objeto | Dados da Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.codigo_rastreio | texto | Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.codigo_tipo_entrega | número inteiro | Código do tipo de entrega. |
pedido_venda_produto[].frete.codigo_transportadora | número inteiro | ID da transportadora. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras. |
pedido_venda_produto[].frete.codigo_transportadora_integracao | texto | Código Integração da Transportadora. Esse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
pedido_venda_produto[].frete.especie_volumes | texto | Espécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.icms_retido | objeto | Dados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.icms_retido.cCfopTr | texto | CFOP. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "nCodigo" do método "ListarCFOP" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. |
pedido_venda_produto[].frete.icms_retido.cCidadeTr | texto | Cidade de Ocorrência do Fato Gerador do ICMS. Utilize o formato: CIDADE (UF), como no exemplos: "SAO PAULO (SP)" "RIO DE JANEIRO (RJ)" "FLORIANOPOLIS (SC)" Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
pedido_venda_produto[].frete.icms_retido.vAliquotaRetencaoTr | decimal | Percentual de Alíquota de Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.icms_retido.vBCRetencaoTr | decimal | Base de Cálculo da Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.icms_retido.vIcmsRetidoTr | decimal | Valor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.icms_retido.vServicoTr | decimal | Valor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.link_rastreio | texto | Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'. |
pedido_venda_produto[].frete.marca_volumes | texto | Marca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.modalidade | texto | Tipo de Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. Valores disponíveis: "0" - Contratação do Frete por conta do Remetente (CIF) "1" - Contratação do Frete por conta do Destinatário (FOB) "2" - Contratação do Frete por conta de Terceiros "3" - Transporte Próprio por conta do Remetente "4" - Transporte Próprio por conta do Destinatário "9" - Sem frete. |
pedido_venda_produto[].frete.numeracao_volumes | texto | Numeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.numero_lacre | texto | Número do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.outras_despesas | decimal | Outras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.peso_bruto | decimal | Peso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.peso_liquido | decimal | Peso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.placa | texto | Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.placa_estado | texto | Estado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.previsao_entrega | texto | Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.quantidade_volumes | número inteiro | Quantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.registro_transportador | texto | RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.valor_frete | decimal | Valor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.valor_seguro | decimal | Valor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].frete.veiculo_proprio | texto | O transporte será realizado com veículo próprio. Informar "S" ou "N". Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda. |
pedido_venda_produto[].infoCadastro | objeto | Informações complementares do pedido. |
pedido_venda_produto[].infoCadastro.autorizado | texto | Indica se o pedido foi autorizado. |
pedido_venda_produto[].infoCadastro.cImpAPI | texto | Importado pela API. |
pedido_venda_produto[].infoCadastro.cancelado | texto | Indica se o pedido foi cancelado. |
pedido_venda_produto[].infoCadastro.dAlt | texto | Data da Alteração. |
pedido_venda_produto[].infoCadastro.dCan | texto | Data da Cancelamento. |
pedido_venda_produto[].infoCadastro.dFat | texto | Data de Faturamento. |
pedido_venda_produto[].infoCadastro.dInc | texto | Data da Inclusão. |
pedido_venda_produto[].infoCadastro.denegado | texto | Indica se o pedido foi denegado. |
pedido_venda_produto[].infoCadastro.devolvido | texto | Indica se o pedido foi devolvido. |
pedido_venda_produto[].infoCadastro.devolvido_parcial | texto | Indica se o pedido foi devolvido parcialmente. |
pedido_venda_produto[].infoCadastro.faturado | texto | Indica se o pedido está faturado. |
pedido_venda_produto[].infoCadastro.hAlt | texto | Hora da Alteração. |
pedido_venda_produto[].infoCadastro.hCan | texto | Hora da Cancelamento. |
pedido_venda_produto[].infoCadastro.hFat | texto | Hora de faturamento. |
pedido_venda_produto[].infoCadastro.hInc | texto | Hora da Inclusão. |
pedido_venda_produto[].infoCadastro.uAlt | texto | Usuário da Alteração. |
pedido_venda_produto[].infoCadastro.uCan | texto | Usuário da Cancelamento. |
pedido_venda_produto[].infoCadastro.uFat | texto | Usuário que realizou o faturamento. |
pedido_venda_produto[].infoCadastro.uInc | texto | Usuário da Inclusão. |
pedido_venda_produto[].informacoes_adicionais | objeto | Dados da Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.codProj | número inteiro | Código do Projeto. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação. |
pedido_venda_produto[].informacoes_adicionais.codVend | número inteiro | Código do Vendedor. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação. |
pedido_venda_produto[].informacoes_adicionais.codigo_categoria | texto | Código da categoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. |
pedido_venda_produto[].informacoes_adicionais.codigo_conta_corrente | número inteiro | Código da Conta Corrente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
pedido_venda_produto[].informacoes_adicionais.consumidor_final | texto | Nota Fiscal para Consumo Final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.contato | texto | Contato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.dados_adicionais_nf | texto | Dados adicionais para a Nota Fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto[].informacoes_adicionais.enviar_email | texto | Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
pedido_venda_produto[].informacoes_adicionais.enviar_pix | texto | Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email". |
pedido_venda_produto[].informacoes_adicionais.impostos_embutidos | texto | DEPRECATED |
pedido_venda_produto[].informacoes_adicionais.meio_pagamento | texto | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada | objeto | Detalhes da NF referenciada. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.InscrEstPR | texto | Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cChaveRef | texto | Chave da NF-e (ou NFC-e ou SAT) Relacionada. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cSeriePR | texto | Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cSerieRef | texto | Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cSigNFRef | texto | Manter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N" |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cUfPR | texto | Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cUfRef | texto | Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cnpjEmitRef | texto | CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cnpjIntermediario | texto | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cnpjPR | texto | CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.dtEmissaoPR | texto | Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.dtEmissaoRef | texto | Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.identIntermediario | texto | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.indIntermediario | texto | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.indPresenca | texto | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nCOORef | texto | Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nECFRef | texto | Número de Ordem Sequencial do ECF. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nNFRef | texto | Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nNfPR | texto | Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscal | lista de objetos | Outros cupons fiscais relacionados |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrCOO | texto | Contador de Ordem de Operação (COO) |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECF | texto | Número do ECF |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A | lista de objetos | Outras notas modelo 1/1A relacionadas |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrCnpjCpf | texto | CNPJ/CPF do emitente da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissao | texto | Data de emissão da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumero | texto | Número da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerie | texto | Série da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUF | texto | Unidade federativa do emitente da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrNF | lista de objetos | Outras NF-e, NFC-e ou SAT relacionadas |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrNF[].nrChave | texto | Chave da NF-e, NFC-e ou SAT relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural | lista de objetos | Outras notas de produtor rural relacionadas |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItem | texto | Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item. |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrCnpjCpf | texto | CNPJ/CPF do emitente da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissao | texto | Data de emissão da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIE | texto | Inscrição Estadual do emitente da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumero | texto | Número da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerie | texto | Série da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUF | texto | Unidade federativa do emitente da NF relacionada |
pedido_venda_produto[].informacoes_adicionais.nsu | texto | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto[].informacoes_adicionais.numero_contrato | texto | Número do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.numero_pedido_cliente | texto | Número do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes | objeto | Outros detalhes da NF-e. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cBairroOd | texto | Bairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cBairroOdRet | texto | Bairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCEPOd | texto | CEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCEPOdRet | texto | CEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCidadeOd | texto | Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCidadeOdRet | texto | Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: "SAO PAULO (SP)" Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "cCod" do método "PesquisarCidades" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCnpjCpfOd | texto | CNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCnpjCpfOdRet | texto | CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCnpjIntOd | texto | CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção "1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cComplementoOd | texto | Complemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cComplementoOdRet | texto | Complemento do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEnderecoOd | texto | Endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEnderecoOdRet | texto | Endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEstadoOd | texto | Estado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEstadoOdRet | texto | Estado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cHoraSaidaOd | texto | Hora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cIdentificadorIntOd | texto | Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cIndicadorIntOd | texto | Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção "0-Operação sem intermediador(em site ou plataforma própria)". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cIndicadorOd | texto | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o "9 - Outros". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cInscrEstadualOd | texto | Inscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cInscrEstadualOdRet | texto | Inscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNatOperacaoOd | texto | Natureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNomeOd | texto | Nome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNomeOdRet | texto | Nome / Razão Social (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNumeroOd | texto | Número do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNumeroOdRet | texto | Número do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cSepararEnderecoOd | texto | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cSepararEnderecoOdRet | texto | Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cTelefoneOd | texto | Telefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cTelefoneOdRet | texto | Telefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.dDataSaidaOd | texto | Data de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
pedido_venda_produto[].informacoes_adicionais.tipo_documento | texto | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
pedido_venda_produto[].informacoes_adicionais.utilizar_emails | texto | Utilizar os seguintes endereços de e-mail. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. |
pedido_venda_produto[].lancamentos | lista de objetos | Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros). |
pedido_venda_produto[].lancamentos[].cCategoria | texto | Código da Categoria. |
pedido_venda_produto[].lancamentos[].cNaturezaDocumento | texto | Natureza do Documento. Pode ser: P - Pagar R - Receber Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto[].lancamentos[].cObs | texto | Observações. |
pedido_venda_produto[].lancamentos[].cOrigem | texto | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto[].lancamentos[].cTipoDocumento | texto | Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto[].lancamentos[].dDataDocumento | texto | Data do documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto[].lancamentos[].nContaCorrente | número inteiro | Id da Conta Corrente. |
pedido_venda_produto[].lancamentos[].nProjeto | número inteiro | Id do projeto. |
pedido_venda_produto[].lancamentos[].nSequencia | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
pedido_venda_produto[].lancamentos[].nValorDocumento | decimal | Valor do Documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda". |
pedido_venda_produto[].lancamentos[].nVendedor | número inteiro | Id do Vendedor. |
pedido_venda_produto[].lista_parcelas | objeto | Dados da Aba "Parcelas" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura. |
pedido_venda_produto[].lista_parcelas.parcela | lista de objetos | Dados da parcela. |
pedido_venda_produto[].lista_parcelas.parcela[].bandeira | texto | Código da Bandeira da operadora de cartão. |
pedido_venda_produto[].lista_parcelas.parcela[].categoria_adiantamento | texto | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].cnpj_fin | texto | Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. |
pedido_venda_produto[].lista_parcelas.parcela[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].data_vencimento | texto | Data de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].descr_meio_pagamento | texto | Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "xPag" do XML). Esse campo precisa ser informado quando a tag "meio_pagamento" for igual a 99 (Outros). Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto[].lista_parcelas.parcela[].meio_pagamento | texto | Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" do Pedido de Venda. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
pedido_venda_produto[].lista_parcelas.parcela[].nao_gerar_boleto | texto | Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Quando informado dentro do tag "cabecalho", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag "lista_parcelas", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].nsu | texto | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". |
pedido_venda_produto[].lista_parcelas.parcela[].numero_parcela | número inteiro | Número da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].parcela_adiantamento | texto | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].percentual | decimal | Percentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].quantidade_dias | número inteiro | Quantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].lista_parcelas.parcela[].tipo_documento | texto | Tipo de Documento. Informação localizada na Aba "Parcelas" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon"ivel na API: /api/v1/ger |
pedido_venda_produto[].lista_parcelas.parcela[].valor | decimal | Valor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda. |
pedido_venda_produto[].market_place | objeto | Dados para o Market Place. |
pedido_venda_produto[].market_place.nEnvio | decimal | Valor do envio do Market Place. |
pedido_venda_produto[].market_place.nTaxa | decimal | Valor da taxa do Market Place. |
pedido_venda_produto[].observacoes | objeto | Dados da Aba "Observações" do Pedido de Venda. |
pedido_venda_produto[].observacoes.obs_venda | texto | Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda. |
pedido_venda_produto[].total_pedido | objeto | Valores totais do pedido. |
pedido_venda_produto[].total_pedido.base_calculo_icms | decimal | Base de Cálculo do ICMS. |
pedido_venda_produto[].total_pedido.base_calculo_st | decimal | Base de cálculo da substituição tributária. |
pedido_venda_produto[].total_pedido.base_ibs_cbs | decimal | Valor total da base de cálculo do IBS e da CBS. |
pedido_venda_produto[].total_pedido.valor_IPI | decimal | Valor do IPI. |
pedido_venda_produto[].total_pedido.valor_cbs | decimal | Valor total da CBS. |
pedido_venda_produto[].total_pedido.valor_cofins | decimal | Valor do cofins. |
pedido_venda_produto[].total_pedido.valor_csll | decimal | Valor da CSLL. |
pedido_venda_produto[].total_pedido.valor_deducoes | decimal | Valor das deduções. |
pedido_venda_produto[].total_pedido.valor_descontos | decimal | Valor dos descontos. |
pedido_venda_produto[].total_pedido.valor_dif_cbs | decimal | Valor total do diferimento da CBS. |
pedido_venda_produto[].total_pedido.valor_dif_ibs_mu | decimal | Valor total do diferimento do IBS do município. |
pedido_venda_produto[].total_pedido.valor_dif_ibs_uf | decimal | Valor total do diferimento do IBS UF. |
pedido_venda_produto[].total_pedido.valor_ibs | decimal | Valor total do IBS. |
pedido_venda_produto[].total_pedido.valor_ibs_mu | decimal | Valor total do IBS do município. |
pedido_venda_produto[].total_pedido.valor_ibs_uf | decimal | Valor total do IBS da UF. |
pedido_venda_produto[].total_pedido.valor_icms | decimal | Valor total do ICMS. |
pedido_venda_produto[].total_pedido.valor_inss | decimal | Valor do INSS. |
pedido_venda_produto[].total_pedido.valor_ir | decimal | Valor do IR. .Preenchimento automático - Não informar. |
pedido_venda_produto[].total_pedido.valor_iss | decimal | Valor do ISS. |
pedido_venda_produto[].total_pedido.valor_mercadorias | decimal | valor das mercadorias. |
pedido_venda_produto[].total_pedido.valor_pis | decimal | Valor do PIS. |
pedido_venda_produto[].total_pedido.valor_st | decimal | Valor total da ST. |
pedido_venda_produto[].total_pedido.valor_tot_ibs_cbs_is | decimal | Total da NF-e com IBS/CBS/IS. |
pedido_venda_produto[].total_pedido.valor_total_pedido | decimal | Valor total do pedido. |
registros | número inteiro | |
total_de_paginas | número inteiro | |
total_de_registros | número inteiro |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarPedidos", "param": [{"pagina": 1, "registros_por_pagina": 100, "apenas_importado_api": "N"}]}'import os
import requests
corpo = {'call': 'ListarPedidos',
'param': [{'pagina': 1, 'registros_por_pagina': 100, 'apenas_importado_api': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarPedidos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 100,
"apenas_importado_api": "N"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "ListarPedidos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 100,
"apenas_importado_api": "N"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "ListarPedidos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 100,
"apenas_importado_api": "N"
}
]
}
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": "ListarPedidos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 100,
"apenas_importado_api": "N"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarPedidos"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 100, ""apenas_importado_api"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosSimula os impostos de um pedido de venda.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 9Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cliente_simul | objeto | Informações de cliente para simulação dos impostos. |
cliente_simul.cidades_codmunibge | texto · até 7 | Código do município conforme tabela do IBGE para simulação dos impostos |
cliente_simul.clientes_cnae | texto · até 7 | Informação localizada na Aba "Inscrições CNAE e Outros" do cadastro do Cliente para simulação dos impostos |
cliente_simul.clientes_contribuinte | texto · até 1 | Indica que o Cliente é Contribuinte do ICMS Informar "S" ou "N". Informação localizada na Aba "Inscrições CNAE e Outros" do cadastro do Cliente. |
cliente_simul.clientes_estado | texto · até 2 | Informação localizada na Aba "Endereço" do cadastro do Cliente. Utilize a tag "cSigla" do método "ListarEstados" da API /api/v1/geral/estados/ para obter essa informação. |
cliente_simul.clientes_suframa | texto · até 20 | Inscrição SUFRAMA do cliente para simulação dos impostos. Informação localizada na Aba "Inscrições CNAE e Outros" do cadastro do Cliente |
cliente_simul.optante_simples_nacional | texto · até 1 | Indica se o Cliente / Fornecedor é Optante do Simples Nacional Informar "S" ou "N". Informação localizada na Aba "Inscrições CNAE e Outros" do cadastro do Cliente. |
cliente_simul.tipo_atividade | texto · até 1 | Tipo da Atividade Informação localizada na Aba "Inscrições CNAE e Outros" do cadastro do Cliente. Utilize a tag "cCodigo" do método "ListarTipoAtiv" da API http://app.omie.com.br/api/v1/geral/tpativ/ para obter essa informação. |
codigo_cliente | número inteiro | Código de identificação do cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API /api/v1/geral/clientes/ para obter essa informação. |
codigo_cliente_integracao | texto · até 60 | Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
consumidor_final | texto · até 1 | Indicativo se a venda seria para consumidor final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
det_simul | lista de objetos | Dados do item do Pedido de Vendas para simulação dos impostos. |
det_simul[].codigo_cenario_impostos_item | número inteiro | Código do Cenário de Impostos. |
det_simul[].produto_simul | objeto | Informações do produto para simulação dos impostos. |
det_simul[].produto_simul.codigo_item_integracao | texto · até 30 | Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido. |
det_simul[].produto_simul.codigo_produto | número inteiro | ID do Produto Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag "codigo_produto" do método "ListarProdutos" da API /api/v1/geral/produtos/ para obter essa informação. |
det_simul[].produto_simul.codigo_produto_integracao | texto · até 60 | Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "codigo_produto". |
det_simul[].produto_simul.quantidadeobrigatório | número | Quantidade do produto para simulação dos impostos. |
det_simul[].produto_simul.valor_desconto | número | Valor do desconto do item, se houver, para ser considerado na simulação dos impostos. |
det_simul[].produto_simul.valor_unitarioobrigatório | número | Valor unitário para simulação dos impostos |
frete_simul | objeto | Dados da Aba "Frete e Outras Despesas" do Pedido de Venda para simulação dos impostos. |
frete_simul.outras_despesas | número | Valor das outras despesas para simulação dos impostos |
frete_simul.valor_frete | número | Valor do Frete |
frete_simul.valor_seguro | número | Valor do seguro para simulação de impostos. |
impostos_embutidos | texto · até 1 | |
indPresenca | texto · até 1 | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Mesma informação da na Aba "Informações Adicionais" do Pedido de Venda. |
uf_entrega | texto · até 2 | Estado onde ocorrerá a entrega do produto. Só preencher esse essa informação caso a entrega do produto não seja no mesmo endereço do cadastro do cliente. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_cliente | número inteiro | Código interno do cliente |
codigo_cliente_integracao | texto | Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
consumidor_final | texto | Indicação se a venda para é consumo final |
det_simul_resp | lista de objetos | Retorno com o detalhe do item com a simulação de impostos |
det_simul_resp[].codigo_cenario_impostos_item | número inteiro | Cenário de impostos do item para simulação |
det_simul_resp[].imposto | objeto | Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados. |
det_simul_resp[].imposto.cbs | objeto | |
det_simul_resp[].imposto.cbs.aliquota_cbs | decimal | Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.cbs.perc_dif_cbs | decimal | Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.cbs.perc_red_cbs | decimal | Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.cbs.valor_cbs | decimal | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.cbs.valor_dif_cbs | decimal | Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.cofins_padrao | objeto | COFINS. |
det_simul_resp[].imposto.cofins_padrao.aliq_cofins | decimal | |
det_simul_resp[].imposto.cofins_padrao.base_cofins | decimal | |
det_simul_resp[].imposto.cofins_padrao.cod_sit_trib_cofins | texto | |
det_simul_resp[].imposto.cofins_padrao.qtde_unid_trib_cofins | decimal | |
det_simul_resp[].imposto.cofins_padrao.tipo_calculo_cofins | texto | |
det_simul_resp[].imposto.cofins_padrao.valor_cofins | decimal | |
det_simul_resp[].imposto.cofins_padrao.valor_unid_trib_cofins | decimal | |
det_simul_resp[].imposto.cofins_st | objeto | COFINS - Substituição Tributária. |
det_simul_resp[].imposto.cofins_st.aliq_cofins_st | decimal | |
det_simul_resp[].imposto.cofins_st.base_cofins_st | decimal | |
det_simul_resp[].imposto.cofins_st.cod_sit_trib_cofins_st | texto | |
det_simul_resp[].imposto.cofins_st.margem_cofins_st | decimal | |
det_simul_resp[].imposto.cofins_st.qtde_unid_trib_cofins_st | decimal | |
det_simul_resp[].imposto.cofins_st.tipo_calculo_cofins_st | texto | |
det_simul_resp[].imposto.cofins_st.valor_cofins_st | decimal | |
det_simul_resp[].imposto.cofins_st.valor_unid_trib_cofins_st | decimal | |
det_simul_resp[].imposto.csll | objeto | CSLL. |
det_simul_resp[].imposto.csll.aliq_csll | decimal | |
det_simul_resp[].imposto.csll.valor_csll | decimal | |
det_simul_resp[].imposto.ibs | objeto | |
det_simul_resp[].imposto.ibs.aliquota_ibs_mu | decimal | Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.aliquota_ibs_uf | decimal | Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.perc_dif_ibs_mu | decimal | Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.perc_dif_ibs_uf | decimal | Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.perc_red_ibs_mu | decimal | Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.perc_red_ibs_uf | decimal | Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal. |
det_simul_resp[].imposto.ibs.valor_dif_ibs_mu | decimal | Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.valor_dif_ibs_uf | decimal | Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.valor_ibs | decimal | Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.valor_ibs_mu | decimal | Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs.valor_ibs_uf | decimal | Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs_cbs | objeto | |
det_simul_resp[].imposto.ibs_cbs.base_ibs_cbs | decimal | Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs_cbs.class_trib | texto | Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.ibs_cbs.cst_ibs_cbs | texto | Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.icms | objeto | ICMS |
det_simul_resp[].imposto.icms.aliq_icms | decimal | |
det_simul_resp[].imposto.icms.base_fcp_icms | decimal | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS. |
det_simul_resp[].imposto.icms.base_icms | decimal | |
det_simul_resp[].imposto.icms.cod_sit_trib_icms | texto | |
det_simul_resp[].imposto.icms.modalidade_icms | texto | |
det_simul_resp[].imposto.icms.origem_icms | texto | |
det_simul_resp[].imposto.icms.perc_fcp_icms | decimal | Percentual do FCP - Fundo de Combate a Pobreza do ICMS. |
det_simul_resp[].imposto.icms.perc_red_base_icms | decimal | |
det_simul_resp[].imposto.icms.valor_fcp_icms | decimal | Valor do FCP - Fundo de Combate a Pobreza do ICMS. |
det_simul_resp[].imposto.icms.valor_icms | decimal | |
det_simul_resp[].imposto.icms_efet | objeto | ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem |
det_simul_resp[].imposto.icms_efet.aliq_icms_efet | decimal | |
det_simul_resp[].imposto.icms_efet.base_icms_efet | decimal | |
det_simul_resp[].imposto.icms_efet.cod_sit_trib_icms_efet | texto | |
det_simul_resp[].imposto.icms_efet.modalidade_icms_efet | texto | |
det_simul_resp[].imposto.icms_efet.origem_icms_efet | texto | |
det_simul_resp[].imposto.icms_efet.perc_red_base_icms_efet | decimal | |
det_simul_resp[].imposto.icms_efet.valor_icms_efet | decimal | |
det_simul_resp[].imposto.icms_ie | objeto | ICMS Interestadual. |
det_simul_resp[].imposto.icms_ie.aliq_icms_FCP | decimal | Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino |
det_simul_resp[].imposto.icms_ie.aliq_interestadual | decimal | Alíquota Interestadual das UFs Envolvidas |
det_simul_resp[].imposto.icms_ie.aliq_interna_uf_destino | decimal | Alíquota Interna da UF de Destino |
det_simul_resp[].imposto.icms_ie.aliq_partilha_icms | decimal | Percentual Provisório de Partilha do ICMS Interestadual |
det_simul_resp[].imposto.icms_ie.base_icms_uf_destino | decimal | BC do ICMS na UF de Destino |
det_simul_resp[].imposto.icms_ie.valor_fcp_icms_inter | decimal | Valor do fundo de combate a pobreza. |
det_simul_resp[].imposto.icms_ie.valor_icms_uf_dest | decimal | Valor do ICMS - UF Destino |
det_simul_resp[].imposto.icms_ie.valor_icms_uf_remet | decimal | Valor do ICMS - UF Remetente |
det_simul_resp[].imposto.icms_sn | objeto | ICMS - Simples Nacional. |
det_simul_resp[].imposto.icms_sn.aliq_icms_sn | decimal | |
det_simul_resp[].imposto.icms_sn.base_icms_sn | decimal | |
det_simul_resp[].imposto.icms_sn.cod_sit_trib_icms_sn | texto | |
det_simul_resp[].imposto.icms_sn.origem_icms_sn | texto | |
det_simul_resp[].imposto.icms_sn.valor_credito_icms_sn | decimal | |
det_simul_resp[].imposto.icms_sn.valor_icms_sn | decimal | |
det_simul_resp[].imposto.icms_st | objeto | ICMS - Substituição Tributária. |
det_simul_resp[].imposto.icms_st.aliq_icms_opprop | decimal | Alíquota de ICMS Operação Própria. |
det_simul_resp[].imposto.icms_st.aliq_icms_st | decimal | |
det_simul_resp[].imposto.icms_st.base_fcp_icms_st | decimal | Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det_simul_resp[].imposto.icms_st.base_icms_st | decimal | |
det_simul_resp[].imposto.icms_st.cest | texto | CEST - Código Especificador da Substituíção Tributária. |
det_simul_resp[].imposto.icms_st.cod_sit_trib_icms_st | texto | |
det_simul_resp[].imposto.icms_st.margem_icms_st | decimal | |
det_simul_resp[].imposto.icms_st.modalidade_icms_st | texto | |
det_simul_resp[].imposto.icms_st.perc_fcp_icms_st | decimal | Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det_simul_resp[].imposto.icms_st.perc_red_base_icms_op | decimal | Percentual de redução de base de cálculo de Icms Operação Própria. |
det_simul_resp[].imposto.icms_st.perc_red_base_icms_st | decimal | |
det_simul_resp[].imposto.icms_st.valor_fcp_icms_st | decimal | Valor do FCP - Fundo de Combate a Pobreza do ICMS ST. |
det_simul_resp[].imposto.icms_st.valor_icms_st | decimal | |
det_simul_resp[].imposto.inss | objeto | INSS. |
det_simul_resp[].imposto.inss.aliq_inss | decimal | |
det_simul_resp[].imposto.inss.valor_inss | decimal | |
det_simul_resp[].imposto.ipi | objeto | IPI. |
det_simul_resp[].imposto.ipi.aliq_ipi | decimal | |
det_simul_resp[].imposto.ipi.base_ipi | decimal | |
det_simul_resp[].imposto.ipi.cod_sit_trib_ipi | texto | |
det_simul_resp[].imposto.ipi.enquadramento_ipi | texto | Enquadramento do IPI |
det_simul_resp[].imposto.ipi.qtde_unid_trib_ipi | decimal | |
det_simul_resp[].imposto.ipi.tipo_calculo_ipi | texto | |
det_simul_resp[].imposto.ipi.valor_ipi | decimal | |
det_simul_resp[].imposto.ipi.valor_unid_trib_ipi | decimal | |
det_simul_resp[].imposto.irrf | objeto | IRRF. |
det_simul_resp[].imposto.irrf.aliq_irrf | decimal | |
det_simul_resp[].imposto.irrf.valor_irrf | decimal | |
det_simul_resp[].imposto.iss | objeto | ISS. |
det_simul_resp[].imposto.iss.aliq_iss | decimal | |
det_simul_resp[].imposto.iss.base_iss | decimal | |
det_simul_resp[].imposto.iss.retem_iss | texto | |
det_simul_resp[].imposto.iss.valor_iss | decimal | |
det_simul_resp[].imposto.pis_padrao | objeto | PIS. |
det_simul_resp[].imposto.pis_padrao.aliq_pis | decimal | |
det_simul_resp[].imposto.pis_padrao.base_pis | decimal | |
det_simul_resp[].imposto.pis_padrao.cod_sit_trib_pis | texto | |
det_simul_resp[].imposto.pis_padrao.qtde_unid_trib_pis | decimal | |
det_simul_resp[].imposto.pis_padrao.tipo_calculo_pis | texto | |
det_simul_resp[].imposto.pis_padrao.valor_pis | decimal | |
det_simul_resp[].imposto.pis_padrao.valor_unid_trib_pis | decimal | |
det_simul_resp[].imposto.pis_st | objeto | PIS - Substituíção Tributária. |
det_simul_resp[].imposto.pis_st.aliq_pis_st | decimal | |
det_simul_resp[].imposto.pis_st.base_pis_st | decimal | |
det_simul_resp[].imposto.pis_st.cod_sit_trib_pis_st | texto | |
det_simul_resp[].imposto.pis_st.margem_pis_st | decimal | |
det_simul_resp[].imposto.pis_st.qtde_unid_trib_pis_st | decimal | |
det_simul_resp[].imposto.pis_st.tipo_calculo_pis_st | texto | |
det_simul_resp[].imposto.pis_st.valor_pis_st | decimal | |
det_simul_resp[].imposto.pis_st.valor_unid_trib_pis_st | decimal | |
det_simul_resp[].imposto.trib_reg | objeto | |
det_simul_resp[].imposto.trib_reg.aliquota_reg_cbs | decimal | Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.aliquota_reg_ibs_mu | decimal | Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.aliquota_reg_ibs_uf | decimal | Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.class_trib_reg | texto | Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.cst_reg_ibs_cst | texto | Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.valor_reg_cbs | decimal | Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.valor_reg_ibs_mu | decimal | Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].imposto.trib_reg.valor_reg_ibs_uf | decimal | Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido. |
det_simul_resp[].produto_simul_resp | objeto | Informações do produto para simulação de impostos |
det_simul_resp[].produto_simul_resp.cfop | texto | CFOP - Código Fiscal de Operações e Prestações. |
det_simul_resp[].produto_simul_resp.codigo_item_integracao | texto | Código de Integração do Item do Pedido de Venda. Código informado em "codigo_item_integracao" ou vazio se o produto for componente de um kit. Presente se a tag "codigo_item_integracao" for informada. |
det_simul_resp[].produto_simul_resp.codigo_item_kit | número inteiro | ID do Item do kit (pai) que o componente pertence. Presente se a tag "codigo_item_integracao" for informada. |
det_simul_resp[].produto_simul_resp.codigo_produto | número inteiro | ID do Produto Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag "codigo_produto" do método "ListarProdutos" da API /api/v1/geral/produtos/ para obter essa informação. |
det_simul_resp[].produto_simul_resp.codigo_produto_integracao | texto | Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "codigo_produto". |
det_simul_resp[].produto_simul_resp.motivo_icms_desonerado | texto | Código do Motivo de desoneração do ICMS Códigos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco |
det_simul_resp[].produto_simul_resp.quantidade | decimal | Quantidade do produto para simulação dos impostos. |
det_simul_resp[].produto_simul_resp.valor_desconto | decimal | Valor do desconto do item, se houver, para ser considerado na simulação dos impostos. |
det_simul_resp[].produto_simul_resp.valor_icms_desonerado | decimal | Valor do ICMS desonerado |
det_simul_resp[].produto_simul_resp.valor_total | decimal | Valor Total. |
det_simul_resp[].produto_simul_resp.valor_unitario | decimal | Valor unitário para simulação dos impostos |
frete_simul | objeto | Dados da Aba "Frete e Outras Despesas" do Pedido de Venda para simulação dos impostos. |
frete_simul.outras_despesas | decimal | Valor das outras despesas para simulação dos impostos |
frete_simul.valor_frete | decimal | Valor do Frete |
frete_simul.valor_seguro | decimal | Valor do seguro para simulação de impostos. |
indPresenca | texto | Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Mesma informação da na Aba "Informações Adicionais" do Pedido de Venda. |
uf_entrega | texto | Estado onde ocorrerá a entrega do produto. Só preencher esse essa informação caso a entrega do produto não seja no mesmo endereço do cadastro do cliente. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "SimularImpostos", "param": [{"codigo_cliente": 0, "consumidor_final": "", "frete_simul": {"valor_frete": 0, "valor_seguro": 0, "outras_despesas": 0}, "det_simul": [{"codigo_cenario_impostos_item": 0, "produto_simul": {"codigo_produto": 0, "quantidade": 0, "valor_unitario": 0, "valor_desconto": 0}}]}]}'import os
import requests
corpo = {'call': 'SimularImpostos',
'param': [{'codigo_cliente': 0,
'consumidor_final': '',
'frete_simul': {'valor_frete': 0, 'valor_seguro': 0, 'outras_despesas': 0},
'det_simul': [{'codigo_cenario_impostos_item': 0,
'produto_simul': {'codigo_produto': 0,
'quantidade': 0,
'valor_unitario': 0,
'valor_desconto': 0}}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "SimularImpostos",
"param": [
{
"codigo_cliente": 0,
"consumidor_final": "",
"frete_simul": {
"valor_frete": 0,
"valor_seguro": 0,
"outras_despesas": 0
},
"det_simul": [
{
"codigo_cenario_impostos_item": 0,
"produto_simul": {
"codigo_produto": 0,
"quantidade": 0,
"valor_unitario": 0,
"valor_desconto": 0
}
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "SimularImpostos",
"param": [
{
"codigo_cliente": 0,
"consumidor_final": "",
"frete_simul": {
"valor_frete": 0,
"valor_seguro": 0,
"outras_despesas": 0
},
"det_simul": [
{
"codigo_cenario_impostos_item": 0,
"produto_simul": {
"codigo_produto": 0,
"quantidade": 0,
"valor_unitario": 0,
"valor_desconto": 0
}
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "SimularImpostos",
"param": [
{
"codigo_cliente": 0,
"consumidor_final": "",
"frete_simul": {
"valor_frete": 0,
"valor_seguro": 0,
"outras_despesas": 0
},
"det_simul": [
{
"codigo_cenario_impostos_item": 0,
"produto_simul": {
"codigo_produto": 0,
"quantidade": 0,
"valor_unitario": 0,
"valor_desconto": 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": "SimularImpostos",
"param": [
{
"codigo_cliente": 0,
"consumidor_final": "",
"frete_simul": {
"valor_frete": 0,
"valor_seguro": 0,
"outras_despesas": 0
},
"det_simul": [
{
"codigo_cenario_impostos_item": 0,
"produto_simul": {
"codigo_produto": 0,
"quantidade": 0,
"valor_unitario": 0,
"valor_desconto": 0
}
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""SimularImpostos"", ""param"": [{""codigo_cliente"": 0, ""consumidor_final"": """", ""frete_simul"": {""valor_frete"": 0, ""valor_seguro"": 0, ""outras_despesas"": 0}, ""det_simul"": [{""codigo_cenario_impostos_item"": 0, ""produto_simul"": {""codigo_produto"": 0, ""quantidade"": 0, ""valor_unitario"": 0, ""valor_desconto"": 0}}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta do Status do Pedido
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
Retorno 9O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
ListaNfe | lista de objetos | Lista de NF-es geradas |
ListaNfe[].chave_nfe | texto | Chave de Acesso da NF-e |
ListaNfe[].contingencia | texto | NF-e emitida em contingência |
ListaNfe[].danfe | texto | Link para o DANFE da NF-e gerada. |
ListaNfe[].data_emissao | texto | Data da Emissão da NF-e |
ListaNfe[].data_fatura | texto | Data do faturamento |
ListaNfe[].data_saida | texto | Data de Saída |
ListaNfe[].hora_emissao | texto | Hora da Emissão da NF-e |
ListaNfe[].hora_fatura | texto | Hora de Faturamento |
ListaNfe[].hora_saida | texto | Hora de Saída da NF-e |
ListaNfe[].mensagens | lista de objetos | Mensagens de Erros |
ListaNfe[].mensagens[].cCodigo | texto | Código da mensagem de erro/aviso |
ListaNfe[].mensagens[].cCorrecao | texto | Correção da descrição de mensagem de erro/aviso. |
ListaNfe[].mensagens[].cDescricao | texto | Descrição da mensagem de erro/aviso. |
ListaNfe[].numero_lote | número inteiro | Número do lote da NF-e |
ListaNfe[].numero_nfe | texto | Número da NF-e gerada |
ListaNfe[].protocolo | número inteiro | Número do Protocolo |
ListaNfe[].recibo | número inteiro | Recibo |
ListaNfe[].serie_nfe | texto | Série da NF-e |
ListaNfe[].status_lote | texto | Status do Lote da NF-e. |
ListaNfe[].status_nfe | texto | Status da NF-e |
ListaNfe[].tipo | texto | Tipo de Emissão. Pode ser: E - Entrada S - Saída |
ListaNfe[].xml_distr | texto | XML de distribuição da NF-e |
ambiente | texto | |
cancelada | texto | NF-e Cancelada? |
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
etapa | texto | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
faturada | texto | |
numero_pedido | texto | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
valor_total_pedido | decimal | Valor total do pedido |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "StatusPedido", "param": [{"codigo_pedido": 0, "codigo_pedido_integracao": ""}]}'import os
import requests
corpo = {'call': 'StatusPedido',
'param': [{'codigo_pedido': 0, 'codigo_pedido_integracao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "StatusPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "StatusPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "StatusPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}
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": "StatusPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""StatusPedido"", ""param"": [{""codigo_pedido"": 0, ""codigo_pedido_integracao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosTroca etapa do pedido.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
etapa | texto · até 2 | Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar. |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto · até 60 | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
numero_pedido | texto · até 15 | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_pedido | número inteiro | ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. |
codigo_pedido_integracao | texto | Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
codigo_status | texto | Código do Status do Pedido de Venda. |
descricao_status | texto | Descrição do status. |
numero_pedido | texto | Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela. |
POST /api/v1/produtos/pedido/
curl -s https://app.omie.com.br/api/v1/produtos/pedido/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "TrocarEtapaPedido", "param": [{"codigo_pedido": 0, "codigo_pedido_integracao": "", "etapa": "20"}]}'import os
import requests
corpo = {'call': 'TrocarEtapaPedido',
'param': [{'codigo_pedido': 0, 'codigo_pedido_integracao': '', 'etapa': '20'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedido/",
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/pedido/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "TrocarEtapaPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"etapa": "20"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedido/");
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": "TrocarEtapaPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"etapa": "20"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedido/")
corpo = <<~'JSON'
{
"call": "TrocarEtapaPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"etapa": "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": "TrocarEtapaPedido",
"param": [
{
"codigo_pedido": 0,
"codigo_pedido_integracao": "",
"etapa": "20"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedido/"))
.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/pedido/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""TrocarEtapaPedido"", ""param"": [{""codigo_pedido"": 0, ""codigo_pedido_integracao"": """", ""etapa"": ""20""}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados