WorkOrders

Post Work Order

Create a new Work Order in Alto

post/work-orders

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/work-orders
  • Auth: appAuth (a scheme the document does not define)

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Request body

propertyIdstring required

The unique identifier for the property associated with the work order.

summarystring required

The title of the work order.

descriptionstring nullable

A detailed description of the work order.

notesstring nullable

Additional notes.

prioritystring required

The priority level of the work order.

reportedDatestring required

The date the work order was reported.

startDatestring nullable

The preferred start date for the works to be carried out.

supplierContactIdstring nullable

The unique identifier for the supplier (recorded in Alto) who will carry out the works.

quotenumber double nullable

The estimated cost of the works.

negotiatorIdstring nullable

The unique identifier of the negotiator

Example request

{
  "negotiatorId": "1234"
}

Response

Returns the new Work Order

idstring nullable

Id of the Work Order

propertyIdstring nullable

The unique identifier for the Property associated with the Work Order.

supplierContactIdstring nullable

The unique identifier for the Supplier associated with the Work Order.

reportedDatestring date-time

The date the Work Order was reported.

startDatestring date-time nullable

The preferred start date for the work to be carried out.

quotenumber double nullable

The estimated cost of the work

workOrderNumberstring nullable

Unique Work Order reference number

statusstring nullable

Current status of the Work Order

summarystring nullable

The title of the Work Order.

descriptionstring nullable

A detailed description of the Work Order.

notesstring nullable

Additional notes.

prioritystring nullable

The priority level of the Work Order.

modifiedDatestring date-time nullable

The date the Work Order was last modified.

Changes

No recorded changes to this operation across all 1 revision of this API.