POST Representantes
Arlan edited this page Jun 28, 2023
·
4 revisions
POST https://integrador.varejonline.com.br/apps/api/representantes
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, entre 0 e 100, 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, entre 0 e 100, 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, entre 0 e 100, 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)
Sucesso:
- HTTP STATUS 201 – CREATED
- Body:
{
"idRecurso": 1,
"codigoMensagem": 0,
"mensagem": "Operação realizada com sucesso."
}
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,
}
}
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"
}
}
}
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": "teste@email.com",
"entidades": [1,2],
"permissao": "3",
"exibirComoComprador": true,
"ativo": false,
"login": "teste"
}
}
Administrativo
- GET dados-login
- GET empresas
- GET entidades
- GET Grupo entidades
- GET Campos Custom.
- ENDPOINTS terceiros
- GET classificacoes-clientes
- ENDPOINTS Usuários
- GET permissao-usuario
- GET marcas
Comercial
Compras
Financeiro
- ENDPOINTS adiantamentos
- POST baixas
- POST estorno baixa
- GET boletos
- POST boletos
- GET Impressao boletos
- GET contas-disponibilidade
- GET contas-pagar
- GET contas-receber
- GET lancamentos-padroes
- GET negociacoes-cartao
- GET planos-gerenciais
- GET plano-contabil
- GET planos-financeiro
- GET previsoes
- POST provisoes
- DELETE Provisão
- POST reneg. receber
- POST reneg. pagar
- PUT transacao-cartao
Controle de crédito
Fiscal
- GET classificao-produtos
- GET conhecim. transporte
- GET cupons fiscais
- GET notas-consumo
- GET notas-mercadoria
- GET XML notas-mercadorias
- GET DANFE notas mercadoria
- GET notas-servico
- GET reducoes-z
Contábil
Operacional
- GET balancos-estoque
- POST balancos-estoque
- POST ajuste-estoque
- GET canais-digitais
- ENDPOINTS Categorias
- GET conferencias-caixa
- GET custo-produtos
- GET devolucoes
- GET entradas
- POST entradas
- GET Niveis Categoria
- GET Orcamentos
- PUT Orcamentos
- POST Orcamentos
- DELETE Orcamentos
- GET Reserva estoque
- PUT Cancelar Reserva
- ENDPOINTS Pedidos
- GET planos-pagamento
- ENDPOINTS Produtos
- GET atendimentos
- GET saidas
- POST entrada movimentação própria
- POST saída movimentação própria
- GET saldos-liquidos-mercadorias
- GET saldos-mercadorias
- GET servicos
- POST servicos
- PUT servicos
- GET tabelas-preco
- GET configuracoes-preco
- POST tabelas-preco
- PUT tabelas-preco
- GET preco-produtos
- PUT preco-produtos
- GET preco-servicos
- PUT preco-servicos
- GET unidades
- POST unidades
- PUT unidades
- POST transferencia
- GET atributos de produto
- ENDPOINTS ações promocionais
- GET Status Pedido Venda
- Integração com Ecom
- Coleta de Alterações
- Paginação de Resultados
- Obter Pagamento de Vendas
- Nota de Devolução de Venda
- Filtro de Datas
- Filtro de Entidades
- Filtro de CPF ou CNPJ
- Filtro de Representantes
- Filtro de Terceiro
- Filtro de Integração