Sign in

v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Clientes

Atualizar cliente

Permite atualizar um cliente previamente cadastrado.

put/v1/parceiros/clientes/{codigoCliente}

Path parameters

codigoClienteinteger required
Example:4599

Informe neste atributo o "código do produto" desejado

Request body

tipo'PF' | 'PJ'

Tipo da pessoa que pode ser Física ou Jurídica

cnpjCpfstring

Documento CNPJ ou CPF, de acordo com o tipo do consumidor

ieRgstring

Documento Inscrição Estadual ou RG, de acordo com o tipo do consumidor

nomestring required

Nome da pessoa física ou nome fantasia para pessoa juridica

razaostring

Nome social para pessoa jurídica

emailstring
telefoneDddstring
telefoneNumerostring
limiteCreditonumber
grupoAutorizacaostring

Este campo garante que um tipo de negociação só possa ser usado por Clientes que fazem parte do mesmo grupo de autorização. Para mais detalhes clique aqui e saiba mais.

Example request

{
  "tipo": "PF",
  "cnpjCpf": "12315914799",
  "ieRg": "12315914799",
  "nome": "José da Silva",
  "razao": "José da Silva ME",
  "email": "contato@provedor.com.br",
  "telefoneDdd": "34",
  "telefoneNumero": "912349966",
  "limiteCredito": 10500,
  "grupoAutorizacao": "AB",
  "endereco": {
    "logradouro": "Rua Maria Roberta",
    "complemento": "Apto 104",
    "bairro": "Centro",
    "cidade": "Uberlândia",
    "uf": "MG"
  },
  "camposAdicionais": {
    "AD_TESTE_API_CAMPO_ADICIONAL_1": "Conteudo do campo 01",
    "AD_TESTE_API_CAMPO_ADICIONAL_2": "Conteudo do campo 02",
    "AD_TESTE_API_CAMPO_ADICIONAL_3": "Conteudo do campo 03",
    "AD_TESTE_API_CAMPO_ADICIONAL_4": "Conteudo do campo 04"
  }
}

Response

Operação bem sucedida. Clique aqui para mais detalhes.

codigoClienteinteger

Insira o código do cliente.Esse código é facilmente retornado pelo serviço: GET /v1/parceiros/clientes

Example response

{
  "codigoCliente": 8115
}