POST Representantes - Varejonline/api GitHub Wiki

URL

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

Parâmetros

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

• apelido: apelido para o representante, max 150 caracteres (string) (opcional)
• matricula: matricula para o representante, max 255 caracteres (string) (opcional)
• ativo: status do representante (boolean) (opcional, padrão: true)
• permiteVender: se o vendedor estará disponível para vendas (boolean) (opcional, padrão: true)
• entidades: lista de ids de entidades do representante (array) (obrigatório)
• perfilVendedor : perfil do representante: CAIXA, GERENTE ou VENDEDOR (string) (obrigatório)
• contaCaixa: para perfil CAIXA ou GERENTE, id da conta caixa para vincular registros financeiro do novo PDV (opcional)
• liberarCreditoExcedente: se o representante pode liberar crédito excedente (boolean) (opcional, padrão: false)
• valorCreditoExcedente: percentual de liberação, de 0 até 99.99, com no máximo 2 casas de precisão (BigDecimal) (obrigatório se liberarCreditoExcedente)
• isentaJurosMulta: se o representante pode isentar juros e multa na baixa de parcelas (boolean) (opcional, padrão: false)
• maximoDesconto: o desconto máximo que o representante poderá conceder na venda, de 0 até 99.99, com no máximo 2 casas de precisão (BigDecimal) (opcional, padrão: 0%)
• comissaoSuasVendas: se o representante terá comissão sobre as vendas próprias (boolean) (opcional, padrão: false)
• comissaoVendasLoja: se o representante terá comissão sobre as vendas da loja (boolean) (opcional, padrão: false)
• porcentagemComissao: o percentual de comissão que o vendedor terá sobre as vendas, de 0 até 99.99, com no máximo 2 casas de precisão (BigDecimal) (opcional, padrão: 0%)
• tipoComissao: se o percentual de comissão se aplicará sobre o valor FATURADO ou REALIZADO (string) (obrigatório)
• diaVencimento: dia de vencimento da provisão de contas a pagar de comissão, de 1 a 31 (int) (obrigatório)
• competenciaVencimento: se o vencimento da provisão de contas a pagar será no MES_CORRENTE ou MES_SEGUINTE (obrigatório)
• usuario: usuário que será associado ao representante. Pode ser informado um usuário existente, pelo id de usuário ou id/documento de um terceiro. Também pode ser informado os dados para criação de um novo usuário (obrigatório)
  • id: id do usuário (long) (opcional)
  • terceiro: terceiro com usuário existente (opcional)
    • id: id do terceiro (opcional)
    • documento: documento do terceiro, com/sem formatação (opcional)
  • email: quando informado um email, ele será o email principal do terceiro. O email principal antigo irá para a lista de emails secundários (string) (opcional)
  • entidades: lista de ids de entidades que o usuário possuirá acesso (array) (obrigatório)
  • permissao: id da permissão de usuário (long) (obrigatório)
  • exibirComoComprador: marcar o usuário como comprador nas rotinas do sistema (boolean) (opcional, padrão: false)
  • ativo: status do usuário (boolean) (opcional, padrão: true)
  • login: login do usuário, 3-50 dígitos, único, sem espaços (string) (opcional, padrão: documento do terceiro, sem formatação)

Exemplo de retorno:

Sucesso:

• HTTP STATUS 201 – CREATED
• Body:

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

Exemplo: Criar representante a partir do ID de um usuário

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

'Content-Type'='application/json'

{
    "apelido": "apelido",
    "matricula": "mat",
    "ativo": false,
    "permiteVender": true,
    "entidades": [1,2],
    "perfil": "GERENTE",
    "contaCaixa": 10,
    "liberarCreditoExcedente": true,
    "valorCreditoExcedente": 10.22,
    "isentaJurosMulta": true,
    "maximoDesconto": 10.1,
    "comissaoSuasVendas": false,
    "comissaoVendasLoja": true,
    "porcentagemComissao": 20,
    "tipoComissao": "FATURADO",
    "diaVencimento": "31",
    "competenciaVencimento": "MES_CORRENTE",
    "usuario": {
        "id": 42
    }
}

Exemplo: Criar representante a partir do ID ou documento de um terceiro

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

'Content-Type'='application/json'

{
    "apelido": "apelido",
    "matricula": "mat",
    "ativo": false,
    "permiteVender": true,
    "entidades": [1,2],
    "perfil": "GERENTE",
    "contaCaixa": 10,
    "liberarCreditoExcedente": true,
    "valorCreditoExcedente": 10.22,
    "isentaJurosMulta": true,
    "maximoDesconto": 10.1,
    "comissaoSuasVendas": false,
    "comissaoVendasLoja": true,
    "porcentagemComissao": 20,
    "tipoComissao": "FATURADO",
    "diaVencimento": "31",
    "competenciaVencimento": "MES_CORRENTE",
    "usuario": {
       "terceiro": {
          "id": 0,
          "documento": "000.000.000-00"
       }
    }
}

Exemplo: Criar representante com novo usuário

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

'Content-Type'='application/json'

{
    "apelido": "apelido",
    "matricula": "mat",
    "ativo": false,
    "permiteVender": true,
    "entidades": [1,2],
    "perfil": "GERENTE",
    "contaCaixa": 10,
    "liberarCreditoExcedente": true,
    "valorCreditoExcedente": 10.22,
    "isentaJurosMulta": true,
    "maximoDesconto": 10.1,
    "comissaoSuasVendas": false,
    "comissaoVendasLoja": true,
    "porcentagemComissao": 20,
    "tipoComissao": "FATURADO",
    "diaVencimento": "31",
    "competenciaVencimento": "MES_CORRENTE",
    "usuario": {
        "terceiro":{
            "id": 0
            "documento": "000.000.000-00"
        },
        "email": "[email protected]",
        "entidades": [1,2],
        "permissao": "3",
        "exibirComoComprador": true,
        "ativo": false,
        "login": "teste"
    }
}