{
  "job_id": "string",
  "data": {}
}

Body

integration_idrequired
string
property_id
string

The Propify unique identifier for the property

unit_id
string

The Propify unique identifier for the unit

task_title
string

Title assigned to the request. Maps to the "Title" field in the PMS

work_details
string

The description of the work order. Maps to the "description" field in the PMS

permission_to_enter
boolean

Indicates whether entry has been allowed to the unit. Maps to the "IsAllowedToEnter" field in the PMS

assigned_to_id
string

The unique identifier of the user assigned to the work order. Maps to the "assignedToUserID" field in the PMS

due_date
string

The due date assigned to the request. Maps to the "DueDate" field in the PMS

entry_details
string

Notes specific to entering the unit. Maps to the "EntryNotes" field in the PMS

invoice_number
string

The invoice or reference number that the vendor assigned to the work order. Maps to the "InvoiceNumber" field in the PMS

priority
string

The priority of the work order, either low, medium, or high

status
string

The current status of the work order

vendor_notes
string

Instructions for the vendor. Maps to the "vendorInstructions" field in the PMS

x_property_id
string

The external ID of the property from the integration vendor

x_resident_id
string

The unique identifier of the resident associated with the work order. Maps to the "requestedByContactID" field in the PMS

x_unit_id
string

The unique identifier of the unit associated with the work order. Maps to the "unitID" field in the PMS

x_vendor_id
string

The unique identifier of the vendor associated with the work order. Maps to the "vendorContactID" field in the PMS

custom_data
object

Custom data

building_name
string

The name of the building associated with the request. Maps to the "buildingName" field in the PMS

category_id
string

The unique identifier of the category associated with the request. Maps to the "CategoryID" field in the PMS

is_floating
boolean

Indicates if work order is floating. Required to be true if there is no associated lease or resident. Maps to the "isFloatingWorkOrder" field in the PMS

location_id
string

The unique identifier of the location associated with the request. Maps to the "maintenanceLocationId" field in the PMS

main_phone
string

The main phone number associated with the request. Maps to the "mainPhoneNumber" field in the PMS

pet_details
string

Pet details are required if the lease has pets or if permission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given. Maps to the "petsDescription" field in the PMS

priority_id
string

The unique identifier of work order priority. Maps to the "priorityID" field in the PMS

problem_id
string

The unique identifier of the problem associated with the request. Maps to the "maintenanceProblemId" field in the PMS

scheduled_end_date
string

The scheduled end date of the work order. Maps to the "scheduledEndDate" field in the PMS

scheduled_start_date
string

The scheduled start date of the work order. Maps to the "scheduledStartDate" field in the PMS

sub_problem_id
string

The unique identifier of the sub problem associated with the request. Maps to the "subMaintenanceProblemId" field in the PMS

unit_number
string

The unit number associated with the request. Maps to the "unitNumber" field in the PMS

x_lease_id
string

The unique identifier of the lease associated with the work order. Maps to the "leaseID" field in the PMS

vendor_id
string

The Propify unique identifier for the vendor

lease_id
string

The Propify unique identifier for the lease

requested_by
string

The name of the person who requested the work order

total_cost_in_cents
number

The total cost in cents

category
string

The category used to classify the work order

completed_date
string

The date the work order was completed

created_date
string

The date the work order was created

entry_date
string

The date to enter the property

problem
string

Description of the problem

total_time_in_minutes
number

The total hours worked in minutes

type
string

The type of work order: General, Service Request, Turnover, Inpsection, or Estimate

Available options:
General,
Service Request,
Turnover,
Inspection,
Estimate
status_id
string

The unique identifier of work order status. Maps to the "workOrderStatusID" field in the PMS

invoice_amount
integer

The estimated amount in cents for the work order. Maps to the "estimatedAmount" field in the PMS

Response

job_idrequired
string

The ID of the job created to handle this operation

datarequired
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.