POST terceiros - Varejonline/api GitHub Wiki

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.

URL

POST https://integrador.varejonline.com.br/apps/api/terceiros

Parâmetros

Envie um JSON no corpo da requisição, contendo:

tipoPessoa: Define se a Pessoa é Física (PF), Jurídica (PJ), Física Estrangeiro (PF_ESTRANGEIRO) ou Jurídica Estrangeiro (PJ_ESTRANGEIRO) (opcional para PF e PJ. Caso não informado, assume PF ou PJ de acordo com o documento informado)
padraoNome: "NOME_FANTASIA" ou "RAZAO_SOCIAL". Indica ao sistema qual nome convencionar na apresentação em tela (apenas para PJ e PJ_ESTRANGEIRO) (string) (opcional, padrão: RAZAO_SOCIAL)
nome: nome do terceiro (considerado razão social para PJ) (string) (obrigatório) (max 255 char)
nomeFantasia: nome fantasia da empresa (apenas para PJ e PJ_ESTRANGEIRO) (string) (obrigatório caso padraoNome NOME_FANTASIA) (max 255 char)
documento: CPF ou CNPJ do terceiro com/sem formatação (string) (obrigatório) (max 255 char)
emails: Emails do terceiro (List String) (opcional) (max 255 char)
rg: número do RG do terceiro. (Apenas PF) (string) (opcional) (max 50 char)
dataNascimento: data de nascimento do terceiro (apenas PF ou PF_ESTRANGEIRO) (dd-mm-aaaa) (opcional)
ie: número da Inscrição Estadual do terceiro. (Apenas PJ) (string) (opcional) (max 255 char)
ativo: indica se o terceiro está ativo ou não (boolean) (opcional, padrão: true)
entidadeCadastro: id da entidade de cadastro do terceiro (long) (opcional)
enderecos: endereços do terceiro (Lista de objetos complexos) (opcional)
- tipo: tipo do logradouro (string). Exemplos: RUA, AVENIDA, RODOVIA. Veja a lista completa (obrigatório)
- logradouro: nome do logradouro (string) (opcional) (max 255 char)
- numero: número do endereço (string) (opcional) (max 400 char)
- bairro: bairro do endereço (string) (obrigatório caso informado o codigoIBGECidade) (max 255 char)
- complemento: complemento do endereço (string) (opcional) (max 255 char)
- cep: CEP do endereço sem máscara (string) (obrigatório)
- codigoIBGECidade: código do IBGE da cidade (long) (opcional)
- pais: País do Endereço (string) (opcional, padrão: BRASIL)
- uf: sigla em caixa alta da UF do endereço (string) (Se estrangeiro enviar "EX") (apenas para pais diferente do BRASIL) (opcional)
- cidade: nome da cidade (string) (apenas para pais diferente do BRASIL) (opcional) (max 255 char)
- tipoEndereco: Tipo do Endereço (string) (opcional, padrão: ENDERECO_SEDE)
telefones: telefones do terceiro (Lista de objetos complexos) (opcional)
- ddd: Código do DDD (int) (obrigatório) (max 10 char)
- ddi: Código do DDI (int) (obrigatório) (max 10 char)
- numero: Número do telefone (string) (obrigatório) (max 255 char)
- ramal: Número do ramal (int) (obrigatório) (max 10 char)
- tipoTelefone: CELULAR, RESIDENCIAL, COMERCIAL, RECADO (string) (opcional, padrão: COMERCIAL)
classes: lista de classes às quais o terceiro pertence (opcional)
categoria: Define a categorização do terceiro no Varejonline (string) (opcional)
autorizaReceberEmail: Opt-in do terceiro autorizando ou não a comunicação por email (boolean) (opcional, padrão: false)
autorizaReceberSms: Opt-in do terceiro autorizando ou não a comunicação por sms (boolean) (opcional, padrão: false)
limiteCredito: Define os valores de limite de crédito para o terceiro (objeto complexo) (opcional)
- valorTotal: limite de crédito total (Decimal) (opcional)
- valorMensal: limite de crédito mensal (Decimal) (opcional)
- valorRenda: valor da renda do terceiro (Decimal) (opcional)
camposCustomizados: Define os valores da estrutura de campos customizados da base. (opcional)
- id: id do terceiro associado aos valores informados (long)
- valoresPrimitivo: valores dos campos customizados primitivos (opcional)
  - 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 (opcional)
  - 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 (opcional)
  - 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: (opcional)
- autorizaReceberSms: (boolean) (opcional, padrão: false)
- autorizaReceberEmail: (boolean) (opcional, padrão: false)
- autorizaReceberWhatsapp: (boolean) (opcional, padrão: false)
- marca: informações da marca
  - id: id da marca (long)
  - nome: nome da marca (string) (max 255 char)

Exemplo de retorno:

Sucesso:

HTTP STATUS 201 – CREATED
Body:

{
      "idRecurso": 1,
      "codigoMensagem": 0,
      "mensagem": "Operação realizada com sucesso."
}

Requisição inválida:

HTTP STATUS 400 – BAD REQUEST
Body:

{
      "idRecurso": 0,
      "codigoMensagem": 1,
      "mensagem": "Terceiro com documento inválido"
}

Exemplo

POST https://integrador.varejonline.com.br/apps/api/terceiros

'Content-Type'='application/json'

{
   "nome":"Nome do terceiro",
   "documento":"023.168.132-00",
   "emails":[
      "[email protected]",
      "[email protected]"
   ],
   "rg":"42.943.412-1",
   "dataNascimento":"12-08-1980",
   "enderecos":[
      {
         "tipo":"AVENIDA",
         "logradouro":"9 de Julho",
         "numero":"900",
         "bairro":"CENTRO",
         "uf":"SP",
         "complemento":"APTO 1",
         "cep":"12000111",
         "codigoIBGECidade":"3554102",
         "tipoEndereco":"ENDERECO_COBRANCA"
      },
      {
         "tipo":"RUA",
         "logradouro":"15 de Novembro",
         "numero":"1020",
         "bairro":"JD. MARIA",
         "uf":"SP",
         "complemento":"APTO 1",
         "cep":"12600123",
         "codigoIBGECidade":"3554102",
         "tipoEndereco":"ENDERECO_SEDE"
      }
   ],
   "telefones":[
      {
         "ddi":"55",
         "ddd":"12",
         "numero":"12341234",
         "tipoTelefone":"RESIDENCIAL"  
      },
      {
         "ddi":"0",
         "ddd":"31",
         "numero":"12340000",
         "ramal":"1234",
         "tipoTelefone":"CELULAR"  
      }
   ],
   "classes":[
      "SOCIO_PROPRIETARIO",
      "FUNCIONARIO"
   ],
   "categoria": "CLIENTES VIP",
   "autorizaReceberEmail": false,
   "autorizaReceberSms": true,
   "marcas": [
        {
            "autorizaReceberSms": false,
            "autorizaReceberEmail": false,
            "autorizaReceberWhatsapp": true,
            "marca": {
                "id": 283,
                "nome": "TESTE"
            }
        },
        {
            "autorizaReceberSms": true,
            "autorizaReceberEmail": false,
            "autorizaReceberWhatsapp": false,
            "marca": {
                "id": 0,
                "nome": "SEM MARCA"
            }
        }
   ]
}