VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Equipe de campo

Nome alternativo da conta-corrente

O endereço ecmanagertransactions, equivalente a manager_transactions, usado pelo app de representantes já instalado.

O app de representantes chama a conta-corrente de ecmanagertransactions, o nome da classe EcManagerTransactions em minúsculas e sem sublinhado. Os dois endereços desta página (com e sem /v1.0) executam o mesmo código de Conta-corrente do representante: mesmos parâmetros, mesma resposta, mesmos erros. Exigem um usuário administrador.

GET/api/v1.0/ecmanagertransactionsAdmin

Mesmo que manager_transactions (GET), forma com versão

Igual a GET /api/v1.0/manager_transactions: extrato e saldo do representante.

Parâmetros de consulta

manager_idstring
Id do representante (inteiro).
internal_codestring
Código interno do representante.
user_idstring
Id do usuário do representante.
typestring
CD
Filtro de comissões (C) ou descontos (D).
pageintegerpadrão: 1
Página.
items_per_pageintegerpadrão: 10
Itens por página, de 1 a 100.
POST/api/v1.0/ecmanagertransactionsAdmin

Mesmo que manager_transactions (POST), forma com versão

Igual a POST /api/v1.0/manager_transactions: lançamento manual de crédito ou redução.

Corpo da requisição

amountnumberobrigatório
Valor em reais, como número.
scopestringobrigatório
A soma; qualquer outro texto subtrai.
manager_idstring
Id do representante.
internal_codestring
Código interno do representante.
user_idstring
Id do usuário do representante.
GET/api/ecmanagertransactionsAdmin

Mesmo que manager_transactions (GET), forma sem versão

Igual a GET /api/manager_transactions: extrato e saldo do representante.

Parâmetros de consulta

manager_idstring
Id do representante (inteiro).
internal_codestring
Código interno do representante.
user_idstring
Id do usuário do representante.
typestring
CD
Filtro de comissões (C) ou descontos (D).
pageintegerpadrão: 1
Página.
items_per_pageintegerpadrão: 10
Itens por página, de 1 a 100.
POST/api/ecmanagertransactionsAdmin

Mesmo que manager_transactions (POST), forma sem versão

Igual a POST /api/manager_transactions: lançamento manual de crédito ou redução.

Corpo da requisição

amountnumberobrigatório
Valor em reais, como número.
scopestringobrigatório
A soma; qualquer outro texto subtrai.
manager_idstring
Id do representante.
internal_codestring
Código interno do representante.
user_idstring
Id do usuário do representante.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1.0/ecmanagertransactions?manager_id=2" -u "$ADMIN_EMAIL:$API_KEY"

curl -X POST "$BASE_URL/api/v1.0/ecmanagertransactions" \
  -u "$ADMIN_EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":50,"scope":"A","manager_id":2}'

Resposta

200Extrato (resumo)
json
{
  "success": true,
  "message": "",
  "balance": "150.00",
  "transactions": [],
  "search": { "page": 1, "items_per_page": 10, "total_items": 0 }
}

Os campos completos e o formato do lançamento estão em Conta-corrente do representante.

Erros

Os mesmos de Conta-corrente do representante: 400 para corpo inválido, amount ou scope ausentes, saldo insuficiente e representante numérico inexistente; 401 sem credencial; 403 sem perfil de administrador; e as respostas 200 enganosas (result: null, lista vazia) quando o identificador não é número.

Confira result e não só success

No lançamento, success: true aparece mesmo quando o representante não foi encontrado. Leia result e message.

Veja também

  • Conta-corrente do representante
  • Check-ins de visita
Anterior
Conta-corrente do representante
Próxima
Integração ERP (1.0)
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também