Consultar Agentes Comerciais - GET

Objetivo

A finalidade deste método é possibilitar a consulta dos agentes comerciais.

Chamada

GET api/v1/sm/commercial-agent?COMMERCIAL_AGENT_NUMBER={COMMERCIAL_AGENT_NUMBER}&LAST_UPDATE_DATE={LAST_UPDATE_DATE}&ONLY_REGISTRED_EMAILS={ONLY_REGISTRED_EMAILS}&ONLY_AFV={ONLY_AFV}&STATUS={STATUS}&TYPE_COMMERCIAL_AGENT={TYPE_COMMERCIAL_AGENT}&_pageNo={_pageNo}&_pageSize={_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
commercial_agent_number	Número representativo do Agente Comercial – Opcional	integer	Não há.
last_update_date	Data Hora da última atualização – Formatos: dd / MM / aaaa hh: mm ou ddMMaaayhhmm – Opcional	string	Não há.
only_registred_emails	Indica se deve filtrar apenas emails registrados. Acrônimos: S (Sim), N (Não) – Padrão ‘N’ – Opcional	string	Tamanho da String: entre 0 e 1
only_afv	Apenas AFV – Siglas: S (Sim), N (Não) – Opcional	string	Tamanho da String: entre 0 e 1
status	Status do agente comercial – Siglas: A (Ativo), I (Inativo) – Opcional	string	Não há.
type_commercial_agent	Tipo de agente comercial – pode ser uma lista, separada por vírgulas. Ex .: A, S – A = Autônomo – E = Empresa – F = Funcionário – G = Gerente – R = Representante Comercial – S = Supervisor – T = Televendas – X = Auxiliar – Opcional	string	Não há.
_pageNo		integer	Não há.
_pageSize		integer	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
commercial_agent_status	Status do Agente Comercial – A = Ativo / Não Bloqueado – I = Inativo / Bloqueado	string	Não há.
current_balance	Saldo atual da sua conta corrente	decimal number	Não há.
current_credit_limit	Valor Atual do Limite de Crédito	decimal number	Não há.
email	O email	string	Tamanho da String: entre 0 e 50
indicates_use_current_account	Indica se o agente comercial usa o conceito de conta corrente	string	Não há.
last_update_date	Data da Última Atualização	date	Não há.
maximum_percentage_increase	Porcentagem máxima de aumento	decimal number	Não há.
minimum_value_sale_order	Valor mínimo de venda por pedido	decimal number	Não há.
name	Nome do Agente Comercial	string	Tamanho da String: entre 0 e 40
nickname	Apelido de Agente Comercial	string	Tamanho da String: entre 0 e 15
number_commercial_agent	Número Representativo do Agente Comercial	integer	Não há.
number_segment	Código de Distribuição	integer	Não há.
number_supervisor	Código do Supervisor	integer	Não há.
supervisor_name	Supervisor de Nome	string	Não há.
percentage_commission_sales	Porcentagem de Comissão sobre Vendas	decimal number	Não há.
phone_number_main	Número de telefone principal	string	Não há.
phone_number_secondary	segundo telefone	string	Não há.
reg_number	Número de registro CPF se type_person = ‘F’ CNPJ se type_person = ‘J’	string	Tamanho da String: entre 0 e 14
seq_sale_region	Sequência da Região de Vendas	decimal number	Não há.
type_commercial_agent	Tipo de Agente Comercial – A = Autônomo – E = Empresa – F = Funcionário – G = Gerente – R = Representante Comercial – S = Supervisor – T = Televendas – X = Auxiliar	string	Não há.
only_afv	Apenas AFV – Siglas: S (Sim), N (Não) – Opcional	string	Não há.
type_person	Tipo de pessoa comercial- J (pessoa jurídica) ou F (pessoa física)	string	Tamanho da String: entre 0 e 1

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "commercial_agent_status": "sample string 8",
    "current_balance": 1.1,
    "current_credit_limit": 1.1,
    "email": "sample string 9",
    "indicates_use_current_account": "sample string 10",
    "last_update_date": "2020-09-06T11:41:03.1514098-03:00",
    "maximum_percentage_increase": 1.1,
    "minimum_value_sale_order": 1.1,
    "name": "sample string 11",
    "nickname": "sample string 12",
    "number_commercial_agent": 13,
    "number_segment": 14,
    "number_supervisor": 15,
    "supervisor_name": "sample string 16",
    "percentage_commission_sales": 1.1,
    "phone_number_main": "sample string 17",
    "phone_number_secondary": "sample string 18",
    "reg_number": "sample string 19",
    "seq_sale_region": 1.0,
    "type_commercial_agent": "sample string 20",
    "only_afv": "sample string 21",
    "type_person": "sample string 22"
  },
  {
    "commercial_agent_status": "sample string 8",
    "current_balance": 1.1,
    "current_credit_limit": 1.1,
    "email": "sample string 9",
    "indicates_use_current_account": "sample string 10",
    "last_update_date": "2020-09-06T11:41:03.1514098-03:00",
    "maximum_percentage_increase": 1.1,
    "minimum_value_sale_order": 1.1,
    "name": "sample string 11",
    "nickname": "sample string 12",
    "number_commercial_agent": 13,
    "number_segment": 14,
    "number_supervisor": 15,
    "supervisor_name": "sample string 16",
    "percentage_commission_sales": 1.1,
    "phone_number_main": "sample string 17",
    "phone_number_secondary": "sample string 18",
    "reg_number": "sample string 19",
    "seq_sale_region": 1.0,
    "type_commercial_agent": "sample string 20",
    "only_afv": "sample string 21",
    "type_person": "sample string 22"
  }
]

application/xml, text/xml