OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Produtos · PedidoVendaProduto

Pedido de Vendas de Produtos

POSThttps://app.omie.com.br/api/v1/produtos/pedido/WSDL
4consultas
6alterações
Claude 10 de 10 · ChatGPT 4 de 10 · MCP 10 de 10pelos assistentes de IA
JSON · XMLformato

AlterarPedFaturado

altera dadosClaudeMCP

Alteração dos dados de um pedido faturado.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 7Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotexto · até 60Có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_rastreiotexto · até 500Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
link_rastreiotexto · até 300Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'.
numero_pedidotexto · até 15Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela.
obs_vendatextoObservações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda.
previsao_entregatexto · até 10Previsã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
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotextoCó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_statustextoCódigo do Status do Pedido de Venda.
descricao_statustextoDescrição do status.
numero_pedidotextoNú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": ""}]}'

AlterarPedidoVenda

altera dadosClaudeMCP

Alteração do Pedido de Venda

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 13Campos e estruturas que você pode enviar
CampoTipoDescrição
agropecuarioobjeto
agropecuario.cCpfResponsaveltexto · até 14CPF do responsá¡vel técnico legalmente habilitado
agropecuario.cNumReceitatexto · até 20Número da receita ou receituário do agrotóxico/defensivo agrícola
agropecuario.cSerieGuiatexto · até 9Número de série da guia
agropecuario.cUFGuiatexto · até 2UF de emissão da Guia
agropecuario.nNumGuianúmero inteiroNúmero da guia
agropecuario.nTipoGuianúmero inteiroTipo 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)
cabecalhoobjetoInformações do cabeçalho do pedido.
cabecalho.bloqueadotexto · até 1Pedido Bloqueado pela API.
cabecalho.codigo_cenario_impostosnúmero inteiroCódigo do Cenário de Impostos. Se não informado, será assumido o cenário padrão.
cabecalho.codigo_clientenúmero inteiroCó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_integracaotexto · até 60Có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_empresadescontinuadonúmero inteiroDEPRECATED
cabecalho.codigo_empresa_integracaodescontinuadotexto · até 20DEPRECATED
cabecalho.codigo_parcelatexto · até 3Có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_pedidonúmero inteiroID 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_integracaotexto · até 60Có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_previsaotexto · até 10Data 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_datatexto · até 10Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.enc_horatexto · até 8Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.enc_motivotexto · até 100Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.enc_usertexto · até 10Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.encerradotexto · até 1Indica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta.Ex.: S, N
cabecalho.etapatexto · até 2Etapa 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_apitexto · até 1Pedido de venda de produto importada pela API.
cabecalho.nao_gerar_boletotexto · até 1Indica 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_pedidotexto · até 15Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela.
cabecalho.origem_pedidotexto · até 3Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda.
cabecalho.perc_desconto_pedidonúmeroPercentual 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_parcelasnúmero inteiroQuantidade de parcelas. Valores permitidos de 1 a 999.
cabecalho.quantidade_itensnúmero inteiroQuantidade de Itens.
cabecalho.sequencialtexto · até 4Nú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_pedidotexto · até 1Tipo 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_pedidonúmeroValor 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.
departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
departamentos[].cCodDeptotexto · até 40ID 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[].nPercnúmeroPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
departamentos[].nValornúmeroValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
departamentos[].nValorFixotexto · até 1Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda.
detlista de objetosDados da Aba "Itens da Venda" do Pedido de Venda.
det[].combustivelobjetoDetalhamento específico de Combustível.
det[].combustivel.cCODIFtexto · até 21Registro do CODIF.
det[].combustivel.cCodigoANPtexto · até 9Código de Produto da ANP.
det[].combustivel.cDescrANPtexto · até 95Descrição do Produto conforme ANP.
det[].combustivel.cUFConsumoCombtexto · até 2UF de Consumo.
det[].combustivel.nAliquota_CIDEnúmeroValor da Alíquota em Reais da CIDE.
det[].combustivel.nBC_CIDEnúmeroBase de Cálculo (em quantidade) da CIDE.
det[].combustivel.nBC_UFDestnúmeroBase de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
det[].combustivel.nBC_UFRemnúmeroBase de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária.
det[].combustivel.nPercGLPnúmeroPercentual de GLP Derivado do Petróleo.
det[].combustivel.nPercGasImportadonúmeroPercentual de Gás Natural Importado.
det[].combustivel.nPercGasNacionalnúmeroPercentual de Gás Natural Nacional.
det[].combustivel.nQtdeFatTempAmbnúmeroQuantidade Faturada à Temperatura Ambiente.
det[].combustivel.nValorPartidanúmeroValor de Partida.
det[].combustivel.nValorUFDestnúmeroValor da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
det[].combustivel.nValorUFRemnúmeroValor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária.
det[].combustivel.nValor_CIDEnúmeroValor da CIDE.
det[].ideobjetoIdentificação do Item do Pedido de Vendas.
det[].ide.acao_itemtexto · até 1Ação para o item. Pode ser: "E" - para excluir um item.
det[].ide.codigo_itemnúmero inteiroID do Item do Pedido.
det[].ide.codigo_item_integracaotexto · até 30Có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_producaonúmero inteiroId 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_impostosdescontinuadonúmero inteiroDEPRECATED
det[].ide.simples_nacionaltexto · até 1Indica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N".
det[].impostoobjetoInformaçõ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.cbsobjeto
det[].imposto.cbs.aliquota_cbsnúmeroAlí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_cbsnúmeroPercentual 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_cbsnúmeroPercentual 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_cbsnúmeroValor 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_cbsnúmeroValor 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_padraoobjetoCOFINS.
det[].imposto.cofins_padrao.aliq_cofinsnúmero
det[].imposto.cofins_padrao.base_cofinsnúmero
det[].imposto.cofins_padrao.cod_sit_trib_cofinstexto · até 2
det[].imposto.cofins_padrao.qtde_unid_trib_cofinsnúmero
det[].imposto.cofins_padrao.tipo_calculo_cofinstexto · até 1
det[].imposto.cofins_padrao.valor_cofinsnúmero
det[].imposto.cofins_padrao.valor_unid_trib_cofinsnúmero
det[].imposto.cofins_stobjetoCOFINS - Substituição Tributária.
det[].imposto.cofins_st.aliq_cofins_stnúmero
det[].imposto.cofins_st.base_cofins_stnúmero
det[].imposto.cofins_st.cod_sit_trib_cofins_sttexto · até 2
det[].imposto.cofins_st.margem_cofins_stnúmero
det[].imposto.cofins_st.qtde_unid_trib_cofins_stnúmero
det[].imposto.cofins_st.tipo_calculo_cofins_sttexto · até 1
det[].imposto.cofins_st.valor_cofins_stnúmero
det[].imposto.cofins_st.valor_unid_trib_cofins_stnúmero
det[].imposto.csllobjetoCSLL.
det[].imposto.csll.aliq_csllnúmero
det[].imposto.csll.valor_csllnúmero
det[].imposto.ibsobjeto
det[].imposto.ibs.aliquota_ibs_munúmeroAlí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_ufnúmeroAlí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_munúmeroPercentual 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_ufnúmeroPercentual 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_munúmeroPercentual 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_ufnúmeroPercentual 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_munúmeroValor 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_ufnúmeroValor 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_ibsnúmeroValor 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_munúmeroValor 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_ufnúmeroValor 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_cbsobjeto
det[].imposto.ibs_cbs.base_ibs_cbsnúmeroBase 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_tribtexto · até 6Có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_cbstexto · até 3Có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.icmsobjetoICMS
det[].imposto.icms.aliq_icmsnúmero
det[].imposto.icms.base_fcp_icmsnúmeroBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS.
det[].imposto.icms.base_icmsnúmero
det[].imposto.icms.cod_sit_trib_icmstexto · até 2
det[].imposto.icms.modalidade_icmstexto · até 1
det[].imposto.icms.origem_icmstexto · até 1
det[].imposto.icms.perc_fcp_icmsnúmeroPercentual do FCP - Fundo de Combate a Pobreza do ICMS.
det[].imposto.icms.perc_red_base_icmsnúmero
det[].imposto.icms.valor_fcp_icmsnúmeroValor do FCP - Fundo de Combate a Pobreza do ICMS.
det[].imposto.icms.valor_icmsnúmero
det[].imposto.icms_efetobjetoICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem
det[].imposto.icms_efet.aliq_icms_efetnúmero
det[].imposto.icms_efet.base_icms_efetnúmero
det[].imposto.icms_efet.cod_sit_trib_icms_efettexto · até 2
det[].imposto.icms_efet.modalidade_icms_efettexto · até 1
det[].imposto.icms_efet.origem_icms_efettexto · até 1
det[].imposto.icms_efet.perc_red_base_icms_efetnúmero
det[].imposto.icms_efet.valor_icms_efetnúmero
det[].imposto.icms_ieobjetoICMS Interestadual.
det[].imposto.icms_ie.aliq_icms_FCPnúmeroPercentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino
det[].imposto.icms_ie.aliq_interestadualnúmeroAlíquota Interestadual das UFs Envolvidas
det[].imposto.icms_ie.aliq_interna_uf_destinonúmeroAlíquota Interna da UF de Destino
det[].imposto.icms_ie.aliq_partilha_icmsnúmeroPercentual Provisório de Partilha do ICMS Interestadual
det[].imposto.icms_ie.base_icms_uf_destinonúmeroBC do ICMS na UF de Destino
det[].imposto.icms_ie.valor_fcp_icms_internúmeroValor do fundo de combate a pobreza.
det[].imposto.icms_ie.valor_icms_uf_destnúmeroValor do ICMS - UF Destino
det[].imposto.icms_ie.valor_icms_uf_remetnúmeroValor do ICMS - UF Remetente
det[].imposto.icms_snobjetoICMS - Simples Nacional.
det[].imposto.icms_sn.aliq_icms_snnúmero
det[].imposto.icms_sn.base_icms_snnúmero
det[].imposto.icms_sn.cod_sit_trib_icms_sntexto · até 3
det[].imposto.icms_sn.origem_icms_sntexto · até 1
det[].imposto.icms_sn.valor_credito_icms_snnúmero
det[].imposto.icms_sn.valor_icms_snnúmero
det[].imposto.icms_stobjetoICMS - Substituição Tributária.
det[].imposto.icms_st.aliq_icms_oppropnúmeroAlíquota de ICMS Operação Própria.
det[].imposto.icms_st.aliq_icms_stnúmero
det[].imposto.icms_st.base_fcp_icms_stnúmeroBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST.
det[].imposto.icms_st.base_icms_stnúmero
det[].imposto.icms_st.cesttexto · até 9CEST - Código Especificador da Substituíção Tributária.
det[].imposto.icms_st.cod_sit_trib_icms_sttexto · até 2
det[].imposto.icms_st.margem_icms_stnúmero
det[].imposto.icms_st.modalidade_icms_sttexto · até 1
det[].imposto.icms_st.perc_fcp_icms_stnúmeroPercentual do FCP - Fundo de Combate a Pobreza do ICMS ST.
det[].imposto.icms_st.perc_red_base_icms_opnúmeroPercentual de redução de base de cálculo de Icms Operação Própria.
det[].imposto.icms_st.perc_red_base_icms_stnúmero
det[].imposto.icms_st.valor_fcp_icms_stnúmeroValor do FCP - Fundo de Combate a Pobreza do ICMS ST.
det[].imposto.icms_st.valor_icms_stnúmero
det[].imposto.inssobjetoINSS.
det[].imposto.inss.aliq_inssnúmero
det[].imposto.inss.valor_inssnúmero
det[].imposto.ipiobjetoIPI.
det[].imposto.ipi.aliq_ipinúmero
det[].imposto.ipi.base_ipinúmero
det[].imposto.ipi.cod_sit_trib_ipitexto · até 2
det[].imposto.ipi.enquadramento_ipitextoEnquadramento do IPI
det[].imposto.ipi.qtde_unid_trib_ipinúmero
det[].imposto.ipi.tipo_calculo_ipitexto · até 1
det[].imposto.ipi.valor_ipinúmero
det[].imposto.ipi.valor_unid_trib_ipinúmero
det[].imposto.irrfobjetoIRRF.
det[].imposto.irrf.aliq_irrfnúmero
det[].imposto.irrf.valor_irrfnúmero
det[].imposto.issobjetoISS.
det[].imposto.iss.aliq_issnúmero
det[].imposto.iss.base_issnúmero
det[].imposto.iss.retem_isstexto · até 1
det[].imposto.iss.valor_issnúmero
det[].imposto.pis_padraoobjetoPIS.
det[].imposto.pis_padrao.aliq_pisnúmero
det[].imposto.pis_padrao.base_pisnúmero
det[].imposto.pis_padrao.cod_sit_trib_pistexto · até 2
det[].imposto.pis_padrao.qtde_unid_trib_pisnúmero
det[].imposto.pis_padrao.tipo_calculo_pistexto · até 1
det[].imposto.pis_padrao.valor_pisnúmero
det[].imposto.pis_padrao.valor_unid_trib_pisnúmero
det[].imposto.pis_stobjetoPIS - Substituíção Tributária.
det[].imposto.pis_st.aliq_pis_stnúmero
det[].imposto.pis_st.base_pis_stnúmero
det[].imposto.pis_st.cod_sit_trib_pis_sttexto · até 2
det[].imposto.pis_st.margem_pis_stnúmero
det[].imposto.pis_st.qtde_unid_trib_pis_stnúmero
det[].imposto.pis_st.tipo_calculo_pis_sttexto · até 1
det[].imposto.pis_st.valor_pis_stnúmero
det[].imposto.pis_st.valor_unid_trib_pis_stnúmero
det[].imposto.trib_regobjeto
det[].imposto.trib_reg.aliquota_reg_cbsnúmeroValor 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_munúmeroValor 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_ufnúmeroValor 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_regtexto · até 6Có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_csttexto · até 3Có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_cbsnúmeroValor 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_munúmeroValor 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_ufnúmeroValor 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_adicobjetoDados da aba "Informações Adicionais" do Item do Pedido de Vendas.
det[].inf_adic.codigo_beneficio_fiscaltexto · até 10Código do Benefício Fiscal.
det[].inf_adic.codigo_categoria_itemtexto · até 20Código da Categoria do item.
det[].inf_adic.codigo_cenario_impostos_itemnúmero inteiroCódigo do Cenário de Impostos.
det[].inf_adic.codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
det[].inf_adic.dados_adicionais_itemtextoInformações para a Nota Fiscal.
det[].inf_adic.item_pedido_compranúmero inteiroItem do Pedido de Compra.
det[].inf_adic.nao_gerar_financeirotexto · até 1Não gerar conta a receber para este item. Informar "S" ou "N". (Informe "S" para ativar essa opção).
det[].inf_adic.nao_movimentar_estoquetexto · até 1Nã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_totaltexto · até 1Não somar este item no total da NF-e
det[].inf_adic.numero_fcitexto · até 36Número da FCI (Ficha de Conteúdo de Importação)
det[].inf_adic.numero_pedido_compratexto · até 15Número do Pedido de Compra.
det[].inf_adic.numero_recopitexto · até 20Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune).
det[].inf_adic.peso_brutonúmeroPeso Bruto (Kg).
det[].inf_adic.peso_liquidonúmeroPeso Líquido (Kg).
det[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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órionúmeroInforme 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[].observacaoobjetoDados da aba "Observações" do Item do Pedido de Vendas.
det[].observacao.obs_itemtextoObservaçõ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[].produtoobjetoIdentificação do Produto do Item do Pedido de Vendas.
det[].produto.cfoptexto · até 10CFOP - 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_fabricantetexto · até 20CNPJ do Fabricante da Mercadoria.
det[].produto.codigotexto · até 60Código do Produto exibido na tela do Pedido de Vendas.
det[].produto.codigo_item_kitnúmero inteiroID do Item do kit (pai) que o componente pertence
det[].produto.codigo_produtonúmero inteiroID 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_integracaotexto · até 60Có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_preconúmero inteiroCó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_kittexto · até 1Indica se o produto é um componente de um kit
det[].produto.descricaotexto · até 120Descrição do Produto.
det[].produto.eantexto · até 14EAN - European Article Number
det[].produto.indicador_escalatexto · até 1Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante.
det[].produto.kittexto · até 1Indica se o produto é um kit
det[].produto.motivo_icms_desoneradotexto · até 2Có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.ncmtexto · até 13NCM - 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_descontonúmeroPercentual de Desconto.
det[].produto.quantidadenúmeroQuantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto.
det[].produto.reservadotexto · até 1(S/N) Indica se o estoque do produto será reservado.Ex.: S, N
det[].produto.tipo_descontotexto · até 1Tipo de Desconto.
det[].produto.unidadetexto · até 6Unidade. 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_deducaonúmeroValor da Dedução
det[].produto.valor_descontonúmeroValor do Desconto
det[].produto.valor_icms_desoneradonúmeroValor do ICMS desonerado
det[].produto.valor_mercadorianúmeroValor da Mercadoria
det[].produto.valor_totalnúmeroValor Total.
det[].produto.valor_unitarionúmeroValor Únitário
det[].rastreabilidadeobjetoDados da rastreabilidade do produto.
det[].rastreabilidade.codigoAgregacaoLotetexto · até 20Código de Agregação
det[].rastreabilidade.dataFabricacaoLotetexto · até 10Data de Fabricação/Produção
det[].rastreabilidade.dataValidadeLotetexto · até 10Data de Validade
det[].rastreabilidade.numeroLotetexto · até 20Número do Lote
det[].rastreabilidade.qtdeProdutoLotenúmeroQuantidade de Produto
det[].tributavelobjetoUnidade, Quantidade, Valor e EAN tributáveis do item do pedido.
det[].tributavel.cEanTribtexto · até 14código EAN tributável do item.
det[].tributavel.cUnidTribtexto · até 6Unidade tributável do Item.
det[].tributavel.nQuantTribnúmeroQuantidade tributável do item.
det[].tributavel.nValorTribnúmeroValor tributável do item.
exportacaoobjetoDados da exportacao
exportacao.local_despachotexto · até 60Local de Despacho
exportacao.local_embarquetexto · até 60Local de Embarque (ou de transposição de fronteira)
exportacao.nao_exportacaotexto · até 1O cliente é estrangeiro, mas na verdade não se trata de uma exportação
exportacao.uf_embarquetexto · até 2UF do Local de Embarque
freteobjetoDados da Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.codigo_rastreiotexto · até 500Có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_entreganúmero inteiroCódigo do tipo de entrega.
frete.codigo_transportadoranúmero inteiroID 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_integracaotexto · até 60Có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_volumestexto · até 60Espécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retidoobjetoDados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.cCfopTrtexto · até 10CFOP. 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.cCidadeTrtexto · até 40Cidade 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.vAliquotaRetencaoTrnúmeroPercentual de Alíquota de Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.vBCRetencaoTrnúmeroBase de Cálculo da Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.vIcmsRetidoTrnúmeroValor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.vServicoTrnúmeroValor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.link_rastreiotexto · até 300Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'.
frete.marca_volumestexto · até 60Marca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.modalidadetexto · até 1Tipo 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_volumestexto · até 60Numeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.numero_lacretexto · até 60Número do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.outras_despesasnúmeroOutras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.peso_brutonúmeroPeso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.peso_liquidonúmeroPeso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.placatexto · até 7Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.placa_estadotexto · até 2Estado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.previsao_entregatexto · até 10Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.quantidade_volumesnúmero inteiroQuantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.registro_transportadortexto · até 20RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.valor_fretenúmeroValor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.valor_seguronúmeroValor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.veiculo_propriotexto · até 1O 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.
infoCadastroobjetoInformações complementares do pedido.
infoCadastro.autorizadotexto · até 1Indica se o pedido foi autorizado.
infoCadastro.cImpAPItexto · até 1Importado pela API.
infoCadastro.canceladotexto · até 1Indica se o pedido foi cancelado.
infoCadastro.dAlttexto · até 10Data da Alteração.
infoCadastro.dCantexto · até 10Data da Cancelamento.
infoCadastro.dFattexto · até 10Data de Faturamento.
infoCadastro.dInctexto · até 10Data da Inclusão.
infoCadastro.denegadotexto · até 1Indica se o pedido foi denegado.
infoCadastro.devolvidotexto · até 1Indica se o pedido foi devolvido.
infoCadastro.devolvido_parcialtexto · até 1Indica se o pedido foi devolvido parcialmente.
infoCadastro.faturadotexto · até 1Indica se o pedido está faturado.
infoCadastro.hAlttexto · até 8Hora da Alteração.
infoCadastro.hCantexto · até 8Hora da Cancelamento.
infoCadastro.hFattexto · até 8Hora de faturamento.
infoCadastro.hInctexto · até 8Hora da Inclusão.
infoCadastro.uAlttexto · até 10Usuário da Alteração.
infoCadastro.uCantexto · até 10Usuário da Cancelamento.
infoCadastro.uFattexto · até 10Usuário que realizou o faturamento.
infoCadastro.uInctexto · até 10Usuário da Inclusão.
informacoes_adicionaisobjetoDados da Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.codProjnúmero inteiroCó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.codVendnúmero inteiroCó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_categoriatexto · até 20Có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_correntenúmero inteiroCó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_finaltexto · até 1Nota Fiscal para Consumo Final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.contatotexto · até 100Contato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.dados_adicionais_nftextoDados 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_pagamentotextoDescriçã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_emailtexto · até 1Enviar 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_pixtexto · até 1Enviar 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_embutidosdescontinuadotexto · até 1DEPRECATED
informacoes_adicionais.meio_pagamentotexto · até 100Meio 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.nfRelacionadaobjetoDetalhes da NF referenciada.
informacoes_adicionais.nfRelacionada.InscrEstPRtexto · até 20Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.cChaveReftexto · até 44Chave da NF-e (ou NFC-e ou SAT) Relacionada.
informacoes_adicionais.nfRelacionada.cSeriePRtexto · até 3Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.cSerieReftexto · até 3Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.cSigNFReftexto · até 1Manter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N"
informacoes_adicionais.nfRelacionada.cUfPRtexto · até 2Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.cUfReftexto · até 2Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.cnpjEmitReftexto · até 20CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.cnpjIntermediariotexto · até 20CNPJ 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.cnpjPRtexto · até 20CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.dtEmissaoPRtexto · até 10Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.dtEmissaoReftexto · até 10Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.identIntermediariotexto · até 60Identificaçã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.indIntermediariotexto · até 1Indicador 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.indPresencatexto · até 1Indicador 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.nCOOReftexto · até 6Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado
informacoes_adicionais.nfRelacionada.nECFReftexto · até 3Número de Ordem Sequencial do ECF.
informacoes_adicionais.nfRelacionada.nNFReftexto · até 9Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.nNfPRtexto · até 9Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.nrCupomFiscallista de objetosOutros cupons fiscais relacionados
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrCOOtexto · até 6Contador de Ordem de Operação (COO)
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECFtexto · até 3Número do ECF
informacoes_adicionais.nfRelacionada.nrModelo1_1Alista de objetosOutras notas modelo 1/1A relacionadas
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrCnpjCpftexto · até 20CNPJ/CPF do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissaotexto · até 10Data de emissão da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumerotexto · até 9Número da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerietexto · até 3Série da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUFtexto · até 2Unidade federativa do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrNFlista de objetosOutras NF-e, NFC-e ou SAT relacionadas
informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrNF[].nrChavetexto · até 44Chave da NF-e, NFC-e ou SAT relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRurallista de objetosOutras notas de produtor rural relacionadas
informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrCnpjCpftexto · até 20CNPJ/CPF do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissaotexto · até 10Data de emissão da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIEtexto · até 20Inscrição Estadual do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumerotexto · até 9Número da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerietexto · até 3Série da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUFtexto · até 2Unidade federativa do emitente da NF relacionada
informacoes_adicionais.nsutexto · até 100Nú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_contratotexto · até 20Número do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.numero_pedido_clientetexto · até 30Número do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhesobjetoOutros detalhes da NF-e.
informacoes_adicionais.outros_detalhes.cBairroOdtexto · até 60Bairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cBairroOdRettexto · até 60Bairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCEPOdtexto · até 10CEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCEPOdRettexto · até 10CEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCidadeOdtexto · até 40Cidade. 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.cCidadeOdRettexto · até 40Cidade (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.cCnpjCpfOdtexto · até 20CNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCnpjCpfOdRettexto · até 20CPF/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.cCnpjIntOdtexto · até 20CNPJ 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.cComplementoOdtexto · até 60Complemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cComplementoOdRettexto · até 60Complemento do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEnderecoOdtexto · até 60Endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEnderecoOdRettexto · até 60Endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEstadoOdtexto · até 2Estado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEstadoOdRettexto · até 2Estado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cHoraSaidaOdtexto · até 8Hora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cIdentificadorIntOdtexto · até 60Identificaçã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.cIndicadorIntOdtexto · até 1Indicador 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.cIndicadorOdtexto · até 1Indicador 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.cInscrEstadualOdtexto · até 20Inscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cInscrEstadualOdRettexto · até 20Inscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNatOperacaoOdtexto · até 60Natureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNomeOdtexto · até 60Nome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNomeOdRettexto · até 60Nome / Razão Social (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNumeroOdtexto · até 10Número do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNumeroOdRettexto · até 10Número do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cSepararEnderecoOdtexto · até 1Separar 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.cSepararEnderecoOdRettexto · até 1Separar 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.cTelefoneOdtexto · até 15Telefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cTelefoneOdRettexto · até 15Telefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.dDataSaidaOdtexto · até 10Data de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.tipo_documentotexto · até 5Tipo 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_emailstextoUtilizar 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.
lancamentoslista de objetosLançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros).
lancamentos[].cCategoriatexto · até 20Código da Categoria.
lancamentos[].cNaturezaDocumentotexto · até 1Natureza 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[].cObstextoObservações.
lancamentos[].cOrigemtexto · até 3Origem 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[].cTipoDocumentotexto · até 5Tipo 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[].dDataDocumentotexto · até 10Data do documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda".
lancamentos[].nContaCorrentenúmero inteiroId da Conta Corrente.
lancamentos[].nProjetonúmero inteiroId do projeto.
lancamentos[].nSequencianúmero inteiroNú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[].nValorDocumentonúmeroValor do Documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda".
lancamentos[].nVendedornúmero inteiroId do Vendedor.
lista_parcelasobjetoDados da Aba "Parcelas" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura.
lista_parcelas.parcelalista de objetosDados da parcela.
lista_parcelas.parcela[].bandeiratexto · até 2Código da Bandeira da operadora de cartão.
lista_parcelas.parcela[].categoria_adiantamentotexto · até 20Có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_fintexto · até 20Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente.
lista_parcelas.parcela[].conta_corrente_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].data_vencimentotexto · até 10Data de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].descr_meio_pagamentotextoDescriçã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_pagamentotexto · até 100Meio 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_boletotexto · até 1Indica 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[].nsutexto · até 100Nú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_parcelanúmero inteiroNúmero da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].parcela_adiantamentotexto · até 1Está é 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[].percentualnúmeroPercentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].quantidade_diasnúmero inteiroQuantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].tipo_documentotexto · até 5Tipo 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[].valornúmeroValor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
market_placeobjetoDados para o Market Place.
market_place.nEnvionúmeroValor do envio do Market Place.
market_place.nTaxanúmeroValor da taxa do Market Place.
observacoesobjetoDados da Aba "Observações" do Pedido de Venda.
observacoes.obs_vendatextoObservações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda.
total_pedidoobjetoValores totais do pedido.
total_pedido.base_calculo_icmsnúmeroBase de Cálculo do ICMS.
total_pedido.base_calculo_stnúmeroBase de cálculo da substituição tributária.
total_pedido.base_ibs_cbsnúmeroValor total da base de cálculo do IBS e da CBS.
total_pedido.valor_IPInúmeroValor do IPI.
total_pedido.valor_cbsnúmeroValor total da CBS.
total_pedido.valor_cofinsnúmeroValor do cofins.
total_pedido.valor_csllnúmeroValor da CSLL.
total_pedido.valor_deducoesnúmeroValor das deduções.
total_pedido.valor_descontosnúmeroValor dos descontos.
total_pedido.valor_dif_cbsnúmeroValor total do diferimento da CBS.
total_pedido.valor_dif_ibs_munúmeroValor total do diferimento do IBS do município.
total_pedido.valor_dif_ibs_ufnúmeroValor total do diferimento do IBS UF.
total_pedido.valor_ibsnúmeroValor total do IBS.
total_pedido.valor_ibs_munúmeroValor total do IBS do município.
total_pedido.valor_ibs_ufnúmeroValor total do IBS da UF.
total_pedido.valor_icmsnúmeroValor total do ICMS.
total_pedido.valor_inssnúmeroValor do INSS.
total_pedido.valor_irnúmeroValor do IR. .Preenchimento automático - Não informar.
total_pedido.valor_issnúmeroValor do ISS.
total_pedido.valor_mercadoriasnúmerovalor das mercadorias.
total_pedido.valor_pisnúmeroValor do PIS.
total_pedido.valor_stnúmeroValor total da ST.
total_pedido.valor_tot_ibs_cbs_isnúmeroTotal da NF-e com IBS/CBS/IS.
total_pedido.valor_total_pedidonúmeroValor total do pedido.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_pedidonúmero inteiroCódigo do Pedido de Venda de Produto
codigo_pedido_integracaotextoCódigo de Integração do Pedido de Venda de Produto
codigo_statustextoCódigo do Status do Pedido de Venda.
descricao_statustextoDescrição do status.
numero_pedidotextoNú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}}]}'

