Get one partner's commission ledger
GET https://api.suger.cloud/org/{orgId}/prm/partner/{partnerId}/commissions
Return the commission ledger for one partner from this organization's perspective: a record per closed-won co-sell deal that partner earns on, each with the deal name, close date, deal value, commission amount and currency, lifecycle state (pending, approved, paid, clawed back) and direction (owed to the partner, or receivable from them), plus totals per currency. Use it to answer what a partner has earned, what is owed, or what is still pending approval. Obtain partnerId from ListPrmPartners. Only deals that closed won appear; open and lost opportunities earn nothing and are omitted. A partner with no closed-won deals returns an empty ledger, not an error.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
partnerId | path | string | yes | Partner ID |
Responses
200 — OK
Content-Type: application/json · Schema: CommissionLedger
CommissionLedger fields:
| Field | Type | Required | Description |
|---|---|---|---|
records | array<CommissionRecord> | no | |
summary | array<CommissionSummary> | no |
CommissionRecord fields:
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | no | Amount is the commission amount — the frozen CommissionLifecycle.Amount when a lifecycle exists, else the computed CommissionPreview value. |
bucket | structs.CommissionBucket | no | |
closeDate | string | no | CloseDate is the deal close date; the table sorts by this descending. |
commissionCurrency | string | no | CommissionCurrency is the ISO-4217 currency for Amount. The commission can be denominated differently from the deal (e.g. a Fixed Amount fee in EUR on a USD deal), so it is carried separately from Currency. Falls back to Currency when the lifecycle carries no currency. |
currency | string | no | Currency is the ISO-4217 currency for DealValue (the deal's own currency). |
dealName | string | no | DealName is the co-sell / deal name shown in the row. |
dealValue | number | no | DealValue is the deal's total value. |
direction | structs.Direction | no | |
id | string | no | ID of the backing record (co-sell referral ID). Drives row navigation. |
sharePercentage | number | no | SharePercentage is the revenue-share percentage (Percentage model); 0 for Fixed Amount / TBD. |
status | structs.CommissionStatus | no | |
type | structs.CommissionRecordType | no |
CommissionSummary fields:
| Field | Type | Required | Description |
|---|---|---|---|
completedPayable | number | no | CompletedPayable — completed outbound commissions (ISV paid the partner): "Paid out". |
completedReceivable | number | no | CompletedReceivable — completed inbound commissions (partner paid the ISV): "Received". |
currency | string | no | Currency is the ISO currency code these totals are denominated in (e.g. "USD"). |
pendingPayable | number | no | PendingPayable — pending outbound commissions (ISV pays the partner): "You owe". |
pendingReceivable | number | no | PendingReceivable — pending inbound commissions (partner pays the ISV): "To be paid". |
400 — Bad request error
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.