Job

A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID.

• code:
  string

  A reference identifier for the job. This is an optional field entered when the job is created. For example, it can be used to match Toast platform jobs to jobs configured in external labor management systems.

• createdDate:
  string <date-time>

  Date created, in UTC format (read-only).

• defaultWage:
  number <double>

  The default wage of the job.

• deleted:
  boolean

  If the job is deleted in the Toast platform.

• deletedDate:
  string <date-time>

  Date deleted, in UTC format (read-only).

• entityType required:
  string

  The type of object this is.

• excludeFromReporting:
  boolean

  Indicates whether labor summary reports should include hours and pay for this job. Restaurant employees set this configuration option for a job on the Jobs page of Toast Web.

• externalId:
  string

  External identifier string that is prefixed by the naming authority. You can, for example, use the labor API to POST an externalId for an employee and then GET the employee with that externalId.

• guid required:
  string

  The GUID maintained by the Toast platform.

• modifiedDate:
  string <date-time>

  Date modified, in UTC format (read-only).

• tipped:
  boolean

  Indicates whether the job receives gratuities (tips).

• title:
  string

  Title of the job.

• wageFrequency:
  string

  An enumerated type specifying how to interpret the default wage for this job.

  Enum: "HOURLY" "SALARY"

{
  "guid": "string",
  "entityType": "string",
  "externalId": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "modifiedDate": "2019-08-24T14:15:22Z",
  "deletedDate": "2019-08-24T14:15:22Z",
  "title": "string",
  "deleted": true,
  "wageFrequency": "HOURLY",
  "defaultWage": 0,
  "tipped": true,
  "code": "string",
  "excludeFromReporting": true
}