getCustomerOperations
ReportWrapper getCustomerOperations(offset, limit, serviceName, startDate, endDate, participantName, credit, debit, type, status, orderBy, orderType)
GET /api/2.0/portal/payment/customer/operations
Get the wallet operations
Lists the money movements on the portal's wallet - top-ups, the charges of the wallet services, refunds and corrections - one page at a time, which is what a billing history is built from. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. Every filter is optional: startDate and endDate are read in the portal time zone and default to the portal creation date and the present moment, serviceName narrows to particular wallet services and fails with 404 on a name this installation does not sell, participantName, type and status narrow to who caused a movement and how it ended, and credit and debit include or exclude the two directions. offset and limit page through the result and default to 0 and 25, orderBy and orderType sort it, and the answer repeats them next to totalQuantity, totalPage and currentPage so a client can page without counting. The same data as a downloadable file is POST api/2.0/portal/payment/customer/operationsreport, and the figures added up per service are GET api/2.0/portal/payment/customer/usage.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| offset | query | Integer (int32) | The number of movements to skip before the first one returned, for walking through a long history page by page. Counted after the filters and the ordering are applied, and starts at 0 when omitted. | [optional] [example: 0] |
| limit | query | Integer (int32) | The maximum number of movements returned in one page. Defaults to 25 when omitted; the answer echoes the window back next to totalQuantity, totalPage and currentPage, so the next offset can be computed without counting the items. | [optional] [example: 25] |
| serviceName | query | List | The wallet services whose movements are kept, named the way the billing catalogue names them - backup, ai-tools, ai-search, disk-storage, docscloud. Take the values from the serviceName field of GET api/2.0/portal/payment/walletservices; the match ignores case, a name this installation does not sell fails the call with 404, and an omitted list keeps every service. A bare string is accepted in place of an array for backward compatibility. | [optional] [example: [backup]] |
| startDate | query | Date (date-time) | The beginning of the reported period, inclusive. Read in the portal time zone rather than in UTC, so a movement at the edge of the period falls where the portal sees it; defaults to the portal creation date. | [optional] [example: 2024-01-01T00:00:00Z] |
| endDate | query | Date (date-time) | The end of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the moment the call is made. | [optional] [example: 2024-01-31T23:59:59Z] |
| participantName | query | String | The participant whose movements are kept - the account the accounting service records as the cause of a movement. A movement caused by a portal user carries that user ID here, and one caused by the portal itself carries the customer name; surrounding whitespace is trimmed, and an omitted value keeps every participant. | [optional] [example: My Own Corporation] |
| credit | query | Boolean | Whether movements that add money to the wallet - top-ups, refunds and corrections in the portal's favour - are kept. Both directions are reported when neither this nor debit is given. | [optional] [example: true] |
| debit | query | Boolean | Whether movements that take money out of the wallet - the charges of the wallet services - are kept. Both directions are reported when neither this nor credit is given. | [optional] [example: false] |
| type | query | OperationType | The kind of movement to keep, which says what caused the money to move rather than how it ended. Every kind is reported when it is omitted. | [optional] [example: ServicePayment] [enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] |
| status | query | OperationStatus | The outcome to keep. A movement that is still being settled is reported as pending and may change later, while the other outcomes are final; every outcome is reported when this is omitted. | [optional] [example: Completed] [enum: 0, 1, 2, 3] |
| orderBy | query | String | The name of the field the movements are sorted by, spelled as the accounting service names it, such as StartDate or ServiceName. Surrounding whitespace is trimmed, and the accounting service applies its own ordering when this is omitted. | [optional] [example: StartDate] |
| orderType | query | OperationOrderType | The direction the field named in orderBy is sorted in. Newest or largest first is what the accounting service does by default, so leaving this out sorts the same way as asking for descending explicitly. | [optional] [example: Descending] [enum: 0, 1] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | A page of wallet movements with its paging information, or an empty result when the portal has no billing customer | ReportWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 403 | The caller is not a DocSpace administrator, or the portal has no billing service configured | - | - |
| 404 | One of the names in serviceName is not a wallet service of this installation | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 400 | Bad Request. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json