Create Transactions

POST

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

POST

/v1/transactions

curl -X POST https://api.fortresstech.io/v1/transactions \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {}
]'

200Successful

[
  {
    "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"
    }
  }
]

Available by Request

Create one or more transactions for households or applications. Transactions can include charges, payments, credits, and other financial records. At least one of householdId or applicationId must be provided for each transaction.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring

API Key authentication via header

Request

Array of transactions to create

idempotencyIdstringOptionalformat: "uuid"

codestringOptional

The code for the transaction

datedatetimeOptional

The date of the transaction

amountdoubleOptional

The amount of the transaction

documentNumberstringOptional<=255 characters

The document number for the transaction

notesstringOptional<=255 characters

Notes about the transaction

orderintegerOptional

The order of the transaction in the list

transactionIdstringOptionalformat: "uuid"

Optional transaction ID

customerIdstringOptionalformat: "uuid"

The customerId field is required when the transaction is associated with a household member other than the head of household.

householdIdstringOptionalformat: "uuid"

At least one of householdId or applicationId must be provided with each transaction.

applicationIdstringOptionalformat: "uuid"

At least one of householdId or applicationId must be provided with each transaction.

Response

The created transaction(s)

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