Summarize Unified Revenue Records

GET https://api.suger.cloud/org/{orgId}/revenue/records/summary

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`search`	query	string	no	Case-insensitive search over buyer name, invoice ID, buyer ID, entitlement ID, disbursement reference number, and offer external ID
`partner`	query	string	no	Partner filter (AWS, AZURE, GCP, STRIPE, CRM_*)
`lifecycleStage`	query	string	no	Lifecycle stage filter (BILLING, CASH_COLLECTED, DISBURSED)
`buyerId`	query	string	no	Buyer ID filter
`productId`	query	string	no	Product ID filter
`startDate`	query	string	no	Earliest invoice_date (RFC3339 or YYYY-MM-DD)
`endDate`	query	string	no	Latest invoice_date (RFC3339 or YYYY-MM-DD)
`currency`	query	string	no	ISO 4217 currency code
`recognitionStatus`	query	string	no	Recognition status filter

Responses

200 — OK

Content-Type: application/json · Schema: RevenueRecordSummaryResponse

RevenueRecordSummaryResponse fields:

Field	Type	Required
`byCurrency`	object	no
`channels`	array<string>	no
`currencies`	array<string>	no
`total`	integer	no

400 — Invalid filter value

Content-Type: application/json

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X GET 'https://api.suger.cloud/org/{orgId}/revenue/records/summary' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "byCurrency": {},
  "channels": [
    "string"
  ],
  "currencies": [
    "string"
  ],
  "total": 1
}

Error — 400

{}

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.