Create Service Request: Propertyware

POSThttps://api.propexo.com/v1/service-requests/propertyware/

Method
createWorkOrder

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

• AuthorizationBearer
  Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringrequired

The Propexo unique identifier for the integration

property_idstringrequired

The Propexo unique identifier for the property

unit_idstring

The Propexo unique identifier for the unit

vendor_idstring

The Propexo unique identifier for the vendor

lease_idstring

The Propexo unique identifier for the lease

access_is_authorizedboolean

Whether or not the tenant has granted permission to enter the unit associated with the service request

service_descriptionstring

A description of the service request

service_categorystring

The category of service request

date_completedstring<date-time>

The date the service request was completed

date_createdstring<date-time>

The date the service request was created

service_detailsstring

Details about the service request

date_duestring<date-time>

The due date associated with the service request

date_scheduledstring<date-time>

The date the service request is scheduled

status_rawstring

The status associated with the work order

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

integration_idstringrequired

The Propexo unique identifier for the integration

property_idstringrequired

The Propexo unique identifier for the property

unit_idstring | nullnullablerequired

The Propexo unique identifier for the unit

vendor_idstring | nullnullablerequired

The Propexo unique identifier for the vendor

lease_idstring | nullnullablerequired

The Propexo unique identifier for the lease

access_is_authorizedboolean | nullnullablerequired

Whether or not the tenant has granted permission to enter the unit associated with the service request

service_descriptionstring | nullnullablerequired

A description of the service request

service_categorystring | nullnullablerequired

The category of service request

date_completed(string | null)<date-time>nullablerequired

The date the service request was completed

date_created(string | null)<date-time>nullablerequired

The date the service request was created

service_detailsstring | nullnullablerequired

Details about the service request

date_due(string | null)<date-time>nullablerequired

The due date associated with the service request

date_scheduled(string | null)<date-time>nullablerequired

The date the service request is scheduled

status_rawstring | nullnullablerequired

The status associated with the work order

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/service-requests/propertyware/

curl -X POST https://api.propexo.com/v1/service-requests/propertyware/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "property_id": "string"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "property_id": "string",
    "unit_id": "string",
    "vendor_id": "string",
    "lease_id": "string",
    "access_is_authorized": true,
    "service_description": "string",
    "service_category": "string",
    "date_completed": "2024-07-29T15:51:28.071Z",
    "date_created": "2024-07-29T15:51:28.071Z",
    "service_details": "string",
    "date_due": "2024-07-29T15:51:28.071Z",
    "date_scheduled": "2024-07-29T15:51:28.071Z",
    "status_raw": "string"
  }
}