CustomerServiceUsageReportRequestDto

The filters that select which wallet service consumption is reported: the services, the period, the participant, the outcome, the usage metadata and the ordering.

Name	Type	Description	Notes
serviceName	List	The wallet services whose consumption is reported, 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 reports every service. A bare string is accepted in place of an array for backward compatibility.	[optional] [example: [backup]] [nullable]
startDate	Date (date-time)	The beginning of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the portal creation date.	[optional] [example: 2024-01-01T00:00:00Z] [nullable]
endDate	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] [nullable]
participantName	String	The participant whose consumption is reported - the account the accounting service records as the consumer. Consumption caused by a portal user carries that user ID here; surrounding whitespace is trimmed, and an omitted value reports every participant.	[optional] [example: My Own Corporation] [nullable]
status	OperationStatus	The outcome to keep. Consumption 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]
metadata	Map	The usage annotations a wallet service records alongside its consumption, as the key and value pairs that must all match for a record to be reported. The keys are chosen by the service that writes them, so read them off the metadata of the records returned by GET api/2.0/portal/payment/customer/usage rather than guessing; an omitted map reports every record.	[optional] [example: {key1=value1, key2=value2}]
orderBy	String	The name of the field the per-service totals are sorted by, spelled as the accounting service names it, such as ServiceName or StartDate. Surrounding whitespace is trimmed, and the accounting service applies its own ordering when this is omitted.	[optional] [example: ServiceName] [nullable]
orderType	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] [enum: 0, 1]