ConsultarPedido

consultaClaudeChatGPTMCP

Consulta de Pedido de Venda de Produto

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotexto · até 60Có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_pedidotexto · até 15Nú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
CampoTipoDescrição
pedido_venda_produtoobjetoCadastro de Pedido de Venda
pedido_venda_produto.agropecuarioobjeto
pedido_venda_produto.agropecuario.cCpfResponsaveltextoCPF do responsá¡vel técnico legalmente habilitado
pedido_venda_produto.agropecuario.cNumReceitatextoNúmero da receita ou receituário do agrotóxico/defensivo agrícola
pedido_venda_produto.agropecuario.cSerieGuiatextoNúmero de série da guia
pedido_venda_produto.agropecuario.cUFGuiatextoUF de emissão da Guia
pedido_venda_produto.agropecuario.nNumGuianúmero inteiroNúmero da guia
pedido_venda_produto.agropecuario.nTipoGuianúmero inteiroTipo 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.cabecalhoobjetoInformações do cabeçalho do pedido.
pedido_venda_produto.cabecalho.bloqueadotextoPedido Bloqueado pela API.
pedido_venda_produto.cabecalho.codigo_cenario_impostosnúmero inteiroCódigo do Cenário de Impostos. Se não informado, será assumido o cenário padrão.
pedido_venda_produto.cabecalho.codigo_clientenúmero inteiroCó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_integracaotextoCó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_empresanúmero inteiroDEPRECATED
pedido_venda_produto.cabecalho.codigo_empresa_integracaotextoDEPRECATED
pedido_venda_produto.cabecalho.codigo_parcelatextoCó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_pedidonúmero inteiroID 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_integracaotextoCó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_previsaotextoData 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_datatextoData de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto.cabecalho.enc_horatextoHora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto.cabecalho.enc_motivotextoDescrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto.cabecalho.enc_usertextoUsuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto.cabecalho.encerradotextoIndica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto.cabecalho.etapatextoEtapa 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_apitextoPedido de venda de produto importada pela API.
pedido_venda_produto.cabecalho.nao_gerar_boletotextoIndica 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_pedidotextoNú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_pedidotextoOrigem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda.
pedido_venda_produto.cabecalho.perc_desconto_pedidodecimalPercentual 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_parcelasnúmero inteiroQuantidade de parcelas. Valores permitidos de 1 a 999.
pedido_venda_produto.cabecalho.quantidade_itensnúmero inteiroQuantidade de Itens.
pedido_venda_produto.cabecalho.sequencialtextoNú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_pedidotextoTipo 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_pedidodecimalValor 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.departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
pedido_venda_produto.departamentos[].cCodDeptotextoID 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[].nPercdecimalPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
pedido_venda_produto.departamentos[].nValordecimalValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
pedido_venda_produto.departamentos[].nValorFixotextoIndica 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.detlista de objetosDados da Aba "Itens da Venda" do Pedido de Venda.
pedido_venda_produto.det[].combustivelobjetoDetalhamento específico de Combustível.
pedido_venda_produto.det[].combustivel.cCODIFtextoRegistro do CODIF.
pedido_venda_produto.det[].combustivel.cCodigoANPtextoCódigo de Produto da ANP.
pedido_venda_produto.det[].combustivel.cDescrANPtextoDescrição do Produto conforme ANP.
pedido_venda_produto.det[].combustivel.cUFConsumoCombtextoUF de Consumo.
pedido_venda_produto.det[].combustivel.nAliquota_CIDEdecimalValor da Alíquota em Reais da CIDE.
pedido_venda_produto.det[].combustivel.nBC_CIDEdecimalBase de Cálculo (em quantidade) da CIDE.
pedido_venda_produto.det[].combustivel.nBC_UFDestdecimalBase de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
pedido_venda_produto.det[].combustivel.nBC_UFRemdecimalBase de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária.
pedido_venda_produto.det[].combustivel.nPercGLPdecimalPercentual de GLP Derivado do Petróleo.
pedido_venda_produto.det[].combustivel.nPercGasImportadodecimalPercentual de Gás Natural Importado.
pedido_venda_produto.det[].combustivel.nPercGasNacionaldecimalPercentual de Gás Natural Nacional.
pedido_venda_produto.det[].combustivel.nQtdeFatTempAmbdecimalQuantidade Faturada à Temperatura Ambiente.
pedido_venda_produto.det[].combustivel.nValorPartidadecimalValor de Partida.
pedido_venda_produto.det[].combustivel.nValorUFDestdecimalValor da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
pedido_venda_produto.det[].combustivel.nValorUFRemdecimalValor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária.
pedido_venda_produto.det[].combustivel.nValor_CIDEdecimalValor da CIDE.
pedido_venda_produto.det[].ideobjetoIdentificação do Item do Pedido de Vendas.
pedido_venda_produto.det[].ide.acao_itemtextoAção para o item. Pode ser: "E" - para excluir um item.
pedido_venda_produto.det[].ide.codigo_itemnúmero inteiroID do Item do Pedido.
pedido_venda_produto.det[].ide.codigo_item_integracaotextoCó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_producaonúmero inteiroId 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_impostosnúmero inteiroDEPRECATED
pedido_venda_produto.det[].ide.simples_nacionaltextoIndica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N".
pedido_venda_produto.det[].impostoobjetoInformaçõ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.cbsobjeto
pedido_venda_produto.det[].imposto.cbs.aliquota_cbsdecimalAlí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_cbsdecimalPercentual 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_cbsdecimalPercentual 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_cbsdecimalValor 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_cbsdecimalValor 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_padraoobjetoCOFINS.
pedido_venda_produto.det[].imposto.cofins_padrao.aliq_cofinsdecimal
pedido_venda_produto.det[].imposto.cofins_padrao.base_cofinsdecimal
pedido_venda_produto.det[].imposto.cofins_padrao.cod_sit_trib_cofinstexto
pedido_venda_produto.det[].imposto.cofins_padrao.qtde_unid_trib_cofinsdecimal
pedido_venda_produto.det[].imposto.cofins_padrao.tipo_calculo_cofinstexto
pedido_venda_produto.det[].imposto.cofins_padrao.valor_cofinsdecimal
pedido_venda_produto.det[].imposto.cofins_padrao.valor_unid_trib_cofinsdecimal
pedido_venda_produto.det[].imposto.cofins_stobjetoCOFINS - Substituição Tributária.
pedido_venda_produto.det[].imposto.cofins_st.aliq_cofins_stdecimal
pedido_venda_produto.det[].imposto.cofins_st.base_cofins_stdecimal
pedido_venda_produto.det[].imposto.cofins_st.cod_sit_trib_cofins_sttexto
pedido_venda_produto.det[].imposto.cofins_st.margem_cofins_stdecimal
pedido_venda_produto.det[].imposto.cofins_st.qtde_unid_trib_cofins_stdecimal
pedido_venda_produto.det[].imposto.cofins_st.tipo_calculo_cofins_sttexto
pedido_venda_produto.det[].imposto.cofins_st.valor_cofins_stdecimal
pedido_venda_produto.det[].imposto.cofins_st.valor_unid_trib_cofins_stdecimal
pedido_venda_produto.det[].imposto.csllobjetoCSLL.
pedido_venda_produto.det[].imposto.csll.aliq_cslldecimal
pedido_venda_produto.det[].imposto.csll.valor_cslldecimal
pedido_venda_produto.det[].imposto.ibsobjeto
pedido_venda_produto.det[].imposto.ibs.aliquota_ibs_mudecimalAlí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_ufdecimalAlí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_mudecimalPercentual 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_ufdecimalPercentual 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_mudecimalPercentual 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_ufdecimalPercentual 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_mudecimalValor 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_ufdecimalValor 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_ibsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_cbsobjeto
pedido_venda_produto.det[].imposto.ibs_cbs.base_ibs_cbsdecimalBase 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_tribtextoCó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_cbstextoCó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.icmsobjetoICMS
pedido_venda_produto.det[].imposto.icms.aliq_icmsdecimal
pedido_venda_produto.det[].imposto.icms.base_fcp_icmsdecimalBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS.
pedido_venda_produto.det[].imposto.icms.base_icmsdecimal
pedido_venda_produto.det[].imposto.icms.cod_sit_trib_icmstexto
pedido_venda_produto.det[].imposto.icms.modalidade_icmstexto
pedido_venda_produto.det[].imposto.icms.origem_icmstexto
pedido_venda_produto.det[].imposto.icms.perc_fcp_icmsdecimalPercentual do FCP - Fundo de Combate a Pobreza do ICMS.
pedido_venda_produto.det[].imposto.icms.perc_red_base_icmsdecimal
pedido_venda_produto.det[].imposto.icms.valor_fcp_icmsdecimalValor do FCP - Fundo de Combate a Pobreza do ICMS.
pedido_venda_produto.det[].imposto.icms.valor_icmsdecimal
pedido_venda_produto.det[].imposto.icms_efetobjetoICMS 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_efetdecimal
pedido_venda_produto.det[].imposto.icms_efet.base_icms_efetdecimal
pedido_venda_produto.det[].imposto.icms_efet.cod_sit_trib_icms_efettexto
pedido_venda_produto.det[].imposto.icms_efet.modalidade_icms_efettexto
pedido_venda_produto.det[].imposto.icms_efet.origem_icms_efettexto
pedido_venda_produto.det[].imposto.icms_efet.perc_red_base_icms_efetdecimal
pedido_venda_produto.det[].imposto.icms_efet.valor_icms_efetdecimal
pedido_venda_produto.det[].imposto.icms_ieobjetoICMS Interestadual.
pedido_venda_produto.det[].imposto.icms_ie.aliq_icms_FCPdecimalPercentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino
pedido_venda_produto.det[].imposto.icms_ie.aliq_interestadualdecimalAlíquota Interestadual das UFs Envolvidas
pedido_venda_produto.det[].imposto.icms_ie.aliq_interna_uf_destinodecimalAlíquota Interna da UF de Destino
pedido_venda_produto.det[].imposto.icms_ie.aliq_partilha_icmsdecimalPercentual Provisório de Partilha do ICMS Interestadual
pedido_venda_produto.det[].imposto.icms_ie.base_icms_uf_destinodecimalBC do ICMS na UF de Destino
pedido_venda_produto.det[].imposto.icms_ie.valor_fcp_icms_interdecimalValor do fundo de combate a pobreza.
pedido_venda_produto.det[].imposto.icms_ie.valor_icms_uf_destdecimalValor do ICMS - UF Destino
pedido_venda_produto.det[].imposto.icms_ie.valor_icms_uf_remetdecimalValor do ICMS - UF Remetente
pedido_venda_produto.det[].imposto.icms_snobjetoICMS - Simples Nacional.
pedido_venda_produto.det[].imposto.icms_sn.aliq_icms_sndecimal
pedido_venda_produto.det[].imposto.icms_sn.base_icms_sndecimal
pedido_venda_produto.det[].imposto.icms_sn.cod_sit_trib_icms_sntexto
pedido_venda_produto.det[].imposto.icms_sn.origem_icms_sntexto
pedido_venda_produto.det[].imposto.icms_sn.valor_credito_icms_sndecimal
pedido_venda_produto.det[].imposto.icms_sn.valor_icms_sndecimal
pedido_venda_produto.det[].imposto.icms_stobjetoICMS - Substituição Tributária.
pedido_venda_produto.det[].imposto.icms_st.aliq_icms_oppropdecimalAlíquota de ICMS Operação Própria.
pedido_venda_produto.det[].imposto.icms_st.aliq_icms_stdecimal
pedido_venda_produto.det[].imposto.icms_st.base_fcp_icms_stdecimalBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST.
pedido_venda_produto.det[].imposto.icms_st.base_icms_stdecimal
pedido_venda_produto.det[].imposto.icms_st.cesttextoCEST - Código Especificador da Substituíção Tributária.
pedido_venda_produto.det[].imposto.icms_st.cod_sit_trib_icms_sttexto
pedido_venda_produto.det[].imposto.icms_st.margem_icms_stdecimal
pedido_venda_produto.det[].imposto.icms_st.modalidade_icms_sttexto
pedido_venda_produto.det[].imposto.icms_st.perc_fcp_icms_stdecimalPercentual do FCP - Fundo de Combate a Pobreza do ICMS ST.
pedido_venda_produto.det[].imposto.icms_st.perc_red_base_icms_opdecimalPercentual 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_stdecimal
pedido_venda_produto.det[].imposto.icms_st.valor_fcp_icms_stdecimalValor do FCP - Fundo de Combate a Pobreza do ICMS ST.
pedido_venda_produto.det[].imposto.icms_st.valor_icms_stdecimal
pedido_venda_produto.det[].imposto.inssobjetoINSS.
pedido_venda_produto.det[].imposto.inss.aliq_inssdecimal
pedido_venda_produto.det[].imposto.inss.valor_inssdecimal
pedido_venda_produto.det[].imposto.ipiobjetoIPI.
pedido_venda_produto.det[].imposto.ipi.aliq_ipidecimal
pedido_venda_produto.det[].imposto.ipi.base_ipidecimal
pedido_venda_produto.det[].imposto.ipi.cod_sit_trib_ipitexto
pedido_venda_produto.det[].imposto.ipi.enquadramento_ipitextoEnquadramento do IPI
pedido_venda_produto.det[].imposto.ipi.qtde_unid_trib_ipidecimal
pedido_venda_produto.det[].imposto.ipi.tipo_calculo_ipitexto
pedido_venda_produto.det[].imposto.ipi.valor_ipidecimal
pedido_venda_produto.det[].imposto.ipi.valor_unid_trib_ipidecimal
pedido_venda_produto.det[].imposto.irrfobjetoIRRF.
pedido_venda_produto.det[].imposto.irrf.aliq_irrfdecimal
pedido_venda_produto.det[].imposto.irrf.valor_irrfdecimal
pedido_venda_produto.det[].imposto.issobjetoISS.
pedido_venda_produto.det[].imposto.iss.aliq_issdecimal
pedido_venda_produto.det[].imposto.iss.base_issdecimal
pedido_venda_produto.det[].imposto.iss.retem_isstexto
pedido_venda_produto.det[].imposto.iss.valor_issdecimal
pedido_venda_produto.det[].imposto.pis_padraoobjetoPIS.
pedido_venda_produto.det[].imposto.pis_padrao.aliq_pisdecimal
pedido_venda_produto.det[].imposto.pis_padrao.base_pisdecimal
pedido_venda_produto.det[].imposto.pis_padrao.cod_sit_trib_pistexto
pedido_venda_produto.det[].imposto.pis_padrao.qtde_unid_trib_pisdecimal
pedido_venda_produto.det[].imposto.pis_padrao.tipo_calculo_pistexto
pedido_venda_produto.det[].imposto.pis_padrao.valor_pisdecimal
pedido_venda_produto.det[].imposto.pis_padrao.valor_unid_trib_pisdecimal
pedido_venda_produto.det[].imposto.pis_stobjetoPIS - Substituíção Tributária.
pedido_venda_produto.det[].imposto.pis_st.aliq_pis_stdecimal
pedido_venda_produto.det[].imposto.pis_st.base_pis_stdecimal
pedido_venda_produto.det[].imposto.pis_st.cod_sit_trib_pis_sttexto
pedido_venda_produto.det[].imposto.pis_st.margem_pis_stdecimal
pedido_venda_produto.det[].imposto.pis_st.qtde_unid_trib_pis_stdecimal
pedido_venda_produto.det[].imposto.pis_st.tipo_calculo_pis_sttexto
pedido_venda_produto.det[].imposto.pis_st.valor_pis_stdecimal
pedido_venda_produto.det[].imposto.pis_st.valor_unid_trib_pis_stdecimal
pedido_venda_produto.det[].imposto.trib_regobjeto
pedido_venda_produto.det[].imposto.trib_reg.aliquota_reg_cbsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_regtextoCó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_csttextoCó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_cbsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_adicobjetoDados da aba "Informações Adicionais" do Item do Pedido de Vendas.
pedido_venda_produto.det[].inf_adic.codigo_beneficio_fiscaltextoCódigo do Benefício Fiscal.
pedido_venda_produto.det[].inf_adic.codigo_categoria_itemtextoCódigo da Categoria do item.
pedido_venda_produto.det[].inf_adic.codigo_cenario_impostos_itemnúmero inteiroCódigo do Cenário de Impostos.
pedido_venda_produto.det[].inf_adic.codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
pedido_venda_produto.det[].inf_adic.dados_adicionais_itemtextoInformações para a Nota Fiscal.
pedido_venda_produto.det[].inf_adic.item_pedido_compranúmero inteiroItem do Pedido de Compra.
pedido_venda_produto.det[].inf_adic.nao_gerar_financeirotextoNã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_estoquetextoNã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_totaltextoNão somar este item no total da NF-e
pedido_venda_produto.det[].inf_adic.numero_fcitextoNúmero da FCI (Ficha de Conteúdo de Importação)
pedido_venda_produto.det[].inf_adic.numero_pedido_compratextoNúmero do Pedido de Compra.
pedido_venda_produto.det[].inf_adic.numero_recopitextoNúmero do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune).
pedido_venda_produto.det[].inf_adic.peso_brutodecimalPeso Bruto (Kg).
pedido_venda_produto.det[].inf_adic.peso_liquidodecimalPeso Líquido (Kg).
pedido_venda_produto.det[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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[].nQtdLotedecimalInforme 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[].observacaoobjetoDados da aba "Observações" do Item do Pedido de Vendas.
pedido_venda_produto.det[].observacao.obs_itemtextoObservaçõ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[].produtoobjetoIdentificação do Produto do Item do Pedido de Vendas.
pedido_venda_produto.det[].produto.cfoptextoCFOP - 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_fabricantetextoCNPJ do Fabricante da Mercadoria.
pedido_venda_produto.det[].produto.codigotextoCódigo do Produto exibido na tela do Pedido de Vendas.
pedido_venda_produto.det[].produto.codigo_item_kitnúmero inteiroID do Item do kit (pai) que o componente pertence
pedido_venda_produto.det[].produto.codigo_produtonúmero inteiroID 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_integracaotextoCó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_preconúmero inteiroCó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_kittextoIndica se o produto é um componente de um kit
pedido_venda_produto.det[].produto.descricaotextoDescrição do Produto.
pedido_venda_produto.det[].produto.eantextoEAN - European Article Number
pedido_venda_produto.det[].produto.indicador_escalatextoIndicador 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.kittextoIndica se o produto é um kit
pedido_venda_produto.det[].produto.motivo_icms_desoneradotextoCó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.ncmtextoNCM - 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_descontodecimalPercentual de Desconto.
pedido_venda_produto.det[].produto.quantidadedecimalQuantidade 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.reservadotexto(S/N) Indica se o estoque do produto será reservado.
pedido_venda_produto.det[].produto.tipo_descontotextoTipo de Desconto.
pedido_venda_produto.det[].produto.unidadetextoUnidade. 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_deducaodecimalValor da Dedução
pedido_venda_produto.det[].produto.valor_descontodecimalValor do Desconto
pedido_venda_produto.det[].produto.valor_icms_desoneradodecimalValor do ICMS desonerado
pedido_venda_produto.det[].produto.valor_mercadoriadecimalValor da Mercadoria
pedido_venda_produto.det[].produto.valor_totaldecimalValor Total.
pedido_venda_produto.det[].produto.valor_unitariodecimalValor Únitário
pedido_venda_produto.det[].rastreabilidadeobjetoDados da rastreabilidade do produto.
pedido_venda_produto.det[].rastreabilidade.codigoAgregacaoLotetextoCódigo de Agregação
pedido_venda_produto.det[].rastreabilidade.dataFabricacaoLotetextoData de Fabricação/Produção
pedido_venda_produto.det[].rastreabilidade.dataValidadeLotetextoData de Validade
pedido_venda_produto.det[].rastreabilidade.numeroLotetextoNúmero do Lote
pedido_venda_produto.det[].rastreabilidade.qtdeProdutoLotedecimalQuantidade de Produto
pedido_venda_produto.det[].tributavelobjetoUnidade, Quantidade, Valor e EAN tributáveis do item do pedido.
pedido_venda_produto.det[].tributavel.cEanTribtextocódigo EAN tributável do item.
pedido_venda_produto.det[].tributavel.cUnidTribtextoUnidade tributável do Item.
pedido_venda_produto.det[].tributavel.nQuantTribdecimalQuantidade tributável do item.
pedido_venda_produto.det[].tributavel.nValorTribdecimalValor tributável do item.
pedido_venda_produto.exportacaoobjetoDados da exportacao
pedido_venda_produto.exportacao.local_despachotextoLocal de Despacho
pedido_venda_produto.exportacao.local_embarquetextoLocal de Embarque (ou de transposição de fronteira)
pedido_venda_produto.exportacao.nao_exportacaotextoO cliente é estrangeiro, mas na verdade não se trata de uma exportação
pedido_venda_produto.exportacao.uf_embarquetextoUF do Local de Embarque
pedido_venda_produto.freteobjetoDados da Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.codigo_rastreiotextoCó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_entreganúmero inteiroCódigo do tipo de entrega.
pedido_venda_produto.frete.codigo_transportadoranúmero inteiroID 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_integracaotextoCó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_volumestextoEspécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.icms_retidoobjetoDados 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.cCfopTrtextoCFOP. 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.cCidadeTrtextoCidade 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.vAliquotaRetencaoTrdecimalPercentual 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.vBCRetencaoTrdecimalBase 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.vIcmsRetidoTrdecimalValor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.icms_retido.vServicoTrdecimalValor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.link_rastreiotextoLink 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_volumestextoMarca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.modalidadetextoTipo 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_volumestextoNumeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.numero_lacretextoNúmero do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.outras_despesasdecimalOutras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.peso_brutodecimalPeso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.peso_liquidodecimalPeso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.placatextoPlaca do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.placa_estadotextoEstado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.previsao_entregatextoPrevisã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_volumesnúmero inteiroQuantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.registro_transportadortextoRNTRC (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_fretedecimalValor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.valor_segurodecimalValor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto.frete.veiculo_propriotextoO 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.infoCadastroobjetoInformações complementares do pedido.
pedido_venda_produto.infoCadastro.autorizadotextoIndica se o pedido foi autorizado.
pedido_venda_produto.infoCadastro.cImpAPItextoImportado pela API.
pedido_venda_produto.infoCadastro.canceladotextoIndica se o pedido foi cancelado.
pedido_venda_produto.infoCadastro.dAlttextoData da Alteração.
pedido_venda_produto.infoCadastro.dCantextoData da Cancelamento.
pedido_venda_produto.infoCadastro.dFattextoData de Faturamento.
pedido_venda_produto.infoCadastro.dInctextoData da Inclusão.
pedido_venda_produto.infoCadastro.denegadotextoIndica se o pedido foi denegado.
pedido_venda_produto.infoCadastro.devolvidotextoIndica se o pedido foi devolvido.
pedido_venda_produto.infoCadastro.devolvido_parcialtextoIndica se o pedido foi devolvido parcialmente.
pedido_venda_produto.infoCadastro.faturadotextoIndica se o pedido está faturado.
pedido_venda_produto.infoCadastro.hAlttextoHora da Alteração.
pedido_venda_produto.infoCadastro.hCantextoHora da Cancelamento.
pedido_venda_produto.infoCadastro.hFattextoHora de faturamento.
pedido_venda_produto.infoCadastro.hInctextoHora da Inclusão.
pedido_venda_produto.infoCadastro.uAlttextoUsuário da Alteração.
pedido_venda_produto.infoCadastro.uCantextoUsuário da Cancelamento.
pedido_venda_produto.infoCadastro.uFattextoUsuário que realizou o faturamento.
pedido_venda_produto.infoCadastro.uInctextoUsuário da Inclusão.
pedido_venda_produto.informacoes_adicionaisobjetoDados da Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.codProjnúmero inteiroCó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.codVendnúmero inteiroCó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_categoriatextoCó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_correntenúmero inteiroCó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_finaltextoNota 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.contatotextoContato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.dados_adicionais_nftextoDados 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_pagamentotextoDescriçã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_emailtextoEnviar 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_pixtextoEnviar 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_embutidostextoDEPRECATED
pedido_venda_produto.informacoes_adicionais.meio_pagamentotextoMeio 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.nfRelacionadaobjetoDetalhes da NF referenciada.
pedido_venda_produto.informacoes_adicionais.nfRelacionada.InscrEstPRtextoInscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cChaveReftextoChave da NF-e (ou NFC-e ou SAT) Relacionada.
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cSeriePRtextoSérie da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cSerieReftextoSérie da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cSigNFReftextoManter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N"
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cUfPRtextoEstado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cUfReftextoEstado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cnpjEmitReftextoCNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto.informacoes_adicionais.nfRelacionada.cnpjIntermediariotextoCNPJ 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.cnpjPRtextoCNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto.informacoes_adicionais.nfRelacionada.dtEmissaoPRtextoData de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto.informacoes_adicionais.nfRelacionada.dtEmissaoReftextoData de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto.informacoes_adicionais.nfRelacionada.identIntermediariotextoIdentificaçã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.indIntermediariotextoIndicador 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.indPresencatextoIndicador 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.nCOOReftextoNúmero do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nECFReftextoNúmero de Ordem Sequencial do ECF.
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nNFReftextoNúmero da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nNfPRtextoNúmero da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscallista de objetosOutros cupons fiscais relacionados
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItemtextoAçã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[].nrCOOtextoContador de Ordem de Operação (COO)
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECFtextoNúmero do ECF
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1Alista de objetosOutras notas modelo 1/1A relacionadas
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItemtextoAçã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[].nrCnpjCpftextoCNPJ/CPF do emitente da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissaotextoData de emissão da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumerotextoNúmero da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerietextoSérie da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUFtextoUnidade federativa do emitente da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrNFlista de objetosOutras NF-e, NFC-e ou SAT relacionadas
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItemtextoAçã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[].nrChavetextoChave da NF-e, NFC-e ou SAT relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRurallista de objetosOutras notas de produtor rural relacionadas
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItemtextoAçã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[].nrCnpjCpftextoCNPJ/CPF do emitente da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissaotextoData de emissão da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIEtextoInscrição Estadual do emitente da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumerotextoNúmero da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerietextoSérie da NF relacionada
pedido_venda_produto.informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUFtextoUnidade federativa do emitente da NF relacionada
pedido_venda_produto.informacoes_adicionais.nsutextoNú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_contratotextoNúmero do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.numero_pedido_clientetextoNúmero do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhesobjetoOutros detalhes da NF-e.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cBairroOdtextoBairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cBairroOdRettextoBairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCEPOdtextoCEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCEPOdRettextoCEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCidadeOdtextoCidade. 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.cCidadeOdRettextoCidade (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.cCnpjCpfOdtextoCNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cCnpjCpfOdRettextoCPF/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.cCnpjIntOdtextoCNPJ 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.cComplementoOdtextoComplemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cComplementoOdRettextoComplemento 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.cEnderecoOdtextoEndereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEnderecoOdRettextoEndereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEstadoOdtextoEstado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cEstadoOdRettextoEstado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cHoraSaidaOdtextoHora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cIdentificadorIntOdtextoIdentificaçã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.cIndicadorIntOdtextoIndicador 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.cIndicadorOdtextoIndicador 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.cInscrEstadualOdtextoInscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cInscrEstadualOdRettextoInscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNatOperacaoOdtextoNatureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNomeOdtextoNome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNomeOdRettextoNome / 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.cNumeroOdtextoNúmero do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cNumeroOdRettextoNú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.cSepararEnderecoOdtextoSeparar 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.cSepararEnderecoOdRettextoSeparar 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.cTelefoneOdtextoTelefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.cTelefoneOdRettextoTelefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.outros_detalhes.dDataSaidaOdtextoData de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto.informacoes_adicionais.tipo_documentotextoTipo 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_emailstextoUtilizar 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.lancamentoslista de objetosLançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros).
pedido_venda_produto.lancamentos[].cCategoriatextoCódigo da Categoria.
pedido_venda_produto.lancamentos[].cNaturezaDocumentotextoNatureza 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[].cObstextoObservações.
pedido_venda_produto.lancamentos[].cOrigemtextoOrigem 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[].cTipoDocumentotextoTipo 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[].dDataDocumentotextoData 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[].nContaCorrentenúmero inteiroId da Conta Corrente.
pedido_venda_produto.lancamentos[].nProjetonúmero inteiroId do projeto.
pedido_venda_produto.lancamentos[].nSequencianúmero inteiroNú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[].nValorDocumentodecimalValor 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[].nVendedornúmero inteiroId do Vendedor.
pedido_venda_produto.lista_parcelasobjetoDados 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.parcelalista de objetosDados da parcela.
pedido_venda_produto.lista_parcelas.parcela[].bandeiratextoCódigo da Bandeira da operadora de cartão.
pedido_venda_produto.lista_parcelas.parcela[].categoria_adiantamentotextoCó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_fintextoInformar o CNPJ da instituição de pagamento, adquirente ou subadquirente.
pedido_venda_produto.lista_parcelas.parcela[].conta_corrente_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto.lista_parcelas.parcela[].data_vencimentotextoData de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto.lista_parcelas.parcela[].descr_meio_pagamentotextoDescriçã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_pagamentotextoMeio 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_boletotextoIndica 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[].nsutextoNú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_parcelanúmero inteiroNúmero da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto.lista_parcelas.parcela[].parcela_adiantamentotextoEstá é 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[].percentualdecimalPercentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto.lista_parcelas.parcela[].quantidade_diasnúmero inteiroQuantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto.lista_parcelas.parcela[].tipo_documentotextoTipo 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[].valordecimalValor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto.market_placeobjetoDados para o Market Place.
pedido_venda_produto.market_place.nEnviodecimalValor do envio do Market Place.
pedido_venda_produto.market_place.nTaxadecimalValor da taxa do Market Place.
pedido_venda_produto.observacoesobjetoDados da Aba "Observações" do Pedido de Venda.
pedido_venda_produto.observacoes.obs_vendatextoObservaçõ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_pedidoobjetoValores totais do pedido.
pedido_venda_produto.total_pedido.base_calculo_icmsdecimalBase de Cálculo do ICMS.
pedido_venda_produto.total_pedido.base_calculo_stdecimalBase de cálculo da substituição tributária.
pedido_venda_produto.total_pedido.base_ibs_cbsdecimalValor total da base de cálculo do IBS e da CBS.
pedido_venda_produto.total_pedido.valor_IPIdecimalValor do IPI.
pedido_venda_produto.total_pedido.valor_cbsdecimalValor total da CBS.
pedido_venda_produto.total_pedido.valor_cofinsdecimalValor do cofins.
pedido_venda_produto.total_pedido.valor_cslldecimalValor da CSLL.
pedido_venda_produto.total_pedido.valor_deducoesdecimalValor das deduções.
pedido_venda_produto.total_pedido.valor_descontosdecimalValor dos descontos.
pedido_venda_produto.total_pedido.valor_dif_cbsdecimalValor total do diferimento da CBS.
pedido_venda_produto.total_pedido.valor_dif_ibs_mudecimalValor total do diferimento do IBS do município.
pedido_venda_produto.total_pedido.valor_dif_ibs_ufdecimalValor total do diferimento do IBS UF.
pedido_venda_produto.total_pedido.valor_ibsdecimalValor total do IBS.
pedido_venda_produto.total_pedido.valor_ibs_mudecimalValor total do IBS do município.
pedido_venda_produto.total_pedido.valor_ibs_ufdecimalValor total do IBS da UF.
pedido_venda_produto.total_pedido.valor_icmsdecimalValor total do ICMS.
pedido_venda_produto.total_pedido.valor_inssdecimalValor do INSS.
pedido_venda_produto.total_pedido.valor_irdecimalValor do IR. .Preenchimento automático - Não informar.
pedido_venda_produto.total_pedido.valor_issdecimalValor do ISS.
pedido_venda_produto.total_pedido.valor_mercadoriasdecimalvalor das mercadorias.
pedido_venda_produto.total_pedido.valor_pisdecimalValor do PIS.
pedido_venda_produto.total_pedido.valor_stdecimalValor total da ST.
pedido_venda_produto.total_pedido.valor_tot_ibs_cbs_isdecimalTotal da NF-e com IBS/CBS/IS.
pedido_venda_produto.total_pedido.valor_total_pedidodecimalValor 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}]}'

