Geral · CenariosImpostos

Cenários de Impostos

POSThttps://app.omie.com.br/api/v1/geral/cenarios/WSDL

2consultas

0alterações

Claude · ChatGPT · MCPpelos assistentes de IA

JSON · XMLformato

ListarCenarios

consultaClaudeChatGPTMCP

Lista os cenários de impostos.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cNome`	texto · até 50
`nPagina`	número inteiro
`nRegPorPagina`	número inteiro

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cenariosEncontrados`	lista de objetos	Lista de Cenários de Impostos encontrados.
`cenariosEncontrados[].cNome`	texto	Nome do Cenário de Impostos.
`cenariosEncontrados[].comercioAtacadista`	sim/não	Indica se o Cenário de Impostos se aplica ao Comércio (Atacadista).
`cenariosEncontrados[].comercioVarejista`	texto	Indica se o Cenário de Impostos se aplica ao Comércio (Varejista).
`cenariosEncontrados[].construcaoCivil`	sim/não	Indica se o Cenário de Impostos se aplica a Construção Civil.
`cenariosEncontrados[].dAlt`	texto	Data de alteração.
`cenariosEncontrados[].dInc`	texto	Data de Inclusão.
`cenariosEncontrados[].hAlt`	texto	Hora de alteração.
`cenariosEncontrados[].hInc`	texto	Hora de inclusão.
`cenariosEncontrados[].inativo`	texto	Indica se o cenário está inativo [S/N].
`cenariosEncontrados[].industria`	texto	Indica se o cenário se aplica a Indústria.
`cenariosEncontrados[].nCodigo`	número inteiro	Código do Cenário de Impostos.
`cenariosEncontrados[].padrao`	sim/não	Indica se o Cenário de Impostos é padrão.
`cenariosEncontrados[].prestadorServico`	sim/não	Indica se o Cenário de Impostos se aplica a Prestação de Serviço.
`cenariosEncontrados[].uAlt`	texto	Código do usuário que realizou a alteração.
`cenariosEncontrados[].uInc`	texto	Código do usuário que realizou a inclusão.
`nPagina`	número inteiro
`nRegistros`	número inteiro
`nTotPaginas`	número inteiro
`nTotRegistros`	número inteiro

POST /api/v1/geral/cenarios/

curl -s https://app.omie.com.br/api/v1/geral/cenarios/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarCenarios", "param": [{"nPagina": 1, "nRegPorPagina": 20, "cNome": ""}]}'

import os
import requests

