OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
CRM · contatos

Operações relacionadas a CRM - Contatos

POSThttps://app.omie.com.br/api/v1/crm/contatos/WSDL
3consultas
4alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

AlterarContato

altera dadosClaudeMCP

Altera um Contato

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cObstextoObservações.
enderecoobjeto
endereco.cBairrotexto · até 60Bairro
endereco.cCEPtexto · até 10CEP
endereco.cCidadetexto · até 50Cidade
endereco.cCompltexto · até 200Complemento
endereco.cEnderecotexto · até 200Endereço do contato
endereco.cPaistexto · até 50País
endereco.cUFtexto · até 50Estado
identificacaoobjeto
identificacao.cCargotexto · até 60Cargo
identificacao.cCodInttextoCódigo de Integração
identificacao.cNometexto · até 60Nome do contato
identificacao.cSobrenometexto · até 60Sobrenome do contato
identificacao.dDtNasctexto · até 10Data de Nascimento
identificacao.nCodnúmero inteiroCódigo do Contato
identificacao.nCodContanúmero inteiroCódigo da Conta
identificacao.nCodVendnúmero inteiroCódigo do Vendedor
telefone_emailobjeto
telefone_email.cDDDCel1texto · até 5DDD do celular
telefone_email.cDDDCel2texto · até 5DDD do Celular
telefone_email.cDDDFaxtexto · até 5DDD do Fax
telefone_email.cDDDTeltexto · até 5DDD do Telefone
telefone_email.cEmailtexto · até 200E-mail do contato
telefone_email.cNumCel1texto · até 15Número do Celular
telefone_email.cNumCel2texto · até 15Número do Celular
telefone_email.cNumFaxtexto · até 15Número do Fax
telefone_email.cNumTeltexto · até 15Número do Telefone
telefone_email.cWebsitetexto · até 100WebSite
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodInttextoCódigo de Integração
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
nCodnúmero inteiroCódigo do contato
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarContato", "param": [{"identificacao": {"cCodInt": "", "cNome": "", "cSobrenome": "", "cCargo": "", "dDtNasc": "", "nCodVend": 0, "nCodConta": 0}, "endereco": {"cEndereco": "", "cCompl": "", "cCEP": "", "cBairro": "", "cCidade": "", "cUF": "", "cPais": ""}, "telefone_email": {"cDDDCel1": "", "cNumCel1": "", "cEmail": "", "cWebsite": ""}}]}'

ConsultarContato

consultaClaudeMCP

Consulta o Contato

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodInttextoCódigo de Integração
nCodnúmero inteiroCódigo do Contato
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cObstextoObservações.
enderecoobjeto
endereco.cBairrotextoBairro
endereco.cCEPtextoCEP
endereco.cCidadetextoCidade
endereco.cCompltextoComplemento
endereco.cEnderecotextoEndereço do contato
endereco.cPaistextoPaís
endereco.cUFtextoEstado
identificacaoobjeto
identificacao.cCargotextoCargo
identificacao.cCodInttextoCódigo de Integração
identificacao.cNometextoNome do contato
identificacao.cSobrenometextoSobrenome do contato
identificacao.dDtNasctextoData de Nascimento
identificacao.nCodnúmero inteiroCódigo do Contato
identificacao.nCodContanúmero inteiroCódigo da Conta
identificacao.nCodVendnúmero inteiroCódigo do Vendedor
telefone_emailobjeto
telefone_email.cDDDCel1textoDDD do celular
telefone_email.cDDDCel2textoDDD do Celular
telefone_email.cDDDFaxtextoDDD do Fax
telefone_email.cDDDTeltextoDDD do Telefone
telefone_email.cEmailtextoE-mail do contato
telefone_email.cNumCel1textoNúmero do Celular
telefone_email.cNumCel2textoNúmero do Celular
telefone_email.cNumFaxtextoNúmero do Fax
telefone_email.cNumTeltextoNúmero do Telefone
telefone_email.cWebsitetextoWebSite
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarContato", "param": [{"nCod": 1, "cCodInt": ""}]}'

ExcluirContato

altera dadosClaudeMCP

