Complete Work Order

PATCH

https://api.fortresstech.io/v1/workOrders/:workOrderId/complete

PATCH

/v1/workOrders/:workOrderId/complete

1 import requests
2 
3 url = "https://api.fortresstech.io/v1/workOrders/workOrderId/complete"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.patch(url, json=payload, headers=headers)
9 
10 print(response.json())

Try it

200Updated

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

Mark a work order with the status "Completed"

Path parameters

workOrderIdstringRequired

The id of the work order

Request

This endpoint expects an object.

thirdPartyVendorNotesstringOptional

Notes from the third party vendor after the service is completed

assigneeNoteAfterServicestringOptional

Notes from the user after the service is completed

serviceLogslist of objectsOptional

Logs from the service

sendEmailNotificationbooleanOptionalDefaults to false

Whether to send an email notification to the customer

sendTextNotificationbooleanOptionalDefaults to false

Whether to send a text notification to the customer

Response

The updated work order

alarmCodestring or null

assignedUserIdstring or nullformat: "uuid"

attachmentIdsstring or nullformat: "uuid"

attachmentslist of objects or null

completedAtdatetime or null

createdAtstring or null

customerobject or null

customerIdstring or nullformat: "uuid"

deletedAtdatetime or null

descriptionstring or null<=500 characters

doorCodestring or null

dueDatestring or nullformat: "date"

entryNotesstring or null<=500 characters

entryPreferenceenum or null

Allowed values:

hasPetAlertboolean or null

holdReasonstring or null

hourlyServiceRatedouble or null

The hourly service rate.

householdobject or null

householdIdstring or nullformat: "uuid"

idstring or nullformat: "uuid"

idempotencyIdstring or nullformat: "uuid"

isAlarmActiveboolean or null

isDoorCodeActiveboolean or null

maintenanceIssueobject or null

maintenanceIssueIdstring or nullformat: "uuid"

maintenanceLocationobject or null

maintenanceLocationIdstring or nullformat: "uuid"

organizationIdstring or nullformat: "uuid"

otherLocationDetailstring or null<=500 characters

previouslyReportedboolean or null

If the Issue was previously reported, this will be true.

priorityenum or null

Allowed values:

propertyobject or null

propertyIdstring or nullformat: "uuid"

readableIdstring or null

requestedStartDateFromstring or nullformat: "date"

requestedStartDateTostring or nullformat: "date"

requestedStartTimeFromstring or null

requestedStartTimeTostring or null

requestorEmailstring or null

requestorPhonestring or null

serviceNotesstring or null<=2000 characters

statusenum or null

Allowed values:

technicianNotesstring or null<=500 characters

Notes to the technician.

totalAmountOwedByPropertydouble or null

The total amount owed by the property.

totalAmountOwedByResidentdouble or null

The total amount owed by the resident.

totalCostOfMaterialsUseddouble or null

The total cost of materials used.

totalLaborCostdouble or null

The total labor cost.

unitobject or null

unitIdstring or nullformat: "uuid"

updatedAtdatetime or null

userobject or null

vendorNotesstring or null<=2000 characters