跳到主要内容

CustomerOperationsReportRequestDto

The filters that select which wallet movements are reported: the services, the period, the participant, the direction and the outcome of the movement, and the ordering.

NameTypeDescriptionNotes
serviceNameListThe 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]] [nullable]
startDateDate (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] [nullable]
endDateDate (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] [nullable]
participantNameStringThe 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] [nullable]
creditBooleanWhether 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] [nullable]
debitBooleanWhether 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] [nullable]
typeOperationTypeThe 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] [enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
statusOperationStatusThe 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] [enum: 0, 1, 2, 3]
orderByStringThe 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] [nullable]
orderTypeOperationOrderTypeThe 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] [enum: 0, 1]