v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Cadastros Básicos

Vendedor específico

Retorna um Vendedor específico com base no parâmetro enviado na requisição.

get/v1/vendedores/{codigoVendedor}

Path parameters

codigoVendedorinteger required

Código do Vendedor para retorno

Response

Dados do Vendedor retornados com sucesso.

codigoVendedorinteger

Código do vendedor.

nomestring

Nome do vendedor.

ativoboolean

Indica se o vendedor está ativo. true para Sim, false para Não.

tipo1 | 2 | 3 | 4 | 5 | 6 | 7

Tipo do vendedor:

1 - Comprador
2 - Executante
3 - Gerente
4 - Vendedor
5 - Supervisor
6 - Técnico
7 - Representante

comissaoGerencianumber float

Percentual de comissão da gerência.

comissaoVendanumber float

Percentual de comissão por venda.

emailstring email

Endereço de e-mail do vendedor.

codigoEmpresainteger

Código da empresa.

nomeEmpresastring

Nome da empresa.

codigoParceirointeger

Código do parceiro.

nomeParceirostring

Nome do parceiro.

codigoFuncionariointeger

Código do funcionário.

nomeFuncionariostring

Nome do funcionário.

codigoGerenteinteger

Código do gerente responsável.

nomeGerentestring

Nome do gerente responsável.

codigoCentroResultadointeger

Código do centro de resultado.

nomeCentroResultadostring

Nome do centro de resultado.

codigoRegiaointeger

Código da região de atuação.

nomeRegiaostring

Nome da região de atuação.

Example response

{
  "codigoVendedor": 101,
  "nome": "joaodasilva",
  "ativo": true,
  "tipo": 4,
  "comissaoGerencia": 2.5,
  "comissaoVenda": 5.75,
  "email": "vendedor@email.com",
  "codigoEmpresa": 1,
  "nomeEmpresa": "Tech Company",
  "codigoParceiro": 456,
  "nomeParceiro": "Josefina Andrade",
  "codigoFuncionario": 789,
  "nomeFuncionario": "Emanuel Oliveira",
  "codigoGerente": 321,
  "nomeGerente": "Evandro Rocha",
  "codigoCentroResultado": 12,
  "nomeCentroResultado": "Vendas",
  "codigoRegiao": 5,
  "nomeRegiao": "Zona Norte"
}