Exclui um Contato

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodInttextoCódigo de Integração
nCodnúmero inteiroCódigo do Contato
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodInttextoCódigo de Integração
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
nCodnúmero inteiroCódigo do contato
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirContato", "param": [{"nCod": 0, "cCodInt": ""}]}'

IncluirContato

altera dadosClaudeMCP

Inclui um novo Contato

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cObstextoObservações.
enderecoobjeto
endereco.cBairrotexto · até 60Bairro
endereco.cCEPtexto · até 10CEP
endereco.cCidadetexto · até 50Cidade
endereco.cCompltexto · até 200Complemento
endereco.cEnderecotexto · até 200Endereço do contato
endereco.cPaistexto · até 50País
endereco.cUFtexto · até 50Estado
identificacaoobjeto
identificacao.cCargotexto · até 60Cargo
identificacao.cCodInttextoCódigo de Integração
identificacao.cNometexto · até 60Nome do contato
identificacao.cSobrenometexto · até 60Sobrenome do contato
identificacao.dDtNasctexto · até 10Data de Nascimento
identificacao.nCodnúmero inteiroCódigo do Contato
identificacao.nCodContanúmero inteiroCódigo da Conta
identificacao.nCodVendnúmero inteiroCódigo do Vendedor
telefone_emailobjeto
telefone_email.cDDDCel1texto · até 5DDD do celular
telefone_email.cDDDCel2texto · até 5DDD do Celular
telefone_email.cDDDFaxtexto · até 5DDD do Fax
telefone_email.cDDDTeltexto · até 5DDD do Telefone
telefone_email.cEmailtexto · até 200E-mail do contato
telefone_email.cNumCel1texto · até 15Número do Celular
telefone_email.cNumCel2texto · até 15Número do Celular
telefone_email.cNumFaxtexto · até 15Número do Fax
telefone_email.cNumTeltexto · até 15Número do Telefone
telefone_email.cWebsitetexto · até 100WebSite
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodInttextoCódigo de Integração
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
nCodnúmero inteiroCódigo do contato
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirContato", "param": [{"identificacao": {"cCodInt": "", "cNome": "", "cSobrenome": "", "cCargo": "", "dDtNasc": "", "nCodVend": 0, "nCodConta": 0}, "endereco": {"cEndereco": "", "cCompl": "", "cCEP": "", "cBairro": "", "cCidade": "", "cUF": "", "cPais": ""}, "telefone_email": {"cDDDCel1": "", "cNumCel1": "", "cEmail": "", "cWebsite": ""}}]}'

ListarContatos

consultaClaudeMCP

Lista os contatos do CRM.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 7Campos e estruturas que você pode enviar
CampoTipoDescrição
apenas_importado_apitexto · até 1Exibir apenas os registros gerados pela API
exibir_obstexto · até 1Exibir as observações do contato (S/N). Preencher com "S" ou "N".
filtrar_por_contanúmero inteiroFiltrar os contatos pelo código da conta. Utilize a tag "nCod" do método "ListarContas" da API /api/v1/crm/contas/ para obter essa informação
ordem_decrescentetexto · até 1Se a lista será apresentada em ordem decrescente.
ordenar_portexto · até 100Ordem de exibição dos dados. Padrão: Código.
paginanúmero inteiroNúmero da página para resgatar os dados.
registros_por_paginanúmero inteiroNúmero de registros a serem exibidos por página. Máximo 50.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cadastroslista de objetosLista os cadastros encontrados.
cadastros[].cObstextoObservações.
cadastros[].enderecoobjeto
cadastros[].endereco.cBairrotextoBairro
cadastros[].endereco.cCEPtextoCEP
cadastros[].endereco.cCidadetextoCidade
cadastros[].endereco.cCompltextoComplemento
cadastros[].endereco.cEnderecotextoEndereço do contato
cadastros[].endereco.cPaistextoPaís
cadastros[].endereco.cUFtextoEstado
cadastros[].identificacaoobjeto
cadastros[].identificacao.cCargotextoCargo
cadastros[].identificacao.cCodInttextoCódigo de Integração
cadastros[].identificacao.cNometextoNome do contato
cadastros[].identificacao.cSobrenometextoSobrenome do contato
cadastros[].identificacao.dDtNasctextoData de Nascimento
cadastros[].identificacao.nCodnúmero inteiroCódigo do Contato
cadastros[].identificacao.nCodContanúmero inteiroCódigo da Conta
cadastros[].identificacao.nCodVendnúmero inteiroCódigo do Vendedor
cadastros[].telefone_emailobjeto
cadastros[].telefone_email.cDDDCel1textoDDD do celular
cadastros[].telefone_email.cDDDCel2textoDDD do Celular
cadastros[].telefone_email.cDDDFaxtextoDDD do Fax
cadastros[].telefone_email.cDDDTeltextoDDD do Telefone
cadastros[].telefone_email.cEmailtextoE-mail do contato
cadastros[].telefone_email.cNumCel1textoNúmero do Celular
cadastros[].telefone_email.cNumCel2textoNúmero do Celular
cadastros[].telefone_email.cNumFaxtextoNúmero do Fax
cadastros[].telefone_email.cNumTeltextoNúmero do Telefone
cadastros[].telefone_email.cWebsitetextoWebSite
paginanúmero inteiroNúmero da página retornada
registrosnúmero inteiroNúmero de registros retornados na página.
total_de_paginasnúmero inteiroNúmero total de páginas
total_de_registrosnúmero inteirototal de registros encontrados
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarContatos", "param": [{"pagina": 1, "registros_por_pagina": 50}]}'

