Geral · ClientesCadastro

Clientes, fornecedores e transportadoras

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

3consultas

7alterações

Claude 10 de 10 · ChatGPT 5 de 10 · MCP 10 de 10pelos assistentes de IA

JSON · XMLformato

AlterarCliente

altera dadosClaudeChatGPTMCP

Altera os dados do cliente

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 50Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`bairro`	texto · até 60	Bairro.
`bloquear_exclusao`	texto · até 1	Bloqueia a exclusão do registro (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`bloquear_faturamento`	texto · até 1	Bloquear o faturamento para o cliente (S/N).Ex.: `S`, `N`Valores: `S`, `N`
`caracteristicas`	lista de objetos	Características do cliente ou fornecedor.
`caracteristicas[].campo`	texto · até 30	Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "AlterarCliente" e "UpsertCliente".
`caracteristicas[].conteudo`	texto · até 60	Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; nas demais operações que reutilizam esta estrutura (ex.: "AlterarCliente"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima.
`cep`	texto · até 10	CEP.
`cidade`	texto · até 40	Código da cidade. Recebe o código IBGE ou o NOME da cidade.
`cidade_ibge`	texto · até 7	Código do IBGE para a cidade.
`cnae`	texto · até 7	Código do CNAE.
`cnpj_cpf`	texto · até 20	CNPJ ou CPF.
`codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`codigo_cliente_omie`	número inteiro	Código de cliente ou fornecedor.
`codigo_pais`	texto · até 4	Código do país.
`complemento`	texto · até 60	Complemento do endereço.
`contato`	texto · até 100	Nome para contato.
`contribuinte`	texto · até 1	Contribuinte (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`dadosBancarios`	objeto	Dados bancários do cliente.
`dadosBancarios.agencia`	texto · até 10	Agência
`dadosBancarios.cChavePix`	texto · até 60	Chave PIX.
`dadosBancarios.codigo_banco`	texto · até 3	Código do banco.
`dadosBancarios.conta_corrente`	texto · até 25	Número da conta corrente.
`dadosBancarios.doc_titular`	texto · até 20	CNPJ ou CPF do titular.
`dadosBancarios.nome_titular`	texto · até 60	Nome do titular.
`dadosBancarios.transf_padrao`	texto · até 1	Definir transferência como forma de pagamento padrão?Ex.: `S`, `N`
`documento_exterior`	texto · até 20	Documento no exterior para clientes estrangeiros.
`email`	texto · até 500	E-mail.
`endereco`	texto · até 60	Endereço.
`enderecoEntrega`	objeto	Dados do endereço de entrega.
`enderecoEntrega.entBairro`	texto · até 60	Bairro.
`enderecoEntrega.entCEP`	texto · até 9	CEP.
`enderecoEntrega.entCidade`	texto · até 40	Cidade.
`enderecoEntrega.entCnpjCpf`	texto · até 20	CNPJ ou CPF do recebedor.
`enderecoEntrega.entComplemento`	texto · até 60	Complemento do endereço.
`enderecoEntrega.entEndereco`	texto · até 60	Endereço.
`enderecoEntrega.entEstado`	texto · até 2	Estado.
`enderecoEntrega.entIE`	texto · até 14	Inscrição estadual.
`enderecoEntrega.entNumero`	texto · até 60	Número do endereço.
`enderecoEntrega.entRazaoSocial`	texto · até 60	Nome ou razão social
`enderecoEntrega.entSepararEndereco`	texto · até 1	Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem.Ex.: `S`, `N`
`enderecoEntrega.entTelefone`	texto · até 15	Telefone.
`endereco_numero`	texto · até 60	Número do endereço.
`enviar_anexos`	texto · até 1	Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo.Ex.: `S`, `N`Valores: `S`, `N`
`estado`	texto · até 2	Sigla do estado.
`exterior`	texto · até 1	Tomador de serviço localizado no exterior (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`fax_ddd`	texto · até 5	DDD do fax.
`fax_numero`	texto · até 15	Número do fax.
`homepage`	texto · até 100	Website.
`inativo`	texto · até 1	Inativo (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`info`	objeto	Informações sobre o cadastro do cliente.
`info.cImpAPI`	texto · até 1	Importado pela API (S/N).Ex.: `S`, `N`
`info.dAlt`	texto · até 10	Data da alteração. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.dInc`	texto · até 10	Data da inclusão. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.hAlt`	texto · até 8	Hora da alteração. No formato hh:mm:ss.Ex.: `23:59:59`
`info.hInc`	texto · até 8	Hora da inclusão. No formato hh:mm:ss.Ex.: `23:59:59`
`info.uAlt`	texto · até 10	Usuário da alteração.
`info.uInc`	texto · até 10	Usuário da inclusão.
`inscricao_estadual`	texto · até 20	Inscrição estadual.
`inscricao_municipal`	texto · até 20	Inscrição municipal.
`inscricao_suframa`	texto · até 20	Inscrição Suframa.
`nif`	texto · até 100	NIF - Número de Identificação Fiscal.
`nome_fantasia`	texto · até 100	Nome fantasia.
`obs_detalhadas`	texto	Observações detalhadas.
`observacao`	texto	Observações internas.
`optante_simples_nacional`	texto · até 1	Optante do Simples Nacional (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`pesquisar_cep`	texto · até 1	Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEPEx.: `S`, `N`Valores: `S`, `N`
`produtor_rural`	texto · até 1	Produtor Rural (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`razao_social`	texto · até 60	Razão social.
`recomendacao_atraso`	texto · até 2	Código da instrução de protesto.
`recomendacoes`	objeto	Recomendações do cliente.
`recomendacoes.codigo_transportadora`	número inteiro	Código da transportadora padrão.
`recomendacoes.codigo_vendedor`	número inteiro	Código do vendedor padrão.
`recomendacoes.email_fatura`	texto · até 200	Enviar a NF-e e boleto para outro e-mail?
`recomendacoes.gerar_boletos`	texto · até 1	Gerar boletos ao emitir NF-e?
`recomendacoes.numero_parcelas`	texto · até 3	Número de parcelas padrão para as vendas.
`recomendacoes.tipo_assinante`	texto · até 1	Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22).
`separar_endereco`	texto · até 1	Separar endereço (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`tags`	lista de objetos	Tags do cliente ou fornecedor.
`tags[].tag`	texto · até 50
`telefone1_ddd`	texto · até 5	DDD do telefone.
`telefone1_numero`	texto · até 15	Telefone para contato.
`telefone2_ddd`	texto · até 5	DDD do telefone 2.
`telefone2_numero`	texto · até 15	Número do telefone 2.
`tipo_atividade`	texto · até 1	Tipo da atividade.
`valor_limite_credito`	número	Valor do limite de crédito total.

Descontinuados 4Ainda aceitos, fora do fluxo principal

Campo	Tipo	Descrição
`bloqueado`descontinuado	texto · até 1	DEPRECATEDValores: `S`, `N`
`importado_api`descontinuado	texto · até 1	DEPRECATED
`logradouro`descontinuado	texto · até 6	DEPRECATED
`pessoa_fisica`descontinuado	texto · até 1	Pessoa Física (S/N)? (Deprecated)Ex.: `S`, `N`Valores: `S`, `N`

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarCliente", "param": [{"codigo_cliente_integracao": "CodigoInterno0001", "email": "primeiro@ccliente.com.br", "razao_social": "Primeiro Cliente  Ltda Me", "nome_fantasia": "Primeiro Cliente"}]}'

import os
import requests

corpo = {'call': 'AlterarCliente',
 'param': [{'codigo_cliente_integracao': 'CodigoInterno0001',
            'email': 'primeiro@ccliente.com.br',
            'razao_social': 'Primeiro Cliente  Ltda Me',
            'nome_fantasia': 'Primeiro Cliente'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clientes/",
    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/clientes/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "AlterarCliente",
    "param": [
      {
        "codigo_cliente_integracao": "CodigoInterno0001",
        "email": "primeiro@ccliente.com.br",
        "razao_social": "Primeiro Cliente  Ltda Me",
        "nome_fantasia": "Primeiro Cliente"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "AlterarCliente",
    "param": [
        {
            "codigo_cliente_integracao": "CodigoInterno0001",
            "email": "primeiro@ccliente.com.br",
            "razao_social": "Primeiro Cliente  Ltda Me",
            "nome_fantasia": "Primeiro Cliente"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "AlterarCliente",
  "param": [
    {
      "codigo_cliente_integracao": "CodigoInterno0001",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
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": "AlterarCliente",
  "param": [
    {
      "codigo_cliente_integracao": "CodigoInterno0001",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clientes/"))
    .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/clientes/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""AlterarCliente"", ""param"": [{""codigo_cliente_integracao"": ""CodigoInterno0001"", ""email"": ""primeiro@ccliente.com.br"", ""razao_social"": ""Primeiro Cliente  Ltda Me"", ""nome_fantasia"": ""Primeiro Cliente""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

AlterarSituacaoCliente

altera dadosClaudeMCP

Ativa ou inativa o cadastro de um cliente ou fornecedor.

Obrigatórios 1

Campo	Tipo	Descrição
`inativo`	texto · até 1	Situação desejada para o cadastro. "S" inativa o cliente ou fornecedor e "N" o ativa.Ex.: `S`, `N`Valores: `S`, `N`

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados. Informe esta tag ou a tag "codigo_cliente_omie".
`codigo_cliente_omie`	número inteiro	Código do cliente ou fornecedor. Informe esta tag ou a tag "codigo_cliente_integracao".

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarSituacaoCliente", "param": [{"codigo_cliente_omie": 0, "inativo": "N"}]}'

import os
import requests

corpo = {'call': 'AlterarSituacaoCliente',
 'param': [{'codigo_cliente_omie': 0, 'inativo': 'N'}]}

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

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "AlterarSituacaoCliente",
    "param": [
        {
            "codigo_cliente_omie": 0,
            "inativo": "N"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "AlterarSituacaoCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "inativo": "N"
    }
  ]
}
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": "AlterarSituacaoCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "inativo": "N"
    }
  ]
}
""";

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

AssociarCodIntCliente

altera dadosClaudeMCP

Associa um código de integração a um cliente cadastrado no Omie.

Obrigatórios 1

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto · até 60

Opcionais 1Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`codigo_cliente_omie`	número inteiro

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AssociarCodIntCliente", "param": [{"codigo_cliente_omie": 0, "codigo_cliente_integracao": ""}]}'

import os
import requests

corpo = {'call': 'AssociarCodIntCliente',
 'param': [{'codigo_cliente_omie': 0, 'codigo_cliente_integracao': ''}]}

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

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "AssociarCodIntCliente",
    "param": [
        {
            "codigo_cliente_omie": 0,
            "codigo_cliente_integracao": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "AssociarCodIntCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "codigo_cliente_integracao": ""
    }
  ]
}
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": "AssociarCodIntCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "codigo_cliente_integracao": ""
    }
  ]
}
""";

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

ConsultarCliente

consultaClaudeChatGPTMCP

Consulta os dados de um cliente

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto · até 60
`codigo_cliente_omie`	número inteiro

Retorno 54O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`bairro`	texto	Bairro.
`bloqueado`	texto	DEPRECATED
`bloquear_exclusao`	texto	Bloqueia a exclusão do registro (S/N)?
`bloquear_faturamento`	texto	Bloquear o faturamento para o cliente (S/N).
`caracteristicas`	lista de objetos	Características do cliente ou fornecedor.
`caracteristicas[].campo`	texto	Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "AlterarCliente" e "UpsertCliente".
`caracteristicas[].conteudo`	texto	Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; nas demais operações que reutilizam esta estrutura (ex.: "AlterarCliente"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima.
`cep`	texto	CEP.
`cidade`	texto	Código da cidade. Recebe o código IBGE ou o NOME da cidade.
`cidade_ibge`	texto	Código do IBGE para a cidade.
`cnae`	texto	Código do CNAE.
`cnpj_cpf`	texto	CNPJ ou CPF.
`codigo_cliente_integracao`	texto	Código de integração com sistemas legados.
`codigo_cliente_omie`	número inteiro	Código de cliente ou fornecedor.
`codigo_pais`	texto	Código do país.
`complemento`	texto	Complemento do endereço.
`contato`	texto	Nome para contato.
`contribuinte`	texto	Contribuinte (S/N)?
`dadosBancarios`	objeto	Dados bancários do cliente.
`dadosBancarios.agencia`	texto	Agência
`dadosBancarios.cChavePix`	texto	Chave PIX.
`dadosBancarios.codigo_banco`	texto	Código do banco.
`dadosBancarios.conta_corrente`	texto	Número da conta corrente.
`dadosBancarios.doc_titular`	texto	CNPJ ou CPF do titular.
`dadosBancarios.nome_titular`	texto	Nome do titular.
`dadosBancarios.transf_padrao`	texto	Definir transferência como forma de pagamento padrão?
`documento_exterior`	texto	Documento no exterior para clientes estrangeiros.
`email`	texto	E-mail.
`endereco`	texto	Endereço.
`enderecoEntrega`	objeto	Dados do endereço de entrega.
`enderecoEntrega.entBairro`	texto	Bairro.
`enderecoEntrega.entCEP`	texto	CEP.
`enderecoEntrega.entCidade`	texto	Cidade.
`enderecoEntrega.entCnpjCpf`	texto	CNPJ ou CPF do recebedor.
`enderecoEntrega.entComplemento`	texto	Complemento do endereço.
`enderecoEntrega.entEndereco`	texto	Endereço.
`enderecoEntrega.entEstado`	texto	Estado.
`enderecoEntrega.entIE`	texto	Inscrição estadual.
`enderecoEntrega.entNumero`	texto	Número do endereço.
`enderecoEntrega.entRazaoSocial`	texto	Nome ou razão social
`enderecoEntrega.entSepararEndereco`	texto	Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem.
`enderecoEntrega.entTelefone`	texto	Telefone.
`endereco_numero`	texto	Número do endereço.
`enviar_anexos`	texto	Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo.
`estado`	texto	Sigla do estado.
`exterior`	texto	Tomador de serviço localizado no exterior (S/N)?
`fax_ddd`	texto	DDD do fax.
`fax_numero`	texto	Número do fax.
`homepage`	texto	Website.
`importado_api`	texto	DEPRECATED
`inativo`	texto	Inativo (S/N)?
`info`	objeto	Informações sobre o cadastro do cliente.
`info.cImpAPI`	texto	Importado pela API (S/N).
`info.dAlt`	texto	Data da alteração. No formato dd/mm/aaaa.
`info.dInc`	texto	Data da inclusão. No formato dd/mm/aaaa.
`info.hAlt`	texto	Hora da alteração. No formato hh:mm:ss.
`info.hInc`	texto	Hora da inclusão. No formato hh:mm:ss.
`info.uAlt`	texto	Usuário da alteração.
`info.uInc`	texto	Usuário da inclusão.
`inscricao_estadual`	texto	Inscrição estadual.
`inscricao_municipal`	texto	Inscrição municipal.
`inscricao_suframa`	texto	Inscrição Suframa.
`logradouro`	texto	DEPRECATED
`nif`	texto	NIF - Número de Identificação Fiscal.
`nome_fantasia`	texto	Nome fantasia.
`obs_detalhadas`	texto	Observações detalhadas.
`observacao`	texto	Observações internas.
`optante_simples_nacional`	texto	Optante do Simples Nacional (S/N)?
`pesquisar_cep`	texto	Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP
`pessoa_fisica`	texto	Pessoa Física (S/N)? (Deprecated)
`produtor_rural`	texto	Produtor Rural (S/N)?
`razao_social`	texto	Razão social.
`recomendacao_atraso`	texto	Código da instrução de protesto.
`recomendacoes`	objeto	Recomendações do cliente.
`recomendacoes.codigo_transportadora`	número inteiro	Código da transportadora padrão.
`recomendacoes.codigo_vendedor`	número inteiro	Código do vendedor padrão.
`recomendacoes.email_fatura`	texto	Enviar a NF-e e boleto para outro e-mail?
`recomendacoes.gerar_boletos`	texto	Gerar boletos ao emitir NF-e?
`recomendacoes.numero_parcelas`	texto	Número de parcelas padrão para as vendas.
`recomendacoes.tipo_assinante`	texto	Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22).
`separar_endereco`	texto	Separar endereço (S/N)?
`tags`	lista de objetos	Tags do cliente ou fornecedor.
`tags[].tag`	texto
`telefone1_ddd`	texto	DDD do telefone.
`telefone1_numero`	texto	Telefone para contato.
`telefone2_ddd`	texto	DDD do telefone 2.
`telefone2_numero`	texto	Número do telefone 2.
`tipo_atividade`	texto	Tipo da atividade.
`valor_limite_credito`	decimal	Valor do limite de crédito total.

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarCliente", "param": [{"codigo_cliente_omie": 0, "codigo_cliente_integracao": ""}]}'

import os
import requests

corpo = {'call': 'ConsultarCliente',
 'param': [{'codigo_cliente_omie': 0, 'codigo_cliente_integracao': ''}]}

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

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "ConsultarCliente",
    "param": [
        {
            "codigo_cliente_omie": 0,
            "codigo_cliente_integracao": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "ConsultarCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "codigo_cliente_integracao": ""
    }
  ]
}
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": "ConsultarCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "codigo_cliente_integracao": ""
    }
  ]
}
""";

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

ExcluirCliente

altera dadosClaudeMCP

Exclui um cliente da base de dados.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto · até 60
`codigo_cliente_omie`	número inteiro

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirCliente", "param": [{"codigo_cliente_omie": 0, "codigo_cliente_integracao": ""}]}'

import os
import requests

corpo = {'call': 'ExcluirCliente',
 'param': [{'codigo_cliente_omie': 0, 'codigo_cliente_integracao': ''}]}

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

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "ExcluirCliente",
    "param": [
        {
            "codigo_cliente_omie": 0,
            "codigo_cliente_integracao": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "ExcluirCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "codigo_cliente_integracao": ""
    }
  ]
}
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": "ExcluirCliente",
  "param": [
    {
      "codigo_cliente_omie": 0,
      "codigo_cliente_integracao": ""
    }
  ]
}
""";

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

IncluirCliente

altera dadosClaudeChatGPTMCP

Inclui um novo cliente ou fornecedor

Obrigatórios 2

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`razao_social`	texto · até 60	Razão social.

Opcionais 48Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`bairro`	texto · até 60	Bairro.
`bloquear_exclusao`	texto · até 1	Bloqueia a exclusão do registro (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`bloquear_faturamento`	texto · até 1	Bloquear o faturamento para o cliente (S/N)?Valores: `S`, `N`
`caracteristicas`	lista de objetos	Características do cliente ou fornecedor.
`caracteristicas[].campo`	texto · até 30	Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "AlterarCliente" e "UpsertCliente".
`caracteristicas[].conteudo`	texto · até 60	Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; nas demais operações que reutilizam esta estrutura (ex.: "AlterarCliente"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima.
`cep`	texto · até 10	CEP.
`cidade`	texto · até 40	Código da cidade. Recebe o código IBGE ou o NOME da cidade.
`cidade_ibge`	texto · até 7	Código do IBGE para a cidade.
`cnae`	texto · até 7	Código do CNAE.
`cnpj_cpf`	texto · até 20	CNPJ ou CPF.Ex.: `12.345.678/0001-01`, `123.456.789-09`
`codigo_cliente_omie`	número inteiro	Código de cliente ou fornecedor.
`codigo_pais`	texto · até 4	Código do país.
`complemento`	texto · até 60	Complemento do endereço.
`contato`	texto · até 100	Nome para contato.
`contribuinte`	texto · até 1	Contribuinte (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`dadosBancarios`	objeto	Dados bancários do cliente.
`dadosBancarios.agencia`	texto · até 10	Agência
`dadosBancarios.cChavePix`	texto · até 60	Chave PIX.
`dadosBancarios.codigo_banco`	texto · até 3	Código do banco.
`dadosBancarios.conta_corrente`	texto · até 25	Número da conta corrente.
`dadosBancarios.doc_titular`	texto · até 20	CNPJ ou CPF do titular.
`dadosBancarios.nome_titular`	texto · até 60	Nome do titular.
`dadosBancarios.transf_padrao`	texto · até 1	Definir transferência como forma de pagamento padrão?Ex.: `S`, `N`
`documento_exterior`	texto · até 20	Documento no exterior para clientes estrangeiros.
`email`	texto · até 500	E-mail.
`endereco`	texto · até 60	Endereço.
`enderecoEntrega`	objeto	Dados do endereço de entrega.
`enderecoEntrega.entBairro`	texto · até 60	Bairro.
`enderecoEntrega.entCEP`	texto · até 9	CEP.
`enderecoEntrega.entCidade`	texto · até 40	Cidade.
`enderecoEntrega.entCnpjCpf`	texto · até 20	CNPJ ou CPF do recebedor.
`enderecoEntrega.entComplemento`	texto · até 60	Complemento do endereço.
`enderecoEntrega.entEndereco`	texto · até 60	Endereço.
`enderecoEntrega.entEstado`	texto · até 2	Estado.
`enderecoEntrega.entIE`	texto · até 14	Inscrição estadual.
`enderecoEntrega.entNumero`	texto · até 60	Número do endereço.
`enderecoEntrega.entRazaoSocial`	texto · até 60	Nome ou razão social
`enderecoEntrega.entSepararEndereco`	texto · até 1	Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem.Ex.: `S`, `N`
`enderecoEntrega.entTelefone`	texto · até 15	Telefone.
`endereco_numero`	texto · até 60	Número do endereço.
`enviar_anexos`	texto · até 1	Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo.Ex.: `S`, `N`Valores: `S`, `N`
`estado`	texto · até 2	Sigla do estado.
`exterior`	texto · até 1	Tomador de serviço localizado no exterior (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`fax_ddd`	texto · até 5	DDD do fax.
`fax_numero`	texto · até 15	Número do fax.
`homepage`	texto · até 100	Website.
`inativo`	texto · até 1	Inativo (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`info`	objeto	Informações sobre o cadastro do cliente.
`info.cImpAPI`	texto · até 1	Importado pela API (S/N).Ex.: `S`, `N`
`info.dAlt`	texto · até 10	Data da alteração. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.dInc`	texto · até 10	Data da inclusão. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.hAlt`	texto · até 8	Hora da alteração. No formato hh:mm:ss.Ex.: `23:59:59`
`info.hInc`	texto · até 8	Hora da inclusão. No formato hh:mm:ss.Ex.: `23:59:59`
`info.uAlt`	texto · até 10	Usuário da alteração.
`info.uInc`	texto · até 10	Usuário da inclusão.
`inscricao_estadual`	texto · até 20	Inscrição estadual.
`inscricao_municipal`	texto · até 20	Inscrição municipal.
`inscricao_suframa`	texto · até 20	Inscrição Suframa.
`nif`	texto · até 100	NIF - Número de Identificação Fiscal.
`nome_fantasia`	texto · até 100	Nome fantasia.
`obs_detalhadas`	texto	Observações detalhadas.
`observacao`	texto	Observações internas.
`optante_simples_nacional`	texto · até 1	Optante do Simples Nacional (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`pesquisar_cep`	texto · até 1	Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEPEx.: `S`, `N`Valores: `S`, `N`
`produtor_rural`	texto · até 1	Produtor Rural (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`recomendacao_atraso`	texto · até 2	Código da instrução de protesto.
`recomendacoes`	objeto	Recomendações do cliente.
`recomendacoes.codigo_transportadora`	número inteiro	Código da transportadora padrão.
`recomendacoes.codigo_vendedor`	número inteiro	Código do vendedor padrão.
`recomendacoes.email_fatura`	texto · até 200	Enviar a NF-e e boleto para outro e-mail?
`recomendacoes.gerar_boletos`	texto · até 1	Gerar boletos ao emitir NF-e?
`recomendacoes.numero_parcelas`	texto · até 3	Número de parcelas padrão para as vendas.
`recomendacoes.tipo_assinante`	texto · até 1	Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22).
`separar_endereco`	texto · até 1	Separar endereço (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`tags`	lista de objetos	Tags do cliente ou fornecedor.
`tags[].tag`	texto · até 50
`telefone1_ddd`	texto · até 5	DDD do telefone.
`telefone1_numero`	texto · até 15	Telefone para contato.
`telefone2_ddd`	texto · até 5	DDD do telefone 2.
`telefone2_numero`	texto · até 15	Número do telefone 2.
`tipo_atividade`	texto · até 1	Tipo da atividade.
`valor_limite_credito`	número	Valor do limite de crédito total.

Descontinuados 4Ainda aceitos, fora do fluxo principal

Campo	Tipo	Descrição
`bloqueado`descontinuado	texto · até 1	Bloqueado (S/N)? (Deprecated)Valores: `S`, `N`
`importado_api`descontinuado	texto · até 1	Importado via API (S/N)? (Deprecated)
`logradouro`descontinuado	texto · até 6	Logradouro (Deprecated)
`pessoa_fisica`descontinuado	texto · até 1	Pessoa Física (S/N)? (Deprecated)Ex.: `S`, `N`Valores: `S`, `N`

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirCliente", "param": [{"codigo_cliente_integracao": "CodigoInterno0001", "email": "primeiro@ccliente.com.br", "razao_social": "Primeiro Cliente  Ltda Me", "nome_fantasia": "Primeiro Cliente"}]}'

import os
import requests

corpo = {'call': 'IncluirCliente',
 'param': [{'codigo_cliente_integracao': 'CodigoInterno0001',
            'email': 'primeiro@ccliente.com.br',
            'razao_social': 'Primeiro Cliente  Ltda Me',
            'nome_fantasia': 'Primeiro Cliente'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clientes/",
    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/clientes/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "IncluirCliente",
    "param": [
      {
        "codigo_cliente_integracao": "CodigoInterno0001",
        "email": "primeiro@ccliente.com.br",
        "razao_social": "Primeiro Cliente  Ltda Me",
        "nome_fantasia": "Primeiro Cliente"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "IncluirCliente",
    "param": [
        {
            "codigo_cliente_integracao": "CodigoInterno0001",
            "email": "primeiro@ccliente.com.br",
            "razao_social": "Primeiro Cliente  Ltda Me",
            "nome_fantasia": "Primeiro Cliente"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "IncluirCliente",
  "param": [
    {
      "codigo_cliente_integracao": "CodigoInterno0001",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
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": "IncluirCliente",
  "param": [
    {
      "codigo_cliente_integracao": "CodigoInterno0001",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clientes/"))
    .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/clientes/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""IncluirCliente"", ""param"": [{""codigo_cliente_integracao"": ""CodigoInterno0001"", ""email"": ""primeiro@ccliente.com.br"", ""razao_social"": ""Primeiro Cliente  Ltda Me"", ""nome_fantasia"": ""Primeiro Cliente""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarClientes

consultaClaudeChatGPTMCP

Lista os clientes cadastrados

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 16Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`apenas_importado_api`	texto · até 1	Exibir apenas os registros gerados pela API
`clientesFiltro`	objeto
`clientesFiltro.bairro`descontinuado	texto · até 60	Bairro (Deprecated).
`clientesFiltro.cep`	texto · até 10	CEP.
`clientesFiltro.cidade`descontinuado	texto · até 40	Cidade (Deprecated).
`clientesFiltro.cnpj_cpf`	texto · até 20	CNPJ ou CPF.Ex.: `000.000.000-00`, `00.000.000/0000-00`
`clientesFiltro.codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`clientesFiltro.codigo_cliente_omie`	número inteiro	Código do cliente ou fornecedor.
`clientesFiltro.contato`descontinuado	texto · até 100	Nome do contato (Deprecated).
`clientesFiltro.email`descontinuado	texto · até 500	E-mail (Deprecated).
`clientesFiltro.endereco`descontinuado	texto · até 60	Endereço (Deprecated).
`clientesFiltro.estado`descontinuado	texto · até 2	Sigla do estado (Deprecated).Ex.: `SP`, `RJ`, `MG`
`clientesFiltro.homepage`descontinuado	texto · até 100	Website (Deprecated).
`clientesFiltro.inativo`	texto · até 1	Inativo (S/N).Ex.: `S`, `N`Valores: `S`, `N`
`clientesFiltro.inscricao_estadual`descontinuado	texto · até 20	Inscrição Estadual (Deprecated).
`clientesFiltro.inscricao_municipal`descontinuado	texto · até 20	Inscrição Municipal (Deprecated).
`clientesFiltro.inscricao_suframa`descontinuado	texto · até 20	Inscrição Suframa (Deprecated).
`clientesFiltro.nome_fantasia`	texto · até 100	Nome fantasia ou nome comercial.
`clientesFiltro.optante_simples_nacional`descontinuado	texto · até 1	Optante do Simples Nacional (S/N) (Deprecated).Ex.: `S`, `N`
`clientesFiltro.pessoa_fisica`descontinuado	texto · até 1	Pessoa Física (Deprecated).Valores: `S`, `N`
`clientesFiltro.razao_social`	texto · até 60	Razão social.
`clientesFiltro.tags`	lista de objetos	Tags do cliente ou fornecedor.
`clientesFiltro.tags[].tag`	texto · até 50
`clientesPorCodigo`	lista de objetos	Lista de códigos para filtro de clientes.
`clientesPorCodigo[].codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`clientesPorCodigo[].codigo_cliente_omie`	número inteiro	Código do cliente ou fornecedor.
`exibir_caracteristicas`	texto · até 1	Exibe as caracteristicas do cliente.
`exibir_obs`	texto · até 1	Exibir as observações do cliente (S/N). Preencher com "S" ou "N". Default "N"
`filtrar_apenas_alteracao`	texto · até 1	Filtrar apenas os registros alterados.
`filtrar_apenas_inclusao`	texto · até 1	Filtrar apenas os registros incluídos.
`filtrar_por_data_ate`	texto · até 10	Filtrar os registros até uma data.
`filtrar_por_data_de`	texto · até 10	Filtrar os registros a partir de uma data.
`filtrar_por_hora_ate`	texto · até 8	Filtro por hora até.
`filtrar_por_hora_de`	texto · até 8	Filtro por hora a apartir de.
`ordem_decrescente`	texto · até 1	DEPRECATED
`ordem_descrescente`	texto · até 1	DEPRECATED
`ordenar_por`	texto · até 100	DEPRECATED
`pagina`	número inteiro	Número da página para resgatar os dados.
`registros_por_pagina`	número inteiro	Número de registros a serem exibidos por página.

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`clientes_cadastro`	lista de objetos	Cadastro reduzido de produtos
`clientes_cadastro[].bairro`	texto	Bairro.
`clientes_cadastro[].bloqueado`	texto	DEPRECATED
`clientes_cadastro[].bloquear_exclusao`	texto	Bloqueia a exclusão do registro (S/N)?
`clientes_cadastro[].bloquear_faturamento`	texto	Bloquear o faturamento para o cliente (S/N).
`clientes_cadastro[].caracteristicas`	lista de objetos	Características do cliente ou fornecedor.
`clientes_cadastro[].caracteristicas[].campo`	texto	Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "AlterarCliente" e "UpsertCliente".
`clientes_cadastro[].caracteristicas[].conteudo`	texto	Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; nas demais operações que reutilizam esta estrutura (ex.: "AlterarCliente"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima.
`clientes_cadastro[].cep`	texto	CEP.
`clientes_cadastro[].cidade`	texto	Código da cidade. Recebe o código IBGE ou o NOME da cidade.
`clientes_cadastro[].cidade_ibge`	texto	Código do IBGE para a cidade.
`clientes_cadastro[].cnae`	texto	Código do CNAE.
`clientes_cadastro[].cnpj_cpf`	texto	CNPJ ou CPF.
`clientes_cadastro[].codigo_cliente_integracao`	texto	Código de integração com sistemas legados. Obrigatório em "UpsertClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirClientesPorLote" e "ListarClientes".
`clientes_cadastro[].codigo_cliente_omie`	número inteiro	Código de cliente ou fornecedor.
`clientes_cadastro[].codigo_pais`	texto	Código do país.
`clientes_cadastro[].complemento`	texto	Complemento do endereço.
`clientes_cadastro[].contato`	texto	Nome para contato.
`clientes_cadastro[].contribuinte`	texto	Contribuinte (S/N)?
`clientes_cadastro[].dadosBancarios`	objeto	Dados bancários do cliente.
`clientes_cadastro[].dadosBancarios.agencia`	texto	Agência
`clientes_cadastro[].dadosBancarios.cChavePix`	texto	Chave PIX.
`clientes_cadastro[].dadosBancarios.codigo_banco`	texto	Código do banco.
`clientes_cadastro[].dadosBancarios.conta_corrente`	texto	Número da conta corrente.
`clientes_cadastro[].dadosBancarios.doc_titular`	texto	CNPJ ou CPF do titular.
`clientes_cadastro[].dadosBancarios.nome_titular`	texto	Nome do titular.
`clientes_cadastro[].dadosBancarios.transf_padrao`	texto	Definir transferência como forma de pagamento padrão?
`clientes_cadastro[].documento_exterior`	texto	Documento no exterior para clientes estrangeiros.
`clientes_cadastro[].email`	texto	E-mail.
`clientes_cadastro[].endereco`	texto	Endereço.
`clientes_cadastro[].enderecoEntrega`	objeto	Dados do endereço de entrega.
`clientes_cadastro[].enderecoEntrega.entBairro`	texto	Bairro.
`clientes_cadastro[].enderecoEntrega.entCEP`	texto	CEP.
`clientes_cadastro[].enderecoEntrega.entCidade`	texto	Cidade.
`clientes_cadastro[].enderecoEntrega.entCnpjCpf`	texto	CNPJ ou CPF do recebedor.
`clientes_cadastro[].enderecoEntrega.entComplemento`	texto	Complemento do endereço.
`clientes_cadastro[].enderecoEntrega.entEndereco`	texto	Endereço.
`clientes_cadastro[].enderecoEntrega.entEstado`	texto	Estado.
`clientes_cadastro[].enderecoEntrega.entIE`	texto	Inscrição estadual.
`clientes_cadastro[].enderecoEntrega.entNumero`	texto	Número do endereço.
`clientes_cadastro[].enderecoEntrega.entRazaoSocial`	texto	Nome ou razão social
`clientes_cadastro[].enderecoEntrega.entSepararEndereco`	texto	Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem.
`clientes_cadastro[].enderecoEntrega.entTelefone`	texto	Telefone.
`clientes_cadastro[].endereco_numero`	texto	Número do endereço.
`clientes_cadastro[].enviar_anexos`	texto	Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo.
`clientes_cadastro[].estado`	texto	Sigla do estado.
`clientes_cadastro[].exterior`	texto	Tomador de serviço localizado no exterior (S/N)?
`clientes_cadastro[].fax_ddd`	texto	DDD do fax.
`clientes_cadastro[].fax_numero`	texto	Número do fax.
`clientes_cadastro[].homepage`	texto	Website.
`clientes_cadastro[].importado_api`	texto	DEPRECATED
`clientes_cadastro[].inativo`	texto	Inativo (S/N)?
`clientes_cadastro[].info`	objeto	Informações sobre o cadastro do cliente.
`clientes_cadastro[].info.cImpAPI`	texto	Importado pela API (S/N).
`clientes_cadastro[].info.dAlt`	texto	Data da alteração. No formato dd/mm/aaaa.
`clientes_cadastro[].info.dInc`	texto	Data da inclusão. No formato dd/mm/aaaa.
`clientes_cadastro[].info.hAlt`	texto	Hora da alteração. No formato hh:mm:ss.
`clientes_cadastro[].info.hInc`	texto	Hora da inclusão. No formato hh:mm:ss.
`clientes_cadastro[].info.uAlt`	texto	Usuário da alteração.
`clientes_cadastro[].info.uInc`	texto	Usuário da inclusão.
`clientes_cadastro[].inscricao_estadual`	texto	Inscrição estadual.
`clientes_cadastro[].inscricao_municipal`	texto	Inscrição municipal.
`clientes_cadastro[].inscricao_suframa`	texto	Inscrição Suframa.
`clientes_cadastro[].logradouro`	texto	DEPRECATED
`clientes_cadastro[].nif`	texto	NIF - Número de Identificação Fiscal.
`clientes_cadastro[].nome_fantasia`	texto	Nome fantasia.
`clientes_cadastro[].obs_detalhadas`	texto	Observações detalhadas.
`clientes_cadastro[].observacao`	texto	Observações internas.
`clientes_cadastro[].optante_simples_nacional`	texto	Optante do Simples Nacional (S/N)?
`clientes_cadastro[].pesquisar_cep`	texto	Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP
`clientes_cadastro[].pessoa_fisica`	texto	Pessoa Física (S/N)? (Deprecated)
`clientes_cadastro[].produtor_rural`	texto	Produtor Rural (S/N)?
`clientes_cadastro[].razao_social`	texto	Razão social.
`clientes_cadastro[].recomendacao_atraso`	texto	Código da instrução de protesto.
`clientes_cadastro[].recomendacoes`	objeto	Recomendações do cliente.
`clientes_cadastro[].recomendacoes.codigo_transportadora`	número inteiro	Código da transportadora padrão.
`clientes_cadastro[].recomendacoes.codigo_vendedor`	número inteiro	Código do vendedor padrão.
`clientes_cadastro[].recomendacoes.email_fatura`	texto	Enviar a NF-e e boleto para outro e-mail?
`clientes_cadastro[].recomendacoes.gerar_boletos`	texto	Gerar boletos ao emitir NF-e?
`clientes_cadastro[].recomendacoes.numero_parcelas`	texto	Número de parcelas padrão para as vendas.
`clientes_cadastro[].recomendacoes.tipo_assinante`	texto	Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22).
`clientes_cadastro[].separar_endereco`	texto	Separar endereço (S/N)?
`clientes_cadastro[].tags`	lista de objetos	Tags do cliente ou fornecedor.
`clientes_cadastro[].tags[].tag`	texto
`clientes_cadastro[].telefone1_ddd`	texto	DDD do telefone.
`clientes_cadastro[].telefone1_numero`	texto	Telefone para contato.
`clientes_cadastro[].telefone2_ddd`	texto	DDD do telefone 2.
`clientes_cadastro[].telefone2_numero`	texto	Número do telefone 2.
`clientes_cadastro[].tipo_atividade`	texto	Tipo da atividade.
`clientes_cadastro[].valor_limite_credito`	decimal	Valor do limite de crédito total.
`pagina`	número inteiro	Número da página retornada
`registros`	número inteiro	Número de registros retornados na página.
`total_de_paginas`	número inteiro	Número total de páginas
`total_de_registros`	número inteiro	total de registros encontrados

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarClientes", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N"}]}'

import os
import requests

corpo = {'call': 'ListarClientes',
 'param': [{'pagina': 1, 'registros_por_pagina': 50, 'apenas_importado_api': 'N'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clientes/",
    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/clientes/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarClientes",
    "param": [
      {
        "pagina": 1,
        "registros_por_pagina": 50,
        "apenas_importado_api": "N"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "ListarClientes",
    "param": [
        {
            "pagina": 1,
            "registros_por_pagina": 50,
            "apenas_importado_api": "N"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "ListarClientes",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 50,
      "apenas_importado_api": "N"
    }
  ]
}
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": "ListarClientes",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 50,
      "apenas_importado_api": "N"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clientes/"))
    .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/clientes/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarClientes"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""apenas_importado_api"": ""N""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarClientesResumido

consultaClaudeChatGPTMCP

Realiza pesquisa dos clientes

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 16Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`apenas_importado_api`	texto · até 1	Exibir apenas os registros gerados pela API
`clientesFiltro`	objeto
`clientesFiltro.bairro`descontinuado	texto · até 60	Bairro (Deprecated).
`clientesFiltro.cep`	texto · até 10	CEP.
`clientesFiltro.cidade`descontinuado	texto · até 40	Cidade (Deprecated).
`clientesFiltro.cnpj_cpf`	texto · até 20	CNPJ ou CPF.Ex.: `000.000.000-00`, `00.000.000/0000-00`
`clientesFiltro.codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`clientesFiltro.codigo_cliente_omie`	número inteiro	Código do cliente ou fornecedor.
`clientesFiltro.contato`descontinuado	texto · até 100	Nome do contato (Deprecated).
`clientesFiltro.email`descontinuado	texto · até 500	E-mail (Deprecated).
`clientesFiltro.endereco`descontinuado	texto · até 60	Endereço (Deprecated).
`clientesFiltro.estado`descontinuado	texto · até 2	Sigla do estado (Deprecated).Ex.: `SP`, `RJ`, `MG`
`clientesFiltro.homepage`descontinuado	texto · até 100	Website (Deprecated).
`clientesFiltro.inativo`	texto · até 1	Inativo (S/N).Ex.: `S`, `N`Valores: `S`, `N`
`clientesFiltro.inscricao_estadual`descontinuado	texto · até 20	Inscrição Estadual (Deprecated).
`clientesFiltro.inscricao_municipal`descontinuado	texto · até 20	Inscrição Municipal (Deprecated).
`clientesFiltro.inscricao_suframa`descontinuado	texto · até 20	Inscrição Suframa (Deprecated).
`clientesFiltro.nome_fantasia`	texto · até 100	Nome fantasia ou nome comercial.
`clientesFiltro.optante_simples_nacional`descontinuado	texto · até 1	Optante do Simples Nacional (S/N) (Deprecated).Ex.: `S`, `N`
`clientesFiltro.pessoa_fisica`descontinuado	texto · até 1	Pessoa Física (Deprecated).Valores: `S`, `N`
`clientesFiltro.razao_social`	texto · até 60	Razão social.
`clientesFiltro.tags`	lista de objetos	Tags do cliente ou fornecedor.
`clientesFiltro.tags[].tag`	texto · até 50
`clientesPorCodigo`	lista de objetos	Lista de códigos para filtro de clientes.
`clientesPorCodigo[].codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`clientesPorCodigo[].codigo_cliente_omie`	número inteiro	Código do cliente ou fornecedor.
`exibir_caracteristicas`	texto · até 1	Exibe as caracteristicas do cliente.
`exibir_obs`	texto · até 1	Exibir as observações do cliente (S/N). Preencher com "S" ou "N". Default "N"
`filtrar_apenas_alteracao`	texto · até 1	Filtrar apenas os registros alterados.
`filtrar_apenas_inclusao`	texto · até 1	Filtrar apenas os registros incluídos.
`filtrar_por_data_ate`	texto · até 10	Filtrar os registros até uma data.
`filtrar_por_data_de`	texto · até 10	Filtrar os registros a partir de uma data.
`filtrar_por_hora_ate`	texto · até 8	Filtro por hora até.
`filtrar_por_hora_de`	texto · até 8	Filtro por hora a apartir de.
`ordem_decrescente`	texto · até 1	DEPRECATED
`ordem_descrescente`	texto · até 1	DEPRECATED
`ordenar_por`	texto · até 100	DEPRECATED
`pagina`	número inteiro	Número da página para resgatar os dados.
`registros_por_pagina`	número inteiro	Número de registros a serem exibidos por página.

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`clientes_cadastro_resumido`	lista de objetos	Cadastro reduzido de clientes.
`clientes_cadastro_resumido[].cnpj_cpf`	texto	CNPJ ou CPF do cliente.
`clientes_cadastro_resumido[].codigo_cliente`	número inteiro	Código do cliente - gerado pelo Omie.
`clientes_cadastro_resumido[].codigo_cliente_integracao`	texto
`clientes_cadastro_resumido[].nome_fantasia`	texto	Nome Fantasia do cliente
`clientes_cadastro_resumido[].razao_social`	texto	Razão Social do cliente
`pagina`	número inteiro	Número da página retornada
`registros`	número inteiro	Número de registros retornados na página.
`total_de_paginas`	número inteiro	Número total de páginas
`total_de_registros`	número inteiro	total de registros encontrados

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarClientesResumido", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N"}]}'

import os
import requests

corpo = {'call': 'ListarClientesResumido',
 'param': [{'pagina': 1, 'registros_por_pagina': 50, 'apenas_importado_api': 'N'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clientes/",
    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/clientes/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarClientesResumido",
    "param": [
      {
        "pagina": 1,
        "registros_por_pagina": 50,
        "apenas_importado_api": "N"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "ListarClientesResumido",
    "param": [
        {
            "pagina": 1,
            "registros_por_pagina": 50,
            "apenas_importado_api": "N"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "ListarClientesResumido",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 50,
      "apenas_importado_api": "N"
    }
  ]
}
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": "ListarClientesResumido",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 50,
      "apenas_importado_api": "N"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clientes/"))
    .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/clientes/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarClientesResumido"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""apenas_importado_api"": ""N""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

UpsertCliente

altera dadosClaudeMCP

Realiza o UPSERT da tabela de clientes (INCLUSÃO/ALTERAÇÃO).

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 50Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`bairro`	texto · até 60	Bairro.
`bloquear_exclusao`	texto · até 1	Bloqueia a exclusão do registro (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`bloquear_faturamento`	texto · até 1	Bloquear o faturamento para o cliente (S/N).Ex.: `S`, `N`Valores: `S`, `N`
`caracteristicas`	lista de objetos	Características do cliente ou fornecedor.
`caracteristicas[].campo`	texto · até 30	Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "AlterarCliente" e "UpsertCliente".
`caracteristicas[].conteudo`	texto · até 60	Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; nas demais operações que reutilizam esta estrutura (ex.: "AlterarCliente"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima.
`cep`	texto · até 10	CEP.
`cidade`	texto · até 40	Código da cidade. Recebe o código IBGE ou o NOME da cidade.
`cidade_ibge`	texto · até 7	Código do IBGE para a cidade.
`cnae`	texto · até 7	Código do CNAE.
`cnpj_cpf`	texto · até 20	CNPJ ou CPF.
`codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`codigo_cliente_omie`	número inteiro	Código de cliente ou fornecedor.
`codigo_pais`	texto · até 4	Código do país.
`complemento`	texto · até 60	Complemento do endereço.
`contato`	texto · até 100	Nome para contato.
`contribuinte`	texto · até 1	Contribuinte (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`dadosBancarios`	objeto	Dados bancários do cliente.
`dadosBancarios.agencia`	texto · até 10	Agência
`dadosBancarios.cChavePix`	texto · até 60	Chave PIX.
`dadosBancarios.codigo_banco`	texto · até 3	Código do banco.
`dadosBancarios.conta_corrente`	texto · até 25	Número da conta corrente.
`dadosBancarios.doc_titular`	texto · até 20	CNPJ ou CPF do titular.
`dadosBancarios.nome_titular`	texto · até 60	Nome do titular.
`dadosBancarios.transf_padrao`	texto · até 1	Definir transferência como forma de pagamento padrão?Ex.: `S`, `N`
`documento_exterior`	texto · até 20	Documento no exterior para clientes estrangeiros.
`email`	texto · até 500	E-mail.
`endereco`	texto · até 60	Endereço.
`enderecoEntrega`	objeto	Dados do endereço de entrega.
`enderecoEntrega.entBairro`	texto · até 60	Bairro.
`enderecoEntrega.entCEP`	texto · até 9	CEP.
`enderecoEntrega.entCidade`	texto · até 40	Cidade.
`enderecoEntrega.entCnpjCpf`	texto · até 20	CNPJ ou CPF do recebedor.
`enderecoEntrega.entComplemento`	texto · até 60	Complemento do endereço.
`enderecoEntrega.entEndereco`	texto · até 60	Endereço.
`enderecoEntrega.entEstado`	texto · até 2	Estado.
`enderecoEntrega.entIE`	texto · até 14	Inscrição estadual.
`enderecoEntrega.entNumero`	texto · até 60	Número do endereço.
`enderecoEntrega.entRazaoSocial`	texto · até 60	Nome ou razão social
`enderecoEntrega.entSepararEndereco`	texto · até 1	Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem.Ex.: `S`, `N`
`enderecoEntrega.entTelefone`	texto · até 15	Telefone.
`endereco_numero`	texto · até 60	Número do endereço.
`enviar_anexos`	texto · até 1	Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo.Ex.: `S`, `N`Valores: `S`, `N`
`estado`	texto · até 2	Sigla do estado.
`exterior`	texto · até 1	Tomador de serviço localizado no exterior (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`fax_ddd`	texto · até 5	DDD do fax.
`fax_numero`	texto · até 15	Número do fax.
`homepage`	texto · até 100	Website.
`inativo`	texto · até 1	Inativo (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`info`	objeto	Informações sobre o cadastro do cliente.
`info.cImpAPI`	texto · até 1	Importado pela API (S/N).Ex.: `S`, `N`
`info.dAlt`	texto · até 10	Data da alteração. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.dInc`	texto · até 10	Data da inclusão. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.hAlt`	texto · até 8	Hora da alteração. No formato hh:mm:ss.Ex.: `23:59:59`
`info.hInc`	texto · até 8	Hora da inclusão. No formato hh:mm:ss.Ex.: `23:59:59`
`info.uAlt`	texto · até 10	Usuário da alteração.
`info.uInc`	texto · até 10	Usuário da inclusão.
`inscricao_estadual`	texto · até 20	Inscrição estadual.
`inscricao_municipal`	texto · até 20	Inscrição municipal.
`inscricao_suframa`	texto · até 20	Inscrição Suframa.
`nif`	texto · até 100	NIF - Número de Identificação Fiscal.
`nome_fantasia`	texto · até 100	Nome fantasia.
`obs_detalhadas`	texto	Observações detalhadas.
`observacao`	texto	Observações internas.
`optante_simples_nacional`	texto · até 1	Optante do Simples Nacional (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`pesquisar_cep`	texto · até 1	Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEPEx.: `S`, `N`Valores: `S`, `N`
`produtor_rural`	texto · até 1	Produtor Rural (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`razao_social`	texto · até 60	Razão social.
`recomendacao_atraso`	texto · até 2	Código da instrução de protesto.
`recomendacoes`	objeto	Recomendações do cliente.
`recomendacoes.codigo_transportadora`	número inteiro	Código da transportadora padrão.
`recomendacoes.codigo_vendedor`	número inteiro	Código do vendedor padrão.
`recomendacoes.email_fatura`	texto · até 200	Enviar a NF-e e boleto para outro e-mail?
`recomendacoes.gerar_boletos`	texto · até 1	Gerar boletos ao emitir NF-e?
`recomendacoes.numero_parcelas`	texto · até 3	Número de parcelas padrão para as vendas.
`recomendacoes.tipo_assinante`	texto · até 1	Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22).
`separar_endereco`	texto · até 1	Separar endereço (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`tags`	lista de objetos	Tags do cliente ou fornecedor.
`tags[].tag`	texto · até 50
`telefone1_ddd`	texto · até 5	DDD do telefone.
`telefone1_numero`	texto · até 15	Telefone para contato.
`telefone2_ddd`	texto · até 5	DDD do telefone 2.
`telefone2_numero`	texto · até 15	Número do telefone 2.
`tipo_atividade`	texto · até 1	Tipo da atividade.
`valor_limite_credito`	número	Valor do limite de crédito total.

Descontinuados 4Ainda aceitos, fora do fluxo principal

Campo	Tipo	Descrição
`bloqueado`descontinuado	texto · até 1	DEPRECATEDValores: `S`, `N`
`importado_api`descontinuado	texto · até 1	DEPRECATED
`logradouro`descontinuado	texto · até 6	DEPRECATED
`pessoa_fisica`descontinuado	texto · até 1	Pessoa Física (S/N)? (Deprecated)Ex.: `S`, `N`Valores: `S`, `N`

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertCliente", "param": [{"codigo_cliente_integracao": "CodigoInterno0001", "email": "primeiro@ccliente.com.br", "razao_social": "Primeiro Cliente  Ltda Me", "nome_fantasia": "Primeiro Cliente"}]}'

import os
import requests

corpo = {'call': 'UpsertCliente',
 'param': [{'codigo_cliente_integracao': 'CodigoInterno0001',
            'email': 'primeiro@ccliente.com.br',
            'razao_social': 'Primeiro Cliente  Ltda Me',
            'nome_fantasia': 'Primeiro Cliente'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clientes/",
    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/clientes/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "UpsertCliente",
    "param": [
      {
        "codigo_cliente_integracao": "CodigoInterno0001",
        "email": "primeiro@ccliente.com.br",
        "razao_social": "Primeiro Cliente  Ltda Me",
        "nome_fantasia": "Primeiro Cliente"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "UpsertCliente",
    "param": [
        {
            "codigo_cliente_integracao": "CodigoInterno0001",
            "email": "primeiro@ccliente.com.br",
            "razao_social": "Primeiro Cliente  Ltda Me",
            "nome_fantasia": "Primeiro Cliente"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "UpsertCliente",
  "param": [
    {
      "codigo_cliente_integracao": "CodigoInterno0001",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
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": "UpsertCliente",
  "param": [
    {
      "codigo_cliente_integracao": "CodigoInterno0001",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clientes/"))
    .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/clientes/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""UpsertCliente"", ""param"": [{""codigo_cliente_integracao"": ""CodigoInterno0001"", ""email"": ""primeiro@ccliente.com.br"", ""razao_social"": ""Primeiro Cliente  Ltda Me"", ""nome_fantasia"": ""Primeiro Cliente""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

UpsertClienteCpfCnpj

altera dadosClaudeMCP

Realiza o UPSERT da tabela de clientes (INCLUSÃO/ALTERAÇÃO) com base no CPF/CNPJ informado.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 50Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`bairro`	texto · até 60	Bairro.
`bloquear_exclusao`	texto · até 1	Bloqueia a exclusão do registro (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`bloquear_faturamento`	texto · até 1	Bloquear o faturamento para o cliente (S/N).Ex.: `S`, `N`Valores: `S`, `N`
`caracteristicas`	lista de objetos	Características do cliente ou fornecedor.
`caracteristicas[].campo`	texto · até 30	Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; opcional nas demais operações que reutilizam esta estrutura, como "AlterarCliente" e "UpsertCliente".
`caracteristicas[].conteudo`	texto · até 60	Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em "IncluirCliente" e "IncluirClientesPorLote"; nas demais operações que reutilizam esta estrutura (ex.: "AlterarCliente"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima.
`cep`	texto · até 10	CEP.
`cidade`	texto · até 40	Código da cidade. Recebe o código IBGE ou o NOME da cidade.
`cidade_ibge`	texto · até 7	Código do IBGE para a cidade.
`cnae`	texto · até 7	Código do CNAE.
`cnpj_cpf`	texto · até 20	CNPJ ou CPF.
`codigo_cliente_integracao`	texto · até 60	Código de integração com sistemas legados.
`codigo_cliente_omie`	número inteiro	Código de cliente ou fornecedor.
`codigo_pais`	texto · até 4	Código do país.
`complemento`	texto · até 60	Complemento do endereço.
`contato`	texto · até 100	Nome para contato.
`contribuinte`	texto · até 1	Contribuinte (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`dadosBancarios`	objeto	Dados bancários do cliente.
`dadosBancarios.agencia`	texto · até 10	Agência
`dadosBancarios.cChavePix`	texto · até 60	Chave PIX.
`dadosBancarios.codigo_banco`	texto · até 3	Código do banco.
`dadosBancarios.conta_corrente`	texto · até 25	Número da conta corrente.
`dadosBancarios.doc_titular`	texto · até 20	CNPJ ou CPF do titular.
`dadosBancarios.nome_titular`	texto · até 60	Nome do titular.
`dadosBancarios.transf_padrao`	texto · até 1	Definir transferência como forma de pagamento padrão?Ex.: `S`, `N`
`documento_exterior`	texto · até 20	Documento no exterior para clientes estrangeiros.
`email`	texto · até 500	E-mail.
`endereco`	texto · até 60	Endereço.
`enderecoEntrega`	objeto	Dados do endereço de entrega.
`enderecoEntrega.entBairro`	texto · até 60	Bairro.
`enderecoEntrega.entCEP`	texto · até 9	CEP.
`enderecoEntrega.entCidade`	texto · até 40	Cidade.
`enderecoEntrega.entCnpjCpf`	texto · até 20	CNPJ ou CPF do recebedor.
`enderecoEntrega.entComplemento`	texto · até 60	Complemento do endereço.
`enderecoEntrega.entEndereco`	texto · até 60	Endereço.
`enderecoEntrega.entEstado`	texto · até 2	Estado.
`enderecoEntrega.entIE`	texto · até 14	Inscrição estadual.
`enderecoEntrega.entNumero`	texto · até 60	Número do endereço.
`enderecoEntrega.entRazaoSocial`	texto · até 60	Nome ou razão social
`enderecoEntrega.entSepararEndereco`	texto · até 1	Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem.Ex.: `S`, `N`
`enderecoEntrega.entTelefone`	texto · até 15	Telefone.
`endereco_numero`	texto · até 60	Número do endereço.
`enviar_anexos`	texto · até 1	Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo.Ex.: `S`, `N`Valores: `S`, `N`
`estado`	texto · até 2	Sigla do estado.
`exterior`	texto · até 1	Tomador de serviço localizado no exterior (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`fax_ddd`	texto · até 5	DDD do fax.
`fax_numero`	texto · até 15	Número do fax.
`homepage`	texto · até 100	Website.
`inativo`	texto · até 1	Inativo (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`info`	objeto	Informações sobre o cadastro do cliente.
`info.cImpAPI`	texto · até 1	Importado pela API (S/N).Ex.: `S`, `N`
`info.dAlt`	texto · até 10	Data da alteração. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.dInc`	texto · até 10	Data da inclusão. No formato dd/mm/aaaa.Ex.: `31/12/2024`
`info.hAlt`	texto · até 8	Hora da alteração. No formato hh:mm:ss.Ex.: `23:59:59`
`info.hInc`	texto · até 8	Hora da inclusão. No formato hh:mm:ss.Ex.: `23:59:59`
`info.uAlt`	texto · até 10	Usuário da alteração.
`info.uInc`	texto · até 10	Usuário da inclusão.
`inscricao_estadual`	texto · até 20	Inscrição estadual.
`inscricao_municipal`	texto · até 20	Inscrição municipal.
`inscricao_suframa`	texto · até 20	Inscrição Suframa.
`nif`	texto · até 100	NIF - Número de Identificação Fiscal.
`nome_fantasia`	texto · até 100	Nome fantasia.
`obs_detalhadas`	texto	Observações detalhadas.
`observacao`	texto	Observações internas.
`optante_simples_nacional`	texto · até 1	Optante do Simples Nacional (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`pesquisar_cep`	texto · até 1	Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEPEx.: `S`, `N`Valores: `S`, `N`
`produtor_rural`	texto · até 1	Produtor Rural (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`razao_social`	texto · até 60	Razão social.
`recomendacao_atraso`	texto · até 2	Código da instrução de protesto.
`recomendacoes`	objeto	Recomendações do cliente.
`recomendacoes.codigo_transportadora`	número inteiro	Código da transportadora padrão.
`recomendacoes.codigo_vendedor`	número inteiro	Código do vendedor padrão.
`recomendacoes.email_fatura`	texto · até 200	Enviar a NF-e e boleto para outro e-mail?
`recomendacoes.gerar_boletos`	texto · até 1	Gerar boletos ao emitir NF-e?
`recomendacoes.numero_parcelas`	texto · até 3	Número de parcelas padrão para as vendas.
`recomendacoes.tipo_assinante`	texto · até 1	Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22).
`separar_endereco`	texto · até 1	Separar endereço (S/N)?Ex.: `S`, `N`Valores: `S`, `N`
`tags`	lista de objetos	Tags do cliente ou fornecedor.
`tags[].tag`	texto · até 50
`telefone1_ddd`	texto · até 5	DDD do telefone.
`telefone1_numero`	texto · até 15	Telefone para contato.
`telefone2_ddd`	texto · até 5	DDD do telefone 2.
`telefone2_numero`	texto · até 15	Número do telefone 2.
`tipo_atividade`	texto · até 1	Tipo da atividade.
`valor_limite_credito`	número	Valor do limite de crédito total.

Descontinuados 4Ainda aceitos, fora do fluxo principal

Campo	Tipo	Descrição
`bloqueado`descontinuado	texto · até 1	DEPRECATEDValores: `S`, `N`
`importado_api`descontinuado	texto · até 1	DEPRECATED
`logradouro`descontinuado	texto · até 6	DEPRECATED
`pessoa_fisica`descontinuado	texto · até 1	Pessoa Física (S/N)? (Deprecated)Ex.: `S`, `N`Valores: `S`, `N`

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_cliente_integracao`	texto
`codigo_cliente_omie`	número inteiro
`codigo_status`	texto
`descricao_status`	texto

POST /api/v1/geral/clientes/

curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertClienteCpfCnpj", "param": [{"cnpj_cpf": "80.716.929/0001-50", "email": "primeiro@ccliente.com.br", "razao_social": "Primeiro Cliente  Ltda Me", "nome_fantasia": "Primeiro Cliente"}]}'

import os
import requests

corpo = {'call': 'UpsertClienteCpfCnpj',
 'param': [{'cnpj_cpf': '80.716.929/0001-50',
            'email': 'primeiro@ccliente.com.br',
            'razao_social': 'Primeiro Cliente  Ltda Me',
            'nome_fantasia': 'Primeiro Cliente'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/clientes/",
    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/clientes/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "UpsertClienteCpfCnpj",
    "param": [
      {
        "cnpj_cpf": "80.716.929/0001-50",
        "email": "primeiro@ccliente.com.br",
        "razao_social": "Primeiro Cliente  Ltda Me",
        "nome_fantasia": "Primeiro Cliente"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/clientes/");
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": "UpsertClienteCpfCnpj",
    "param": [
        {
            "cnpj_cpf": "80.716.929/0001-50",
            "email": "primeiro@ccliente.com.br",
            "razao_social": "Primeiro Cliente  Ltda Me",
            "nome_fantasia": "Primeiro Cliente"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/clientes/")
corpo = <<~'JSON'
{
  "call": "UpsertClienteCpfCnpj",
  "param": [
    {
      "cnpj_cpf": "80.716.929/0001-50",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
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": "UpsertClienteCpfCnpj",
  "param": [
    {
      "cnpj_cpf": "80.716.929/0001-50",
      "email": "primeiro@ccliente.com.br",
      "razao_social": "Primeiro Cliente  Ltda Me",
      "nome_fantasia": "Primeiro Cliente"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/clientes/"))
    .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/clientes/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""UpsertClienteCpfCnpj"", ""param"": [{""cnpj_cpf"": ""80.716.929/0001-50"", ""email"": ""primeiro@ccliente.com.br"", ""razao_social"": ""Primeiro Cliente  Ltda Me"", ""nome_fantasia"": ""Primeiro Cliente""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

AlterarCliente
AlterarSituacaoCliente
AssociarCodIntCliente
ConsultarCliente
ExcluirCliente
IncluirCliente
ListarClientes
ListarClientesResumido
UpsertCliente
UpsertClienteCpfCnpj