query revenue records
GET https://api.suger.cloud/org/{orgId}/revenueRecord/query
Query revenue records with filtering, sorting, and pagination using the CRUD query language. Returns a paginated envelope with total_count so callers can page one screen at a time.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
page_size | query | integer | no | Number of items per page (default 20, max 1000) |
page_number | query | integer | no | Page number (default 1) |
q | query | string | no | LISP-style filter expression (e.g., '(and (= partner \ |
s | query | string | no | Sort fields: 'field:asc,field2:desc' or '-field,field2' (e.g., 'invoice_date:desc') |
Responses
200 — Paginated list of revenue records
Content-Type: application/json · Schema: crud.ListBaseResponse-orm_BillingRevenueRecord
400 — Bad request error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json