API de Comissão – Novos filtros e campos no retorno
A API de Comissões recebeu melhorias que ampliam as possibilidades de filtragem e enriquecem as informações retornadas no response.
Endpoint:
GET /api/v1/financeiro/comissoes
Por que isso é importante?
As melhorias permitem integrações mais completas com sistemas financeiros e de pagamento, facilitando:
- Identificação da pagadoria responsável
- Visualização da forma de pagamento realizada
- Vínculo com cobranças específicas por meio do codigo_pagadoria_int
Isso aumenta a rastreabilidade, melhora a conciliação financeira e traz mais precisão nas integrações.
O que foi implementado?
Novo filtro por pagadoria
Foi incluído um novo parâmetro de filtro que permite consultar as comissões considerando a pagadoria vinculada.
Com isso, integrações podem segmentar os dados conforme a entidade responsável pelo pagamento das comissões.
Forma de pagamento no array de pagamentos
No response da API, dentro do array de pagamentos dos beneficiários, passa a ser retornado o campo que identifica a forma de pagamento realizada.
Isso permite diferenciar pagamentos como:
- Boleto
- Transferência
- PIX
- Outros meios configurados
Inclusão do código da pagadoria na programação
No array de programação da comissão, foi adicionado o campo: codigo_pagadoria_int
Esse campo identifica a cobrança associada ao agendamento de pagamento vinculado à pagadoria Avendre Pay, sendo equivalente ao ChargeID.
Essa informação facilita:
- Rastreamento da cobrança no gateway/pagadoria
- Integração com sistemas externos de faturamento
- Auditorias financeiras
Pré-requisitos
- Credenciais válidas de API
- Permissão de acesso aos dados financeiros de comissão