{

"job_id": 6903,

"slug": "few3z",

"source": "API Request",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"state_id": 3,

"state": {

  "state_id": 3,

  "name": "Finding Service Provider"

},

"state_updated_at": "2019-08-24T14:15:22Z",

"scheduled_start": null,

"scheduled_end": null,

"is_urgent": 0,

"is_emergency": 0,

"job_rating": null,

"job_rated_at": null,

"rating_comments": null,

"order_number": "32423-394823",

"name": "Toilet not flushing",

"description": "Toilet does not seem to get the poops down, no matter how many times it is flushed. Each flush is small; very little water is emitted.",

"vendor_description": "Use your biggest plunger, do not use little plunger.",

"vendor_rating": 5,

"access_instructions": "Look under the door mat; there is a secret entrance.",

"max_cost": 120,

"estimate": 120,

"estimate_note": "Additional parts are needed",

"enter_permission": 0,

"is_vacant": 0,

"is_mandatory": 0,

"is_tenant_caused": 0,

"is_resident_responsible": 0,

"is_archived": 0,

"managed_by": "latchel",

"vendor_locked_in": 0,

"tenant_id": 978,

"pm_id": 0,

"ref_job_id": 2938,

"ref_service_request_id": 2938,

"severity": "normal",

"issue_id": 723,

"vendor_id": 454,

"property_id": 2345

}

Request Body schema: application/json

job_id
integer

Unique ID for Job

slug
string

Unique 5 digit string used to identify Job

source
string

Source of the Job, such as Tenant Web Form, Appfolio Plugin, Internal Web Form, Tenant Call, or API Request

created_at
string

string <date-time>

updated_at
string

string <date-time>

state_id
integer

ID of current Job State

state
object

State object (schemas)

state_updated_at
string

string <date-time>

Date and time of the last state change

scheduled_start
string
default:"null"

Date and time the work is scheduled to start. This, combined with scheduled_end, creates the arrival window for the Vendor.

scheduled_end
string
default:"null"

Date and time the work is scheduled to end. This, combined with scheduled_start, creates the arrival window for the Vendor.

is_urgent
integer
default:"0"

1 or 0 representing if the Job is Urgent severity

is_emergency
integer
default:"0"

1 or 0 representing if the Job is Emergency severity

job_rating
integer
default:"null"

Rating (by Tenant) of the service received

job_rated_at
string
default:"null"

Date and time the Tenant left a Job rating

rating_comments
string
default:"null"

Comments added by Tenant with Job rating

order_number
string

Mutable identifier for the Job

name
string

Human readable name (title)

description
string

Long description of the problem to be solved

vendor_description
string

Description of problem and work to performed, specifically for the Vendor

vendor_rating
integer

Vendor rating given by the tenant for this job

access_instructions
string
default:"null"

Instructions for entering the Property if the Tenant is not present. Access instructions are required to set enter_permission = 1 (see enter_permission for more information).

max_cost
float
default:"null"

Cost Vendor not to exceed for the Job

estimate
float
default:"null"

Estimate amount provided by the vendor

estimate_note
string
default:"null"

Note provided by the vendor explaining the estimate amount

enter_permission
integer
default:"0"

1 or 0 representing if the Vendor has permission to enter the Property if the Tenant is not present. To set enter_permission = 1, access instructions must be included with the request, OR default_access_instructions must be set for the Job’s property (an [INHERITABLE] field).

is_vacant
integer
default:"0"

1 or 0 representing if the Property is vacant

is_mandatory
integer
default:"0"

1 or 0 representing if the Job is mandatory (i.e., the Tenant cannot cancel the Job)

is_tenant_caused
integer
default:"0"

1 or 0 representing if the issue needing repairs was caused by the Tenant

is_resident_responsible
integer
default:"0"

1 or 0 representing if the Tenant is responsible for payment of the Job’s Invoice

is_archived
integer
default:"0"

1 or 0 representing if the Job is archived. While archived, the Job will not show up in search results in the UI

managed_by
string
default:"latchel"

The party currently managing the Job (“latchel” or “pm”)

vendor_locked_in
integer
default:"0"

1 or 0 representing if the Vendor currently assigned to the Job can be changed

tenant_id
integer
default:"null"

ID referencing Tenant the Job is for

pm_id
integer

ID referencing the PropertyManager in charge of Job (defaults to primary User in Property Manager Company)

ref_job_id
string
default:"null"

Reference ID for the Job; use this field to reference the ID of a Job within a 3rd party system (with which you may be integrating).

ref_service_request_id
string
default:"null"

Additional reference ID for the Job used by integrations that implement the concept of service requests

severity
string
default:"normal"

String representing Job severity. Enum: “emergency” “urgent” “normal”

issue_id
integer
default:"null"

ID referencing Issue for Job

vendor_id
integer
default:"null"

ID referencing Vendor assigned to Job

property_id
integer

ID referencing the Property the Job is for

Response

200

Return a 200 status to indicate that the data was received successfully

{

"job_id": 6903,

"slug": "few3z",

"source": "API Request",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"state_id": 3,

"state": {

  "state_id": 3,

  "name": "Finding Service Provider"

},

"state_updated_at": "2019-08-24T14:15:22Z",

"scheduled_start": null,

"scheduled_end": null,

"is_urgent": 0,

"is_emergency": 0,

"job_rating": null,

"job_rated_at": null,

"rating_comments": null,

"order_number": "32423-394823",

"name": "Toilet not flushing",

"description": "Toilet does not seem to get the poops down, no matter how many times it is flushed. Each flush is small; very little water is emitted.",

"vendor_description": "Use your biggest plunger, do not use little plunger.",

"vendor_rating": 5,

"access_instructions": "Look under the door mat; there is a secret entrance.",

"max_cost": 120,

"estimate": 120,

"estimate_note": "Additional parts are needed",

"enter_permission": 0,

"is_vacant": 0,

"is_mandatory": 0,

"is_tenant_caused": 0,

"is_resident_responsible": 0,

"is_archived": 0,

"managed_by": "latchel",

"vendor_locked_in": 0,

"tenant_id": 978,

"pm_id": 0,

"ref_job_id": 2938,

"ref_service_request_id": 2938,

"severity": "normal",

"issue_id": 723,

"vendor_id": 454,

"property_id": 2345

}

Was this page helpful?