DevolverPedido

altera dadosClaudeMCP

Método para efetuar a devolução de um pedido.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotexto · até 60Có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.
itensobjetoInformaçõ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órionúmero inteiroId do produto.
itens.quantidadenúmeroQuantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto.
nIdMotivDevolnúmero inteiroID 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
CampoTipoDescrição
cCodStatustexto
cDesStatustexto
cNumeroDevolucaotextoNúmero do documento da devolução gerada, como aparece na tela.
nIdDevolucaonúmero inteiroID 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}]}]}'

ExcluirPedido

altera dadosClaudeMCP

Excluir pedido de venda de produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotexto · até 60Có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
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotextoCó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_statustextoCódigo do Status do Pedido de Venda.
descricao_statustextoDescrição do status.
numero_pedidotextoNú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": ""}]}'

IncluirPedido

altera dadosClaudeChatGPTMCP

Inclui um pedido de venda de produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 13Campos e estruturas que você pode enviar
CampoTipoDescrição
agropecuarioobjeto
agropecuario.cCpfResponsaveltexto · até 14CPF do responsá¡vel técnico legalmente habilitado
agropecuario.cNumReceitatexto · até 20Número da receita ou receituário do agrotóxico/defensivo agrícola
agropecuario.cSerieGuiatexto · até 9Número de série da guia
agropecuario.cUFGuiatexto · até 2UF de emissão da Guia
agropecuario.nNumGuianúmero inteiroNúmero da guia
agropecuario.nTipoGuianúmero inteiroTipo 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)
cabecalhoobjetoInformações do cabeçalho do pedido.
cabecalho.bloqueadotexto · até 1Pedido Bloqueado pela API.
cabecalho.codigo_cenario_impostosnúmero inteiroCódigo do Cenário de Impostos. Se não informado, será assumido o cenário padrão.
cabecalho.codigo_clientenúmero inteiroCó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_integracaotexto · até 60Có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_empresadescontinuadonúmero inteiroDEPRECATED
cabecalho.codigo_empresa_integracaodescontinuadotexto · até 20DEPRECATED
cabecalho.codigo_parcelatexto · até 3Có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_pedidonúmero inteiroID 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_integracaotexto · até 60Có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_previsaotexto · até 10Data 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_datatexto · até 10Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.enc_horatexto · até 8Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.enc_motivotexto · até 100Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.enc_usertexto · até 10Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
cabecalho.encerradotexto · até 1Indica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta.Ex.: S, N
cabecalho.etapatexto · até 2Etapa 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_apitexto · até 1Pedido de venda de produto importada pela API.
cabecalho.nao_gerar_boletotexto · até 1Indica 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_pedidotexto · até 15Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela.
cabecalho.origem_pedidotexto · até 3Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda.
cabecalho.perc_desconto_pedidonúmeroPercentual 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_parcelasnúmero inteiroQuantidade de parcelas. Valores permitidos de 1 a 999.
cabecalho.quantidade_itensnúmero inteiroQuantidade de Itens.
cabecalho.sequencialtexto · até 4Nú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_pedidotexto · até 1Tipo 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_pedidonúmeroValor 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.
departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
departamentos[].cCodDeptotexto · até 40ID 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[].nPercnúmeroPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
departamentos[].nValornúmeroValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
departamentos[].nValorFixotexto · até 1Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda.
detlista de objetosDados da Aba "Itens da Venda" do Pedido de Venda.
det[].combustivelobjetoDetalhamento específico de Combustível.
det[].combustivel.cCODIFtexto · até 21Registro do CODIF.
det[].combustivel.cCodigoANPtexto · até 9Código de Produto da ANP.
det[].combustivel.cDescrANPtexto · até 95Descrição do Produto conforme ANP.
det[].combustivel.cUFConsumoCombtexto · até 2UF de Consumo.
det[].combustivel.nAliquota_CIDEnúmeroValor da Alíquota em Reais da CIDE.
det[].combustivel.nBC_CIDEnúmeroBase de Cálculo (em quantidade) da CIDE.
det[].combustivel.nBC_UFDestnúmeroBase de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
det[].combustivel.nBC_UFRemnúmeroBase de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária.
det[].combustivel.nPercGLPnúmeroPercentual de GLP Derivado do Petróleo.
det[].combustivel.nPercGasImportadonúmeroPercentual de Gás Natural Importado.
det[].combustivel.nPercGasNacionalnúmeroPercentual de Gás Natural Nacional.
det[].combustivel.nQtdeFatTempAmbnúmeroQuantidade Faturada à Temperatura Ambiente.
det[].combustivel.nValorPartidanúmeroValor de Partida.
det[].combustivel.nValorUFDestnúmeroValor da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
det[].combustivel.nValorUFRemnúmeroValor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária.
det[].combustivel.nValor_CIDEnúmeroValor da CIDE.
det[].ideobjetoIdentificação do Item do Pedido de Vendas.
det[].ide.acao_itemtexto · até 1Ação para o item. Pode ser: "E" - para excluir um item.
det[].ide.codigo_itemnúmero inteiroID do Item do Pedido.
det[].ide.codigo_item_integracaotexto · até 30Có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_producaonúmero inteiroId 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_impostosdescontinuadonúmero inteiroDEPRECATED
det[].ide.simples_nacionaltexto · até 1Indica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N".
det[].impostoobjetoInformaçõ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.cbsobjeto
det[].imposto.cbs.aliquota_cbsnúmeroAlí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_cbsnúmeroPercentual 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_cbsnúmeroPercentual 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_cbsnúmeroValor 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_cbsnúmeroValor 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_padraoobjetoCOFINS.
det[].imposto.cofins_padrao.aliq_cofinsnúmero
det[].imposto.cofins_padrao.base_cofinsnúmero
det[].imposto.cofins_padrao.cod_sit_trib_cofinstexto · até 2
det[].imposto.cofins_padrao.qtde_unid_trib_cofinsnúmero
det[].imposto.cofins_padrao.tipo_calculo_cofinstexto · até 1
det[].imposto.cofins_padrao.valor_cofinsnúmero
det[].imposto.cofins_padrao.valor_unid_trib_cofinsnúmero
det[].imposto.cofins_stobjetoCOFINS - Substituição Tributária.
det[].imposto.cofins_st.aliq_cofins_stnúmero
det[].imposto.cofins_st.base_cofins_stnúmero
det[].imposto.cofins_st.cod_sit_trib_cofins_sttexto · até 2
det[].imposto.cofins_st.margem_cofins_stnúmero
det[].imposto.cofins_st.qtde_unid_trib_cofins_stnúmero
det[].imposto.cofins_st.tipo_calculo_cofins_sttexto · até 1
det[].imposto.cofins_st.valor_cofins_stnúmero
det[].imposto.cofins_st.valor_unid_trib_cofins_stnúmero
det[].imposto.csllobjetoCSLL.
det[].imposto.csll.aliq_csllnúmero
det[].imposto.csll.valor_csllnúmero
det[].imposto.ibsobjeto
det[].imposto.ibs.aliquota_ibs_munúmeroAlí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_ufnúmeroAlí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_munúmeroPercentual 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_ufnúmeroPercentual 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_munúmeroPercentual 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_ufnúmeroPercentual 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_munúmeroValor 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_ufnúmeroValor 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_ibsnúmeroValor 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_munúmeroValor 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_ufnúmeroValor 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_cbsobjeto
det[].imposto.ibs_cbs.base_ibs_cbsnúmeroBase 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_tribtexto · até 6Có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_cbstexto · até 3Có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.icmsobjetoICMS
det[].imposto.icms.aliq_icmsnúmero
det[].imposto.icms.base_fcp_icmsnúmeroBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS.
det[].imposto.icms.base_icmsnúmero
det[].imposto.icms.cod_sit_trib_icmstexto · até 2
det[].imposto.icms.modalidade_icmstexto · até 1
det[].imposto.icms.origem_icmstexto · até 1
det[].imposto.icms.perc_fcp_icmsnúmeroPercentual do FCP - Fundo de Combate a Pobreza do ICMS.
det[].imposto.icms.perc_red_base_icmsnúmero
det[].imposto.icms.valor_fcp_icmsnúmeroValor do FCP - Fundo de Combate a Pobreza do ICMS.
det[].imposto.icms.valor_icmsnúmero
det[].imposto.icms_efetobjetoICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem
det[].imposto.icms_efet.aliq_icms_efetnúmero
det[].imposto.icms_efet.base_icms_efetnúmero
det[].imposto.icms_efet.cod_sit_trib_icms_efettexto · até 2
det[].imposto.icms_efet.modalidade_icms_efettexto · até 1
det[].imposto.icms_efet.origem_icms_efettexto · até 1
det[].imposto.icms_efet.perc_red_base_icms_efetnúmero
det[].imposto.icms_efet.valor_icms_efetnúmero
det[].imposto.icms_ieobjetoICMS Interestadual.
det[].imposto.icms_ie.aliq_icms_FCPnúmeroPercentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino
det[].imposto.icms_ie.aliq_interestadualnúmeroAlíquota Interestadual das UFs Envolvidas
det[].imposto.icms_ie.aliq_interna_uf_destinonúmeroAlíquota Interna da UF de Destino
det[].imposto.icms_ie.aliq_partilha_icmsnúmeroPercentual Provisório de Partilha do ICMS Interestadual
det[].imposto.icms_ie.base_icms_uf_destinonúmeroBC do ICMS na UF de Destino
det[].imposto.icms_ie.valor_fcp_icms_internúmeroValor do fundo de combate a pobreza.
det[].imposto.icms_ie.valor_icms_uf_destnúmeroValor do ICMS - UF Destino
det[].imposto.icms_ie.valor_icms_uf_remetnúmeroValor do ICMS - UF Remetente
det[].imposto.icms_snobjetoICMS - Simples Nacional.
det[].imposto.icms_sn.aliq_icms_snnúmero
det[].imposto.icms_sn.base_icms_snnúmero
det[].imposto.icms_sn.cod_sit_trib_icms_sntexto · até 3
det[].imposto.icms_sn.origem_icms_sntexto · até 1
det[].imposto.icms_sn.valor_credito_icms_snnúmero
det[].imposto.icms_sn.valor_icms_snnúmero
det[].imposto.icms_stobjetoICMS - Substituição Tributária.
det[].imposto.icms_st.aliq_icms_oppropnúmeroAlíquota de ICMS Operação Própria.
det[].imposto.icms_st.aliq_icms_stnúmero
det[].imposto.icms_st.base_fcp_icms_stnúmeroBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST.
det[].imposto.icms_st.base_icms_stnúmero
det[].imposto.icms_st.cesttexto · até 9CEST - Código Especificador da Substituíção Tributária.
det[].imposto.icms_st.cod_sit_trib_icms_sttexto · até 2
det[].imposto.icms_st.margem_icms_stnúmero
det[].imposto.icms_st.modalidade_icms_sttexto · até 1
det[].imposto.icms_st.perc_fcp_icms_stnúmeroPercentual do FCP - Fundo de Combate a Pobreza do ICMS ST.
det[].imposto.icms_st.perc_red_base_icms_opnúmeroPercentual de redução de base de cálculo de Icms Operação Própria.
det[].imposto.icms_st.perc_red_base_icms_stnúmero
det[].imposto.icms_st.valor_fcp_icms_stnúmeroValor do FCP - Fundo de Combate a Pobreza do ICMS ST.
det[].imposto.icms_st.valor_icms_stnúmero
det[].imposto.inssobjetoINSS.
det[].imposto.inss.aliq_inssnúmero
det[].imposto.inss.valor_inssnúmero
det[].imposto.ipiobjetoIPI.
det[].imposto.ipi.aliq_ipinúmero
det[].imposto.ipi.base_ipinúmero
det[].imposto.ipi.cod_sit_trib_ipitexto · até 2
det[].imposto.ipi.enquadramento_ipitextoEnquadramento do IPI
det[].imposto.ipi.qtde_unid_trib_ipinúmero
det[].imposto.ipi.tipo_calculo_ipitexto · até 1
det[].imposto.ipi.valor_ipinúmero
det[].imposto.ipi.valor_unid_trib_ipinúmero
det[].imposto.irrfobjetoIRRF.
det[].imposto.irrf.aliq_irrfnúmero
det[].imposto.irrf.valor_irrfnúmero
det[].imposto.issobjetoISS.
det[].imposto.iss.aliq_issnúmero
det[].imposto.iss.base_issnúmero
det[].imposto.iss.retem_isstexto · até 1
det[].imposto.iss.valor_issnúmero
det[].imposto.pis_padraoobjetoPIS.
det[].imposto.pis_padrao.aliq_pisnúmero
det[].imposto.pis_padrao.base_pisnúmero
det[].imposto.pis_padrao.cod_sit_trib_pistexto · até 2
det[].imposto.pis_padrao.qtde_unid_trib_pisnúmero
det[].imposto.pis_padrao.tipo_calculo_pistexto · até 1
det[].imposto.pis_padrao.valor_pisnúmero
det[].imposto.pis_padrao.valor_unid_trib_pisnúmero
det[].imposto.pis_stobjetoPIS - Substituíção Tributária.
det[].imposto.pis_st.aliq_pis_stnúmero
det[].imposto.pis_st.base_pis_stnúmero
det[].imposto.pis_st.cod_sit_trib_pis_sttexto · até 2
det[].imposto.pis_st.margem_pis_stnúmero
det[].imposto.pis_st.qtde_unid_trib_pis_stnúmero
det[].imposto.pis_st.tipo_calculo_pis_sttexto · até 1
det[].imposto.pis_st.valor_pis_stnúmero
det[].imposto.pis_st.valor_unid_trib_pis_stnúmero
det[].imposto.trib_regobjeto
det[].imposto.trib_reg.aliquota_reg_cbsnúmeroValor 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_munúmeroValor 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_ufnúmeroValor 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_regtexto · até 6Có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_csttexto · até 3Có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_cbsnúmeroValor 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_munúmeroValor 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_ufnúmeroValor 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_adicobjetoDados da aba "Informações Adicionais" do Item do Pedido de Vendas.
det[].inf_adic.codigo_beneficio_fiscaltexto · até 10Código do Benefício Fiscal.
det[].inf_adic.codigo_categoria_itemtexto · até 20Código da Categoria do item.
det[].inf_adic.codigo_cenario_impostos_itemnúmero inteiroCódigo do Cenário de Impostos.
det[].inf_adic.codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
det[].inf_adic.dados_adicionais_itemtextoInformações para a Nota Fiscal.
det[].inf_adic.item_pedido_compranúmero inteiroItem do Pedido de Compra.
det[].inf_adic.nao_gerar_financeirotexto · até 1Não gerar conta a receber para este item. Informar "S" ou "N". (Informe "S" para ativar essa opção).
det[].inf_adic.nao_movimentar_estoquetexto · até 1Nã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_totaltexto · até 1Não somar este item no total da NF-e
det[].inf_adic.numero_fcitexto · até 36Número da FCI (Ficha de Conteúdo de Importação)
det[].inf_adic.numero_pedido_compratexto · até 15Número do Pedido de Compra.
det[].inf_adic.numero_recopitexto · até 20Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune).
det[].inf_adic.peso_brutonúmeroPeso Bruto (Kg).
det[].inf_adic.peso_liquidonúmeroPeso Líquido (Kg).
det[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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órionúmeroInforme 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[].observacaoobjetoDados da aba "Observações" do Item do Pedido de Vendas.
det[].observacao.obs_itemtextoObservaçõ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[].produtoobjetoIdentificação do Produto do Item do Pedido de Vendas.
det[].produto.cfoptexto · até 10CFOP - 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_fabricantetexto · até 20CNPJ do Fabricante da Mercadoria.
det[].produto.codigotexto · até 60Código do Produto exibido na tela do Pedido de Vendas.
det[].produto.codigo_item_kitnúmero inteiroID do Item do kit (pai) que o componente pertence
det[].produto.codigo_produtonúmero inteiroID 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_integracaotexto · até 60Có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_preconúmero inteiroCó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_kittexto · até 1Indica se o produto é um componente de um kit
det[].produto.descricaotexto · até 120Descrição do Produto.
det[].produto.eantexto · até 14EAN - European Article Number
det[].produto.indicador_escalatexto · até 1Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante.
det[].produto.kittexto · até 1Indica se o produto é um kit
det[].produto.motivo_icms_desoneradotexto · até 2Có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.ncmtexto · até 13NCM - 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_descontonúmeroPercentual de Desconto.
det[].produto.quantidadenúmeroQuantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto.
det[].produto.reservadotexto · até 1(S/N) Indica se o estoque do produto será reservado.Ex.: S, N
det[].produto.tipo_descontotexto · até 1Tipo de Desconto.
det[].produto.unidadetexto · até 6Unidade. 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_deducaonúmeroValor da Dedução
det[].produto.valor_descontonúmeroValor do Desconto
det[].produto.valor_icms_desoneradonúmeroValor do ICMS desonerado
det[].produto.valor_mercadorianúmeroValor da Mercadoria
det[].produto.valor_totalnúmeroValor Total.
det[].produto.valor_unitarionúmeroValor Únitário
det[].rastreabilidadeobjetoDados da rastreabilidade do produto.
det[].rastreabilidade.codigoAgregacaoLotetexto · até 20Código de Agregação
det[].rastreabilidade.dataFabricacaoLotetexto · até 10Data de Fabricação/Produção
det[].rastreabilidade.dataValidadeLotetexto · até 10Data de Validade
det[].rastreabilidade.numeroLotetexto · até 20Número do Lote
det[].rastreabilidade.qtdeProdutoLotenúmeroQuantidade de Produto
det[].tributavelobjetoUnidade, Quantidade, Valor e EAN tributáveis do item do pedido.
det[].tributavel.cEanTribtexto · até 14código EAN tributável do item.
det[].tributavel.cUnidTribtexto · até 6Unidade tributável do Item.
det[].tributavel.nQuantTribnúmeroQuantidade tributável do item.
det[].tributavel.nValorTribnúmeroValor tributável do item.
exportacaoobjetoDados da exportacao
exportacao.local_despachotexto · até 60Local de Despacho
exportacao.local_embarquetexto · até 60Local de Embarque (ou de transposição de fronteira)
exportacao.nao_exportacaotexto · até 1O cliente é estrangeiro, mas na verdade não se trata de uma exportação
exportacao.uf_embarquetexto · até 2UF do Local de Embarque
freteobjetoDados da Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.codigo_rastreiotexto · até 500Có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_entreganúmero inteiroCódigo do tipo de entrega.
frete.codigo_transportadoranúmero inteiroID 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_integracaotexto · até 60Có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_volumestexto · até 60Espécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retidoobjetoDados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.cCfopTrtexto · até 10CFOP. 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.cCidadeTrtexto · até 40Cidade 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.vAliquotaRetencaoTrnúmeroPercentual de Alíquota de Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.vBCRetencaoTrnúmeroBase de Cálculo da Retenção. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.vIcmsRetidoTrnúmeroValor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.icms_retido.vServicoTrnúmeroValor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.link_rastreiotexto · até 300Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'.
frete.marca_volumestexto · até 60Marca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.modalidadetexto · até 1Tipo 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_volumestexto · até 60Numeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.numero_lacretexto · até 60Número do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.outras_despesasnúmeroOutras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.peso_brutonúmeroPeso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.peso_liquidonúmeroPeso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.placatexto · até 7Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.placa_estadotexto · até 2Estado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.previsao_entregatexto · até 10Previsão de entrega do Pedido de Venda Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.quantidade_volumesnúmero inteiroQuantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.registro_transportadortexto · até 20RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.valor_fretenúmeroValor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.valor_seguronúmeroValor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
frete.veiculo_propriotexto · até 1O 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.
infoCadastroobjetoInformações complementares do pedido.
infoCadastro.autorizadotexto · até 1Indica se o pedido foi autorizado.
infoCadastro.cImpAPItexto · até 1Importado pela API.
infoCadastro.canceladotexto · até 1Indica se o pedido foi cancelado.
infoCadastro.dAlttexto · até 10Data da Alteração.
infoCadastro.dCantexto · até 10Data da Cancelamento.
infoCadastro.dFattexto · até 10Data de Faturamento.
infoCadastro.dInctexto · até 10Data da Inclusão.
infoCadastro.denegadotexto · até 1Indica se o pedido foi denegado.
infoCadastro.devolvidotexto · até 1Indica se o pedido foi devolvido.
infoCadastro.devolvido_parcialtexto · até 1Indica se o pedido foi devolvido parcialmente.
infoCadastro.faturadotexto · até 1Indica se o pedido está faturado.
infoCadastro.hAlttexto · até 8Hora da Alteração.
infoCadastro.hCantexto · até 8Hora da Cancelamento.
infoCadastro.hFattexto · até 8Hora de faturamento.
infoCadastro.hInctexto · até 8Hora da Inclusão.
infoCadastro.uAlttexto · até 10Usuário da Alteração.
infoCadastro.uCantexto · até 10Usuário da Cancelamento.
infoCadastro.uFattexto · até 10Usuário que realizou o faturamento.
infoCadastro.uInctexto · até 10Usuário da Inclusão.
informacoes_adicionaisobjetoDados da Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.codProjnúmero inteiroCó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.codVendnúmero inteiroCó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_categoriatexto · até 20Có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_correntenúmero inteiroCó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_finaltexto · até 1Nota Fiscal para Consumo Final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.contatotexto · até 100Contato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.dados_adicionais_nftextoDados 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_pagamentotextoDescriçã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_emailtexto · até 1Enviar 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_pixtexto · até 1Enviar 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_embutidosdescontinuadotexto · até 1DEPRECATED
informacoes_adicionais.meio_pagamentotexto · até 100Meio 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.nfRelacionadaobjetoDetalhes da NF referenciada.
informacoes_adicionais.nfRelacionada.InscrEstPRtexto · até 20Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.cChaveReftexto · até 44Chave da NF-e (ou NFC-e ou SAT) Relacionada.
informacoes_adicionais.nfRelacionada.cSeriePRtexto · até 3Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.cSerieReftexto · até 3Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.cSigNFReftexto · até 1Manter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N"
informacoes_adicionais.nfRelacionada.cUfPRtexto · até 2Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.cUfReftexto · até 2Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.cnpjEmitReftexto · até 20CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.cnpjIntermediariotexto · até 20CNPJ 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.cnpjPRtexto · até 20CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.dtEmissaoPRtexto · até 10Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.dtEmissaoReftexto · até 10Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.identIntermediariotexto · até 60Identificaçã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.indIntermediariotexto · até 1Indicador 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.indPresencatexto · até 1Indicador 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.nCOOReftexto · até 6Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado
informacoes_adicionais.nfRelacionada.nECFReftexto · até 3Número de Ordem Sequencial do ECF.
informacoes_adicionais.nfRelacionada.nNFReftexto · até 9Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A
informacoes_adicionais.nfRelacionada.nNfPRtexto · até 9Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
informacoes_adicionais.nfRelacionada.nrCupomFiscallista de objetosOutros cupons fiscais relacionados
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrCOOtexto · até 6Contador de Ordem de Operação (COO)
informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECFtexto · até 3Número do ECF
informacoes_adicionais.nfRelacionada.nrModelo1_1Alista de objetosOutras notas modelo 1/1A relacionadas
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrCnpjCpftexto · até 20CNPJ/CPF do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissaotexto · até 10Data de emissão da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumerotexto · até 9Número da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerietexto · até 3Série da NF relacionada
informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUFtexto · até 2Unidade federativa do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrNFlista de objetosOutras NF-e, NFC-e ou SAT relacionadas
informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrNF[].nrChavetexto · até 44Chave da NF-e, NFC-e ou SAT relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRurallista de objetosOutras notas de produtor rural relacionadas
informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItemtexto · até 1Ação a ser realizada no item na alteração. Pode ser: "I" - Incluir o item. "E" - Excluir o item.
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrCnpjCpftexto · até 20CNPJ/CPF do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissaotexto · até 10Data de emissão da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIEtexto · até 20Inscrição Estadual do emitente da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumerotexto · até 9Número da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerietexto · até 3Série da NF relacionada
informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUFtexto · até 2Unidade federativa do emitente da NF relacionada
informacoes_adicionais.nsutexto · até 100Nú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_contratotexto · até 20Número do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.numero_pedido_clientetexto · até 30Número do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhesobjetoOutros detalhes da NF-e.
informacoes_adicionais.outros_detalhes.cBairroOdtexto · até 60Bairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cBairroOdRettexto · até 60Bairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCEPOdtexto · até 10CEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCEPOdRettexto · até 10CEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCidadeOdtexto · até 40Cidade. 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.cCidadeOdRettexto · até 40Cidade (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.cCnpjCpfOdtexto · até 20CNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cCnpjCpfOdRettexto · até 20CPF/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.cCnpjIntOdtexto · até 20CNPJ 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.cComplementoOdtexto · até 60Complemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cComplementoOdRettexto · até 60Complemento do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEnderecoOdtexto · até 60Endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEnderecoOdRettexto · até 60Endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEstadoOdtexto · até 2Estado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cEstadoOdRettexto · até 2Estado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cHoraSaidaOdtexto · até 8Hora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cIdentificadorIntOdtexto · até 60Identificaçã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.cIndicadorIntOdtexto · até 1Indicador 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.cIndicadorOdtexto · até 1Indicador 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.cInscrEstadualOdtexto · até 20Inscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cInscrEstadualOdRettexto · até 20Inscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNatOperacaoOdtexto · até 60Natureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNomeOdtexto · até 60Nome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNomeOdRettexto · até 60Nome / Razão Social (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNumeroOdtexto · até 10Número do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cNumeroOdRettexto · até 10Número do endereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cSepararEnderecoOdtexto · até 1Separar 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.cSepararEnderecoOdRettexto · até 1Separar 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.cTelefoneOdtexto · até 15Telefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.cTelefoneOdRettexto · até 15Telefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.outros_detalhes.dDataSaidaOdtexto · até 10Data de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
informacoes_adicionais.tipo_documentotexto · até 5Tipo 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_emailstextoUtilizar 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.
lancamentoslista de objetosLançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros).
lancamentos[].cCategoriatexto · até 20Código da Categoria.
lancamentos[].cNaturezaDocumentotexto · até 1Natureza 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[].cObstextoObservações.
lancamentos[].cOrigemtexto · até 3Origem 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[].cTipoDocumentotexto · até 5Tipo 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[].dDataDocumentotexto · até 10Data do documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda".
lancamentos[].nContaCorrentenúmero inteiroId da Conta Corrente.
lancamentos[].nProjetonúmero inteiroId do projeto.
lancamentos[].nSequencianúmero inteiroNú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[].nValorDocumentonúmeroValor do Documento. Obrigatório na operação "IncluirPedido"; não é processado nas demais operações que reutilizam esta estrutura, como "AlterarPedidoVenda".
lancamentos[].nVendedornúmero inteiroId do Vendedor.
lista_parcelasobjetoDados da Aba "Parcelas" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura.
lista_parcelas.parcelalista de objetosDados da parcela.
lista_parcelas.parcela[].bandeiratexto · até 2Código da Bandeira da operadora de cartão.
lista_parcelas.parcela[].categoria_adiantamentotexto · até 20Có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_fintexto · até 20Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente.
lista_parcelas.parcela[].conta_corrente_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].data_vencimentotexto · até 10Data de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].descr_meio_pagamentotextoDescriçã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_pagamentotexto · até 100Meio 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_boletotexto · até 1Indica 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[].nsutexto · até 100Nú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_parcelanúmero inteiroNúmero da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].parcela_adiantamentotexto · até 1Está é 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[].percentualnúmeroPercentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].quantidade_diasnúmero inteiroQuantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
lista_parcelas.parcela[].tipo_documentotexto · até 5Tipo 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[].valornúmeroValor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
market_placeobjetoDados para o Market Place.
market_place.nEnvionúmeroValor do envio do Market Place.
market_place.nTaxanúmeroValor da taxa do Market Place.
observacoesobjetoDados da Aba "Observações" do Pedido de Venda.
observacoes.obs_vendatextoObservações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba "Observações" do Pedido de Venda.
total_pedidoobjetoValores totais do pedido.
total_pedido.base_calculo_icmsnúmeroBase de Cálculo do ICMS.
total_pedido.base_calculo_stnúmeroBase de cálculo da substituição tributária.
total_pedido.base_ibs_cbsnúmeroValor total da base de cálculo do IBS e da CBS.
total_pedido.valor_IPInúmeroValor do IPI.
total_pedido.valor_cbsnúmeroValor total da CBS.
total_pedido.valor_cofinsnúmeroValor do cofins.
total_pedido.valor_csllnúmeroValor da CSLL.
total_pedido.valor_deducoesnúmeroValor das deduções.
total_pedido.valor_descontosnúmeroValor dos descontos.
total_pedido.valor_dif_cbsnúmeroValor total do diferimento da CBS.
total_pedido.valor_dif_ibs_munúmeroValor total do diferimento do IBS do município.
total_pedido.valor_dif_ibs_ufnúmeroValor total do diferimento do IBS UF.
total_pedido.valor_ibsnúmeroValor total do IBS.
total_pedido.valor_ibs_munúmeroValor total do IBS do município.
total_pedido.valor_ibs_ufnúmeroValor total do IBS da UF.
total_pedido.valor_icmsnúmeroValor total do ICMS.
total_pedido.valor_inssnúmeroValor do INSS.
total_pedido.valor_irnúmeroValor do IR. .Preenchimento automático - Não informar.
total_pedido.valor_issnúmeroValor do ISS.
total_pedido.valor_mercadoriasnúmerovalor das mercadorias.
total_pedido.valor_pisnúmeroValor do PIS.
total_pedido.valor_stnúmeroValor total da ST.
total_pedido.valor_tot_ibs_cbs_isnúmeroTotal da NF-e com IBS/CBS/IS.
total_pedido.valor_total_pedidonúmeroValor total do pedido.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_pedidonúmero inteiroCódigo do Pedido de Venda de Produto
codigo_pedido_integracaotextoCódigo de Integração do Pedido de Venda de Produto
codigo_statustextoCódigo do Status do Pedido de Venda.
descricao_statustextoDescrição do status.
numero_pedidotextoNú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}]}}]}'

