Update Work Order

Update information for a specific work order

Path parameters

workOrderIdstringRequired

The id of the work order

Request

This endpoint expects an object.

maintenanceIssueIdstringRequiredformat: "uuid"

ID from the maintenance issue api response.

maintenanceLocationIdstringRequiredformat: "uuid"

ID from the maintenance location api response.

maintenanceLocationTypeenumRequired

Indicates the type of location. Used to conditionally require certain fields (e.g., unitId, householdId).

Allowed values:

priorityenumRequired

Allowed values:

updatedBystringRequiredformat: "uuid"

alarmCodestringOptional

The alarm code for the location.

customerIdstringOptionalformat: "uuid"

ID from the Customer table. Required if maintenanceLocationType is UNIT.

descriptionstringOptional<=500 characters

doorCodestringOptional

The door code for the location.

dueDatestringOptionalformat: "date"

The due date for the work order.

entryNotesstringOptional<=500 characters

entryPreferenceenumOptional

Allowed values:

hasPetAlertbooleanOptional

Indicates if there are pets at the location.

holdReasonstringOptional

hourlyServiceRatedoubleOptional

The hourly service rate.

householdIdstringOptionalformat: "uuid"

Required if maintenanceLocationType is UNIT.

isAlarmActivebooleanOptional

Indicates if the alarm is active.

isDoorCodeActivebooleanOptional

Indicates if the door code is active.

otherLocationDetailsstringOptional<=100 characters

previouslyReportedbooleanOptional

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

readableIdstringOptional

requestedStartDateFromstringOptionalformat: "date"

requestedStartDateTostringOptionalformat: "date"

requestedStartTimeFromstringOptional

Time format string (HH:mm:ss or similar)

requestedStartTimeTostringOptional

Time format string (HH:mm:ss or similar)

requestorEmailstringOptionalformat: "email"<=100 characters

requestorNamestringOptional<=100 characters

requestorPhonestringOptional<=15 characters

serviceNotesstringOptional<=500 characters

technicianNotesstringOptional

Notes to the technician.

totalAmountOwedByResidentdoubleOptional

The total amount owed by the resident.

totalCostOfMaterialsUseddoubleOptional

The total cost of materials used.

unitIdstringOptionalformat: "uuid"

Required if maintenanceLocationType is UNIT.

vendorNotesstringOptional<=500 characters

Response

Expected response to a valid request

statusenum

Allowed values:

priorityenum

Allowed values:

hasPetAlertboolean

completedAtdatetime

requestorPhonestring

requestorEmailstring

requestedStartDateFromstringformat: "date"

requestedStartDateTostringformat: "date"

requestedStartTimeFromstring

requestedStartTimeTostring

dueDatestringformat: "date"

descriptionstring<=500 characters

serviceNotesstring<=2000 characters

vendorNotesstring<=2000 characters

entryNotesstring<=500 characters

entryPreferenceenum

Allowed values:

isDoorCodeActiveboolean

isAlarmActiveboolean

doorCodestring

alarmCodestring

holdReasonstring

otherLocationDetailstring<=500 characters

attachmentIdsstringformat: "uuid"

technicianNotesstring<=500 characters

Notes to the technician.

previouslyReportedboolean

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

idstringformat: "uuid"

readableIdstring

idempotencyIdstringformat: "uuid"

createdAtstring

updatedAtdatetime

deletedAtdatetime

assignedUserIdstringformat: "uuid"

householdIdstringformat: "uuid"

customerIdstringformat: "uuid"

unitIdstringformat: "uuid"

maintenanceIssueIdstringformat: "uuid"

maintenanceLocationIdstringformat: "uuid"

propertyIdstringformat: "uuid"

organizationIdstringformat: "uuid"

totalCostOfMaterialsUseddouble

The total cost of materials used.

totalAmountOwedByResidentdouble

The total amount owed by the resident.

totalAmountOwedByPropertydouble

The total amount owed by the property.

hourlyServiceRatedouble

The hourly service rate.

totalLaborCostdouble

The total labor cost.

$	curl -X PUT https://api.fortresstech.io/v1/workOrders/workOrderId \
>	-H "Content-Type: application/json" \
>	-d '{
>	"maintenanceIssueId": "maintenanceIssueId",
>	"maintenanceLocationId": "maintenanceLocationId",
>	"maintenanceLocationType": "COMMON_AREA",
>	"priority": "LOW",
>	"updatedBy": "updatedBy"
>	}'

1	{
2	"status": "OPEN",
3	"priority": "LOW",
4	"hasPetAlert": true,
5	"completedAt": "2024-01-15T09:30:00Z",
6	"requestorPhone": "requestorPhone",
7	"requestorEmail": "requestorEmail",
8	"requestedStartDateFrom": "requestedStartDateFrom",
9	"requestedStartDateTo": "requestedStartDateTo",
10	"requestedStartTimeFrom": "requestedStartTimeFrom",
11	"requestedStartTimeTo": "requestedStartTimeTo",
12	"dueDate": "dueDate",
13	"description": "description",
14	"serviceNotes": "serviceNotes",
15	"vendorNotes": "vendorNotes",
16	"entryNotes": "entryNotes",
17	"entryPreference": "24_HOUR_NOTICE",
18	"isDoorCodeActive": true,
19	"isAlarmActive": true,
20	"doorCode": "doorCode",
21	"alarmCode": "alarmCode",
22	"holdReason": "holdReason",
23	"otherLocationDetail": "otherLocationDetail",
24	"attachmentIds": "attachmentIds",
25	"technicianNotes": "technicianNotes",
26	"previouslyReported": true,
27	"id": "id",
28	"readableId": "readableId",
29	"idempotencyId": "idempotencyId",
30	"createdAt": "createdAt",
31	"updatedAt": "2024-01-15T09:30:00Z",
32	"deletedAt": "2024-01-15T09:30:00Z",
33	"assignedUserId": "assignedUserId",
34	"householdId": "householdId",
35	"customerId": "customerId",
36	"unitId": "unitId",
37	"maintenanceIssueId": "maintenanceIssueId",
38	"maintenanceLocationId": "maintenanceLocationId",
39	"propertyId": "propertyId",
40	"organizationId": "organizationId",
41	"totalCostOfMaterialsUsed": 1.1,
42	"totalAmountOwedByResident": 1.1,
43	"totalAmountOwedByProperty": 1.1,
44	"hourlyServiceRate": 1.1,
45	"totalLaborCost": 1.1
46	}