Delete Customer

DELETE

https://api.fortresstech.io/v1/customers/:customerId

DELETE

/v1/customers/:customerId

$ curl -X DELETE https://api.fortresstech.io/v1/customers/customerId

200Deleted

1 {
2   "assets": [
3     {
4       "customerId": "customerId",
5       "type": "CASH",
6       "marketValue": 1.1,
7       "interestRate": 1.1,
8       "cashConversionFee": 1.1,
9       "id": "id",
10       "readableId": "readableId",
11       "idempotencyId": "idempotencyId",
12       "createdAt": "2024-01-15T09:30:00Z",
13       "updatedAt": "2024-01-15T09:30:00Z",
14       "deletedAt": "2024-01-15T09:30:00Z"
15     }
16   ],
17   "attachments": [
18     {
19       "name": "name",
20       "url": "url",
21       "type": "ISSUE",
22       "createdAt": "2024-01-15T09:30:00Z",
23       "updatedAt": "2024-01-15T09:30:00Z",
24       "workOrderId": "workOrderId",
25       "propertyId": "propertyId",
26       "organizationId": "organizationId",
27       "notes": "notes",
28       "id": "id",
29       "readableId": "readableId",
30       "idempotencyId": "idempotencyId",
31       "deletedAt": "2024-01-15T09:30:00Z",
32       "householdId": "householdId",
33       "customerId": "customerId"
34     }
35   ],
36   "birthDate": "birthDate",
37   "createdAt": "2024-01-15T09:30:00Z",
38   "deletedAt": "2024-01-15T09:30:00Z",
39   "email": "email",
40   "firstName": "firstName",
41   "gender": "gender",
42   "glEntries": [
43     {
44       "amount": 1.1,
45       "note": "note",
46       "date": "2024-01-15T09:30:00Z",
47       "creditAmount": 1.1,
48       "debitAmount": 1.1,
49       "accountNumber": "accountNumber",
50       "fiscalPeriod": "fiscalPeriod",
51       "id": "id",
52       "readableId": "readableId",
53       "idempotencyId": "idempotencyId",
54       "createdAt": "2024-01-15T09:30:00Z",
55       "updatedAt": "2024-01-15T09:30:00Z",
56       "deletedAt": "2024-01-15T09:30:00Z",
57       "householdId": "householdId",
58       "customerId": "customerId",
59       "propertyId": "propertyId",
60       "organizationId": "organizationId",
61       "transactionId": "transactionId"
62     }
63   ],
64   "headOfHousehold": true,
65   "household": {
66     "status": "APPLICANT",
67     "isUnderEviction": true,
68     "id": "id",
69     "readableId": "readableId",
70     "idempotencyId": "idempotencyId",
71     "createdAt": "2024-01-15T09:30:00Z",
72     "updatedAt": "2024-01-15T09:30:00Z",
73     "deletedAt": "2024-01-15T09:30:00Z",
74     "currentUnitId": "currentUnitId",
75     "currentLeaseId": "currentLeaseId",
76     "applicationId": "applicationId",
77     "organizationId": "organizationId",
78     "propertyId": "propertyId",
79     "currentCertificationId": "currentCertificationId",
80     "prospectId": "prospectId",
81     "primaryCustomerId": "primaryCustomerId",
82     "totalActiveRentAmount": 1.1,
83     "totalActiveSubsidyAmount": 1.1,
84     "totalActiveFeesAmount": 1.1,
85     "unitId": "unitId"
86   },
87   "householdId": "householdId",
88   "id": "id",
89   "idempotencyId": "idempotencyId",
90   "lastName": "lastName",
91   "middleName": "middleName",
92   "organizationId": "organizationId",
93   "phone": "phone",
94   "preferredName": "preferredName",
95   "property": {
96     "name": "name",
97     "shortName": "shortName",
98     "email": "email",
99     "phone": "phone",
100     "physicalStreetAddress1": "physicalStreetAddress1",
101     "physicalStreetAddress2": "physicalStreetAddress2",
102     "physicalCity": "physicalCity",
103     "physicalState": "physicalState",
104     "physicalZip": "physicalZip",
105     "physicalCountry": "physicalCountry",
106     "mailingStreetAddress1": "mailingStreetAddress1",
107     "mailingStreetAddress2": "mailingStreetAddress2",
108     "mailingCity": "mailingCity",
109     "mailingState": "mailingState",
110     "mailingZip": "mailingZip",
111     "mailingCountry": "mailingCountry",
112     "phoneNumber": "phoneNumber",
113     "faxNumber": "faxNumber",
114     "timezone": "timezone",
115     "longitude": 1.1,
116     "latitude": 1.1,
117     "turnMoveOutDays": 1,
118     "status": "ACTIVE",
119     "propertyClass": "Conventional",
120     "organizationId": "organizationId",
121     "id": "id",
122     "readableId": "readableId",
123     "idempotencyId": "idempotencyId",
124     "createdAt": "2024-01-15T09:30:00Z",
125     "updatedAt": "2024-01-15T09:30:00Z",
126     "deletedAt": "2024-01-15T09:30:00Z",
127     "offboardedAt": "2024-01-15T09:30:00Z",
128     "countyName": "countyName",
129     "acquisitionDate": "2024-01-15T09:30:00Z"
130   },
131   "propertyId": "propertyId",
132   "readableId": "readableId",
133   "relationship": "PARTNER",
134   "reversals": [
135     {
136       "amount": 1.1,
137       "method": "method",
138       "householdId": "householdId",
139       "customerId": "customerId",
140       "date": "2024-01-15T09:30:00Z",
141       "note": "note",
142       "id": "id",
143       "readableId": "readableId",
144       "idempotencyId": "idempotencyId",
145       "createdAt": "2024-01-15T09:30:00Z",
146       "updatedAt": "2024-01-15T09:30:00Z",
147       "deletedAt": "2024-01-15T09:30:00Z",
148       "transactionId": "transactionId",
149       "organizationId": "organizationId"
150     }
151   ],
152   "status": "APPLICANT",
153   "suffix": "suffix",
154   "transactions": [
155     {
156       "id": "id",
157       "readableId": "readableId",
158       "customerId": "customerId",
159       "householdId": "householdId",
160       "propertyId": "propertyId",
161       "organizationId": "organizationId",
162       "depositId": "depositId",
163       "date": "2024-01-15T09:30:00Z",
164       "amount": 1.1,
165       "note": "note",
166       "code": "code",
167       "subjournal": "RESIDENT",
168       "ledger": "RESIDENT",
169       "fiscalPeriod": "fiscalPeriod",
170       "isPaid": true,
171       "type": "CREDIT",
172       "reversedTransactionId": "reversedTransactionId",
173       "runningBalanceAmount": 1.1,
174       "paymentDate": "2024-01-15T09:30:00Z",
175       "createdAt": "2024-01-15T09:30:00Z",
176       "updatedAt": "2024-01-15T09:30:00Z",
177       "deletedAt": "2024-01-15T09:30:00Z"
178     }
179   ],
180   "updatedAt": "2024-01-15T09:30:00Z",
181   "workOrders": [
182     {
183       "status": "OPEN",
184       "priority": "LOW",
185       "hasPetAlert": true,
186       "completedAt": "2024-01-15T09:30:00Z",
187       "requestorPhone": "requestorPhone",
188       "requestorEmail": "requestorEmail",
189       "requestedStartDateFrom": "requestedStartDateFrom",
190       "requestedStartDateTo": "requestedStartDateTo",
191       "requestedStartTimeFrom": "requestedStartTimeFrom",
192       "requestedStartTimeTo": "requestedStartTimeTo",
193       "dueDate": "dueDate",
194       "description": "description",
195       "serviceNotes": "serviceNotes",
196       "vendorNotes": "vendorNotes",
197       "entryNotes": "entryNotes",
198       "entryPreference": "24_HOUR_NOTICE",
199       "isDoorCodeActive": true,
200       "isAlarmActive": true,
201       "doorCode": "doorCode",
202       "alarmCode": "alarmCode",
203       "holdReason": "holdReason",
204       "otherLocationDetail": "otherLocationDetail",
205       "attachmentIds": "attachmentIds",
206       "technicianNotes": "technicianNotes",
207       "previouslyReported": true,
208       "id": "id",
209       "readableId": "readableId",
210       "idempotencyId": "idempotencyId",
211       "createdAt": "createdAt",
212       "updatedAt": "2024-01-15T09:30:00Z",
213       "deletedAt": "2024-01-15T09:30:00Z",
214       "assignedUserId": "assignedUserId",
215       "householdId": "householdId",
216       "customerId": "customerId",
217       "unitId": "unitId",
218       "maintenanceIssueId": "maintenanceIssueId",
219       "maintenanceLocationId": "maintenanceLocationId",
220       "propertyId": "propertyId",
221       "organizationId": "organizationId",
222       "totalCostOfMaterialsUsed": 1.1,
223       "totalAmountOwedByResident": 1.1,
224       "totalAmountOwedByProperty": 1.1,
225       "hourlyServiceRate": 1.1,
226       "totalLaborCost": 1.1
227     }
228   ]
229 }

Available by Request

Remove a customer from the system. This is typically used when a customer record needs to be deleted due to data correction or removal requests.

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

<Badge>Available by Request</Badge> Remove a customer from the system. This is typically used when a customer record needs to be deleted due to data correction or removal requests. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

customerIdstringRequired

The id of the customer

Response

Expected response to a valid request

assetslist of objectsOptional

attachmentslist of objectsOptional

birthDatestringOptionalformat: "date"

createdAtdatetimeOptional

deletedAtdatetimeOptional

emailstringOptional

firstNamestringOptional

genderstringOptional

glEntrieslist of objectsOptional

headOfHouseholdbooleanOptional

Indicates whether the customer is the head of household

householdobjectOptional

householdIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

lastNamestringOptional

middleNamestringOptional

organizationIdstringOptionalformat: "uuid"

phonestringOptional

preferredNamestringOptional

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

relationshipenumOptional

Relationship of the customer to the head of household (null for head of household)

reversalslist of objectsOptional

statusenumOptional

suffixstringOptional

transactionslist of objectsOptional

updatedAtdatetimeOptional

workOrderslist of objectsOptional