List Transactions

GET

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

GET

/v1/transactions

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

200Retrieved

1 {
2   "amount": 1.1,
3   "code": "code",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "customerId": "customerId",
6   "date": "2024-01-15T09:30:00Z",
7   "deletedAt": "2024-01-15T09:30:00Z",
8   "depositId": "depositId",
9   "fiscalPeriod": "fiscalPeriod",
10   "household": {
11     "status": "APPLICANT",
12     "isUnderEviction": true,
13     "id": "id",
14     "readableId": "readableId",
15     "idempotencyId": "idempotencyId",
16     "createdAt": "2024-01-15T09:30:00Z",
17     "updatedAt": "2024-01-15T09:30:00Z",
18     "deletedAt": "2024-01-15T09:30:00Z",
19     "currentUnitId": "currentUnitId",
20     "currentLeaseId": "currentLeaseId",
21     "applicationId": "applicationId",
22     "organizationId": "organizationId",
23     "propertyId": "propertyId",
24     "currentCertificationId": "currentCertificationId",
25     "prospectId": "prospectId",
26     "primaryCustomerId": "primaryCustomerId",
27     "totalActiveRentAmount": 1.1,
28     "totalActiveSubsidyAmount": 1.1,
29     "totalActiveFeesAmount": 1.1,
30     "unitId": "unitId"
31   },
32   "householdId": "householdId",
33   "id": "id",
34   "isPaid": true,
35   "ledger": "RESIDENT",
36   "note": "note",
37   "organizationId": "organizationId",
38   "paymentDate": "2024-01-15T09:30:00Z",
39   "propertyId": "propertyId",
40   "readableId": "readableId",
41   "reversedTransactionId": "reversedTransactionId",
42   "runningBalanceAmount": 1.1,
43   "subjournal": "RESIDENT",
44   "type": "CREDIT",
45   "updatedAt": "2024-01-15T09:30:00Z"
46 }

List all transactions

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)

formatenumOptionalDefaults to JSON

The format of the response

Allowed values:

Response

A paged array of transactions

amountdoubleOptional

codestringOptional

The code for the transaction

createdAtdatetimeOptional

customerIdstringOptionalformat: "uuid"

The ID of the customer associated with the transaction

datedatetimeOptional

deletedAtdatetimeOptional

depositIdstringOptionalformat: "uuid"

The ID of the deposit associated with the transaction

fiscalPeriodstringOptional

The fiscal period for the transaction

householdobjectOptional

householdIdstringOptionalformat: "uuid"

The ID of the household associated with the transaction

idstringOptionalformat: "uuid"

isPaidbooleanOptional

Whether the transaction is paid

ledgerenumOptional

The ledger for the transaction

notestringOptional

Notes about the transaction

organizationIdstringOptionalformat: "uuid"

The ID of the organization associated with the transaction

paymentDatedatetimeOptional

The date the charge was paid

propertyIdstringOptionalformat: "uuid"

The ID of the property associated with the transaction

readableIdstringOptional

The readable ID for the transaction

reversedTransactionIdstringOptionalformat: "uuid"

The ID of the reversed transaction

runningBalanceAmountdoubleOptional

The running balance amount after the transaction

subjournalenumOptional

The subjournal for the transaction

typeenumOptional

The type of the transaction

updatedAtdatetimeOptional