ListarPedidos

consultaClaudeChatGPTMCP

Listar os pedidos de venda de produto

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 24Campos e estruturas que você pode enviar
CampoTipoDescrição
apenas_importado_apitexto · até 1
apenas_resumotexto · até 1Exibir apenas o resumo do pedido de vendas. Preencher com "S" ou "N".
data_cancelamento_atetexto · até 10Data de Cancelamento final.
data_cancelamento_detexto · até 10Data de Cancelamento inicial.
data_faturamento_atetexto · até 10Data de Faturamento final.
data_faturamento_detexto · até 10Data de Faturamento inicial.
data_previsao_atetexto · até 10Data de Previsão do faturamento final.
data_previsao_detexto · até 10Data de Previsão do faturamento inicio.
etapatexto · até 2Etapa 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_alteracaotexto · até 1
filtrar_apenas_inclusaotexto · até 1
filtrar_por_clientenúmero inteiroFiltra os registros do cliente específicado.
filtrar_por_data_atetexto · até 10
filtrar_por_data_detexto · até 10
filtrar_por_hora_atetexto · até 8Filtra os registros até a hora específicada.
filtrar_por_hora_detexto · até 8Filtra os registros a partir da hora específicada.
filtrar_por_projetonúmero inteiroFiltra os registros do projeto específicado.
filtrar_por_vendedornúmero inteiroFiltra os registros do vendedor específicado.
numero_pedido_atenúmero inteiroFiltra os registros até o número do pedido específicado.
numero_pedido_denúmero inteiroFiltra os registros a partir do número do pedido específicado.
ordenar_portexto · até 100Ordem de exibição dos dados. Padrão: Código.
paginanúmero inteiro
registros_por_paginanúmero inteiro
status_pedidotexto · até 100Status do Pedido. FATURADO CANCELADO AUTORIZADO DENEGADO DEVOLVIDO
Descontinuados 3Ainda aceitos, fora do fluxo principal
CampoTipoDescrição
data_emissao_atedescontinuadotexto · até 10DEPRECATED
data_emissao_dedescontinuadotexto · até 10DEPRECATED
ordem_descrescentedescontinuadotexto · até 1DEPRECATED
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
paginanúmero inteiro
pedido_venda_produtolista de objetosCadastro de Pedido de Venda
pedido_venda_produto[].agropecuarioobjeto
pedido_venda_produto[].agropecuario.cCpfResponsaveltextoCPF do responsá¡vel técnico legalmente habilitado
pedido_venda_produto[].agropecuario.cNumReceitatextoNúmero da receita ou receituário do agrotóxico/defensivo agrícola
pedido_venda_produto[].agropecuario.cSerieGuiatextoNúmero de série da guia
pedido_venda_produto[].agropecuario.cUFGuiatextoUF de emissão da Guia
pedido_venda_produto[].agropecuario.nNumGuianúmero inteiroNúmero da guia
pedido_venda_produto[].agropecuario.nTipoGuianúmero inteiroTipo 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[].cabecalhoobjetoInformações do cabeçalho do pedido.
pedido_venda_produto[].cabecalho.bloqueadotextoPedido Bloqueado pela API.
pedido_venda_produto[].cabecalho.codigo_cenario_impostosnúmero inteiroCódigo do Cenário de Impostos. Se não informado, será assumido o cenário padrão.
pedido_venda_produto[].cabecalho.codigo_clientenúmero inteiroCó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_integracaotextoCó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_empresanúmero inteiroDEPRECATED
pedido_venda_produto[].cabecalho.codigo_empresa_integracaotextoDEPRECATED
pedido_venda_produto[].cabecalho.codigo_parcelatextoCó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_pedidonúmero inteiroID 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_integracaotextoCó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_previsaotextoData 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_datatextoData de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto[].cabecalho.enc_horatextoHora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto[].cabecalho.enc_motivotextoDescrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto[].cabecalho.enc_usertextoUsuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto[].cabecalho.encerradotextoIndica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta.
pedido_venda_produto[].cabecalho.etapatextoEtapa 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_apitextoPedido de venda de produto importada pela API.
pedido_venda_produto[].cabecalho.nao_gerar_boletotextoIndica 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_pedidotextoNú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_pedidotextoOrigem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda.
pedido_venda_produto[].cabecalho.perc_desconto_pedidodecimalPercentual 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_parcelasnúmero inteiroQuantidade de parcelas. Valores permitidos de 1 a 999.
pedido_venda_produto[].cabecalho.quantidade_itensnúmero inteiroQuantidade de Itens.
pedido_venda_produto[].cabecalho.sequencialtextoNú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_pedidotextoTipo 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_pedidodecimalValor 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[].departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
pedido_venda_produto[].departamentos[].cCodDeptotextoID 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[].nPercdecimalPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
pedido_venda_produto[].departamentos[].nValordecimalValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
pedido_venda_produto[].departamentos[].nValorFixotextoIndica 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[].detlista de objetosDados da Aba "Itens da Venda" do Pedido de Venda.
pedido_venda_produto[].det[].combustivelobjetoDetalhamento específico de Combustível.
pedido_venda_produto[].det[].combustivel.cCODIFtextoRegistro do CODIF.
pedido_venda_produto[].det[].combustivel.cCodigoANPtextoCódigo de Produto da ANP.
pedido_venda_produto[].det[].combustivel.cDescrANPtextoDescrição do Produto conforme ANP.
pedido_venda_produto[].det[].combustivel.cUFConsumoCombtextoUF de Consumo.
pedido_venda_produto[].det[].combustivel.nAliquota_CIDEdecimalValor da Alíquota em Reais da CIDE.
pedido_venda_produto[].det[].combustivel.nBC_CIDEdecimalBase de Cálculo (em quantidade) da CIDE.
pedido_venda_produto[].det[].combustivel.nBC_UFDestdecimalBase de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
pedido_venda_produto[].det[].combustivel.nBC_UFRemdecimalBase de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária.
pedido_venda_produto[].det[].combustivel.nPercGLPdecimalPercentual de GLP Derivado do Petróleo.
pedido_venda_produto[].det[].combustivel.nPercGasImportadodecimalPercentual de Gás Natural Importado.
pedido_venda_produto[].det[].combustivel.nPercGasNacionaldecimalPercentual de Gás Natural Nacional.
pedido_venda_produto[].det[].combustivel.nQtdeFatTempAmbdecimalQuantidade Faturada à Temperatura Ambiente.
pedido_venda_produto[].det[].combustivel.nValorPartidadecimalValor de Partida.
pedido_venda_produto[].det[].combustivel.nValorUFDestdecimalValor da UF Destino. Base de Cálculo do ICMS ST da UF Destino.
pedido_venda_produto[].det[].combustivel.nValorUFRemdecimalValor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária.
pedido_venda_produto[].det[].combustivel.nValor_CIDEdecimalValor da CIDE.
pedido_venda_produto[].det[].ideobjetoIdentificação do Item do Pedido de Vendas.
pedido_venda_produto[].det[].ide.acao_itemtextoAção para o item. Pode ser: "E" - para excluir um item.
pedido_venda_produto[].det[].ide.codigo_itemnúmero inteiroID do Item do Pedido.
pedido_venda_produto[].det[].ide.codigo_item_integracaotextoCó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_producaonúmero inteiroId 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_impostosnúmero inteiroDEPRECATED
pedido_venda_produto[].det[].ide.simples_nacionaltextoIndica que a empresa é Optante pelo Simples Nacional. Informar "S" ou "N".
pedido_venda_produto[].det[].impostoobjetoInformaçõ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.cbsobjeto
pedido_venda_produto[].det[].imposto.cbs.aliquota_cbsdecimalAlí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_cbsdecimalPercentual 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_cbsdecimalPercentual 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_cbsdecimalValor 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_cbsdecimalValor 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_padraoobjetoCOFINS.
pedido_venda_produto[].det[].imposto.cofins_padrao.aliq_cofinsdecimal
pedido_venda_produto[].det[].imposto.cofins_padrao.base_cofinsdecimal
pedido_venda_produto[].det[].imposto.cofins_padrao.cod_sit_trib_cofinstexto
pedido_venda_produto[].det[].imposto.cofins_padrao.qtde_unid_trib_cofinsdecimal
pedido_venda_produto[].det[].imposto.cofins_padrao.tipo_calculo_cofinstexto
pedido_venda_produto[].det[].imposto.cofins_padrao.valor_cofinsdecimal
pedido_venda_produto[].det[].imposto.cofins_padrao.valor_unid_trib_cofinsdecimal
pedido_venda_produto[].det[].imposto.cofins_stobjetoCOFINS - Substituição Tributária.
pedido_venda_produto[].det[].imposto.cofins_st.aliq_cofins_stdecimal
pedido_venda_produto[].det[].imposto.cofins_st.base_cofins_stdecimal
pedido_venda_produto[].det[].imposto.cofins_st.cod_sit_trib_cofins_sttexto
pedido_venda_produto[].det[].imposto.cofins_st.margem_cofins_stdecimal
pedido_venda_produto[].det[].imposto.cofins_st.qtde_unid_trib_cofins_stdecimal
pedido_venda_produto[].det[].imposto.cofins_st.tipo_calculo_cofins_sttexto
pedido_venda_produto[].det[].imposto.cofins_st.valor_cofins_stdecimal
pedido_venda_produto[].det[].imposto.cofins_st.valor_unid_trib_cofins_stdecimal
pedido_venda_produto[].det[].imposto.csllobjetoCSLL.
pedido_venda_produto[].det[].imposto.csll.aliq_cslldecimal
pedido_venda_produto[].det[].imposto.csll.valor_cslldecimal
pedido_venda_produto[].det[].imposto.ibsobjeto
pedido_venda_produto[].det[].imposto.ibs.aliquota_ibs_mudecimalAlí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_ufdecimalAlí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_mudecimalPercentual 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_ufdecimalPercentual 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_mudecimalPercentual 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_ufdecimalPercentual 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_mudecimalValor 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_ufdecimalValor 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_ibsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_cbsobjeto
pedido_venda_produto[].det[].imposto.ibs_cbs.base_ibs_cbsdecimalBase 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_tribtextoCó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_cbstextoCó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.icmsobjetoICMS
pedido_venda_produto[].det[].imposto.icms.aliq_icmsdecimal
pedido_venda_produto[].det[].imposto.icms.base_fcp_icmsdecimalBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS.
pedido_venda_produto[].det[].imposto.icms.base_icmsdecimal
pedido_venda_produto[].det[].imposto.icms.cod_sit_trib_icmstexto
pedido_venda_produto[].det[].imposto.icms.modalidade_icmstexto
pedido_venda_produto[].det[].imposto.icms.origem_icmstexto
pedido_venda_produto[].det[].imposto.icms.perc_fcp_icmsdecimalPercentual do FCP - Fundo de Combate a Pobreza do ICMS.
pedido_venda_produto[].det[].imposto.icms.perc_red_base_icmsdecimal
pedido_venda_produto[].det[].imposto.icms.valor_fcp_icmsdecimalValor do FCP - Fundo de Combate a Pobreza do ICMS.
pedido_venda_produto[].det[].imposto.icms.valor_icmsdecimal
pedido_venda_produto[].det[].imposto.icms_efetobjetoICMS 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_efetdecimal
pedido_venda_produto[].det[].imposto.icms_efet.base_icms_efetdecimal
pedido_venda_produto[].det[].imposto.icms_efet.cod_sit_trib_icms_efettexto
pedido_venda_produto[].det[].imposto.icms_efet.modalidade_icms_efettexto
pedido_venda_produto[].det[].imposto.icms_efet.origem_icms_efettexto
pedido_venda_produto[].det[].imposto.icms_efet.perc_red_base_icms_efetdecimal
pedido_venda_produto[].det[].imposto.icms_efet.valor_icms_efetdecimal
pedido_venda_produto[].det[].imposto.icms_ieobjetoICMS Interestadual.
pedido_venda_produto[].det[].imposto.icms_ie.aliq_icms_FCPdecimalPercentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino
pedido_venda_produto[].det[].imposto.icms_ie.aliq_interestadualdecimalAlíquota Interestadual das UFs Envolvidas
pedido_venda_produto[].det[].imposto.icms_ie.aliq_interna_uf_destinodecimalAlíquota Interna da UF de Destino
pedido_venda_produto[].det[].imposto.icms_ie.aliq_partilha_icmsdecimalPercentual Provisório de Partilha do ICMS Interestadual
pedido_venda_produto[].det[].imposto.icms_ie.base_icms_uf_destinodecimalBC do ICMS na UF de Destino
pedido_venda_produto[].det[].imposto.icms_ie.valor_fcp_icms_interdecimalValor do fundo de combate a pobreza.
pedido_venda_produto[].det[].imposto.icms_ie.valor_icms_uf_destdecimalValor do ICMS - UF Destino
pedido_venda_produto[].det[].imposto.icms_ie.valor_icms_uf_remetdecimalValor do ICMS - UF Remetente
pedido_venda_produto[].det[].imposto.icms_snobjetoICMS - Simples Nacional.
pedido_venda_produto[].det[].imposto.icms_sn.aliq_icms_sndecimal
pedido_venda_produto[].det[].imposto.icms_sn.base_icms_sndecimal
pedido_venda_produto[].det[].imposto.icms_sn.cod_sit_trib_icms_sntexto
pedido_venda_produto[].det[].imposto.icms_sn.origem_icms_sntexto
pedido_venda_produto[].det[].imposto.icms_sn.valor_credito_icms_sndecimal
pedido_venda_produto[].det[].imposto.icms_sn.valor_icms_sndecimal
pedido_venda_produto[].det[].imposto.icms_stobjetoICMS - Substituição Tributária.
pedido_venda_produto[].det[].imposto.icms_st.aliq_icms_oppropdecimalAlíquota de ICMS Operação Própria.
pedido_venda_produto[].det[].imposto.icms_st.aliq_icms_stdecimal
pedido_venda_produto[].det[].imposto.icms_st.base_fcp_icms_stdecimalBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST.
pedido_venda_produto[].det[].imposto.icms_st.base_icms_stdecimal
pedido_venda_produto[].det[].imposto.icms_st.cesttextoCEST - Código Especificador da Substituíção Tributária.
pedido_venda_produto[].det[].imposto.icms_st.cod_sit_trib_icms_sttexto
pedido_venda_produto[].det[].imposto.icms_st.margem_icms_stdecimal
pedido_venda_produto[].det[].imposto.icms_st.modalidade_icms_sttexto
pedido_venda_produto[].det[].imposto.icms_st.perc_fcp_icms_stdecimalPercentual do FCP - Fundo de Combate a Pobreza do ICMS ST.
pedido_venda_produto[].det[].imposto.icms_st.perc_red_base_icms_opdecimalPercentual 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_stdecimal
pedido_venda_produto[].det[].imposto.icms_st.valor_fcp_icms_stdecimalValor do FCP - Fundo de Combate a Pobreza do ICMS ST.
pedido_venda_produto[].det[].imposto.icms_st.valor_icms_stdecimal
pedido_venda_produto[].det[].imposto.inssobjetoINSS.
pedido_venda_produto[].det[].imposto.inss.aliq_inssdecimal
pedido_venda_produto[].det[].imposto.inss.valor_inssdecimal
pedido_venda_produto[].det[].imposto.ipiobjetoIPI.
pedido_venda_produto[].det[].imposto.ipi.aliq_ipidecimal
pedido_venda_produto[].det[].imposto.ipi.base_ipidecimal
pedido_venda_produto[].det[].imposto.ipi.cod_sit_trib_ipitexto
pedido_venda_produto[].det[].imposto.ipi.enquadramento_ipitextoEnquadramento do IPI
pedido_venda_produto[].det[].imposto.ipi.qtde_unid_trib_ipidecimal
pedido_venda_produto[].det[].imposto.ipi.tipo_calculo_ipitexto
pedido_venda_produto[].det[].imposto.ipi.valor_ipidecimal
pedido_venda_produto[].det[].imposto.ipi.valor_unid_trib_ipidecimal
pedido_venda_produto[].det[].imposto.irrfobjetoIRRF.
pedido_venda_produto[].det[].imposto.irrf.aliq_irrfdecimal
pedido_venda_produto[].det[].imposto.irrf.valor_irrfdecimal
pedido_venda_produto[].det[].imposto.issobjetoISS.
pedido_venda_produto[].det[].imposto.iss.aliq_issdecimal
pedido_venda_produto[].det[].imposto.iss.base_issdecimal
pedido_venda_produto[].det[].imposto.iss.retem_isstexto
pedido_venda_produto[].det[].imposto.iss.valor_issdecimal
pedido_venda_produto[].det[].imposto.pis_padraoobjetoPIS.
pedido_venda_produto[].det[].imposto.pis_padrao.aliq_pisdecimal
pedido_venda_produto[].det[].imposto.pis_padrao.base_pisdecimal
pedido_venda_produto[].det[].imposto.pis_padrao.cod_sit_trib_pistexto
pedido_venda_produto[].det[].imposto.pis_padrao.qtde_unid_trib_pisdecimal
pedido_venda_produto[].det[].imposto.pis_padrao.tipo_calculo_pistexto
pedido_venda_produto[].det[].imposto.pis_padrao.valor_pisdecimal
pedido_venda_produto[].det[].imposto.pis_padrao.valor_unid_trib_pisdecimal
pedido_venda_produto[].det[].imposto.pis_stobjetoPIS - Substituíção Tributária.
pedido_venda_produto[].det[].imposto.pis_st.aliq_pis_stdecimal
pedido_venda_produto[].det[].imposto.pis_st.base_pis_stdecimal
pedido_venda_produto[].det[].imposto.pis_st.cod_sit_trib_pis_sttexto
pedido_venda_produto[].det[].imposto.pis_st.margem_pis_stdecimal
pedido_venda_produto[].det[].imposto.pis_st.qtde_unid_trib_pis_stdecimal
pedido_venda_produto[].det[].imposto.pis_st.tipo_calculo_pis_sttexto
pedido_venda_produto[].det[].imposto.pis_st.valor_pis_stdecimal
pedido_venda_produto[].det[].imposto.pis_st.valor_unid_trib_pis_stdecimal
pedido_venda_produto[].det[].imposto.trib_regobjeto
pedido_venda_produto[].det[].imposto.trib_reg.aliquota_reg_cbsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_regtextoCó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_csttextoCó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_cbsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_adicobjetoDados da aba "Informações Adicionais" do Item do Pedido de Vendas.
pedido_venda_produto[].det[].inf_adic.codigo_beneficio_fiscaltextoCódigo do Benefício Fiscal.
pedido_venda_produto[].det[].inf_adic.codigo_categoria_itemtextoCódigo da Categoria do item.
pedido_venda_produto[].det[].inf_adic.codigo_cenario_impostos_itemnúmero inteiroCódigo do Cenário de Impostos.
pedido_venda_produto[].det[].inf_adic.codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
pedido_venda_produto[].det[].inf_adic.dados_adicionais_itemtextoInformações para a Nota Fiscal.
pedido_venda_produto[].det[].inf_adic.item_pedido_compranúmero inteiroItem do Pedido de Compra.
pedido_venda_produto[].det[].inf_adic.nao_gerar_financeirotextoNã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_estoquetextoNã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_totaltextoNão somar este item no total da NF-e
pedido_venda_produto[].det[].inf_adic.numero_fcitextoNúmero da FCI (Ficha de Conteúdo de Importação)
pedido_venda_produto[].det[].inf_adic.numero_pedido_compratextoNúmero do Pedido de Compra.
pedido_venda_produto[].det[].inf_adic.numero_recopitextoNúmero do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune).
pedido_venda_produto[].det[].inf_adic.peso_brutodecimalPeso Bruto (Kg).
pedido_venda_produto[].det[].inf_adic.peso_liquidodecimalPeso Líquido (Kg).
pedido_venda_produto[].det[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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[].nQtdLotedecimalInforme 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[].observacaoobjetoDados da aba "Observações" do Item do Pedido de Vendas.
pedido_venda_produto[].det[].observacao.obs_itemtextoObservaçõ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[].produtoobjetoIdentificação do Produto do Item do Pedido de Vendas.
pedido_venda_produto[].det[].produto.cfoptextoCFOP - 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_fabricantetextoCNPJ do Fabricante da Mercadoria.
pedido_venda_produto[].det[].produto.codigotextoCódigo do Produto exibido na tela do Pedido de Vendas.
pedido_venda_produto[].det[].produto.codigo_item_kitnúmero inteiroID do Item do kit (pai) que o componente pertence
pedido_venda_produto[].det[].produto.codigo_produtonúmero inteiroID 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_integracaotextoCó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_preconúmero inteiroCó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_kittextoIndica se o produto é um componente de um kit
pedido_venda_produto[].det[].produto.descricaotextoDescrição do Produto.
pedido_venda_produto[].det[].produto.eantextoEAN - European Article Number
pedido_venda_produto[].det[].produto.indicador_escalatextoIndicador 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.kittextoIndica se o produto é um kit
pedido_venda_produto[].det[].produto.motivo_icms_desoneradotextoCó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.ncmtextoNCM - 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_descontodecimalPercentual de Desconto.
pedido_venda_produto[].det[].produto.quantidadedecimalQuantidade 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.reservadotexto(S/N) Indica se o estoque do produto será reservado.
pedido_venda_produto[].det[].produto.tipo_descontotextoTipo de Desconto.
pedido_venda_produto[].det[].produto.unidadetextoUnidade. 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_deducaodecimalValor da Dedução
pedido_venda_produto[].det[].produto.valor_descontodecimalValor do Desconto
pedido_venda_produto[].det[].produto.valor_icms_desoneradodecimalValor do ICMS desonerado
pedido_venda_produto[].det[].produto.valor_mercadoriadecimalValor da Mercadoria
pedido_venda_produto[].det[].produto.valor_totaldecimalValor Total.
pedido_venda_produto[].det[].produto.valor_unitariodecimalValor Únitário
pedido_venda_produto[].det[].rastreabilidadeobjetoDados da rastreabilidade do produto.
pedido_venda_produto[].det[].rastreabilidade.codigoAgregacaoLotetextoCódigo de Agregação
pedido_venda_produto[].det[].rastreabilidade.dataFabricacaoLotetextoData de Fabricação/Produção
pedido_venda_produto[].det[].rastreabilidade.dataValidadeLotetextoData de Validade
pedido_venda_produto[].det[].rastreabilidade.numeroLotetextoNúmero do Lote
pedido_venda_produto[].det[].rastreabilidade.qtdeProdutoLotedecimalQuantidade de Produto
pedido_venda_produto[].det[].tributavelobjetoUnidade, Quantidade, Valor e EAN tributáveis do item do pedido.
pedido_venda_produto[].det[].tributavel.cEanTribtextocódigo EAN tributável do item.
pedido_venda_produto[].det[].tributavel.cUnidTribtextoUnidade tributável do Item.
pedido_venda_produto[].det[].tributavel.nQuantTribdecimalQuantidade tributável do item.
pedido_venda_produto[].det[].tributavel.nValorTribdecimalValor tributável do item.
pedido_venda_produto[].exportacaoobjetoDados da exportacao
pedido_venda_produto[].exportacao.local_despachotextoLocal de Despacho
pedido_venda_produto[].exportacao.local_embarquetextoLocal de Embarque (ou de transposição de fronteira)
pedido_venda_produto[].exportacao.nao_exportacaotextoO cliente é estrangeiro, mas na verdade não se trata de uma exportação
pedido_venda_produto[].exportacao.uf_embarquetextoUF do Local de Embarque
pedido_venda_produto[].freteobjetoDados da Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.codigo_rastreiotextoCó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_entreganúmero inteiroCódigo do tipo de entrega.
pedido_venda_produto[].frete.codigo_transportadoranúmero inteiroID 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_integracaotextoCó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_volumestextoEspécie dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.icms_retidoobjetoDados 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.cCfopTrtextoCFOP. 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.cCidadeTrtextoCidade 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.vAliquotaRetencaoTrdecimalPercentual 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.vBCRetencaoTrdecimalBase 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.vIcmsRetidoTrdecimalValor de ICMS Retido. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.icms_retido.vServicoTrdecimalValor de Serviço de Transporte. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.link_rastreiotextoLink 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_volumestextoMarca dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.modalidadetextoTipo 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_volumestextoNumeração dos Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.numero_lacretextoNúmero do Lacre. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.outras_despesasdecimalOutras Despesas Acessórias. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.peso_brutodecimalPeso Bruto (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.peso_liquidodecimalPeso Líquido (Kg). Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.placatextoPlaca do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.placa_estadotextoEstado da Placa do Veículo. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.previsao_entregatextoPrevisã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_volumesnúmero inteiroQuantidade de Volumes. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.registro_transportadortextoRNTRC (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_fretedecimalValor do Frete. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.valor_segurodecimalValor do Seguro. Informação localizada na Aba "Frete e Outras Despesas" do Pedido de Venda.
pedido_venda_produto[].frete.veiculo_propriotextoO 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[].infoCadastroobjetoInformações complementares do pedido.
pedido_venda_produto[].infoCadastro.autorizadotextoIndica se o pedido foi autorizado.
pedido_venda_produto[].infoCadastro.cImpAPItextoImportado pela API.
pedido_venda_produto[].infoCadastro.canceladotextoIndica se o pedido foi cancelado.
pedido_venda_produto[].infoCadastro.dAlttextoData da Alteração.
pedido_venda_produto[].infoCadastro.dCantextoData da Cancelamento.
pedido_venda_produto[].infoCadastro.dFattextoData de Faturamento.
pedido_venda_produto[].infoCadastro.dInctextoData da Inclusão.
pedido_venda_produto[].infoCadastro.denegadotextoIndica se o pedido foi denegado.
pedido_venda_produto[].infoCadastro.devolvidotextoIndica se o pedido foi devolvido.
pedido_venda_produto[].infoCadastro.devolvido_parcialtextoIndica se o pedido foi devolvido parcialmente.
pedido_venda_produto[].infoCadastro.faturadotextoIndica se o pedido está faturado.
pedido_venda_produto[].infoCadastro.hAlttextoHora da Alteração.
pedido_venda_produto[].infoCadastro.hCantextoHora da Cancelamento.
pedido_venda_produto[].infoCadastro.hFattextoHora de faturamento.
pedido_venda_produto[].infoCadastro.hInctextoHora da Inclusão.
pedido_venda_produto[].infoCadastro.uAlttextoUsuário da Alteração.
pedido_venda_produto[].infoCadastro.uCantextoUsuário da Cancelamento.
pedido_venda_produto[].infoCadastro.uFattextoUsuário que realizou o faturamento.
pedido_venda_produto[].infoCadastro.uInctextoUsuário da Inclusão.
pedido_venda_produto[].informacoes_adicionaisobjetoDados da Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.codProjnúmero inteiroCó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.codVendnúmero inteiroCó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_categoriatextoCó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_correntenúmero inteiroCó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_finaltextoNota 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.contatotextoContato. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.dados_adicionais_nftextoDados 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_pagamentotextoDescriçã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_emailtextoEnviar 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_pixtextoEnviar 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_embutidostextoDEPRECATED
pedido_venda_produto[].informacoes_adicionais.meio_pagamentotextoMeio 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.nfRelacionadaobjetoDetalhes da NF referenciada.
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.InscrEstPRtextoInscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cChaveReftextoChave da NF-e (ou NFC-e ou SAT) Relacionada.
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cSeriePRtextoSérie da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cSerieReftextoSérie da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cSigNFReftextoManter o sigilo da NF-e referenciada. Preencher com "S" ou "N". Default "N"
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cUfPRtextoEstado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cUfReftextoEstado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cnpjEmitReftextoCNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.cnpjIntermediariotextoCNPJ 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.cnpjPRtextoCNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.dtEmissaoPRtextoData de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.dtEmissaoReftextoData de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.identIntermediariotextoIdentificaçã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.indIntermediariotextoIndicador 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.indPresencatextoIndicador 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.nCOOReftextoNúmero do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nECFReftextoNúmero de Ordem Sequencial do ECF.
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nNFReftextoNúmero da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nNfPRtextoNúmero da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscallista de objetosOutros cupons fiscais relacionados
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscal[].cAcaoItemtextoAçã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[].nrCOOtextoContador de Ordem de Operação (COO)
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrCupomFiscal[].nrNumeroECFtextoNúmero do ECF
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1Alista de objetosOutras notas modelo 1/1A relacionadas
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].cAcaoItemtextoAçã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[].nrCnpjCpftextoCNPJ/CPF do emitente da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrDtEmissaotextoData de emissão da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrNumerotextoNúmero da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrSerietextoSérie da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrModelo1_1A[].nrUFtextoUnidade federativa do emitente da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrNFlista de objetosOutras NF-e, NFC-e ou SAT relacionadas
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrNF[].cAcaoItemtextoAçã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[].nrChavetextoChave da NF-e, NFC-e ou SAT relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRurallista de objetosOutras notas de produtor rural relacionadas
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].cAcaoItemtextoAçã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[].nrCnpjCpftextoCNPJ/CPF do emitente da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrDtEmissaotextoData de emissão da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrIEtextoInscrição Estadual do emitente da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrNumerotextoNúmero da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrSerietextoSérie da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nfRelacionada.nrProdutorRural[].nrUFtextoUnidade federativa do emitente da NF relacionada
pedido_venda_produto[].informacoes_adicionais.nsutextoNú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_contratotextoNúmero do Contrato de Venda. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.numero_pedido_clientetextoNúmero do pedido do cliente. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhesobjetoOutros detalhes da NF-e.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cBairroOdtextoBairro. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cBairroOdRettextoBairro (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCEPOdtextoCEP. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCEPOdRettextoCEP (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCidadeOdtextoCidade. 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.cCidadeOdRettextoCidade (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.cCnpjCpfOdtextoCNPJ / CPF (do recebedor). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cCnpjCpfOdRettextoCPF/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.cCnpjIntOdtextoCNPJ 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.cComplementoOdtextoComplemento do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cComplementoOdRettextoComplemento 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.cEnderecoOdtextoEndereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEnderecoOdRettextoEndereço (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEstadoOdtextoEstado. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cEstadoOdRettextoEstado (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cHoraSaidaOdtextoHora de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cIdentificadorIntOdtextoIdentificaçã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.cIndicadorIntOdtextoIndicador 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.cIndicadorOdtextoIndicador 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.cInscrEstadualOdtextoInscrição Estadual. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cInscrEstadualOdRettextoInscrição Estadual (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNatOperacaoOdtextoNatureza da Operação. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNomeOdtextoNome / Razão Social. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNomeOdRettextoNome / 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.cNumeroOdtextoNúmero do endereço. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cNumeroOdRettextoNú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.cSepararEnderecoOdtextoSeparar 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.cSepararEnderecoOdRettextoSeparar 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.cTelefoneOdtextoTelefone. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.cTelefoneOdRettextoTelefone (Local de Retirada). Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.outros_detalhes.dDataSaidaOdtextoData de Saída. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
pedido_venda_produto[].informacoes_adicionais.tipo_documentotextoTipo 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_emailstextoUtilizar 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[].lancamentoslista de objetosLançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros).
pedido_venda_produto[].lancamentos[].cCategoriatextoCódigo da Categoria.
pedido_venda_produto[].lancamentos[].cNaturezaDocumentotextoNatureza 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[].cObstextoObservações.
pedido_venda_produto[].lancamentos[].cOrigemtextoOrigem 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[].cTipoDocumentotextoTipo 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[].dDataDocumentotextoData 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[].nContaCorrentenúmero inteiroId da Conta Corrente.
pedido_venda_produto[].lancamentos[].nProjetonúmero inteiroId do projeto.
pedido_venda_produto[].lancamentos[].nSequencianúmero inteiroNú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[].nValorDocumentodecimalValor 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[].nVendedornúmero inteiroId do Vendedor.
pedido_venda_produto[].lista_parcelasobjetoDados 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.parcelalista de objetosDados da parcela.
pedido_venda_produto[].lista_parcelas.parcela[].bandeiratextoCódigo da Bandeira da operadora de cartão.
pedido_venda_produto[].lista_parcelas.parcela[].categoria_adiantamentotextoCó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_fintextoInformar o CNPJ da instituição de pagamento, adquirente ou subadquirente.
pedido_venda_produto[].lista_parcelas.parcela[].conta_corrente_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto[].lista_parcelas.parcela[].data_vencimentotextoData de Vencimento da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto[].lista_parcelas.parcela[].descr_meio_pagamentotextoDescriçã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_pagamentotextoMeio 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_boletotextoIndica 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[].nsutextoNú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_parcelanúmero inteiroNúmero da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto[].lista_parcelas.parcela[].parcela_adiantamentotextoEstá é 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[].percentualdecimalPercentual da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto[].lista_parcelas.parcela[].quantidade_diasnúmero inteiroQuantidade de dias até o vencimento da parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto[].lista_parcelas.parcela[].tipo_documentotextoTipo 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[].valordecimalValor da Parcela. Informação localizada na Aba "Parcelas" do Pedido de Venda.
pedido_venda_produto[].market_placeobjetoDados para o Market Place.
pedido_venda_produto[].market_place.nEnviodecimalValor do envio do Market Place.
pedido_venda_produto[].market_place.nTaxadecimalValor da taxa do Market Place.
pedido_venda_produto[].observacoesobjetoDados da Aba "Observações" do Pedido de Venda.
pedido_venda_produto[].observacoes.obs_vendatextoObservaçõ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_pedidoobjetoValores totais do pedido.
pedido_venda_produto[].total_pedido.base_calculo_icmsdecimalBase de Cálculo do ICMS.
pedido_venda_produto[].total_pedido.base_calculo_stdecimalBase de cálculo da substituição tributária.
pedido_venda_produto[].total_pedido.base_ibs_cbsdecimalValor total da base de cálculo do IBS e da CBS.
pedido_venda_produto[].total_pedido.valor_IPIdecimalValor do IPI.
pedido_venda_produto[].total_pedido.valor_cbsdecimalValor total da CBS.
pedido_venda_produto[].total_pedido.valor_cofinsdecimalValor do cofins.
pedido_venda_produto[].total_pedido.valor_cslldecimalValor da CSLL.
pedido_venda_produto[].total_pedido.valor_deducoesdecimalValor das deduções.
pedido_venda_produto[].total_pedido.valor_descontosdecimalValor dos descontos.
pedido_venda_produto[].total_pedido.valor_dif_cbsdecimalValor total do diferimento da CBS.
pedido_venda_produto[].total_pedido.valor_dif_ibs_mudecimalValor total do diferimento do IBS do município.
pedido_venda_produto[].total_pedido.valor_dif_ibs_ufdecimalValor total do diferimento do IBS UF.
pedido_venda_produto[].total_pedido.valor_ibsdecimalValor total do IBS.
pedido_venda_produto[].total_pedido.valor_ibs_mudecimalValor total do IBS do município.
pedido_venda_produto[].total_pedido.valor_ibs_ufdecimalValor total do IBS da UF.
pedido_venda_produto[].total_pedido.valor_icmsdecimalValor total do ICMS.
pedido_venda_produto[].total_pedido.valor_inssdecimalValor do INSS.
pedido_venda_produto[].total_pedido.valor_irdecimalValor do IR. .Preenchimento automático - Não informar.
pedido_venda_produto[].total_pedido.valor_issdecimalValor do ISS.
pedido_venda_produto[].total_pedido.valor_mercadoriasdecimalvalor das mercadorias.
pedido_venda_produto[].total_pedido.valor_pisdecimalValor do PIS.
pedido_venda_produto[].total_pedido.valor_stdecimalValor total da ST.
pedido_venda_produto[].total_pedido.valor_tot_ibs_cbs_isdecimalTotal da NF-e com IBS/CBS/IS.
pedido_venda_produto[].total_pedido.valor_total_pedidodecimalValor total do pedido.
registrosnúmero inteiro
total_de_paginasnúmero inteiro
total_de_registrosnú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"}]}'

SimularImpostos

consultaClaudeMCP

Simula os impostos de um pedido de venda.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 9Campos e estruturas que você pode enviar
CampoTipoDescrição
cliente_simulobjetoInformações de cliente para simulação dos impostos.
cliente_simul.cidades_codmunibgetexto · até 7Código do município conforme tabela do IBGE para simulação dos impostos
cliente_simul.clientes_cnaetexto · até 7Informação localizada na Aba "Inscrições CNAE e Outros" do cadastro do Cliente para simulação dos impostos
cliente_simul.clientes_contribuintetexto · até 1Indica 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_estadotexto · até 2Informaçã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_suframatexto · até 20Inscriçã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_nacionaltexto · até 1Indica 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_atividadetexto · até 1Tipo 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_clientenúmero inteiroCó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_integracaotexto · até 60Có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_finaltexto · até 1Indicativo se a venda seria para consumidor final. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda.
det_simullista de objetosDados do item do Pedido de Vendas para simulação dos impostos.
det_simul[].codigo_cenario_impostos_itemnúmero inteiroCódigo do Cenário de Impostos.
det_simul[].produto_simulobjetoInformações do produto para simulação dos impostos.
det_simul[].produto_simul.codigo_item_integracaotexto · até 30Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido.
det_simul[].produto_simul.codigo_produtonúmero inteiroID 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_integracaotexto · até 60Có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órionúmeroQuantidade do produto para simulação dos impostos.
det_simul[].produto_simul.valor_descontonúmeroValor do desconto do item, se houver, para ser considerado na simulação dos impostos.
det_simul[].produto_simul.valor_unitarioobrigatórionúmeroValor unitário para simulação dos impostos
frete_simulobjetoDados da Aba "Frete e Outras Despesas" do Pedido de Venda para simulação dos impostos.
frete_simul.outras_despesasnúmeroValor das outras despesas para simulação dos impostos
frete_simul.valor_fretenúmeroValor do Frete
frete_simul.valor_seguronúmeroValor do seguro para simulação de impostos.
impostos_embutidostexto · até 1
indPresencatexto · até 1Indicador 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_entregatexto · até 2Estado 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
CampoTipoDescrição
codigo_clientenúmero inteiroCódigo interno do cliente
codigo_cliente_integracaotextoCó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_finaltextoIndicação se a venda para é consumo final
det_simul_resplista de objetosRetorno com o detalhe do item com a simulação de impostos
det_simul_resp[].codigo_cenario_impostos_itemnúmero inteiroCenário de impostos do item para simulação
det_simul_resp[].impostoobjetoInformaçõ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.cbsobjeto
det_simul_resp[].imposto.cbs.aliquota_cbsdecimalAlí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_cbsdecimalPercentual 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_cbsdecimalPercentual 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_cbsdecimalValor 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_cbsdecimalValor 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_padraoobjetoCOFINS.
det_simul_resp[].imposto.cofins_padrao.aliq_cofinsdecimal
det_simul_resp[].imposto.cofins_padrao.base_cofinsdecimal
det_simul_resp[].imposto.cofins_padrao.cod_sit_trib_cofinstexto
det_simul_resp[].imposto.cofins_padrao.qtde_unid_trib_cofinsdecimal
det_simul_resp[].imposto.cofins_padrao.tipo_calculo_cofinstexto
det_simul_resp[].imposto.cofins_padrao.valor_cofinsdecimal
det_simul_resp[].imposto.cofins_padrao.valor_unid_trib_cofinsdecimal
det_simul_resp[].imposto.cofins_stobjetoCOFINS - Substituição Tributária.
det_simul_resp[].imposto.cofins_st.aliq_cofins_stdecimal
det_simul_resp[].imposto.cofins_st.base_cofins_stdecimal
det_simul_resp[].imposto.cofins_st.cod_sit_trib_cofins_sttexto
det_simul_resp[].imposto.cofins_st.margem_cofins_stdecimal
det_simul_resp[].imposto.cofins_st.qtde_unid_trib_cofins_stdecimal
det_simul_resp[].imposto.cofins_st.tipo_calculo_cofins_sttexto
det_simul_resp[].imposto.cofins_st.valor_cofins_stdecimal
det_simul_resp[].imposto.cofins_st.valor_unid_trib_cofins_stdecimal
det_simul_resp[].imposto.csllobjetoCSLL.
det_simul_resp[].imposto.csll.aliq_cslldecimal
det_simul_resp[].imposto.csll.valor_cslldecimal
det_simul_resp[].imposto.ibsobjeto
det_simul_resp[].imposto.ibs.aliquota_ibs_mudecimalAlí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_ufdecimalAlí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_mudecimalPercentual 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_ufdecimalPercentual 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_mudecimalPercentual 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_ufdecimalPercentual 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_mudecimalValor 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_ufdecimalValor 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_ibsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_cbsobjeto
det_simul_resp[].imposto.ibs_cbs.base_ibs_cbsdecimalBase 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_tribtextoCó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_cbstextoCó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.icmsobjetoICMS
det_simul_resp[].imposto.icms.aliq_icmsdecimal
det_simul_resp[].imposto.icms.base_fcp_icmsdecimalBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS.
det_simul_resp[].imposto.icms.base_icmsdecimal
det_simul_resp[].imposto.icms.cod_sit_trib_icmstexto
det_simul_resp[].imposto.icms.modalidade_icmstexto
det_simul_resp[].imposto.icms.origem_icmstexto
det_simul_resp[].imposto.icms.perc_fcp_icmsdecimalPercentual do FCP - Fundo de Combate a Pobreza do ICMS.
det_simul_resp[].imposto.icms.perc_red_base_icmsdecimal
det_simul_resp[].imposto.icms.valor_fcp_icmsdecimalValor do FCP - Fundo de Combate a Pobreza do ICMS.
det_simul_resp[].imposto.icms.valor_icmsdecimal
det_simul_resp[].imposto.icms_efetobjetoICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem
det_simul_resp[].imposto.icms_efet.aliq_icms_efetdecimal
det_simul_resp[].imposto.icms_efet.base_icms_efetdecimal
det_simul_resp[].imposto.icms_efet.cod_sit_trib_icms_efettexto
det_simul_resp[].imposto.icms_efet.modalidade_icms_efettexto
det_simul_resp[].imposto.icms_efet.origem_icms_efettexto
det_simul_resp[].imposto.icms_efet.perc_red_base_icms_efetdecimal
det_simul_resp[].imposto.icms_efet.valor_icms_efetdecimal
det_simul_resp[].imposto.icms_ieobjetoICMS Interestadual.
det_simul_resp[].imposto.icms_ie.aliq_icms_FCPdecimalPercentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino
det_simul_resp[].imposto.icms_ie.aliq_interestadualdecimalAlíquota Interestadual das UFs Envolvidas
det_simul_resp[].imposto.icms_ie.aliq_interna_uf_destinodecimalAlíquota Interna da UF de Destino
det_simul_resp[].imposto.icms_ie.aliq_partilha_icmsdecimalPercentual Provisório de Partilha do ICMS Interestadual
det_simul_resp[].imposto.icms_ie.base_icms_uf_destinodecimalBC do ICMS na UF de Destino
det_simul_resp[].imposto.icms_ie.valor_fcp_icms_interdecimalValor do fundo de combate a pobreza.
det_simul_resp[].imposto.icms_ie.valor_icms_uf_destdecimalValor do ICMS - UF Destino
det_simul_resp[].imposto.icms_ie.valor_icms_uf_remetdecimalValor do ICMS - UF Remetente
det_simul_resp[].imposto.icms_snobjetoICMS - Simples Nacional.
det_simul_resp[].imposto.icms_sn.aliq_icms_sndecimal
det_simul_resp[].imposto.icms_sn.base_icms_sndecimal
det_simul_resp[].imposto.icms_sn.cod_sit_trib_icms_sntexto
det_simul_resp[].imposto.icms_sn.origem_icms_sntexto
det_simul_resp[].imposto.icms_sn.valor_credito_icms_sndecimal
det_simul_resp[].imposto.icms_sn.valor_icms_sndecimal
det_simul_resp[].imposto.icms_stobjetoICMS - Substituição Tributária.
det_simul_resp[].imposto.icms_st.aliq_icms_oppropdecimalAlíquota de ICMS Operação Própria.
det_simul_resp[].imposto.icms_st.aliq_icms_stdecimal
det_simul_resp[].imposto.icms_st.base_fcp_icms_stdecimalBase de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST.
det_simul_resp[].imposto.icms_st.base_icms_stdecimal
det_simul_resp[].imposto.icms_st.cesttextoCEST - Código Especificador da Substituíção Tributária.
det_simul_resp[].imposto.icms_st.cod_sit_trib_icms_sttexto
det_simul_resp[].imposto.icms_st.margem_icms_stdecimal
det_simul_resp[].imposto.icms_st.modalidade_icms_sttexto
det_simul_resp[].imposto.icms_st.perc_fcp_icms_stdecimalPercentual do FCP - Fundo de Combate a Pobreza do ICMS ST.
det_simul_resp[].imposto.icms_st.perc_red_base_icms_opdecimalPercentual de redução de base de cálculo de Icms Operação Própria.
det_simul_resp[].imposto.icms_st.perc_red_base_icms_stdecimal
det_simul_resp[].imposto.icms_st.valor_fcp_icms_stdecimalValor do FCP - Fundo de Combate a Pobreza do ICMS ST.
det_simul_resp[].imposto.icms_st.valor_icms_stdecimal
det_simul_resp[].imposto.inssobjetoINSS.
det_simul_resp[].imposto.inss.aliq_inssdecimal
det_simul_resp[].imposto.inss.valor_inssdecimal
det_simul_resp[].imposto.ipiobjetoIPI.
det_simul_resp[].imposto.ipi.aliq_ipidecimal
det_simul_resp[].imposto.ipi.base_ipidecimal
det_simul_resp[].imposto.ipi.cod_sit_trib_ipitexto
det_simul_resp[].imposto.ipi.enquadramento_ipitextoEnquadramento do IPI
det_simul_resp[].imposto.ipi.qtde_unid_trib_ipidecimal
det_simul_resp[].imposto.ipi.tipo_calculo_ipitexto
det_simul_resp[].imposto.ipi.valor_ipidecimal
det_simul_resp[].imposto.ipi.valor_unid_trib_ipidecimal
det_simul_resp[].imposto.irrfobjetoIRRF.
det_simul_resp[].imposto.irrf.aliq_irrfdecimal
det_simul_resp[].imposto.irrf.valor_irrfdecimal
det_simul_resp[].imposto.issobjetoISS.
det_simul_resp[].imposto.iss.aliq_issdecimal
det_simul_resp[].imposto.iss.base_issdecimal
det_simul_resp[].imposto.iss.retem_isstexto
det_simul_resp[].imposto.iss.valor_issdecimal
det_simul_resp[].imposto.pis_padraoobjetoPIS.
det_simul_resp[].imposto.pis_padrao.aliq_pisdecimal
det_simul_resp[].imposto.pis_padrao.base_pisdecimal
det_simul_resp[].imposto.pis_padrao.cod_sit_trib_pistexto
det_simul_resp[].imposto.pis_padrao.qtde_unid_trib_pisdecimal
det_simul_resp[].imposto.pis_padrao.tipo_calculo_pistexto
det_simul_resp[].imposto.pis_padrao.valor_pisdecimal
det_simul_resp[].imposto.pis_padrao.valor_unid_trib_pisdecimal
det_simul_resp[].imposto.pis_stobjetoPIS - Substituíção Tributária.
det_simul_resp[].imposto.pis_st.aliq_pis_stdecimal
det_simul_resp[].imposto.pis_st.base_pis_stdecimal
det_simul_resp[].imposto.pis_st.cod_sit_trib_pis_sttexto
det_simul_resp[].imposto.pis_st.margem_pis_stdecimal
det_simul_resp[].imposto.pis_st.qtde_unid_trib_pis_stdecimal
det_simul_resp[].imposto.pis_st.tipo_calculo_pis_sttexto
det_simul_resp[].imposto.pis_st.valor_pis_stdecimal
det_simul_resp[].imposto.pis_st.valor_unid_trib_pis_stdecimal
det_simul_resp[].imposto.trib_regobjeto
det_simul_resp[].imposto.trib_reg.aliquota_reg_cbsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_regtextoCó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_csttextoCó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_cbsdecimalValor 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_mudecimalValor 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_ufdecimalValor 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_respobjetoInformações do produto para simulação de impostos
det_simul_resp[].produto_simul_resp.cfoptextoCFOP - Código Fiscal de Operações e Prestações.
det_simul_resp[].produto_simul_resp.codigo_item_integracaotextoCó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_kitnúmero inteiroID 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_produtonúmero inteiroID 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_integracaotextoCó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_desoneradotextoCó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.quantidadedecimalQuantidade do produto para simulação dos impostos.
det_simul_resp[].produto_simul_resp.valor_descontodecimalValor do desconto do item, se houver, para ser considerado na simulação dos impostos.
det_simul_resp[].produto_simul_resp.valor_icms_desoneradodecimalValor do ICMS desonerado
det_simul_resp[].produto_simul_resp.valor_totaldecimalValor Total.
det_simul_resp[].produto_simul_resp.valor_unitariodecimalValor unitário para simulação dos impostos
frete_simulobjetoDados da Aba "Frete e Outras Despesas" do Pedido de Venda para simulação dos impostos.
frete_simul.outras_despesasdecimalValor das outras despesas para simulação dos impostos
frete_simul.valor_fretedecimalValor do Frete
frete_simul.valor_segurodecimalValor do seguro para simulação de impostos.
indPresencatextoIndicador 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_entregatextoEstado 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}}]}]}'

