List Deposit Transactions

GET

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

GET

/v1/deposits/:depositId/transactions

curl https://api.fortresstech.io/v1/deposits/depositId/transactions \
     -H "x-api-key: <apiKey>"

200Retrieved

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

List the transactions associated with a deposit

Authentication

x-api-keystring

API Key authentication via header

Path parameters

depositIdstringRequiredformat: "uuid"

The id of the deposit

Response

A paged array of the deposit's transactions

idstringOptionalformat: "uuid"

readableIdstringOptional

The readable ID for the transaction

customerIdstringOptionalformat: "uuid"

The ID of the customer associated with the transaction

householdIdstringOptionalformat: "uuid"

The ID of the household associated with the transaction

propertyIdstringOptionalformat: "uuid"

The ID of the property associated with the transaction

organizationIdstringOptionalformat: "uuid"

The ID of the organization associated with the transaction

depositIdstringOptionalformat: "uuid"

The ID of the deposit associated with the transaction

datedatetimeOptional

amountdoubleOptional

notestringOptional

Notes about the transaction

codestringOptional

The code for the transaction

subjournalenumOptional

The subjournal for the transaction

Allowed values:

ledgerenumOptional

The ledger for the transaction

Allowed values:

fiscalPeriodstringOptional

The fiscal period for the transaction

isPaidbooleanOptional

Whether the transaction is paid

typeenumOptional

The type of the transaction

reversedTransactionIdstringOptionalformat: "uuid"

The ID of the reversed transaction

runningBalanceAmountdoubleOptional

The running balance amount after the transaction

paymentDatedatetimeOptional

The date the charge was paid

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

householdobjectOptional