Obtendo as Comissões da Assessoria

A lista de comissões da assessoria pode ser obtida através do método Comissões API - Listar comissões e, por poder retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas a este método.

Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de comissões retornadas. O parâmetro numeroAcordo pode ser utilizado para pesquisar as comissões de uma negociação específica, identificada através do seu número. O parâmetro produto pode ser utilizado para pesquisar somente comissões de dívidas associadas a um produto específico, identificado através do seu ID. O parâmetro situacao (ATIVO, PRIVADO, CONCLUIDO, ESTORNADO e REMOVIDO) pode ser utilizado para pesquisar comissões que estejam em uma ou mais situações específicas. O parâmetro cliente pode ser utilizado para pesquisar somente comissões de dívidas de um cliente específico, identificado através do seu ID. O parâmetro contrato pode ser utilizado para pesquisar somente comissões de um contrato (dívida) específico, identificado através do seu ID. Através dos parâmetros dataInicio e dataFim podem ser pesquisadas comissões de um determinado período.

O método retorna uma lista com as informações detalhadas de cada comissão da assessoria, dentre elas o valor (valorComissao), o percentual (percentualComissao) e a data (dataComissao) da comissão, bem como a parcela de dívida do cliente e a negociação que originaram a comissão.

Exemplos de chamadas e de retornos deste método constam no arquivo Assessorias - Comissões API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.