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

Get financial overview for tenancies in particular status

Request Information

URI Parameters

Name	Type	Additional information
tenancyRoleStatus	string	Default value is PreTenancy
pageSize	integer	Default value is 25
pageNumber	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.TenancyFinancialOverviewDataContract

Name	Type	Additional information
Total	decimal number	None.
TotalRemaining	decimal number	None.
TotalPaid	decimal number	None.
DueDate	date	None.
Regarding	string	None.
TotalFunds	decimal number	None.
TotalAvailable	decimal number	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Total": 1.0,
    "TotalRemaining": 2.0,
    "TotalPaid": 3.0,
    "DueDate": "2024-11-21T09:33:24.3832498Z",
    "Regarding": "sample string 5",
    "TotalFunds": 6.0,
    "TotalAvailable": 7.0,
    "Id": 8
  },
  {
    "Total": 1.0,
    "TotalRemaining": 2.0,
    "TotalPaid": 3.0,
    "DueDate": "2024-11-21T09:33:24.3832498Z",
    "Regarding": "sample string 5",
    "TotalFunds": 6.0,
    "TotalAvailable": 7.0,
    "Id": 8
  }
]