Pular para o conteúdo principal

ClienteResponse

Cliente, como a API o devolve.

codigointeger<int32>

Código do cliente.

filialinteger<int32>

Código da filial dona do cadastro. É sempre a filial da credencial.

razaoSocialstring

Razão social, ou o nome no caso de pessoa física.

nomeFantasianull | stringanulável

Nome fantasia.

cpfCnpjnull | stringanulável

CPF ou CNPJ, só os dígitos.

inscricaoEstadualnull | stringanulável

Inscrição estadual.

inscricaoMunicipalnull | stringanulável

Inscrição municipal.

dataAbertura(null | string)<date-time>anulável

Data de abertura, no caso de pessoa jurídica.

dataNascimento(null | string)<date-time>anulável

Data de nascimento, no caso de pessoa física.

naturezaNatureza

1 = pessoa física, 2 = pessoa jurídica.

Valores possíveis: [1, 2]

naturezaDescricaonull | stringanulável

Texto correspondente a natureza.

rgnull | stringanulável

RG.

orgaoExpeditornull | stringanulável

Órgão expeditor do RG.

ufRgnull | stringanulável

Sigla da UF do RG.

naturalidadenull | stringanulável

Naturalidade.

painull | stringanulável

Nome do pai.

maenull | stringanulável

Nome da mãe.

sexonull | integeranulável

1 = masculino, 2 = feminino, 3 = outros. Valores: 1 = MASCULINO; 2 = FEMININO; 3 = OUTROS.

Valores possíveis: [1, 2, 3]

sexoDescricaonull | stringanulável

Texto correspondente a sexo.

estadoCivilnull | integeranulável

1 = solteiro, 2 = casado, 3 = divorciado, 4 = viúvo, 5 = outros. Valores: 1 = SOLTEIRO(A); 2 = CASADO(A); 3 = DIVORCIADO(A); 4 = VIÚVO(A); 5 = OUTROS.

Valores possíveis: [1, 2, 3, 4, 5]

estadoCivilDescricaonull | stringanulável

Texto correspondente a estadoCivil.

tipoDestinatario(null | integer)<int32>anulável

Código do tipo de destinatário fiscal.

tipoDestinatarioDescricaonull | stringanulável

Descrição do tipo de destinatário fiscal, como cadastrada no ERP.

ativoboolean

Se o cliente está ativo no cadastro do ERP.

enderecos object[]

Endereços do cliente. Vazia quando não há nenhum.

  • Array [
  • tipoEnderecoTipoEndereco

    0 = principal, 1 = cobrança, 2 = retirada, 3 = entrega.

    Valores possíveis: [0, 1, 2, 3]

    tipoEnderecoDescricaonull | stringanulável

    Texto correspondente a tipoEndereco.

    cepnull | stringanulável

    CEP, só os dígitos.

    logradourostring

    Logradouro.

    numeronull | stringanulável

    Número.

    bairrostring

    Bairro.

    codigoIbgeCidadenull | stringanulável

    Código IBGE do município.

    cidadenull | stringanulável

    Nome da cidade.

    ufnull | stringanulável

    Sigla da UF.

    caixaPostalnull | stringanulável

    Caixa postal.

    complementonull | stringanulável

    Complemento.

    referencianull | stringanulável

    Ponto de referência.

    ativoboolean

    Se o endereço está ativo no cadastro do ERP.

  • ]
  • emails object[]

    E-mails do cliente. Vazia quando não há nenhum.

  • Array [
  • enderecostring

    O endereço de e-mail.

    tipoTipoEmail

    Soma das finalidades marcadas para este e-mail. É um campo de bits — use tipoDescricao se não for decompor o número.

    tipoDescricaostring[]anulável

    As finalidades marcadas, uma a uma.

    ativoboolean

    Se o e-mail está ativo no cadastro do ERP.

  • ]
  • telefones object[]

    Telefones do cliente. Vazia quando não há nenhum.

  • Array [
  • tipoTipoTelefone

    1 = fixo, 2 = celular, 3 = outros.

    Valores possíveis: [1, 2, 3]

    tipoDescricaonull | stringanulável

    Texto correspondente a tipo.

    tipoCadastronull | integeranulável

    De quem é o telefone: 1 = cliente, 2 = cônjuge, 3 = dependente. Valores: 1 = CLIENTE; 2 = CÔNJUGE; 3 = DEPENDENTE.

    Valores possíveis: [1, 2, 3]

    tipoCadastroDescricaonull | stringanulável

    Texto correspondente a tipoCadastro.

    numerostring

    O número, como gravado no ERP.

    ativoboolean

    Se o telefone está ativo no cadastro do ERP.

  • ]
  • observacoes object[]

    Observações do cliente. Vazia quando não há nenhuma.

  • Array [
  • textostring

    O texto da observação.

    exibirboolean

    Se o ERP exibe a observação ao operador no atendimento.

    fixarboolean

    Se a observação fica fixada no topo.

    ativoboolean

    Se a observação está ativa no cadastro do ERP.

  • ]
  • ClienteResponse
    {
    "codigo": 0,
    "filial": 0,
    "razaoSocial": "string",
    "nomeFantasia": "null",
    "cpfCnpj": "null",
    "inscricaoEstadual": "null",
    "inscricaoMunicipal": "null",
    "dataAbertura": "null",
    "dataNascimento": "null",
    "natureza": 1,
    "naturezaDescricao": "null",
    "rg": "null",
    "orgaoExpeditor": "null",
    "ufRg": "null",
    "naturalidade": "null",
    "pai": "null",
    "mae": "null",
    "sexo": 1,
    "sexoDescricao": "null",
    "estadoCivil": 1,
    "estadoCivilDescricao": "null",
    "tipoDestinatario": "null",
    "tipoDestinatarioDescricao": "null",
    "ativo": true,
    "enderecos": [
    {
    "tipoEndereco": 0,
    "tipoEnderecoDescricao": "null",
    "cep": "null",
    "logradouro": "string",
    "numero": "null",
    "bairro": "string",
    "codigoIbgeCidade": "null",
    "cidade": "null",
    "uf": "null",
    "caixaPostal": "null",
    "complemento": "null",
    "referencia": "null",
    "ativo": true
    }
    ],
    "emails": [
    {
    "endereco": "string",
    "tipo": 0,
    "tipoDescricao": "null",
    "ativo": true
    }
    ],
    "telefones": [
    {
    "tipo": 1,
    "tipoDescricao": "null",
    "tipoCadastro": 1,
    "tipoCadastroDescricao": "null",
    "numero": "string",
    "ativo": true
    }
    ],
    "observacoes": [
    {
    "texto": "string",
    "exibir": true,
    "fixar": true,
    "ativo": true
    }
    ]
    }