Geral · ClienteRestricao

Consulta de restrição de crédito de clientes

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

2consultas

0alterações

Claude · MCPpelos assistentes de IA

JSON · XMLformato

ConsultarRestricao

consultaClaudeMCP

Consulta restrição de crédito de cliente.

Obrigatórios 2

Campo	Tipo	Descrição
`cTipoConsulta`	texto · até 100	Tipo de consulta de restrição: o cCodigo de um item de tiposConsulta em ObterInfoRestricao. Para CPF: PF_BASIC, PF_ESSENCIAL, PF_POSITIVE, PF_PLUS ou PF_COMPLETE. Para CNPJ: PJ_BASIC, PJ_RISK, PJ_POSITIVE, PJ_BUSINESS ou PJ_LIMIT. Cada tipo tem um valor, cobrado na fatura do aplicativo a cada consulta com sucesso.
`lForcarNovaConsulta`	sim/não	Forçar nova consulta de restrição? O preenchimento desta tag não é obrigatório. Caso não seja informada, assumirá o valor FALSE. Informe TRUE para forçar a execução de nova consulta de restrição (com cobrança) mesmo que já exista consulta com sucesso na data corrente para o mesmo CPF/CNPJ e o mesmo tipo. Informe FALSE para retornar a consulta do mesmo tipo já realizada hoje para o CPF/CNPJ, pelo mesmo usuário ou por integração, caso exista. Neste caso, não será gerada cobrança. Se não existir, uma nova consulta (com cobrança) será realizada automaticamente.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCnpjCpf`	texto · até 20	CNPJ ou CPF a consultar, com ou sem formatação. Informe "nIdCliente" ou "cCnpjCpf", não os dois. Se nenhum cliente tiver esse documento, a consulta cria o cliente.
`nIdCliente`	número inteiro	Código do cliente no Omie. Informe "nIdCliente" ou "cCnpjCpf", não os dois. Por nIdCliente, a consulta usa o CPF/CNPJ do cadastro do cliente.

Retorno 8O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodStatus`	texto	Código do status do processamento. "0" indica consulta realizada ou recuperada do histórico do dia. Outros valores: "30" serviço não ativado, "100" usuário de integração não autorizado, "101" falha na consulta (motivo em cDesStatus), "403" sem permissão, "721" CPF/CNPJ inválido, "821" cliente não encontrado, "1000" cliente não identificado.
`cDesStatus`	texto	Descrição do status do processamento. Explica o resultado de "cCodStatus".
`cResultado`	texto	Resumo do resultado da consulta de restrição.
`cTipo`	texto	Tipo da consulta realizada, sem o prefixo de pessoa (ex.: BASIC, RISK, LIMIT).
`cUrlPesquisa`	texto	Link temporário para baixar o PDF da consulta de restrição.
`cUsuario`	texto	Nome do usuário que realizou a consulta.
`dPesquisa`	texto	Data em que a consulta foi realizada (dd/mm/aaaa).
`hPesquisa`	texto	Hora em que a consulta foi realizada (hh:mm:ss).

POST /api/v1/geral/clienterestricao/

curl -s https://app.omie.com.br/api/v1/geral/clienterestricao/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarRestricao", "param": [{"cCnpjCpf": "11.222.333/0001-81", "cTipoConsulta": "PJ_BASIC", "lForcarNovaConsulta": false}]}'

import os
import requests

