Create Deposit

POST

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

POST

/v1/deposits

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

200Successful

{
  "total": 1.1,
  "fiscalPeriod": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "propertyId": "string",
  "organizationId": "string",
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "transactions": [
    {
      "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"
    }
  ]
}

Available by Request

Create a new deposit record for a customer. This endpoint allows you to track security deposits, pet deposits, and other deposit types associated with a lease or rental agreement.

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

Response

The created deposit

totaldoubleOptional

fiscalPeriodstringOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

transactionslist of objectsOptional