Recuperar status da antecipação automática

Este endpoint permite consultar a configuração atual de antecipação automática da conta.

A antecipação automática é um recurso que antecipa automaticamente os valores de vendas realizadas por cartão de crédito, sem necessidade de solicitar antecipações manualmente para cada cobrança. Ao consultar esta configuração, sua aplicação pode identificar se o recurso está ativo, quais parâmetros estão configurados e como os recebimentos futuros serão tratados.

Quando utilizar

Este endpoint é recomendado para integrações que precisam:

  • Exibir ao usuário o status atual da antecipação automática.
  • Validar se a antecipação automática está habilitada antes de apresentar funcionalidades relacionadas ao fluxo de recebimentos.
  • Sincronizar configurações financeiras entre o Asaas e sistemas externos.
  • Auditar ou monitorar alterações na configuração de antecipação automática da conta.

Um cenário comum é em plataformas financeiras ou ERPs que desejam apresentar previsões de recebimento considerando o comportamento da antecipação configurada na conta.


Papel da antecipação automática no fluxo financeiro

Quando a antecipação automática está habilitada, os recebimentos de vendas parceladas ou à vista realizadas por cartão de crédito podem ser liquidados antes do prazo original, conforme as regras configuradas para a conta.

Em vez de solicitar antecipações manualmente para cada cobrança, o processo ocorre automaticamente para os recebíveis elegíveis.

Fluxo simplificado:

Cobrança paga por cartão
            ↓
Recebível gerado
            ↓
Validação das regras de antecipação
            ↓
Antecipação automática executada
            ↓
Valor disponibilizado antecipadamente

Informações retornadas

A resposta deste endpoint permite identificar informações importantes da configuração ativa, como:

  • Status da antecipação automática.
  • Regras atualmente configuradas para a conta.
  • Critérios utilizados para antecipação dos recebíveis.
  • Demais parâmetros relacionados ao processamento automático das antecipações.

Essas informações podem ser utilizadas para exibição em painéis administrativos, relatórios financeiros ou validações internas da integração.


📘

Importante

A disponibilidade da antecipação automática depende da elegibilidade da conta e das políticas vigentes para utilização do produto. Nem todas as contas possuem o recurso habilitado.


Impactos operacionais

A antecipação automática pode alterar a previsão de recebimentos originalmente esperada para cobranças de cartão.

Por esse motivo, integrações que realizam:

  • projeção de fluxo de caixa;
  • conciliação financeira;
  • previsão de saldo futuro;
  • relatórios de recebimentos;

devem considerar a configuração retornada por este endpoint para refletir corretamente os valores e datas de liquidação.


Boas práticas

  • Consulte esta configuração periodicamente caso sua aplicação utilize previsões financeiras.
  • Não assuma que todas as contas possuem antecipação automática habilitada.
  • Considere que alterações realizadas pelo usuário no ambiente Asaas podem modificar o comportamento dos recebimentos futuros.
  • Utilize os dados retornados para atualizar informações exibidas em dashboards e relatórios financeiros.

Possíveis erros

403 - Forbidden

Este erro pode ocorrer quando uma requisição GET é enviada contendo conteúdo no corpo da requisição (request body).

Requisições GET devem ser realizadas sem body.


Conteúdos relacionados

  • Configurar antecipação automática.
  • Solicitar antecipação manual.
  • Consultar antecipações.
  • Recebimentos de cartão de crédito.
  • Extrato financeiro.

Responses

403

Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json