List Rent Changes

GET

https://api.fortresstech.io/v1/rentChanges

GET

/v1/rentChanges

$ curl -G https://api.fortresstech.io/v1/rentChanges \
>      --data-urlencode fields=id,name,property.*,documents.type

200Retrieved

1 {
2   "createdAt": "2024-01-15T09:30:00Z",
3   "deletedAt": "2024-01-15T09:30:00Z",
4   "endDate": "endDate",
5   "id": "id",
6   "idempotencyId": "idempotencyId",
7   "lease": {
8     "startDate": "startDate",
9     "endDate": "endDate",
10     "moveInDate": "moveInDate",
11     "moveOutDate": "moveOutDate",
12     "rentAmount": 1.1,
13     "leasedRent": 1.1,
14     "securityDepositAmount": 1.1,
15     "makeReadyDate": "makeReadyDate",
16     "turnMoveOutDays": 1,
17     "documentId": "documentId",
18     "moveOutId": "moveOutId",
19     "id": "id",
20     "readableId": "readableId",
21     "idempotencyId": "idempotencyId",
22     "createdAt": "2024-01-15T09:30:00Z",
23     "updatedAt": "2024-01-15T09:30:00Z",
24     "deletedAt": "2024-01-15T09:30:00Z",
25     "propertyId": "propertyId",
26     "unitId": "unitId",
27     "householdId": "householdId",
28     "organizationId": "organizationId"
29   },
30   "leaseId": "leaseId",
31   "note": "note",
32   "organizationId": "organizationId",
33   "property": {
34     "name": "name",
35     "shortName": "shortName",
36     "email": "email",
37     "phone": "phone",
38     "physicalStreetAddress1": "physicalStreetAddress1",
39     "physicalStreetAddress2": "physicalStreetAddress2",
40     "physicalCity": "physicalCity",
41     "physicalState": "physicalState",
42     "physicalZip": "physicalZip",
43     "physicalCountry": "physicalCountry",
44     "mailingStreetAddress1": "mailingStreetAddress1",
45     "mailingStreetAddress2": "mailingStreetAddress2",
46     "mailingCity": "mailingCity",
47     "mailingState": "mailingState",
48     "mailingZip": "mailingZip",
49     "mailingCountry": "mailingCountry",
50     "phoneNumber": "phoneNumber",
51     "faxNumber": "faxNumber",
52     "timezone": "timezone",
53     "longitude": 1.1,
54     "latitude": 1.1,
55     "turnMoveOutDays": 1,
56     "status": "ACTIVE",
57     "propertyClass": "Conventional",
58     "organizationId": "organizationId",
59     "id": "id",
60     "readableId": "readableId",
61     "idempotencyId": "idempotencyId",
62     "createdAt": "2024-01-15T09:30:00Z",
63     "updatedAt": "2024-01-15T09:30:00Z",
64     "deletedAt": "2024-01-15T09:30:00Z",
65     "offboardedAt": "2024-01-15T09:30:00Z",
66     "countyName": "countyName",
67     "acquisitionDate": "2024-01-15T09:30:00Z"
68   },
69   "propertyId": "propertyId",
70   "readableId": "readableId",
71   "rentAmount": 1.1,
72   "startDate": "startDate",
73   "updatedAt": "2024-01-15T09:30:00Z"
74 }

List all rent changes

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0

the page number when used with pagination, defaults to 0

limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of rents changes

createdAtdatetimeOptional

deletedAtdatetimeOptional

endDatestringOptionalformat: "date"

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

leaseobjectOptional

leaseIdstringOptionalformat: "uuid"

notestringOptional

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

rentAmountdoubleOptional

startDatestringOptionalformat: "date"

updatedAtdatetimeOptional