Create Deposit

POST

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

POST

/v1/deposits

$ curl -X POST https://api.fortresstech.io/v1/deposits

200Successful

1 {
2   "createdAt": "2024-01-15T09:30:00Z",
3   "deletedAt": "2024-01-15T09:30:00Z",
4   "fiscalPeriod": "fiscalPeriod",
5   "id": "id",
6   "idempotencyId": "idempotencyId",
7   "organizationId": "organizationId",
8   "property": {
9     "name": "name",
10     "shortName": "shortName",
11     "email": "email",
12     "phone": "phone",
13     "physicalStreetAddress1": "physicalStreetAddress1",
14     "physicalStreetAddress2": "physicalStreetAddress2",
15     "physicalCity": "physicalCity",
16     "physicalState": "physicalState",
17     "physicalZip": "physicalZip",
18     "physicalCountry": "physicalCountry",
19     "mailingStreetAddress1": "mailingStreetAddress1",
20     "mailingStreetAddress2": "mailingStreetAddress2",
21     "mailingCity": "mailingCity",
22     "mailingState": "mailingState",
23     "mailingZip": "mailingZip",
24     "mailingCountry": "mailingCountry",
25     "phoneNumber": "phoneNumber",
26     "faxNumber": "faxNumber",
27     "timezone": "timezone",
28     "longitude": 1.1,
29     "latitude": 1.1,
30     "turnMoveOutDays": 1,
31     "status": "ACTIVE",
32     "propertyClass": "Conventional",
33     "organizationId": "organizationId",
34     "id": "id",
35     "readableId": "readableId",
36     "idempotencyId": "idempotencyId",
37     "createdAt": "2024-01-15T09:30:00Z",
38     "updatedAt": "2024-01-15T09:30:00Z",
39     "deletedAt": "2024-01-15T09:30:00Z",
40     "offboardedAt": "2024-01-15T09:30:00Z",
41     "countyName": "countyName",
42     "acquisitionDate": "2024-01-15T09:30:00Z"
43   },
44   "propertyId": "propertyId",
45   "readableId": "readableId",
46   "total": 1.1,
47   "transactions": [
48     {
49       "id": "id",
50       "readableId": "readableId",
51       "customerId": "customerId",
52       "householdId": "householdId",
53       "propertyId": "propertyId",
54       "organizationId": "organizationId",
55       "depositId": "depositId",
56       "date": "2024-01-15T09:30:00Z",
57       "amount": 1.1,
58       "note": "note",
59       "code": "code",
60       "subjournal": "RESIDENT",
61       "ledger": "RESIDENT",
62       "fiscalPeriod": "fiscalPeriod",
63       "isPaid": true,
64       "type": "CREDIT",
65       "reversedTransactionId": "reversedTransactionId",
66       "runningBalanceAmount": 1.1,
67       "paymentDate": "2024-01-15T09:30:00Z",
68       "createdAt": "2024-01-15T09:30:00Z",
69       "updatedAt": "2024-01-15T09:30:00Z",
70       "deletedAt": "2024-01-15T09:30:00Z"
71     }
72   ],
73   "updatedAt": "2024-01-15T09:30:00Z"
74 }

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.

<Badge>Available by Request</Badge> 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. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Response

The created deposit

createdAtdatetimeOptional

deletedAtdatetimeOptional

fiscalPeriodstringOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

totaldoubleOptional

transactionslist of objectsOptional

updatedAtdatetimeOptional