Delete Customer

DELETE

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

DELETE

/v1/customers/:customerId

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

Try it

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     "organizationId": "organizationId",
119     "id": "id",
120     "readableId": "readableId",
121     "idempotencyId": "idempotencyId",
122     "createdAt": "2024-01-15T09:30:00Z",
123     "updatedAt": "2024-01-15T09:30:00Z",
124     "deletedAt": "2024-01-15T09:30:00Z",
125     "offboardedAt": "2024-01-15T09:30:00Z",
126     "countyName": "countyName",
127     "acquisitionDate": "2024-01-15T09:30:00Z"
128   },
129   "propertyId": "propertyId",
130   "readableId": "readableId",
131   "relationship": "PARTNER",
132   "reversals": [
133     {
134       "amount": 1.1,
135       "method": "method",
136       "householdId": "householdId",
137       "customerId": "customerId",
138       "date": "2024-01-15T09:30:00Z",
139       "note": "note",
140       "id": "id",
141       "readableId": "readableId",
142       "idempotencyId": "idempotencyId",
143       "createdAt": "2024-01-15T09:30:00Z",
144       "updatedAt": "2024-01-15T09:30:00Z",
145       "deletedAt": "2024-01-15T09:30:00Z",
146       "transactionId": "transactionId",
147       "organizationId": "organizationId"
148     }
149   ],
150   "status": "APPLICANT",
151   "suffix": "suffix",
152   "transactions": [
153     {
154       "id": "id",
155       "readableId": "readableId",
156       "customerId": "customerId",
157       "householdId": "householdId",
158       "propertyId": "propertyId",
159       "organizationId": "organizationId",
160       "depositId": "depositId",
161       "date": "2024-01-15T09:30:00Z",
162       "amount": 1.1,
163       "note": "note",
164       "code": "code",
165       "subjournal": "RESIDENT",
166       "ledger": "RESIDENT",
167       "fiscalPeriod": "fiscalPeriod",
168       "isPaid": true,
169       "type": "CREDIT",
170       "reversedTransactionId": "reversedTransactionId",
171       "runningBalanceAmount": 1.1,
172       "paymentDate": "2024-01-15T09:30:00Z",
173       "createdAt": "2024-01-15T09:30:00Z",
174       "updatedAt": "2024-01-15T09:30:00Z",
175       "deletedAt": "2024-01-15T09:30:00Z"
176     }
177   ],
178   "updatedAt": "2024-01-15T09:30:00Z",
179   "workOrders": [
180     {
181       "status": "OPEN",
182       "priority": "LOW",
183       "hasPetAlert": true,
184       "completedAt": "2024-01-15T09:30:00Z",
185       "requestorPhone": "requestorPhone",
186       "requestorEmail": "requestorEmail",
187       "requestedStartDateFrom": "requestedStartDateFrom",
188       "requestedStartDateTo": "requestedStartDateTo",
189       "requestedStartTimeFrom": "requestedStartTimeFrom",
190       "requestedStartTimeTo": "requestedStartTimeTo",
191       "dueDate": "dueDate",
192       "description": "description",
193       "serviceNotes": "serviceNotes",
194       "vendorNotes": "vendorNotes",
195       "entryNotes": "entryNotes",
196       "entryPreference": "24_HOUR_NOTICE",
197       "isDoorCodeActive": true,
198       "isAlarmActive": true,
199       "doorCode": "doorCode",
200       "alarmCode": "alarmCode",
201       "holdReason": "holdReason",
202       "otherLocationDetail": "otherLocationDetail",
203       "attachmentIds": "attachmentIds",
204       "technicianNotes": "technicianNotes",
205       "previouslyReported": true,
206       "id": "id",
207       "readableId": "readableId",
208       "idempotencyId": "idempotencyId",
209       "createdAt": "createdAt",
210       "updatedAt": "2024-01-15T09:30:00Z",
211       "deletedAt": "2024-01-15T09:30:00Z",
212       "assignedUserId": "assignedUserId",
213       "householdId": "householdId",
214       "customerId": "customerId",
215       "unitId": "unitId",
216       "maintenanceIssueId": "maintenanceIssueId",
217       "maintenanceLocationId": "maintenanceLocationId",
218       "propertyId": "propertyId",
219       "organizationId": "organizationId",
220       "totalCostOfMaterialsUsed": 1.1,
221       "totalAmountOwedByResident": 1.1,
222       "totalAmountOwedByProperty": 1.1,
223       "hourlyServiceRate": 1.1,
224       "totalLaborCost": 1.1
225     }
226   ]
227 }

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 objects or null

attachmentslist of objects or null

birthDatestring or nullformat: "date"

createdAtdatetime or null

deletedAtdatetime or null

emailstring or null

firstNamestring or null

genderstring or null

glEntrieslist of objects or null

headOfHouseholdboolean or null

Indicates whether the customer is the head of household

householdobject or null

householdIdstring or nullformat: "uuid"

idstring or nullformat: "uuid"

idempotencyIdstring or nullformat: "uuid"

lastNamestring or null

middleNamestring or null

organizationIdstring or nullformat: "uuid"

phonestring or null

preferredNamestring or null

propertyobject or null

propertyIdstring or nullformat: "uuid"

readableIdstring or null

relationshipenum or null

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

reversalslist of objects or null

statusenum or null

Allowed values:

suffixstring or null

transactionslist of objects or null

updatedAtdatetime or null

workOrderslist of objects or null