Atualizar cliente

Permite atualizar o cliente de um determinado escritório.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário de propriedades do corpo da requisição

TaxRegime

Essa propriedade representa o regime tributário do cliente:

  • 0 - Não especificado
  • 1 - Lucro Real
  • 2 - Lucro Presumido
  • 3 - Lucro Arbitrado
  • 4 - Simples Nacional
  • 5 - Microempreendedor Individual
  • 6 - Isento/Imune

A atualização substitui o valor: omitir o campo ou enviar null limpa o regime do cadastro. Com CPF no DocumentNumber, o valor é ignorado e o regime fica null.


BusinessActivity

Essa propriedade utiliza flags (pode combinar valores) e representa os tipos de atividade empresarial:

  • 0 - Não especificado
  • 1 - Comércio
  • 2 - Serviço
  • 4 - Indústria
Combinações possíveis:
  • 3 - Comércio e Serviço (1 | 2)
  • 5 - Comércio e Indústria (1 | 4)
  • 6 - Serviço e Indústria (2 | 4)
  • 7 - Comércio, Serviço e Indústria (1 | 2 | 4)

Omitir o campo ou enviar null limpa o ramo de atividade do cadastro.

Path Params
string
required

Id do escritório.

string
required

Id do cliente.

Body Params
string

Nome do cliente.

string

Código do cliente.

boolean

Agenda diária habilitada para o cliente.

boolean

Permitir visualização de documentos do cliente sem login.

string

Número de documento do cliente (CPF ou CNPJ).

string

CEI do cliente.

string

CAEPF do cliente (Pessoa física).

string

Inscrição Estadual do cliente.

string

Inscrição Municipal do cliente.

integer | null
enum

Regime tributário do cliente.

  • 0 - Não especificado
  • 1 - Lucro Real
  • 2 - Lucro Presumido
  • 3 - Lucro Arbitrado
  • 4 - Simples Nacional
  • 5 - Microempreendedor Individual
  • 6 - Isento/Imune

A atualização substitui o valor: omitido ou null, limpa o regime do cadastro. Com CPF no DocumentNumber, o valor é ignorado e o regime fica null.

integer | null
enum

Ramo de atividade do cliente. É um campo de flags: o valor é a soma das atividades.

  • 0 - Não especificado
  • 1 - Comércio
  • 2 - Serviço
  • 4 - Indústria
  • 3 - Comércio e Serviço (1 | 2)
  • 5 - Comércio e Indústria (1 | 4)
  • 6 - Serviço e Indústria (2 | 4)
  • 7 - Comércio, Serviço e Indústria (1 | 2 | 4)

A atualização substitui o valor: omitido ou null, limpa o ramo de atividade do cadastro.

CustomerAddress
array of objects

Endereço do cliente.

CustomerAddress
Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json