POST api/tenancy/tenanciesoverview?tenancyRoleStatus={tenancyRoleStatus}&pageSize={pageSize}&pageNumber={pageNumber}

Get financial overview for tenancies in particular status Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
tenancyRoleStatus	The tenancy role status value supplied with the request.	string	Default value is PreTenancy
pageSize	The page size value supplied with the request.	integer	Default value is 25
pageNumber	The page number value supplied with the request.	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of TenancyFinancialOverviewDataContract

Name	Description	Type	Additional information
Total	The total value.	decimal number	None.
TotalRemaining	The total remaining value.	decimal number	None.
TotalPaid	The total paid value.	decimal number	None.
DueDate	The due date, expressed as a date and time.	date	None.
Regarding	The regarding value.	string	None.
TotalFunds	The total funds value.	decimal number	None.
TotalAvailable	The total available value.	decimal number	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Total": 1.0,
    "TotalRemaining": 2.0,
    "TotalPaid": 3.0,
    "DueDate": "2026-08-05T01:30:41.681545Z",
    "Regarding": "sample string 5",
    "TotalFunds": 6.0,
    "TotalAvailable": 7.0,
    "Id": 8
  },
  {
    "Total": 1.0,
    "TotalRemaining": 2.0,
    "TotalPaid": 3.0,
    "DueDate": "2026-08-05T01:30:41.681545Z",
    "Regarding": "sample string 5",
    "TotalFunds": 6.0,
    "TotalAvailable": 7.0,
    "Id": 8
  }
]