Valorizza API Docs

Permite retornar os registros do cadastro de pessoas incluídos e/ou alterados no período especificado.

Detalhamento dos campos do serviço - dados de entrada:

Campo	Tipo	Descrição
`token`	Varchar	Código/Token fornecido pela Valorizza para a integração
`dataInicio`	Data	Data inicial para retornar os elementos cadastrados no período informado
`dataFim`	Data	Data final para retornar os elementos cadastrados no período informado
`quantidade`	Numérico	Quantidade de elementos por página, quando não informado, não irá existir paginação
`pagina`	Numérico	Página a ser visualizada quando for utilizado a paginação

Detalhamento dos campos do serviço - dados de saída:

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
`identificadorPessoa`	Numérico	Identificador da pessoa
`tipoPessoa`	Varchar	Tipo da pessoa
`classificacao`	Varchar	Classificação
`razaoSocial`	Varchar	Razão social
`nomeFantasia`	Varchar	Nome fantasia
`clientePrincipal`	Varchar	Cliente principal
`unidade`	Varchar	Unidade
`codigoIntegracao`	Varchar	Código de integração
`tipoCadastro`	Varchar	Tipo de cadastro Física Jurídica
`tipoServico`	Varchar	Tipo de serviço
`cnpj`	Varchar	CNPJ
`cpf`	Varchar	CPF
`rg`	Varchar	RG
`dataNascimento`	Data	Data de nascimento
`profissao`	Varchar	Profissão
`nacionalidade`	Varchar	Nacionalidade
`estadoCivil`	Varchar	Estado civil Solteiro(a) Casado(a) Viúvo(a) Separado(a) Divorciado(a) União estável Outros Não desejo informar
`suframa`	Varchar	SUFRAMA
`cnae`	Varchar	CNAE
`inscricaoEstadual`	Varchar	Inscrição estadual
`optanteSimplesNacional`	Varchar	Optante por simples nacional Sim Não
`site`	Varchar	Site
`regional`	Varchar	Regional
`validade`	Data	Data de validade
`percentualFreteCif`	Numérico	Percentral de frete CIF
`valorMinimo`	Varchar	Valor mínimo
`inclusao`	DataHora	Data de inclusão
`usuario`	Varchar	Usuário do cadastro
`atualizacao`	DataHora	Data de atualização
`telefoneTipo`	Varchar	Tipo de telefone Comercial Celular Outro Fax Residencial
`telefone`	Varchar	Telefone
`telefoneObservacao`	Varchar	Observação do telefone
`enderecoTipo`	Varchar	Tipo de endereço Comercial Residencial Outro Cobrança Balcão Entrega
`enderecoCep`	Varchar	CEP
`endereco`	Varchar	Endereço
`enderecoComplemento`	Varchar	Complemento
`enderecoBairro`	Varchar	Bairro
`enderecoUf`	Varchar	Estado
`enderecoUfSigla`	Varchar	Sigla do estado
`enderecoCidade`	Varchar	Cidade
`enderecoPais`	Varchar	País
`enderecoReferenciaIntegracao`	Varchar	Referência de Integração
`enderecoObservacao`	Varchar	Observação do endereço
`emailTipo`	Varchar	Tipo de e-mail Trabalho Particular Nota eletrônica Outro
`email`	Varchar	E-mail
`contato`	Varchar	Nome do contato
`responsavelCobranca`	Varchar	Contato é responsável pela cobrança Sim Não
`representanteLegal`	Varchar	Contato é representante legal Sim Não
`testemunha`	Varchar	Contato é testemunha Sim Não
`area`	Varchar	Área do contato
`cargo`	Varchar	Cargo do contato
`registroProfissional`	Varchar	Registro profissional do contato
`recebeEmailConsultoria`	Varchar	Contato recebe e-mail da consultoria Sim Não
`areaConsultoria`	Varchar	Área da consultoria do contato
`tipoAssinaturaDigital`	Varchar	Tipo de assinatura digital do contato Assinatura digital Assinatura eletrônica
`ordemAssinaturaDigital`	Numérico	Ordem de assinatura digital do contato
`assinaturaDigitalSuspensaDe`	Data	Data de início da suspensão da assinatura digital do contato
`assinaturaDigitalSuspensaAte`	Data	Data de fim da suspensão da assinatura digital do contato
`loginSite`	Varchar	Login no site do contato
`menu`	Varchar	Menu utilizado pelo contato
`obrigarTrocaSenhaPrimeiroAcesso`	Varchar	Obriga a trocar senha no primeiro acesso do contato Sim Não
`acessaSomenteSuasInformacoes`	Varchar	Contato acessa somente as suas informações Sim Não
`cadastraSomenteViaAtendimento`	Varchar	Contato cadastra somente via atendimento Sim Não
`cadastraSomenteViaOportunidade`	Varchar	Contato cadastra somente via oportunidade Sim Não
`cadastraValorEspecial`	Varchar	Contato cadastra valor especial Sim Não
`contatoPadrao`	Varchar	Contato padrão Sim Não
`permiteEnviarPedidoFabrica`	Varchar	Permite contato enviar pedido para fábrica Sim Não
`margem`	Varchar	Margem do contato
`descontoAte`	Numérico	Desconte até do contato
`comentario`	Varchar	Comentário do contato
`segmento`	Varchar	Segmento
`grupo`	Varchar	Grupo
`descricaoSite`	Varchar	Descrição do site
`observacao`	Varchar	Observação
`produtos`	Varchar	Produtos
`dataFundacao`	Data	Data de fundação
`funcionarios`	Numérico	Número de funcionário
`numeroFiliais`	Varchar	Número de filiais
`turnoAdministrativo`	Varchar	Turno administrativo
`primeiroTurno`	Varchar	Primeiro turno
`segundoTurno`	Varchar	Segundo turno
`terceiroTurno`	Varchar	Terceiro turno
`quartoTurno`	Varchar	Quarto turno
`turnoEstagio`	Varchar	Turno estágio
`turnoEspecial`	Varchar	Turno especial
`outrosTurnos`	Varchar	Outros turnos
`distancia`	Numérico	Distância
`processoContratacao`	Varchar	Processo de contratação Sim Não
`diaVencimento`	Numérico	Dia de vencimento
`diaPagamento`	Numérico	Dia de pagamento
`instrucaoCobranca`	Varchar	Instrução de cobrança
`formaPagamento`	Varchar	Forma de pagamento
`banco`	Varchar	Banco
`agencia`	Varchar	Agência
`conta`	Varchar	Conta
`realizaPagamentoBoleto`	Varchar	Realiza pagamento do boleto Sim Não
`encargosFiscais`	Varchar	Encargos fiscais
`linkedInCompanyId`	Varchar	Company id do linkedin
`linkedInIndustryCode`	Varchar	Industry code do linkedin

curl --location --request POST '/apiconsultadadosvalorizza/RetornaDadosPessoas' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Token", "dataInicio": "2012-01-20", "dataFim": "2012-06-20", "quantidade": 0, "pagina": 0 }'

{ "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": "" } ] } ] } ] }, "MsgRetorno": "" }

RetornaDadosPessoas

Request

Responses