OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Geral · NegativacaoClientes

A negativação de clientes é uma funcionalidade que permite registrar pendências...

POSThttps://app.omie.com.br/api/v1/geral/negativacaoclientes/WSDL
6consultas
2alterações
Claude 6 de 8 · MCP 6 de 8pelos assistentes de IA
JSON · XMLformato

Verifica se a negativação de clientes está contratado para o aplicativo.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
aplicativonúmero inteiroOpcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
contratadosim/não
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesContratado", "param": [{}]}'

NegativacaoClientesContratar

altera dadosClaudeMCP

Contrata a negativação de clientes para o aplicativo.

Obrigatórios 1

CampoTipoDescrição
planotextoPlano da negativação de clientes a ser contratado, se é mensal, anual, etc.Ex.: mensal
Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
aplicativonúmero inteiroOpcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
successsim/não
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesContratar", "param": [{}]}'

NegativacaoClientesCriar

altera dadosClaudeMCP

Inicia e executa a negativação de uma Conta em Atraso através de uma Conta a Receber, Cliente e Natureza da dívida. Ao criar uma negativação, você autoriza o envio dos dados da dívida para registro no Serasa. As informações do débito serão incluídas nos bancos de dados do Serasa, tornando-as visíveis para consultas realizadas por outras empresas e instituições financeiras.

Obrigatórios 3

CampoTipoDescrição
clientenúmero inteiroIdentificador único do Cliente Fornecedor (código)
conta_recebernúmero inteiroIdentificador único da Conta a Receber (chave)
natureza_dividatextoIdentificador único da Natureza da dívida (código)
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
mensagemtexto
successsim/não
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesCriar", "param": [{}]}'

NegativacaoClientesCusto

consultaClaudeMCP

Retorna o custo da negativação de clientes para o aplicativo.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
aplicativonúmero inteiroOpcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
dadoslista de objetos
dados[].custonúmero
dados[].tipotextoTipo de custo da negativação de clientes, se é mensal, anual, etc.
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesCusto", "param": [{}]}'

Lista clientes por palavra-chave.

Obrigatórios 1

CampoTipoDescrição
termotextoPalavra-chave para busca de clientes, como CNAE´s (principal ou secundários), nome da empresa, etc.
Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
bairrotextoBairro onde a empresa está localizada.Ex.: Centro, Jardins, Savassi
cidadetextoCidade onde a empresa está localizada.Ex.: São Paulo, Rio de Janeiro, Belo Horizonte
estadotextoEstado onde a empresa está localizada.Ex.: SP, RJ, MG
periodonúmero inteiroPeríodo de abertura da empresa. Valores: últimos 2 meses até os últimos 20 anos. Deve ser sempre informado em meses. Exemplo: 2 para últimos 2 meses, 6 para últimos 6 meses, 12 para últimos 12 meses, etc.Ex.: 2, 6, 12
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
dadoslista de objetos
dados[].documentotextoCPF ou CNPJ do cliente.
dados[].nometextoNome do cliente.
successsim/não
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesLista", "param": [{}]}'

Listar e consultar as naturezas de dívida disponíveis para negativação de clientes

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
descricaotextoPalavra-chave para buscar e filtrar uma natureza de dívida específica.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
dadoslista de objetos
dados[].codigotexto
dados[].descricaotexto
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesNaturezasDivida", "param": [{}]}'

Pesquisa os dados do cliente pelo CPF ou CNPJ.

Obrigatórios 1

CampoTipoDescrição
documentotextoCPF ou CNPJ do cliente para busca nas bases de dados de parceiros.
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
dadosobjetoDados do cliente retornados pela pesquisa no radar de clientes.
dados.documentotextoCPF ou CNPJ do cliente.
dados.nometextoNome do cliente.
successsim/não
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesPesquisa", "param": [{}]}'

Consultar o valor total recuperado pós negativações

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
aplicativonúmero inteiroOpcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
valor_totalnúmero
POST /api/v1/geral/negativacaoclientes/
curl -s https://app.omie.com.br/api/v1/geral/negativacaoclientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "NegativacaoClientesTotalRecuperado", "param": [{}]}'