Cobrança
📄️ Criar cobrança por estratégia
Cria uma cobrança a partir de filtros de recebíveis e da estratégia informada. A resposta `202` indica que o pedido foi aceito e continuará sendo processado de forma assíncrona. O par `acquirerTaxIds` + `paymentSchemes` precisa existir na agenda da empresa. O token precisa incluir `create:contracts:collections`.
📄️ Listar contratos de cobrança
Lista contratos de cobrança com paginação. Use os filtros disponíveis para acompanhar operações criadas por estratégia, status ou período, sem precisar abrir contrato por contrato. O token precisa incluir `read:contracts:collections`.
📄️ Consultar contrato de cobrança
Consulta os detalhes de um contrato de cobrança específico. Use para ver valores, empresas envolvidas, status e informações operacionais da cobrança. O token precisa incluir `read:contracts:collections`.
📄️ Consultar eventos da cobrança
Lista os eventos registrados para um contrato de cobrança. Use para acompanhar mudanças de status e marcos relevantes da operação ao longo do tempo. O token precisa incluir `read:contracts:collections:events`.
📄️ Consultar resumo agregado de cobranças (totais por status e estratégia)
Devolve totalizadores monetários e quantidades agrupadas por status do contrato e por estratégia. Exposto apenas `requestedAmount` (sem `effectivelyEncumberedAmount`). O token precisa incluir `read:contracts:collections:summary`.
📄️ Configurar devolução automática
Habilita ou desabilita a devolução automática para uma empresa. Use esta configuração quando a cobrança precisar devolver valores automaticamente pela conta de devolução cadastrada. O token precisa incluir `manage:collections:automatic-refund`.
📄️ Consultar recebíveis vinculados ao contrato de cobrança
Consultar recebíveis vinculados ao contrato de cobrança