RetornaDadosPessoas
POST
/apiconsultadadosvalorizza/RetornaDadosPessoas
| Campo | Tipo | Descrição |
|---|---|---|
token | Varchar | Código/Token fornecido pela Valorizza para a integração |
dataInicio | Date | Data inicial para retornar os elementos cadastrados no período informado |
dataFim | Date | Data final para retornar os elementos cadastrados no período informado |
quantidade | Numeric | Quantidade de elementos por página, quando não informado, não irá existir paginação |
pagina | Numeric | Página a ser visualizada quando for utilizado a paginação |
identificador | Numeric | Identificador de uma pessoa específica |
| Campo | Tipo | Descrição |
|---|---|---|
| Permite retornar os registros do cadastro de pessoas incluídos e/ou alterados no período especificado. |
| Campo | Tipo | Descrição |
|---|---|---|
token | Varchar | Código/Token fornecido pela Valorizza para a integração |
dataInicio | Date | Data inicial para retornar os elementos cadastrados no período informado |
dataFim | Date | Data final para retornar os elementos cadastrados no período informado |
quantidade | Numeric | Quantidade de elementos por página, quando não informado, não irá existir paginação |
pagina | Numeric | Página a ser visualizada quando for utilizado a paginação |
identificador | Numeric | Identificador de uma pessoa específica |
| Campo | Tipo | Descrição |
|---|---|---|
totalElementos | Varchar | Total de elementos encontrados |
totalPaginas | Varchar | Total de páginas de acordo com a quantidade informada nos dados de entrada |
paginaAtual | Varchar | Página que está sendo visualizada, visível quando quantidade for informada nos dados de entrada |
elementos[].identificadorPessoa | Numérico | Identificador da pessoa |
elementos[].tipoPessoa | Varchar | Tipo da pessoa |
elementos[].classificacao | Varchar | Classificação |
elementos[].razaoSocial | Varchar | Razão social |
elementos[].nomeFantasia | Varchar | Nome fantasia |
elementos[].clientePrincipal | Varchar | Cliente principal |
elementos[].unidade | Varchar | Unidade |
elementos[].codigoIntegracao | Varchar | Código de integração |
elementos[].tipoCadastro | Varchar | Tipo de cadastro |
elementos[].tipoServico | Varchar | Tipo de serviço |
elementos[].cnpj | Varchar | CNPJ |
elementos[].cpf | Varchar | CPF |
elementos[].rg | Varchar | RG |
elementos[].dataNascimento | Data | Data de nascimento |
elementos[].profissao | Varchar | Profissão |
elementos[].nacionalidade | Varchar | Nacionalidade |
elementos[].estadoCivil | Varchar | Estado civil |
elementos[].suframa | Varchar | SUFRAMA |
elementos[].cnae | Varchar | CNAE |
elementos[].inscricaoEstadual | Varchar | Inscrição estadual |
elementos[].optanteSimplesNacional | Varchar | Optante por simples nacional |
elementos[].site | Varchar | Site |
elementos[].validade | Data | Data de validade |
elementos[].percentualFreteCif | Numérico | Percentual de frete CIF |
elementos[].valorMinimo | Numérico | Valor mínimo |
elementos[].inclusao | DataHora | Data de inclusão |
elementos[].usuario | Varchar | Usuário do cadastro |
elementos[].atualizacao | DataHora | Data de atualização |
elementos[].dadosAdicionais.segmento | Varchar | Segmento |
elementos[].dadosAdicionais.grupo | Varchar | Grupo |
elementos[].dadosAdicionais.descricaoSite | Varchar | Descrição do site |
elementos[].dadosAdicionais.observacao | Varchar | Observação |
elementos[].dadosAdicionais.produtos | Varchar | Produtos |
elementos[].dadosAdicionais.dataFundacao | Data | Data de fundação |
elementos[].dadosAdicionais.funcionarios | Numérico | Número de funcionários |
elementos[].dadosAdicionais.numeroFiliais | Varchar | Número de filiais |
elementos[].dadosAdicionais.turnoAdministrativo | Varchar | Turno administrativo |
elementos[].dadosAdicionais.primeiroTurno | Varchar | Primeiro turno |
elementos[].dadosAdicionais.segundoTurno | Varchar | Segundo turno |
elementos[].dadosAdicionais.terceiroTurno | Varchar | Terceiro turno |
elementos[].dadosAdicionais.quartoTurno | Varchar | Quarto turno |
elementos[].dadosAdicionais.turnoEstagio | Varchar | Turno estágio |
elementos[].dadosAdicionais.turnoEspecial | Varchar | Turno especial |
elementos[].dadosAdicionais.outrosTurnos | Varchar | Outros turnos |
elementos[].dadosAdicionais.distancia | Numérico | Distância |
elementos[].dadosAdicionais.processoContratacao | Varchar | Processo de contratação |
elementos[].dadosAdicionais.diaVencimento | Numérico | Dia de vencimento |
elementos[].dadosAdicionais.diaPagamento | Numérico | Dia de pagamento |
elementos[].dadosAdicionais.instrucaoCobranca | Varchar | Instrução de cobrança |
elementos[].dadosAdicionais.formaPagamento | Varchar | Forma de pagamento |
elementos[].dadosAdicionais.banco | Varchar | Banco |
elementos[].dadosAdicionais.agencia | Varchar | Agência |
elementos[].dadosAdicionais.conta | Varchar | Conta |
elementos[].dadosAdicionais.realizaPagamentoBoleto | Varchar | Realiza pagamento do boleto |
elementos[].dadosAdicionais.encargosFiscais | Varchar | Encargos fiscais |
elementos[].dadosAdicionais.linkedInCompanyId | Varchar | Company ID do LinkedIn |
elementos[].dadosAdicionais.linkedInIndustryCode | Varchar | Industry code do LinkedIn |
elementos[].telefones[].telefoneTipo | Varchar | Tipo de telefone |
elementos[].telefones[].telefone | Varchar | Telefone |
elementos[].telefones[].telefoneObservacao | Varchar | Observação do telefone |
elementos[].enderecos[].enderecoTipo | Varchar | Tipo de endereço |
elementos[].enderecos[].enderecoCep | Varchar | CEP |
elementos[].enderecos[].endereco | Varchar | Endereço |
elementos[].enderecos[].enderecoComplemento | Varchar | Complemento |
elementos[].enderecos[].enderecoBairro | Varchar | Bairro |
elementos[].enderecos[].enderecoUf | Varchar | Estado |
elementos[].enderecos[].enderecoUfSigla | Varchar | Sigla do estado |
elementos[].enderecos[].enderecoCidade | Varchar | Cidade |
elementos[].enderecos[].enderecoPais | Varchar | País |
elementos[].enderecos[].enderecoReferenciaIntegracao | Varchar | Referência de integração |
elementos[].enderecos[].enderecoObservacao | Varchar | Observação do endereço |
elementos[].emails[].emailTipo | Varchar | Tipo de e-mail |
elementos[].emails[].email | Varchar | |
elementos[].contatos[].contato | Varchar | Nome do contato |
elementos[].contatos[].responsavelCobranca | Varchar | Contato é responsável pela cobrança |
elementos[].contatos[].representanteLegal | Varchar | Contato é representante legal |
elementos[].contatos[].testemunha | Varchar | Contato é testemunha |
elementos[].contatos[].area | Varchar | Área do contato |
elementos[].contatos[].cargo | Varchar | Cargo do contato |
elementos[].contatos[].orgaoClasse | Varchar | Órgão de classe |
elementos[].contatos[].cpf | Varchar | CPF do contato |
elementos[].contatos[].rg | Varchar | RG do contato |
elementos[].contatos[].dataNascimento | Data | Data de nascimento do contato |
elementos[].contatos[].estadoCivil | Varchar | Estado civil do contato |
elementos[].contatos[].recebeEmailConsultoria | Varchar | Contato recebe e-mail da consultoria |
elementos[].contatos[].areaConsultoria | Varchar | Área da consultoria do contato |
elementos[].contatos[].tipoAssinaturaDigital | Varchar | Tipo de assinatura digital |
elementos[].contatos[].ordemAssinaturaDigital | Numérico | Ordem de assinatura digital |
elementos[].contatos[].assinaturaDigitalSuspensaDe | Data | Data de início da suspensão da assinatura digital |
elementos[].contatos[].assinaturaDigitalSuspensaAte | Data | Data de fim da suspensão da assinatura digital |
elementos[].contatos[].loginSite | Varchar | Login no site |
elementos[].contatos[].menu | Varchar | Menu utilizado |
elementos[].contatos[].obrigarTrocaSenhaPrimeiroAcesso | Varchar | Obriga troca de senha no primeiro acesso |
elementos[].contatos[].acessaSomenteSuasInformacoes | Varchar | Acessa somente suas informações |
elementos[].contatos[].cadastraSomenteViaAtendimento | Varchar | Cadastra somente via atendimento |
elementos[].contatos[].cadastraSomenteViaOportunidade | Varchar | Cadastra somente via oportunidade |
elementos[].contatos[].cadastraValorEspecial | Varchar | Cadastra valor especial |
elementos[].contatos[].contatoPadrao | Varchar | Contato padrão |
elementos[].contatos[].permiteEnviarPedidoFabrica | Varchar | Permite enviar pedido para fábrica |
elementos[].contatos[].margem | Numérico | Margem |
elementos[].contatos[].descontoAte | Numérico | Desconto até |
elementos[].contatos[].comentario | Varchar | Comentário |
elementos[].contatos[].validade | Data | Data de validade |
elementos[].contatos[].inclusao | DataHora | Data de inclusão |
elementos[].contatos[].usuario | Varchar | Usuário do cadastro |
elementos[].contatos[].telefones[].telefoneTipo | Varchar | Tipo de telefone |
elementos[].contatos[].telefones[].telefone | Varchar | Telefone |
elementos[].contatos[].telefones[].telefoneObservacao | Varchar | Observação do telefone |
elementos[].contatos[].enderecos[].enderecoTipo | Varchar | Tipo de endereço |
elementos[].contatos[].enderecos[].enderecoCep | Varchar | CEP |
elementos[].contatos[].enderecos[].endereco | Varchar | Endereço |
elementos[].contatos[].enderecos[].enderecoComplemento | Varchar | Complemento |
elementos[].contatos[].enderecos[].enderecoBairro | Varchar | Bairro |
elementos[].contatos[].enderecos[].enderecoUf | Varchar | Estado |
elementos[].contatos[].enderecos[].enderecoUfSigla | Varchar | Sigla do estado |
elementos[].contatos[].enderecos[].enderecoCidade | Varchar | Cidade |
elementos[].contatos[].enderecos[].enderecoPais | Varchar | País |
elementos[].contatos[].enderecos[].enderecoReferenciaIntegracao | Varchar | Referência de integração |
elementos[].contatos[].enderecos[].enderecoObservacao | Varchar | Observação do endereço |
elementos[].contatos[].emails[].emailTipo | Varchar | Tipo de e-mail |
elementos[].contatos[].emails[].email | Varchar | |
elementos[].representantes[].representante | Varchar | Nome do representante |
elementos[].representantes[].principal | Boolean | Representante principal |
elementos[].historicosAtendimento[].data | DataHora | Data do histórico |
elementos[].historicosAtendimento[].responsavel.identificador | Numérico | Identificador do responsável |
elementos[].historicosAtendimento[].responsavel.nome | Varchar | Nome do responsável |
elementos[].historicosAtendimento[].historico | Varchar | Histórico do atendimento |
MsgRetorno | Varchar | Mensagem de retorno |
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/apiconsultadadosvalorizza/RetornaDadosPessoas' \
--header 'Content-Type: application/json' \
--data '{
"token": "",
"dataInicio": "",
"dataFim": "",
"quantidade": 0,
"pagina": 0,
"identificador": 0
}'Response Response Example
{
"pessoas": {
"totalElementos": "",
"totalPaginas": "",
"paginaAtual": "",
"elementos": [
{
"identificadorPessoa": "",
"tipoPessoa": "",
"classificacao": "",
"razaoSocial": "",
"nomeFantasia": "",
"clientePrincipal": "",
"unidade": "",
"codigoIntegracao": "",
"tipoCadastro": "",
"tipoServico": "",
"cnpj": "",
"cpf": "",
"rg": "",
"dataNascimento": "",
"profissao": "",
"nacionalidade": "",
"estadoCivil": "",
"suframa": "",
"cnae": "",
"inscricaoEstadual": "",
"optanteSimplesNacional": "",
"site": "",
"validade": "",
"percentualFreteCif": 0,
"valorMinimo": 0,
"inclusao": "",
"usuario": "",
"atualizacao": "",
"dadosAdicionais": {
"segmento": "",
"grupo": "",
"descricaoSite": "",
"observacao": "",
"produtos": "",
"dataFundacao": "0000-00-00",
"funcionarios": 0,
"numeroFiliais": "",
"turnoAdministrativo": "",
"primeiroTurno": "",
"segundoTurno": "",
"terceiroTurno": "",
"quartoTurno": "",
"turnoEstagio": "",
"turnoEspecial": "",
"outrosTurnos": "",
"distancia": 0,
"processoContratacao": "",
"diaVencimento": 0,
"diaPagamento": 0,
"instrucaoCobranca": "",
"formaPagamento": "",
"banco": "",
"agencia": "",
"conta": "",
"realizaPagamentoBoleto": "",
"encargosFiscais": "0.00",
"linkedInCompanyId": "",
"linkedInIndustryCode": ""
},
"telefones": [
{
"telefoneTipo": "",
"telefone": "",
"telefoneObservacao": ""
}
],
"enderecos": [
{
"enderecoTipo": "",
"enderecoCep": "",
"endereco": "",
"enderecoComplemento": "",
"enderecoBairro": "",
"enderecoUf": "",
"enderecoUfSigla": "",
"enderecoCidade": "",
"enderecoPais": "",
"enderecoReferenciaIntegracao": "",
"enderecoObservacao": ""
}
],
"emails": [
{
"emailTipo": "",
"email": ""
}
],
"contatos": [
{
"contato": "",
"responsavelCobranca": "",
"representanteLegal": "",
"testemunha": "",
"area": "",
"cargo": "",
"orgaoClasse": "",
"cpf": "",
"rg": "",
"dataNascimento": "",
"estadoCivil": "",
"recebeEmailConsultoria": "",
"areaConsultoria": "",
"tipoAssinaturaDigital": "",
"ordemAssinaturaDigital": 0,
"assinaturaDigitalSuspensaDe": "",
"assinaturaDigitalSuspensaAte": "",
"loginSite": "",
"menu": "",
"obrigarTrocaSenhaPrimeiroAcesso": "",
"acessaSomenteSuasInformacoes": "",
"cadastraSomenteViaAtendimento": "",
"cadastraSomenteViaOportunidade": "",
"cadastraValorEspecial": "",
"contatoPadrao": "",
"permiteEnviarPedidoFabrica": "",
"margem": 0,
"descontoAte": 0,
"comentario": "",
"validade": "",
"inclusao": "",
"usuario": "",
"telefones": [
{
"telefoneTipo": "",
"telefone": "",
"telefoneObservacao": ""
}
],
"enderecos": [
{
"enderecoTipo": "",
"enderecoCep": "",
"endereco": "",
"enderecoComplemento": "",
"enderecoBairro": "",
"enderecoUf": "",
"enderecoUfSigla": "",
"enderecoCidade": "",
"enderecoPais": "",
"enderecoReferenciaIntegracao": "",
"enderecoObservacao": ""
}
],
"emails": [
{
"emailTipo": "",
"email": ""
}
]
}
],
"representantes": [
{
"representante": "",
"principal": true
}
],
"historicosAtendimento": [
{
"data": "",
"responsavel": {
"identificador": 0,
"nome": ""
},
"historico": ""
}
]
}
]
},
"MsgRetorno": ""
}Modified at 2026-05-07 17:16:17