corpo = {'call': 'ConsultarRestricao',
 'param': [{'cCnpjCpf': '11.222.333/0001-81',
            'cTipoConsulta': 'PJ_BASIC',
            'lForcarNovaConsulta': False}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clienterestricao/",
    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/clienterestricao/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ConsultarRestricao",
    "param": [
      {
        "cCnpjCpf": "11.222.333/0001-81",
        "cTipoConsulta": "PJ_BASIC",
        "lForcarNovaConsulta": false
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clienterestricao/");
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": "ConsultarRestricao",
    "param": [
        {
            "cCnpjCpf": "11.222.333/0001-81",
            "cTipoConsulta": "PJ_BASIC",
            "lForcarNovaConsulta": false
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clienterestricao/")
corpo = <<~'JSON'
{
  "call": "ConsultarRestricao",
  "param": [
    {
      "cCnpjCpf": "11.222.333/0001-81",
      "cTipoConsulta": "PJ_BASIC",
      "lForcarNovaConsulta": false
    }
  ]
}
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": "ConsultarRestricao",
  "param": [
    {
      "cCnpjCpf": "11.222.333/0001-81",
      "cTipoConsulta": "PJ_BASIC",
      "lForcarNovaConsulta": false
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clienterestricao/"))
    .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/clienterestricao/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ConsultarRestricao"", ""param"": [{""cCnpjCpf"": ""11.222.333/0001-81"", ""cTipoConsulta"": ""PJ_BASIC"", ""lForcarNovaConsulta"": false}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ObterInfoRestricao

consultaClaudeMCP

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCnpjCpf`	texto · até 20	CNPJ ou CPF do cliente, com ou sem formatação. Informe uma das tags: "nIdCliente", "cCnpjCpf" ou "xCodigo". Por CPF/CNPJ vêm também os tipos de consulta (PF ou PJ) e a última consulta.
`nIdCliente`	número inteiro	Código do cliente no Omie. Informe uma das tags: "nIdCliente", "cCnpjCpf" ou "xCodigo". Por nIdCliente vem só o cadastro, sem os tipos de consulta.
`xCodigo`	texto	Busca livre: CPF/CNPJ (11 ou 14 dígitos) ou o início do nome fantasia ou da razão social. Traz até 50 clientes. Não pode ser usada junto com "nIdCliente" ou "cCnpjCpf".

Retorno 6O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodStatus`	texto	Código do status do processamento. "0" indica sucesso e "20" indica que mais de um cliente foi encontrado (escolha um em listaClientes). Outros valores: "30" serviço não ativado, "40" nenhum filtro informado, "403" sem permissão, "721" CPF/CNPJ inválido, "727" xCodigo junto com outro filtro.
`cDesStatus`	texto	Descrição do status do processamento. Explica o resultado de "cCodStatus".
`listaClientes`	lista de objetos	Clientes encontrados. Com mais de um, cCodStatus vem "20" para a pessoa escolher.
`listaClientes[].cBairro`	texto	Bairro.
`listaClientes[].cCep`	texto	CEP.
`listaClientes[].cCidade`	texto	Cidade.
`listaClientes[].cCnpjCpf`	texto	CNPJ ou CPF do cliente.
`listaClientes[].cComplemento`	texto	Complemento do endereço.
`listaClientes[].cContato`	texto	Nome do contato.
`listaClientes[].cCor`	texto	Não preenchido por esta API.
`listaClientes[].cEmail`	texto	E-mail do cliente.
`listaClientes[].cEndereco`	texto	Logradouro.
`listaClientes[].cEstado`	texto	Sigla do estado.
`listaClientes[].cIcone`	texto	Não preenchido por esta API.
`listaClientes[].cNomeFantasia`	texto	Nome fantasia do cliente; vem só para pessoa jurídica quando difere da razão social.
`listaClientes[].cNumero`	texto	Número do endereço.
`listaClientes[].cRazaoSocial`	texto	Razão social do cliente.
`listaClientes[].cTelefone`	texto	Telefone principal, com DDD entre parênteses quando cadastrado.
`listaClientes[].cTipoPessoa`	texto	Tipo de pessoa do cliente: PF ou PJ.
`listaClientes[].nIdCliente`	número inteiro	Código do cliente no Omie.
`listaTipoConsulta`	texto	Os mesmos tipos de consulta de tiposConsulta, em texto JSON (formato usado pela tela do ERP). Prefira tiposConsulta.
`tiposConsulta`	lista de objetos	Tipos de consulta disponíveis para o tipo de pessoa do CPF/CNPJ (PF ou PJ), com valor e conteúdo de cada um. Vem só quando a busca é por CPF/CNPJ.
`tiposConsulta[].cCodigo`	texto	Código do tipo de consulta, a informar em cTipoConsulta de ConsultarRestricao (ex.: PJ_BASIC).
`tiposConsulta[].cConteudo`	texto	Cobertura de protestos do tipo (todos os estados ou um estado).
`tiposConsulta[].cDescricao`	texto	Nome do tipo de consulta.
`tiposConsulta[].cDetalhes`	lista de objetos	Itens que a consulta inclui.
`tiposConsulta[].cDetalhes[].cBold`	sim/não	Indica se deve ser negrito.
`tiposConsulta[].cDetalhes[].cConteudo`	texto	Descrição do item incluído na consulta.
`tiposConsulta[].cDetalhes[].nOrdem`	número inteiro	Ordem de exibição do item.
`tiposConsulta[].cExemplo`	texto	Link de um exemplo do relatório deste tipo, quando houver.
`tiposConsulta[].cRecomendacao`	sim/não	Indica se é o tipo recomendado pela Omie.
`tiposConsulta[].cTipoPessoa`	texto	Tipo de pessoa atendido: PF ou PJ.
`tiposConsulta[].cValor`	texto	Valor cobrado por consulta, formatado em reais (ex.: R$ 9,90).
`ultimaConsulta`	objeto	Última consulta com sucesso para o cliente encontrado. Vazia quando não há consulta ou a busca não foi por CPF/CNPJ.
`ultimaConsulta.cResultado`	texto	Resumo do resultado da última consulta.
`ultimaConsulta.cTipo`	texto	Nome do tipo de consulta realizado.
`ultimaConsulta.cUrlPesquisa`	texto	Link para baixar o PDF da última consulta.
`ultimaConsulta.cUsuario`	texto	Nome do usuário que fez a última consulta.
`ultimaConsulta.dPesquisa`	texto	Data da última consulta (dd/mm/aaaa).
`ultimaConsulta.hPesquisa`	texto	Hora da última consulta (hh:mm:ss).

POST /api/v1/geral/clienterestricao/

curl -s https://app.omie.com.br/api/v1/geral/clienterestricao/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterInfoRestricao", "param": [{"cCnpjCpf": "11.222.333/0001-81"}]}'

import os
import requests

corpo = {'call': 'ObterInfoRestricao', 'param': [{'cCnpjCpf': '11.222.333/0001-81'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clienterestricao/",
    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/clienterestricao/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ObterInfoRestricao",
    "param": [
      {
        "cCnpjCpf": "11.222.333/0001-81"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clienterestricao/");
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": "ObterInfoRestricao",
    "param": [
        {
            "cCnpjCpf": "11.222.333/0001-81"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clienterestricao/")
corpo = <<~'JSON'
{
  "call": "ObterInfoRestricao",
  "param": [
    {
      "cCnpjCpf": "11.222.333/0001-81"
    }
  ]
}
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": "ObterInfoRestricao",
  "param": [
    {
      "cCnpjCpf": "11.222.333/0001-81"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clienterestricao/"))
    .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/clienterestricao/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ObterInfoRestricao"", ""param"": [{""cCnpjCpf"": ""11.222.333/0001-81""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

ConsultarRestricao
ObterInfoRestricao