| Name | Description | Type | Additional information |
|---|---|---|---|
| idcadastro |
Código do cadastro do cliente. Indique ZERO ser for um novo cadastro. |
integer |
Required |
| tipo_cadastro |
(*) 1 = Cliente, 2 = Fornecedor, 3 = Funcionário |
integer |
Required |
| cadastro_ativo |
(*) Indica se o cadastro está ativo ou encerrado |
boolean |
Required |
| data_encerramento |
Data de encerramento do cadastro |
string |
Required |
| motivo_encerramento |
Motivo do encerramento |
string |
None. |
| pessoa |
(*) PF - Pessoa física, PJ - Pessoa jurídica, PP - Poder público |
string |
Required |
| tipo_empresa |
(*) 0 - indefinido, 1 - Outros, 2 - Comércio, 3 - Indústria. (apenas se for empresa) |
integer |
Required |
| sexo |
(*) M - Masculino, F - Feminino, vazio se empresa |
string |
Required |
| nome |
(*) Nome do cliente (maxlength: 40) |
string |
Required |
| secretaria |
Secretaria (prefeituras) (maxlength: 50) |
string |
Required |
| data_nascimento |
(*) Data de nascimento do cliente (apenas PF) |
string |
Required |
| cpf |
(*) Cpf ou Cnpj do cliente/empresa |
string |
Required |
| rg |
(*) RG do cliente ou Inscrição estadual da empresa (maxlength: 17) |
string |
Required |
| estado_civil |
Estado civil do cliente. SOLTEIRO(A), CASADO(A), SEPARADO(A), VIÚVO(A), OUTRO ou EM BRANCO |
string |
None. |
| conjuge |
Nome do conjuge do cliente (maxlength: 50) |
string |
Required |
| profissao |
Profissão do cliente (maxlength: 30) |
string |
Required |
| referencia_pessoal |
Referência pessoal (maxlength: 100) |
string |
Required |
|
Email. Pode ser mais de um, separados por virgula (maxlength: 100) |
string |
Required |
|
| telefone1 |
Telefone fixo, incluindo ddd |
string |
Required |
| telefone2 |
(*) Telefone celular, incluindo ddd (obrigatório ao menos um telefone) |
string |
Required |
| telefone2_whatsapp |
1 indica que é whatsapp |
integer |
None. |
| telefone3 |
Telefone fixo ou celular, incluindo ddd |
string |
Required |
| telefone3_whatsapp |
1 indica que é whatsapp |
integer |
None. |
| telefone4 |
Telefone fixo ou celular, incluindo ddd |
string |
Required |
| telefone4_whatsapp |
1 indica que é whatsapp |
integer |
None. |
| receber_sms |
True indica que o cliente aceita receber SMS |
boolean |
Required |
| endereco |
(*) Endereço do cliente aonde o serviço é prestado |
CadastroEndereco |
Required |
| endereco_cobranca |
Endereço de cobrança, para onde o boleto deve ser enviado. (não é obrigatório) |
CadastroEndereco |
None. |
| formacontratacao_codigo |
(*) Código da forma de contratação: 1=Pessoalmente, 2=Por telefone, 3=On-Line, 4=Venda externa |
integer |
Required |
| formacontratacao_nome |
(*) Nome do tipo de contratação |
string |
Required |
| comonosconheceu_id |
(*) Código do como nos conheceu |
integer |
Required |
| comonosconheceu_nome |
(*) Descrição do como nos conheceu |
string |
Required |
| comonosconheceu_outros |
Outra forma de como nos conheceu |
string |
Required |
| anotacoes |
Anotações do cadastro |
string |
None. |
| notificacoes |
Anotações de alguma ocorrência importante e que outros colaboradores tenham conhecimento |
string |
None. |
| observacoes |
Observações diversas em curtas palavras |
string |
None. |
| data_cadastro |
Data de criação do cadastro do cliente |
string |
None. |
| contrato_numero |
Número do contrato |
string |
None. |
| contrato_data |
Data da contratação/ativação do serviço |
string |
None. |
| contrato_fidelidade |
Informações sobre a fidelidade contratual |
string |
None. |
| cliente_desde |
Quantidade de meses em que o cliente efetuou cadastro |
string |
None. |
| data_atualizacao |
data da última atualização do cadastro |
string |
None. |
| precisa_atualizar |
True indica que precisa atualizar o cadastro |
boolean |
None. |
| usando_app |
True indica que o cliente usa ou já usou o aplicativo |
boolean |
None. |
| ultimo_acesso_app |
Data do último acesso via app |
string |
None. |
| codigo_app |
Código para uso no aplicativo do cliente |
string |
None. |
| score |
Score do cadastro |
integer |
None. |
| id_venda_online |
Código do cadastro de vendas online (importação). Padrão = 0 |
integer |
None. |
| plano_nome |
Nome do plano contratado pelo cliente |
string |
None. |
| latitude |
Latitude |
decimal number |
None. |
| longitude |
Longitude |
decimal number |
None. |
| mudanca_endereco_valor |
Valor da taxa de mudança de endereço/ponto |
decimal number |
None. |
| mudanca_endereco_refideliza |
True indica que pode refidelizar |
boolean |
None. |
| mudanca_endereco_descricao |
Descrição sobre mudança de endereço/ponto |
string |
None. |
| TemTelefonia |
Valor maior que ZERO indica que tem telefonia móvel |
integer |
None. |
| valor_taxa_instalacao |
Valor da taxa de instalação, se for o caso |
decimal number |
None. |
| erro_mensagem |
Alguma mensagem de erro, caso ocorra |
string |
None. |