Back to APIs

GET data/revenues

Gets revenues from your authorised venue. Each page shows the revenues of a maximum of 100 bookings. The response would also indicate the total number of pages available. In order to get the whole revenues under the specified date range, be sure to call this endpoint for every available page.

Request Information

data/revenues?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&bookingReferences={bookingReferences}

URI Parameters

NameDescriptionTypeAdditional information
startDate

Search start date

date

Accepted format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss

endDate

Search end date

date

Accepted format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss

pageNumber

Page number

integer

Optional

Default value is 1

bookingReferences

Booking references specified in comma separated value. Max limit is 100.

string

Optional

Response Information

Resource Description

BasicPageOfRevenue
NameDescriptionTypeAdditional information
CurrentPage

integer

None.

TotalPages

integer

None.

Items

Collection of Revenue

None.

Response Formats

application/json

Sample:

Sample not available.