GET api/Cadastro/{id}

Obtém os dados do cadastro indicado pelo id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Código do cadastro a ser consultado

 integer

Required

Body Parameters

None.

Response Information

Resource Description

CadastroDados
NameDescriptionTypeAdditional 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

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.

Response Formats

application/json, text/json

Sample: 
{
  "idcadastro": 1,
  "tipo_cadastro": 2,
  "cadastro_ativo": true,
  "data_encerramento": "sample string 4",
  "motivo_encerramento": "sample string 5",
  "pessoa": "sample string 6",
  "tipo_empresa": 7,
  "sexo": "sample string 8",
  "nome": "sample string 9",
  "secretaria": "sample string 10",
  "data_nascimento": "sample string 11",
  "cpf": "sample string 12",
  "rg": "sample string 13",
  "estado_civil": "sample string 14",
  "conjuge": "sample string 15",
  "profissao": "sample string 16",
  "referencia_pessoal": "sample string 17",
  "email": "sample string 18",
  "telefone1": "sample string 19",
  "telefone2": "sample string 20",
  "telefone2_whatsapp": 21,
  "telefone3": "sample string 22",
  "telefone3_whatsapp": 23,
  "telefone4": "sample string 24",
  "telefone4_whatsapp": 25,
  "receber_sms": true,
  "endereco": {
    "endereco": "sample string 1",
    "numero": "sample string 2",
    "complemento": "sample string 3",
    "cep": 4,
    "idcidade": 5,
    "cidade": "sample string 6",
    "uf": "sample string 7",
    "idbairro": 8,
    "bairro": "sample string 9",
    "idcondominio": 10,
    "condominio": "sample string 11",
    "apartamento": "sample string 12",
    "bloco": "sample string 13"
  },
  "endereco_cobranca": {
    "endereco": "sample string 1",
    "numero": "sample string 2",
    "complemento": "sample string 3",
    "cep": 4,
    "idcidade": 5,
    "cidade": "sample string 6",
    "uf": "sample string 7",
    "idbairro": 8,
    "bairro": "sample string 9",
    "idcondominio": 10,
    "condominio": "sample string 11",
    "apartamento": "sample string 12",
    "bloco": "sample string 13"
  },
  "formacontratacao_codigo": 27,
  "formacontratacao_nome": "sample string 28",
  "comonosconheceu_id": 29,
  "comonosconheceu_nome": "sample string 30",
  "comonosconheceu_outros": "sample string 31",
  "anotacoes": "sample string 32",
  "notificacoes": "sample string 33",
  "observacoes": "sample string 34",
  "data_cadastro": "sample string 35",
  "contrato_numero": "sample string 36",
  "contrato_data": "sample string 37",
  "contrato_fidelidade": "sample string 38",
  "cliente_desde": "sample string 39",
  "data_atualizacao": "sample string 40",
  "precisa_atualizar": true,
  "usando_app": true,
  "ultimo_acesso_app": "sample string 43",
  "codigo_app": "sample string 44",
  "score": 45,
  "id_venda_online": 46,
  "plano_nome": "sample string 47",
  "latitude": 48.1,
  "longitude": 49.1,
  "mudanca_endereco_valor": 50.0,
  "mudanca_endereco_refideliza": true,
  "mudanca_endereco_descricao": "sample string 52",
  "TemTelefonia": 53,
  "valor_taxa_instalacao": 54.0,
  "erro_mensagem": "sample string 55"
}

application/xml, text/xml

Sample: 
<CadastroDados xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <TemTelefonia>53</TemTelefonia>
  <anotacoes>sample string 32</anotacoes>
  <cadastro_ativo>true</cadastro_ativo>
  <cliente_desde>sample string 39</cliente_desde>
  <codigo_app>sample string 44</codigo_app>
  <comonosconheceu_id>29</comonosconheceu_id>
  <comonosconheceu_nome>sample string 30</comonosconheceu_nome>
  <comonosconheceu_outros>sample string 31</comonosconheceu_outros>
  <conjuge>sample string 15</conjuge>
  <contrato_data>sample string 37</contrato_data>
  <contrato_fidelidade>sample string 38</contrato_fidelidade>
  <contrato_numero>sample string 36</contrato_numero>
  <cpf>sample string 12</cpf>
  <data_atualizacao>sample string 40</data_atualizacao>
  <data_cadastro>sample string 35</data_cadastro>
  <data_encerramento>sample string 4</data_encerramento>
  <data_nascimento>sample string 11</data_nascimento>
  <email>sample string 18</email>
  <endereco>
    <apartamento>sample string 12</apartamento>
    <bairro>sample string 9</bairro>
    <bloco>sample string 13</bloco>
    <cep>4</cep>
    <cidade>sample string 6</cidade>
    <complemento>sample string 3</complemento>
    <condominio>sample string 11</condominio>
    <endereco>sample string 1</endereco>
    <idbairro>8</idbairro>
    <idcidade>5</idcidade>
    <idcondominio>10</idcondominio>
    <numero>sample string 2</numero>
    <uf>sample string 7</uf>
  </endereco>
  <endereco_cobranca>
    <apartamento>sample string 12</apartamento>
    <bairro>sample string 9</bairro>
    <bloco>sample string 13</bloco>
    <cep>4</cep>
    <cidade>sample string 6</cidade>
    <complemento>sample string 3</complemento>
    <condominio>sample string 11</condominio>
    <endereco>sample string 1</endereco>
    <idbairro>8</idbairro>
    <idcidade>5</idcidade>
    <idcondominio>10</idcondominio>
    <numero>sample string 2</numero>
    <uf>sample string 7</uf>
  </endereco_cobranca>
  <erro_mensagem>sample string 55</erro_mensagem>
  <estado_civil>sample string 14</estado_civil>
  <formacontratacao_codigo>27</formacontratacao_codigo>
  <formacontratacao_nome>sample string 28</formacontratacao_nome>
  <id_venda_online>46</id_venda_online>
  <idcadastro>1</idcadastro>
  <latitude>48.1</latitude>
  <longitude>49.1</longitude>
  <motivo_encerramento>sample string 5</motivo_encerramento>
  <mudanca_endereco_descricao>sample string 52</mudanca_endereco_descricao>
  <mudanca_endereco_refideliza>true</mudanca_endereco_refideliza>
  <mudanca_endereco_valor>50</mudanca_endereco_valor>
  <nome>sample string 9</nome>
  <notificacoes>sample string 33</notificacoes>
  <observacoes>sample string 34</observacoes>
  <pessoa>sample string 6</pessoa>
  <plano_nome>sample string 47</plano_nome>
  <precisa_atualizar>true</precisa_atualizar>
  <profissao>sample string 16</profissao>
  <receber_sms>true</receber_sms>
  <referencia_pessoal>sample string 17</referencia_pessoal>
  <rg>sample string 13</rg>
  <score>45</score>
  <secretaria>sample string 10</secretaria>
  <sexo>sample string 8</sexo>
  <telefone1>sample string 19</telefone1>
  <telefone2>sample string 20</telefone2>
  <telefone2_whatsapp>21</telefone2_whatsapp>
  <telefone3>sample string 22</telefone3>
  <telefone3_whatsapp>23</telefone3_whatsapp>
  <telefone4>sample string 24</telefone4>
  <telefone4_whatsapp>25</telefone4_whatsapp>
  <tipo_cadastro>2</tipo_cadastro>
  <tipo_empresa>7</tipo_empresa>
  <ultimo_acesso_app>sample string 43</ultimo_acesso_app>
  <usando_app>true</usando_app>
  <valor_taxa_instalacao>54</valor_taxa_instalacao>
</CadastroDados>