List Reversals

{
  "amount": 1.1,
  "customerId": "customerId",
  "householdId": "householdId",
  "method": "method",
  "createdAt": "2024-01-15T09:30:00Z",
  "customer": {
    "firstName": "firstName",
    "middleName": "middleName",
    "lastName": "lastName",
    "preferredName": "preferredName",
    "suffix": "suffix",
    "birthDate": "birthDate",
    "status": "APPLICANT",
    "email": "email",
    "phone": "phone",
    "gender": "gender",
    "headOfHousehold": true,
    "relationship": "PARTNER",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "householdId": "householdId",
    "propertyId": "propertyId",
    "organizationId": "organizationId"
  },
  "date": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "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"
  },
  "id": "id",
  "idempotencyId": "idempotencyId",
  "note": "note",
  "organizationId": "organizationId",
  "readableId": "readableId",
  "transaction": {
    "id": "id",
    "readableId": "readableId",
    "customerId": "customerId",
    "householdId": "householdId",
    "propertyId": "propertyId",
    "organizationId": "organizationId",
    "depositId": "depositId",
    "date": "2024-01-15T09:30:00Z",
    "amount": 1.1,
    "note": "note",
    "code": "code",
    "subjournal": "RESIDENT",
    "ledger": "RESIDENT",
    "fiscalPeriod": "fiscalPeriod",
    "isPaid": true,
    "type": "CREDIT",
    "reversedTransactionId": "reversedTransactionId",
    "runningBalanceAmount": 1.1,
    "paymentDate": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  },
  "transactionId": "transactionId",
  "updatedAt": "2024-01-15T09:30:00Z"
}

List all reversals

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 reversals

amountdouble

customerIdstringformat: "uuid"

householdIdstringformat: "uuid"

methodstring

createdAtdatetimeOptional

customerobjectOptional

datedatetimeOptional

deletedAtdatetimeOptional

householdobjectOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

notestringOptional

organizationIdstringOptionalformat: "uuid"

readableIdstringOptional

transactionobjectOptional

transactionIdstringOptionalformat: "uuid"

updatedAtdatetimeOptional

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