Skip to main content
PUT
Alterar Cliente
PUT substitui o registro inteiro — envie todos os campos, não apenas os alterados.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Cliente. Utilizado tanto como body de inclusão/alteração quanto como retorno das rotas de consulta.

nomeComercial
string
required

Nome/razão social de exibição do cliente. Obrigatório.

Example:

"Comercial Alfa"

razaoSocial
string | null
Example:

"Comercial Alfa Distribuidora Ltda"

natureza
enum<string> | null
default:J

Natureza jurídica: J (Pessoa Jurídica) ou F (Pessoa Física). Padrão: J.

Available options:
J,
F
seuCodigo
string | null

Código auxiliar/externo do cliente no sistema de origem.

cnpj
string | null

Obrigatório informar cnpj quando natureza = J e se desejar CNPJ/CPF preenchido; formato validado quando informado.

Example:

"12345678000199"

cpf
string | null

Formato validado quando informado (natureza F).

Example:

"12345678909"

inscricaoEstadual
string | null
inscricaoMunicipal
string | null
indicadorContribuinte
string | null
codigoDoTipoDeCliente
integer<int16> | null
codigoDoGrupoDeCliente
integer<int32> | null
codigoDaClassificacaoAuxiliar
integer<int32> | null
codigoDoSegmento
string | null
idRamoDeAtividade
integer<int32>
codigoDoVendedor
integer<int32> | null
codigoDaCategoria
integer<int16> | null
codigoDaSituacaoFinanceira
integer<int16> | null
endereco
object

Endereço utilizado pelos cadastros de Cliente e Filial.

telefone
string | null
Example:

"(11) 4002-8922"

site
string | null
Example:

"https://www.suaempresa.com.br"

email
string | null

Formato validado quando informado.

receberEmailBoleto
boolean
paisExterior
boolean

Indica se o cliente está localizado no exterior.

codigoDoPais
integer<int32> | null
idExterior
string | null
observacao
string | null
observacaoFinanceiro
string | null
textoLivre
string | null
codigoDoRegimeTributario
integer<int16>
contatoFinanceiro
string | null
emailContatoFinanceiro
string | null

Formato validado quando informado.

telefoneFinanceiro
string | null
emailsFinanceiro
string[]
contatoFaturamento
string | null
emailContatoFaturamento
string | null

Formato validado quando informado.

telefoneFaturamento
string | null
aliquotaISSRetidoFaturamento
number<double>
idClienteWS
string | null

Identificador externo do cliente, usado para integração.

Response

Cliente alterado com sucesso.

success
boolean
Example:

true

data
object

Cliente. Utilizado tanto como body de inclusão/alteração quanto como retorno das rotas de consulta.