StatusPedido

consultaClaudeChatGPTMCP

Consulta do Status do Pedido

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotexto · até 60Có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
CampoTipoDescrição
ListaNfelista de objetosLista de NF-es geradas
ListaNfe[].chave_nfetextoChave de Acesso da NF-e
ListaNfe[].contingenciatextoNF-e emitida em contingência
ListaNfe[].danfetextoLink para o DANFE da NF-e gerada.
ListaNfe[].data_emissaotextoData da Emissão da NF-e
ListaNfe[].data_faturatextoData do faturamento
ListaNfe[].data_saidatextoData de Saída
ListaNfe[].hora_emissaotextoHora da Emissão da NF-e
ListaNfe[].hora_faturatextoHora de Faturamento
ListaNfe[].hora_saidatextoHora de Saída da NF-e
ListaNfe[].mensagenslista de objetosMensagens de Erros
ListaNfe[].mensagens[].cCodigotextoCódigo da mensagem de erro/aviso
ListaNfe[].mensagens[].cCorrecaotextoCorreção da descrição de mensagem de erro/aviso.
ListaNfe[].mensagens[].cDescricaotextoDescrição da mensagem de erro/aviso.
ListaNfe[].numero_lotenúmero inteiroNúmero do lote da NF-e
ListaNfe[].numero_nfetextoNúmero da NF-e gerada
ListaNfe[].protocolonúmero inteiroNúmero do Protocolo
ListaNfe[].recibonúmero inteiroRecibo
ListaNfe[].serie_nfetextoSérie da NF-e
ListaNfe[].status_lotetextoStatus do Lote da NF-e.
ListaNfe[].status_nfetextoStatus da NF-e
ListaNfe[].tipotextoTipo de Emissão. Pode ser: E - Entrada S - Saída
ListaNfe[].xml_distrtextoXML de distribuição da NF-e
ambientetexto
canceladatextoNF-e Cancelada?
codigo_pedidonúmero inteiroID 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_integracaotextoCó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.
etapatextoEtapa 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.
faturadatexto
numero_pedidotextoNúmero do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela.
valor_total_pedidodecimalValor 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": ""}]}'

TrocarEtapaPedido

altera dadosClaudeMCP

Troca etapa do pedido.

Obrigatórios 1

CampoTipoDescrição
etapatexto · até 2Etapa 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
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotexto · até 60Có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_pedidotexto · até 15Nú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
CampoTipoDescrição
codigo_pedidonúmero inteiroID 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_integracaotextoCó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_statustextoCódigo do Status do Pedido de Venda.
descricao_statustextoDescrição do status.
numero_pedidotextoNú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"}]}'