API
Status PageSuporte

Cria e executa simulação de antecipação de recebíveis.

post
https://sandbox.openfinance.celcoin.dev/baas/v1/cash/companies//simulation-antecipation-receivables

Cria e executa de forma síncrona a simulação de antecipação. Consulta as transações
elegíveis, calcula os valores e persiste o resultado.

Janela de execução: somente entre 07h00 e 22h59 (America/Sao_Paulo), independente
do timezone do servidor.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identificador público da company

Body Params

Exatamente um dos campos deve ser informado:

  • Por valor: value — para quando totalAntecipatedValue + antecipatedValue > value; mantém o total inferior mais próximo ao limite.
  • Por transações: transactionIds — processa todas as transações informadas sem limite de valor.

Quando ambos são informados, transactionIds prevalece e value é ignorado.

float

Valor máximo a antecipar (em reais). Mutuamente exclusivo com transactionIds — quando ambos informados, este campo é ignorado.

transactionIds
array of integers

IDs das transações a antecipar. Quando informado, prevalece sobre value e processa todas as transações sem limite.

transactionIds
Responses

Updated 10 days ago

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

Updated 10 days ago