corpo = {'call': 'ListarCenarios', 'param': [{'nPagina': 1, 'nRegPorPagina': 20, 'cNome': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/cenarios/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
    json=corpo,
    timeout=60,
)
print(resp.json())

const resp = await fetch("https://app.omie.com.br/api/v1/geral/cenarios/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarCenarios",
    "param": [
      {
        "nPagina": 1,
        "nRegPorPagina": 20,
        "cNome": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/cenarios/");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
    "call": "ListarCenarios",
    "param": [
        {
            "nPagina": 1,
            "nRegPorPagina": 20,
            "cNome": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/cenarios/")
corpo = <<~'JSON'
{
  "call": "ListarCenarios",
  "param": [
    {
      "nPagina": 1,
      "nRegPorPagina": 20,
      "cNome": ""
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "ListarCenarios",
  "param": [
    {
      "nPagina": 1,
      "nRegPorPagina": 20,
      "cNome": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/cenarios/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(corpo))
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/v1/geral/cenarios/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarCenarios"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 20, ""cNome"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarImpostosCenario

consultaClaudeChatGPTMCP

Lista os impostos do cenário e produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 7Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`codigo`	texto · até 60	É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.
`codigo_cenario`	número inteiro	Código do Cenário de Impostos.
`codigo_cliente_integracao`	texto · até 60	Código de Integração para o Cliente.
`codigo_cliente_omie`	número inteiro	Código Omie para o cliente.
`codigo_produto`	número inteiro	(Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao".
`codigo_produto_integracao`	texto · até 60	Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie.
`consumo_final`	texto · até 1	Indica se a operação é uma venda para consumo final.

Retorno 14O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cnae_cliente`	texto	CNAE do cliente.
`codigo`	texto	É o código do produto que é exibido na tela do Omie. Ele pode ser alterado a qualquer momento.
`codigo_cenario`	número inteiro	Código do Cenário de Impostos.
`codigo_cliente_integracao`	texto	Código de Integração par ao cliente.
`codigo_cliente_omie`	número inteiro	Código interno de identificação do cliente.
`codigo_empresa`	número inteiro	Código interno identificador da Empresa.
`codigo_produto`	número inteiro	(Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance.
`codigo_produto_integracao`	texto	Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie.
`consumo_final`	texto	Indicação se a operação é uma venda para consumo final.
`contribuinte_cliente`	texto	Indicativo se o cliente é contribuinte.
`impostos`	objeto	Impostos do cenário fiscal para o produto e cliente.
`impostos.al_icms_interes_destino`	decimal	Alíquota para o ICMS interestadual para o estado de destino.
`impostos.al_icms_interes_fcp`	decimal	Alíquota para o fundo de combate a pobreza para o estado destino relativo ao ICMS Interestadual.
`impostos.al_icms_interes_partilha`	decimal	Percentual de partilha do ICMS Interestadual.
`impostos.al_icms_interestadual`	decimal	Alíquota do ICMS próprio utilizada para o cálculo do ICMS interestadual.
`impostos.aliquota_cbs`	decimal	Alíquota da CBS.
`impostos.aliquota_cofins`	decimal	Alíquota para o cálculo de COFINS.
`impostos.aliquota_cofins_st`	decimal	Alíquota para o cálculo de COFINS-ST.
`impostos.aliquota_ibs_mu`	decimal	Alíquota do IBS de competência do Município.
`impostos.aliquota_ibs_uf`	decimal	Alíquota do IBS de competência das UF.
`impostos.aliquota_icms`	decimal	Alíquota de ICMS.
`impostos.aliquota_icms_op`	decimal	Alíquota do ICMS da operacação própria, para cálculo do ICMS-ST.
`impostos.aliquota_icms_simples`	decimal	Alíquota para cálculo do crédito do ICMS por empresa do Simples Nacional.
`impostos.aliquota_ipi`	decimal	Alíquota do IPI.
`impostos.aliquota_pis`	decimal	Alíquota de PIS.
`impostos.aliquota_pis_st`	decimal	Alíquota de PIS-ST.
`impostos.aliquota_reg_cbs`	decimal	Valor da alíquota Regular da CBS.
`impostos.aliquota_reg_ibs_mu`	decimal	Valor da alíquota Regular do IBS do Município.
`impostos.aliquota_reg_ibs_uf`	decimal	Valor da alíquota Regular do IBS da UF.
`impostos.aliquota_st`	decimal	Alíquota do ICMS-ST.
`impostos.carga_media_mt`	decimal	Carga média para cálculo do ICMS-ST.
`impostos.cfop`	texto	CFOP - Código Fiscal da Operação Fiscal configurado.
`impostos.class_trib`	texto
`impostos.class_trib_reg`	texto	Código de Classificação Tributária Regular do IBS e CBS.
`impostos.csosn`	texto	CSOSN - Código da Situação da Operação do Simples Nacional.
`impostos.cst_cofins`	texto	Código da Situação Tributária do PIS.
`impostos.cst_ibs_cbs`	texto	Código de Situação Tributária do IBS e CBS.
`impostos.cst_icms`	texto	Código da Situação Tributária para o ICMS.
`impostos.cst_ipi`	texto	Código da Situação Tributária para o IPI.
`impostos.cst_pis`	texto	Código da Situação Tributária do PIS.
`impostos.cst_reg_ibs_cst`	texto	Código da Situação Tributária Regular do IBS e CBS.
`impostos.enq_ipi`	texto	Enquadramento do IPI.
`impostos.id_pauta_icms`	número inteiro	Código identificador do cadastro da pauta de ICMS.
`impostos.inf_adicional_item`	texto	Informação adicional para o item no documento fiscal.
`impostos.inf_adicional_nf`	texto	Informação adicional para o documento fiscal.
`impostos.margem_cofins_st`	decimal	Margem de Valor agregado para o cálculo do COFINS-ST.
`impostos.margem_pis_st`	decimal	Margem de cálculo para PIS-ST.
`impostos.margem_st`	decimal	Margem de Valor Agregado para base de cálculo do ICMS-ST.
`impostos.modalidade_bc_icms`	texto	Modalidade da base de cálculo para o ICMS.
`impostos.modalidade_bc_st`	texto	Modalidade de cálculo para a base do ICMS-ST.
`impostos.motivo_desoneracao_icms`	texto	Motivo da Desoneração do ICMS.
`impostos.nao_gera_conta_receb`	texto	Indica que não deve gerar conta a receber para o item.
`impostos.nao_mov_estoque`	texto	Indica que não deve movimentar estoque.
`impostos.perc_dif_cbs`	decimal	Percentual do diferimento - CBS.
`impostos.perc_dif_ibs_mu`	decimal	Percentual do diferimento - UBS Município.
`impostos.perc_dif_ibs_uf`	decimal	Percentual do Diferimento - IBS UF.
`impostos.perc_diferimento_icms`	decimal	Percentual de Diferimento de ICMS.
`impostos.perc_fcp_icms`	decimal	Percentual para o Fundo de Combate a Pobreza para o ICMS.
`impostos.perc_fcp_st`	decimal	Percentual para o Fundo de Combate a Pobreza relativa ao ICMS-ST.
`impostos.perc_red_cbs`	decimal	Percentual da redução de alíquota do cClassTrib - CBS.
`impostos.perc_red_ibs_mu`	decimal	Percentual da redução de alíquota do cClassTrib - IBS Município.
`impostos.perc_red_ibs_uf`	decimal	Percentual da redução de alíquota do cClassTrib - IBS UF.
`impostos.reducao_bc_cofins`	decimal	Percentual de Redução de base de cálculo para COFINS.
`impostos.reducao_bc_icms`	decimal	Redução da base de cálculo de ICMS.
`impostos.reducao_bc_ipi`	decimal	Redução de base de cálculo para o IPI.
`impostos.reducao_bc_pis`	decimal	Redução de base de cálculo do PIS.
`impostos.reducao_bc_st`	decimal	Redução da base de cálculo do ICMS-ST.
`impostos.tipo_calculo_cofins`	texto	Tipo do cálculo de COFINS.
`impostos.tipo_calculo_cofins_st`	texto	Tipo de cálculo para o COFINS-ST.
`impostos.tipo_calculo_ipi`	texto	Tipo de cálculo para o IPI.
`impostos.tipo_calculo_pis`	texto	Tipo do Cálculo do PIS.
`impostos.tipo_calculo_pis_st`	texto	Tipo de Cálculo para o PIS-ST.
`impostos.tipo_cred_prez`	texto
`impostos.valor_pauta_icms`	decimal	Valor da Pauta do ICMS-ST.
`impostos.valor_trib_cofins`	decimal	Valor tributado de COFINS por unidade.
`impostos.valor_trib_cofins_st`	decimal	Valor tributário de COFINS-ST por unidade.
`impostos.valor_trib_ipi`	decimal	Valor tributável de IPI por unidade.
`impostos.valor_trib_pis`	decimal	Valor tributável de PIS por unidade.
`impostos.valor_trib_pis_st`	decimal	Valor tributado de PIS-ST por unidade.
`impostos.zera_mva_cf`	texto	Indica que deve zerar o MVA na venda para consumo final.
`ncm`	texto	NCM do produto utilizado na pesquisa.
`uf_cliente`	texto	Estado onde o cliente está localizado.
`uf_empresa`	texto	Estado onde a Empresa está localizada.

POST /api/v1/geral/cenarios/

curl -s https://app.omie.com.br/api/v1/geral/cenarios/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarImpostosCenario", "param": [{"codigo_cliente_integracao": "CLI00001", "consumo_final": "N", "codigo_produto_integracao": "PRD00001", "codigo_cenario": 152055}]}'

import os
import requests

corpo = {'call': 'ListarImpostosCenario',
 'param': [{'codigo_cliente_integracao': 'CLI00001',
            'consumo_final': 'N',
            'codigo_produto_integracao': 'PRD00001',
            'codigo_cenario': 152055}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/cenarios/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
    json=corpo,
    timeout=60,
)
print(resp.json())

const resp = await fetch("https://app.omie.com.br/api/v1/geral/cenarios/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarImpostosCenario",
    "param": [
      {
        "codigo_cliente_integracao": "CLI00001",
        "consumo_final": "N",
        "codigo_produto_integracao": "PRD00001",
        "codigo_cenario": 152055
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/cenarios/");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
    "call": "ListarImpostosCenario",
    "param": [
        {
            "codigo_cliente_integracao": "CLI00001",
            "consumo_final": "N",
            "codigo_produto_integracao": "PRD00001",
            "codigo_cenario": 152055
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/cenarios/")
corpo = <<~'JSON'
{
  "call": "ListarImpostosCenario",
  "param": [
    {
      "codigo_cliente_integracao": "CLI00001",
      "consumo_final": "N",
      "codigo_produto_integracao": "PRD00001",
      "codigo_cenario": 152055
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "ListarImpostosCenario",
  "param": [
    {
      "codigo_cliente_integracao": "CLI00001",
      "consumo_final": "N",
      "codigo_produto_integracao": "PRD00001",
      "codigo_cenario": 152055
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/cenarios/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(corpo))
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/v1/geral/cenarios/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarImpostosCenario"", ""param"": [{""codigo_cliente_integracao"": ""CLI00001"", ""consumo_final"": ""N"", ""codigo_produto_integracao"": ""PRD00001"", ""codigo_cenario"": 152055}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

ListarCenarios
ListarImpostosCenario