List Transactions

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

{
  "amount": 1.1,
  "code": "code",
  "createdAt": "2024-01-15T09:30:00Z",
  "customerId": "customerId",
  "date": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "depositId": "depositId",
  "fiscalPeriod": "fiscalPeriod",
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "currentUnitId",
    "currentLeaseId": "currentLeaseId",
    "applicationId": "applicationId",
    "organizationId": "organizationId",
    "propertyId": "propertyId",
    "currentCertificationId": "currentCertificationId",
    "prospectId": "prospectId",
    "primaryCustomerId": "primaryCustomerId",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "unitId"
  },
  "householdId": "householdId",
  "id": "id",
  "isPaid": true,
  "ledger": "RESIDENT",
  "note": "note",
  "organizationId": "organizationId",
  "paymentDate": "2024-01-15T09:30:00Z",
  "propertyId": "propertyId",
  "readableId": "readableId",
  "reversedTransactionId": "reversedTransactionId",
  "runningBalanceAmount": 1.1,
  "subjournal": "RESIDENT",
  "type": "CREDIT",
  "updatedAt": "2024-01-15T09:30:00Z"
}

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

amountdouble

codestring

The code for the transaction

createdAtdatetime

customerIdstringformat: "uuid"

The ID of the customer associated with the transaction

datedatetime

deletedAtdatetime

depositIdstringformat: "uuid"

The ID of the deposit associated with the transaction

fiscalPeriodstring

The fiscal period for the transaction

householdobject

householdIdstringformat: "uuid"

The ID of the household associated with the transaction

idstringformat: "uuid"

isPaidboolean

Whether the transaction is paid

ledgerenum

The ledger for the transaction

Allowed values:

notestring

Notes about the transaction

organizationIdstringformat: "uuid"

The ID of the organization associated with the transaction

paymentDatedatetime

The date the charge was paid

propertyIdstringformat: "uuid"

The ID of the property associated with the transaction

readableIdstring

The readable ID for the transaction

reversedTransactionIdstringformat: "uuid"

The ID of the reversed transaction

runningBalanceAmountdouble

The running balance amount after the transaction

subjournalenum

The subjournal for the transaction

Allowed values:

typeenum

The type of the transaction

updatedAtdatetime