Trigger revenue backfill
POST https://api.suger.cloud/org/{orgId}/revenue/connection/{partner}/backfill
Start a historical revenue-data backfill for one marketplace connection, covering the trailing 24 months. Use this when a channel was connected late or missed data and its past invoices and disbursements need to be re-synced into unified revenue records. The backfill runs asynchronously: this returns 202 as soon as it is scheduled, and progress is reported by GetRevenueConnectionHealth.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
partner | path | string | yes | Channel to backfill: AWS, AZURE, GCP, or STRIPE |
partnerID | query | string | no | Partner account ID. Required when the organization has more than one connection for this partner; otherwise the single connection is used. |
Responses
202 — Backfill started; covers the trailing 24 months
Content-Type: application/json · Schema: RevenueBackfillResponse
RevenueBackfillResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
backfillStatus | string | no | |
estimatedMonths | integer | no | |
partner | string | no | |
partnerID | string | no |
400 — partnerID is required when multiple connections exist for the partner
Content-Type: application/json
401 — Missing or invalid access token, or the caller lacks the revenue write permission
Content-Type: application/json
404 — No verified revenue connection matches the partner and partnerID
Content-Type: application/json
500 — Failed to query connections or start the backfill
Content-Type: application/json
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.