Opt-In
📄️ Solicitar acesso à agenda de recebíveis
Solicita acesso à agenda de recebíveis das empresas informadas. A solicitação é assíncrona: a API aceita o pedido e o processamento continua em segundo plano. Use um token com `companies:write`.
📄️ Listar opt-ins
Lista os opt-ins do cliente autenticado com filtros opcionais e paginação por cursor. Use para acompanhar quais empresas autorizaram o acesso e em que situação a autorização se encontra. O token precisa incluir `companies:read`.
📄️ Realizar opt-in
Cria opt-ins para as empresas informadas e habilita a recorrência conforme o payload. Use esta operação para iniciar a autorização de acesso à agenda de recebíveis. O token precisa incluir `companies:write`.
📄️ Alterar recorrência do opt-in
Altera a recorrência de opt-ins já existentes para as empresas informadas. Use quando a autorização deve continuar ativa ou deixar de ser recorrente sem recriar o opt-in. O token precisa incluir `companies:write`.
📄️ Consultar um opt-in
Consulta os detalhes de um opt-in específico do cliente autenticado. Use para verificar status, empresa relacionada e dados de controle depois da criação ou atualização. O token precisa incluir `companies:read`.