UpsertContato

altera dadosClaudeMCP

Upsert do contato

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cObstextoObservações.
enderecoobjeto
endereco.cBairrotexto · até 60Bairro
endereco.cCEPtexto · até 10CEP
endereco.cCidadetexto · até 50Cidade
endereco.cCompltexto · até 200Complemento
endereco.cEnderecotexto · até 200Endereço do contato
endereco.cPaistexto · até 50País
endereco.cUFtexto · até 50Estado
identificacaoobjeto
identificacao.cCargotexto · até 60Cargo
identificacao.cCodInttextoCódigo de Integração
identificacao.cNometexto · até 60Nome do contato
identificacao.cSobrenometexto · até 60Sobrenome do contato
identificacao.dDtNasctexto · até 10Data de Nascimento
identificacao.nCodnúmero inteiroCódigo do Contato
identificacao.nCodContanúmero inteiroCódigo da Conta
identificacao.nCodVendnúmero inteiroCódigo do Vendedor
telefone_emailobjeto
telefone_email.cDDDCel1texto · até 5DDD do celular
telefone_email.cDDDCel2texto · até 5DDD do Celular
telefone_email.cDDDFaxtexto · até 5DDD do Fax
telefone_email.cDDDTeltexto · até 5DDD do Telefone
telefone_email.cEmailtexto · até 200E-mail do contato
telefone_email.cNumCel1texto · até 15Número do Celular
telefone_email.cNumCel2texto · até 15Número do Celular
telefone_email.cNumFaxtexto · até 15Número do Fax
telefone_email.cNumTeltexto · até 15Número do Telefone
telefone_email.cWebsitetexto · até 100WebSite
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodInttextoCódigo de Integração
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
nCodnúmero inteiroCódigo do contato
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertContato", "param": [{"identificacao": {"cCodInt": "", "cNome": "", "cSobrenome": "", "cCargo": "", "dDtNasc": "", "nCodVend": 0, "nCodConta": 0}, "endereco": {"cEndereco": "", "cCompl": "", "cCEP": "", "cBairro": "", "cCidade": "", "cUF": "", "cPais": ""}, "telefone_email": {"cDDDCel1": "", "cNumCel1": "", "cEmail": "", "cWebsite": ""}}]}'

VerificarContato

consultaClaudeMCP

Verifica se um contato já existe.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
cEmailtexto · até 200E-mail do contato
cNometexto · até 60Nome completo (Nome + Sobrenome) do contato.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodInttextoCódigo de Integração
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
nCodnúmero inteiroCódigo do contato
POST /api/v1/crm/contatos/
curl -s https://app.omie.com.br/api/v1/crm/contatos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "VerificarContato", "param": [{"cNome": "", "cEmail": ""}]}'