mark_paid_scheduled_charge
Manually mark a scheduled charge as paid when a customer pays outside the system. Supports one-time and recurring charges by specifying the cycle number for recurring payments.
Instructions
Manually mark a scheduled charge as paid (e.g. customer paid via bank transfer outside Garu). For one-time: omit cycleNumber, allowed from due_today / overdue. For recurring: pass cycleNumber, allowed from cycle status due_today / overdue / failed; future cycles continue.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Scheduled charge ID | |
| cycleNumber | No | Cycle to mark paid. REQUIRED for recurring schedules; omit for one-time. | |
| paymentDate | Yes | YYYY-MM-DD in São Paulo time. Must be today or past. | |
| externalReference | No | Bank reference, internal ID, or any stable string for reconciliation. |