Simular a antecipação de recebíveis a vencer.
Simulação pura, sem efeitos colaterais. Sem receivable_ids, exclui recebíveis reservados por pedidos em análise até a decisão da whitelabel. Com receivable_ids explícitos, a seleção deve ser integralmente elegível: qualquer recebível indisponível ou reservado devolve validation_error (HTTP 422), sem reduzir a prévia. Exige a permissão anticipations:read e uma key com escopo de seller. O preço da antecipação e o D+N vêm do plano comercial do whitelabel quando definido (override do seller > padrão); caso contrário, vêm da própria configuração de antecipação do seller. A resposta ecoa o fee_bps_per_month, o auto_batch_min_sale_age_days (há quantos dias a venda precisa existir para o lote AUTOMÁTICO antecipá-la — não é quando o dinheiro cai) e o pricing_plan_id resolvidos.
Simulação pura, sem efeitos colaterais. Sem receivable_ids, exclui recebíveis reservados por pedidos em análise até a decisão da whitelabel. Com receivable_ids explícitos, a seleção deve ser integralmente elegível: qualquer recebível indisponível ou reservado devolve validation_error (HTTP 422), sem reduzir a prévia. Exige a permissão anticipations:read e uma key com escopo de seller. O preço da antecipação e o D+N vêm do plano comercial do whitelabel quando definido (override do seller > padrão); caso contrário, vêm da própria configuração de antecipação do seller. A resposta ecoa o fee_bps_per_month, o auto_batch_min_sale_age_days (há quantos dias a venda precisa existir para o lote AUTOMÁTICO antecipá-la — não é quando o dinheiro cai) e o pricing_plan_id resolvidos.
Autorização
ApiKeyAuth Em: header
Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body em TypeScript.
Corpo da resposta
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/anticipations/simulate" \ -H "Content-Type: application/json" \ -d '{}'{ "object": "anticipation_simulation", "eligible_receivable_count": 0, "gross_amount_cents": 0, "fee_amount_cents": 0, "net_amount_cents": 0, "fee_bps_per_month": 0, "auto_batch_min_sale_age_days": 0, "pricing_plan_id": "string", "items": [ { "gross_amount_cents": 0, "fee_amount_cents": 0, "net_amount_cents": 0, "days_anticipated": 0 } ], "exposure": { "outstanding_cents": 0, "projected_cents": 0, "limit_cents": 0, "available_cents": 0, "within_limit": true }, "availability": { "can_anticipate": true }, "request_id": "req_xxx"}