GET Terceiros - Varejonline/api GitHub Wiki
Descrição
Terceiros são quaisquer pessoas físicas ou jurídicas cadastradas no sistema. Estão neste grupo os clientes, funcionários, fornecedores e todas pessoas com as quais a empresa tem relação.
URLs
GET https://integrador.varejonline.com.br/apps/api/terceiros
GET https://integrador.varejonline.com.br/apps/api/terceiros/:id
Parâmetros
- inicio: Entenda a Coleta Paginada
- quantidade: Entenda a Coleta Paginada
- status: filtra pelo status do terceiro (enum: ATIVO, INATIVO, EXCLUIDO), separados por vírgula
- classes: lista de classes de terceiro desejadas, separadas por vírgula.
- desde: filta por registros criados/alterados desde uma data específica (String no formato dd/mm/yyyy ou dd/mm/yyyy hh:mm:ss)
- ate: filta por registros criados/alterados até uma data específica (string no formato dd/mm/yyyy ou dd/mm/yyyy hh:mm:ss)
- filtroData: pode ser informado para ser combinado com o filtro desde-ate. Aceita-se "dataAlteracao" ou "dataCriacao" (padrão: dataAlteracao)
- alteradoApos: Entenda a Coleta de Alterações
- documento: Veja este Filtro
- nome: filtra pelo nome do terceiro (string)
- orderBy: Tipo da ordenação de resultados desejada (string)
- id ordenação crescente pelo id dos registros (Valor padrão caso não informado)
- dataAlteracao ordenação crescente pela data de alteração dos registros
- dataCriacao ordenação crescente pela data de criação dos registros
- documentoTerceiro ordenação crescente pelo documento CPF ou CNPJ do terceiro
- nome ordenação crescente pelo nome do terceiro
- integrados: Filtro de controle de integração de registros (boolean)
- 1 retorna apenas registros já marcados como coletados pelo integrador
- 0 retorna apenas registros não marcados como coletados pelo integrador
- integrador: Nome utilizado pelo integrador para registrar o registro como integrado (String)
- carregarCamposCustomizados: indica se os campos customizados devem ser exibidos no retorno (boolean)
Retorno
- id: id do terceiro (long)
- ativo: indica se o terceiro está ativo ou não (boolean)
- excluido: indica se o terceiro foi excluído (boolean)
- dataAlteracao: última data de alteração do terceiro (string) (dd-mm-aaaa hh:mi:ss)
- nome: nome do terceiro Pessoa Física ou Razão Social da Pessoa Jurídica (string) (max 255 char)
- nomeFantasia: nome fantasia do terceiro. Retornado apenas para terceiros Pessoa Jurídica (string) (max 255 char)
- padraoNome: indica qual é o campo de nome usando na apresentação do cliente em tela. Opções: "NOME_FANTASIA" ou "RAZAO_SOCIAL" (string)
- documento: cpf ou cnpj do terceiro formatado (string) (max 255 char)
- entidadeCadastro: Entidade na qual o terceiro foi cadastrado (long)
- emails: emails do terceiro (List string) (max 255 char)
- rg: número do RG do terceiro. Retornado apenas para terceiros Pessoa Física, se existir (string) (max 50 char)
- tipoPessoa: Define se a Pessoa é Física (PF), Jurídica (PJ), Física Estrangeiro (PF_ESTRANGEIRO) ou Jurídica Estrangeiro (PJ_ESTRANGEIRO)
- dataNascimento: data de nascimento do terceiro. Retornado apenas para terceiros Pessoa Fisica, no formato dd-mm-aaaa hh:mi:ss.
- ie: número da Inscrição Estadual do terceiro. Retornado apenas para terceiros Pessoa Jurídica, se existir (string) (max 255 char)
- inscricaoMunicipal: número da inscrição municipal do terceiro. Retornado apenas para terceiros Pessoa Jurídica, se existir (string) (max 255 char)
- modalidadeTributacao: indica qual é a modalidade de tributação do terceiro, aplicado apenas para Pessoa Jurídica, se existir (string)
- enderecos: lista de endereços do terceiro, contendo:
- tipo: tipo do logradouro (string). Exemplos: RUA, AVENIDA, RODOVIA. Veja a lista completa
- logradouro: logradouro do endereço (string) (max 255 char)
- numero: número do endereço (string) (max 400 char)
- complemento: complemento do endereço (string) (max 255 char)
- bairro: bairro do endereço (string) (max 255 char)
- cep: CEP do endereço (string)
- cidade: cidade do endereço (string) (max 255 char)
- siglaEstado: UF do endereço (string)
- pais: País do Endereço (string).
- tipoEndereco: Tipo do Endereço (string)
- codigoIBGECidade: Código da cidade conforme tabela IBGE (Long).
- telefones: lista de telefones do terceiro, contendo:
- ddd: Código do DDD (integer) (max 10 char)
- ddi: Código do DDI (integer) (max 10 char)
- numero: Número do telefone (string) (max 255 char)
- ramal: Número do ramal (string) (max 10 char)
- tipoTelefone: Opções: CELULAR, RESIDENCIAL, COMERCIAL, RECADO (string)
- classes: lista de classes às quais o terceiro pertence.
- categoria: Define a categorização do terceiro no Varejonline (string)
- autorizaReceberEmail: Opt-in do terceiro autorizando ou não a comunicação por email (boolean)
- autorizaReceberSms: Opt-in do terceiro autorizando ou não a comunicação por sms (boolean)
- autorizaReceberWhatsapp: Opt-in do terceiro autorizando ou não a comunicação por whatsapp (boolean)
- limiteCredito: Define os valores de limite de crédito para o terceiro (objeto complexo).
- valorTotal: limite de crédito total (long)
- valorMensal: limite de crédito mensal (long)
- valorRenda: valor da renda do terceiro (long)
- camposCustomizados: Define os valores da estrutura de campos customizados da base.
- id: id do terceiro associado aos valores informados (long)
- valoresPrimitivo: valores dos campos customizados primitivos
- id: id do campo customizado (long)
- value: valor do campo customizado (object - varia conforme tipagem do campo)
- type: tipo do campo customizado (string)
- valoresComposicao: valores dos campos customizados do tipo COMPOSICAO
- id: id do campo customizado (long)
- valores: lista de valores primitivos
- id: id do campo customizado (long)
- value: valor do campo customizado (object - varia conforme tipagem do campo) (max para string 255 BYTE)
- type: tipo do campo customizado (string)
- valoresLista: valores dos campos customizados do tipo LISTA
- campoId: id do campo customizado retornado pela lista (long)
- valoresPrimitivo: lista de valores primitivos
- id: id do campo customizado (long)
- value: valor do campo customizado (object - varia conforme tipagem do campo) (max para string 255 BYTE)
- type: tipo do campo customizado (string)
- valoresComposicao: valores dos campos customizados do tipo COMPOSICAO
- id: id do campo customizado (long)
- valores: lista de valores primitivos
- id: id do campo customizado (long)
- value: valor do campo customizado (object - varia conforme tipagem do campo) (max para string 255 BYTE)
- type: tipo do campo customizado (string)
- marcas: lista de marcas do terceiro, contendo:
- autorizaReceberSms: limite de crédito total (boolean)
- autorizaReceberEmail: limite de crédito total (boolean)
- autorizaReceberWhatsapp: limite de crédito total (boolean)
- marca: informações da marca
- id: id da marca (long)
- nome: nome da marca (string) (max 255 char)
- dependentes: lista de dependentes do terceiro, contendo:
- observacao: (string) (max 255 byte)
- nome: (string) (max 100 byte)
- documento: documento formatado (string)
- parentesco: (string) (max 100 byte)
- dataNascimento: (string) (dd-mm-aaaa hh:mm:ss)
Exemplo
GET https://integrador.varejonline.com.br/apps/api/terceiros?classes=PRESTADOR_SERVICO,CLIENTE
[
{
"id":1,
"ativo":true,
"excluido":false,
"dataAlteracao":"21-01-2013 15:28:05",
"nome":"Empresa Exemplo",
"nomeFantasia":"Nome Fantasia da Empresa"
"documento":"12.123.123/0001-12",
"tipoPessoa":"PJ",
"padraoNome": "RAZAO_SOCIAL",
"entidadeCadastro":1,
"emails":[
"[email protected]",
"[email protected]"
],
"ie":"493.656.191.721",
"enderecos":[
{
"tipo":"AVENIDA",
"logradouro":"Lineu de Moura",
"numero":"900",
"complemento":"Sala 45",
"bairro":"Chácara Condomínio Eucaliptos",
"cep":"32600134",
"cidade":"São José dos Campos",
"siglaEstado":"SP",
"pais":"Brasil",
"tipoEndereco":"ENDERECO_CORRESPONDENCIA",
"codigoIBGECidade":"3554102"
}
],
"telefones":[
{
"ddd":12,
"ddi":55,
"numero":"99998888",
"ramal":"1002",
"tipoTelefone":"CELULAR"
}
],
"classes":[
"PRESTADOR_SERVICO"
],
"categoria":"PADRÃO",
"marcas": [
{
"autorizaReceberSms": false,
"autorizaReceberEmail": false,
"autorizaReceberWhatsapp": true,
"marca": {
"id": 283,
"nome": "TESTE"
}
},
{
"autorizaReceberSms": true,
"autorizaReceberEmail": false,
"autorizaReceberWhatsapp": false,
"marca": {
"id": 0,
"nome": "SEM MARCA"
}
}
],
"dependentes": [
{
"observacao": "obs",
"nome": "dependente 1 ",
"documento": "402.325.670-69",
"parentesco": "parentesco",
"dataNascimento": "04-09-1999 00:00:00"
},
{
"observacao": "obs",
"nome": "dependente 2",
"documento": "523.792.490-59",
"parentesco": "parentesco",
"dataNascimento": "01-07-2000 00:00:00"
}
]
},
{
"id":2,
"ativo":true,
"excluido":false,
"nome":"Cliente Exemplo",
"documento":"123.123.123-12",
"tipoPessoa":"PF",
"padraoNome": "NOME_FANTASIA",
"entidadeCadastro":1,
"emails":[
"[email protected]",
"[email protected]"
],
"rg":"91.122.534-1",
"dataNascimento":"12-08-1980 00:00:00",
"enderecos":[
{
"tipo":"AVENIDA",
"logradouro":"São João",
"numero":"2045",
"complemento":"Apto 203",
"bairro":"Jardim Colinas",
"cep":"32600134",
"cidade":"São José dos Campos",
"siglaEstado":"SP",
"pais":"Brasil",
"tipoEndereco":"ENDERECO_CORRESPONDENCIA",
"codigoIBGECidade":"3554102"
}
],
"telefones":[
{
"ddd":12,
"ddi":55,
"numero":"88888888",
"ramal":"1002",
"tipoTelefone":"CELULAR"
}
],
"classes":[
"CLIENTE",
"OUTROS"
],
"categoria":"PADRÃO",
"autorizaReceberEmail": false,
"autorizaReceberSms": true,
"camposCustomizados": {
"id": 3702,
"valoresPrimitivo": [],
"valoresLista": [
{
"valoresPrimitivo": [],
"valoresComposicao": [
{
"id": 27,
"valores": [
{
"value": "BOB",
"id": 21,
"type": "TEXTO"
},
{
"value": "24/05/2018 00:00:00",
"id": 23,
"type": "DATA"
},
{
"value": "M",
"id": 22,
"type": "OPCIONAL"
},
{
"value": "SHIH TZU",
"id": 25,
"type": "OPCIONAL"
},
{
"value": "CAES",
"id": 24,
"type": "OPCIONAL"
},
{
"value": "GRANDE",
"id": 26,
"type": "OPCIONAL"
}
]
}
],
"campoId": 28
}
],
"valoresComposicao": []
}
},
{
"classes": [
"CLIENTE"
],
"id": 3,
"website": "DELETADO",
"entidadeCadastro": 2,
"categoriasAdicionais": [],
"dataAlteracao": "30-10-2020 11:27:33",
"excluido": true,
"ativo": false,
"tipoPessoa": "PF",
"padraoNome": "NOME_FANTASIA",
"emails": [],
"enderecos": [],
"telefones": [],
"nome": "DELETADO",
"dataCriacao": "30-10-2020 11:15:55",
"documento": "999.999.999-99",
"nomeContato": "DELETADO",
"observacao": "DELETADO",
"camposCustomizados": {
"id": 6670,
"valoresComposicao": [],
"valoresPrimitivo": [],
"valoresLista": []
},
"autorizaReceberEmail": false,
"participaProgramaFidelidade": false,
"autorizaReceberSms": false,
"categoria": "PADRÃO"
}
]
URL de controle de registro integrado
POST https://integrador.varejonline.com.br/apps/api/terceiros/registro/integracao/{integrador}
Onde {integrador} deve ser substituído pelo nome de integrador utilizado no controle de registros integrados
No corpo da mensagem, enviar um array com os ids a serem marcados como integrados pelo integrador:
{
"objectIds": [
1,
2,
....
]
}