Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Jobs

Create a Job

Adds a new job record to the system.

post/v1/job

Query parameters

encodingstring nullable

The encoding type for the job description.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

idinteger

The identifier for the job.

companyIdinteger required

The identifier for the company.

branchIdinteger required

The identifier for the company branch or department.

frontOfficeIdinteger required

The identifier for the job's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the <a href="https://developer.avionte.com/reference/getbranches">Get Branches</a> endpoint to retrieve the ID.

contactIdinteger required

The identifier for the company contact.

worksiteAddressIdinteger required

The identifier for the worksite address.

positionsinteger required

The number of positions.

startDatestring date-time required

The estimated start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endDatestring date-time

The estimated end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

estimatedHoursinteger

The estimated amount of time the job requires.

targetBillRatenumber

The target bill rate for the job.

targetPayRatenumber

The target pay rate for the job.

overtimeType'StraightTime' | 'PaidAndBilledOT' | 'PaidNotBilledOT'

The overtime types available for selection for a job.

expenseType'None' | 'PaidAndBilled' | 'PaidNotBilled'

The expense types available for selection for a job.

overtimeRuleIdinteger

The identifier for the overtime rule.

useCustomOTRatesboolean

A flag indicating custom overtime rates can be used.

overtimeBillRatenumber

The overtime bill rate value.

overtimePayRatenumber

The overtime pay rate value.

doubletimeBillRatenumber

The double time bill rate value.

doubletimePayRatenumber

The double time pay rate value.

maxBillRatenumber

The maximum bill rate value.

minBillRatenumber

The minimum bill rate value.

maxPayRatenumber

The maximum pay rate value.

minPayRatenumber

The minimum pay rate value.

rateType'HourlyRate' | 'DailyRate'

The rate types available for selection for a job.

weekDuration'MondayToSunday' | 'SundayToSaturday' | 'SaturdayToFriday'

The week duration options available for a job.

markupPercentagenumber

The mark-up percentage value.

billingManagerIdinteger

The identifier for the billing manager for the job.

billingNamestring

The name of the billing contact.

billingAddress1string

Billing address, line 1.

billingAddress2string

Billing address, line 2.

billingCitystring

Billing city.

billingStatestring

Billing state.

billingZipstring

Billing ZIP/postal code.

billingPhonestring

Billing contact phone.

billingEmailstring

Billing contact email.

billingTerm'DueUponReceipt' | 'Net7' | 'Net10' | 'Net15' | 'Net20' | 'Net30' | 'Net35' | 'Net45' | 'Net60' | 'Net65' | 'Net90' | 'Net120' | 'Net135'

The billing term options available for a job used for invoicing a customer. Options include "DueUponReceipt" and NetN terms, where N is the number of days in which the payment is due. For example, Net7 creates an invoice due 7 days after the date of the invoice.

placementFeenumber

The placement fee for the job.

placementPercentagenumber float

The placement percentage for the job.

titlestring required

The title for the job.

positionCategoryIdinteger

The identifier for the position category.

costCenterstring

The company's cost center.

divisionstring

The company's division.

departmentstring

The company department name.

workerCompCodeIdinteger

The identifier for the worker's comp code.

statusIdinteger required

The identifier for the job order status.

orderTypeIdinteger required

The identifier for the job type.

salesRepUserIdinteger

The identifier for the sales representative user for the job.

ownerUserIdinteger required

The identifier for the user who created a job.

descriptionstring

The job description.

notesstring

The job notes.

originstring required

The partner or vendor that originated the request.

isArchivedboolean

An indication of whether the job record is archived or not.

startTimeLocalstring

The start time for the job in 24-hour local time. This property is specific to Avionté 24/7.

endTimeLocalstring

The end time for the job in 24-hour local time. This property is specific to Avionté 24/7.

offerboolean

An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7.

pickListboolean

An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7.

postJobToMobileAppboolean

An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7.

payPeriod'Unknown' | 'Weekly' | 'BiWeekly' | 'Monthly' | 'SemiMonthly' | 'Daily' | 'Yearly' | 'Hourly'
bundledboolean

An indication of whether workers can pick up one job. This property is specific to Avionté 24/7.

scheduleLengthWeeksinteger

The identifier for Weeks in a Schedule.

mobileJobTitlestring

The job title for mobile applications.

timeCaptureMethod'TIMESHEET' | 'DAILY_TIME' | 'GROUP_TIME' | 'BATCH_HOURS' | 'MOBILE_PUNCH'

The time capture method for this job. Indicates how talent should log their time.

Example request

{
  "id": 188499,
  "companyId": 17845,
  "branchId": 17582,
  "frontOfficeId": 2774,
  "contactId": 178843,
  "worksiteAddressId": 17748,
  "positions": 5,
  "estimatedHours": 40,
  "targetBillRate": 30,
  "targetPayRate": 25,
  "overtimeRuleId": 434,
  "useCustomOTRates": true,
  "overtimeBillRate": 45,
  "overtimePayRate": 37.5,
  "doubletimeBillRate": 60,
  "doubletimePayRate": 50,
  "maxBillRate": 60,
  "minBillRate": 30,
  "maxPayRate": 50,
  "minPayRate": 25,
  "markupPercentage": 8,
  "billingManagerId": 148724,
  "billingName": "John Doe",
  "billingAddress1": "123 Main Street",
  "billingAddress2": "Suite 100",
  "billingCity": "Eagan",
  "billingState": "MN",
  "billingZip": "55121",
  "billingPhone": "651-555-1234",
  "billingEmail": "john.doe@example.com",
  "placementFee": 25,
  "placementPercentage": 5,
  "title": "Warehouse Worker",
  "positionCategoryId": 247,
  "costCenter": "Center A",
  "division": "Employer ABC",
  "department": "Warehouse",
  "workerCompCodeId": 4136,
  "statusId": 273,
  "orderTypeId": 248,
  "salesRepUserId": 17845,
  "ownerUserId": 17845,
  "description": "General warehouse duties including picking, packing, and shipping.",
  "notes": "Handle all incoming shipments and ensure proper documentation.",
  "customJobDetails": [
    {
      "id": 12345,
      "jobId": 67890,
      "name": "Dress Code",
      "value": "Business Casual",
      "additionalValue": "No jeans",
      "type": "text",
      "isActive": true,
      "customJobDetailId": 54321
    }
  ],
  "origin": "Partner XYZ",
  "startTimeLocal": "08:00",
  "endTimeLocal": "17:00",
  "shiftScheduleDays": {
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true
  },
  "postJobToMobileApp": true,
  "scheduleLengthWeeks": 4,
  "scheduleShifts": [
    {
      "id": 12345,
      "shiftDay": 1,
      "duration": 480,
      "startTime": "08:00:00",
      "positions": 2,
      "createdDate": "2024-12-01T14:30:00.546Z",
      "updatedDate": "2024-12-01T14:30:00.546Z"
    }
  ],
  "mobileJobTitle": "Software Engineer",
  "timeCaptureMethod": "TIMESHEET"
}

Response

The created job record.

idinteger

The identifier for the job.

positionsinteger

The number of job positions.

startDatestring date-time

The estimated start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endDatestring date-time

The estimated end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

titlestring

The job title.

standardJobTitleIdinteger

The identifier for the standard job title.

standardJobTitlestring

The standard job title.

socCodestring

The Standard Occupational Classification (SOC) code mapped to the standard job title in the Table Editor. SOC codes are only used for U.S. jobs.

socCodeTitlestring

The Standard Occupational Classification (SOC) title mapped to the standard job title in the Table Editor. SOC codes are only used for U.S. jobs.

costCenterstring

The company's cost center.

employeeType'Temporary' | 'Permanent'

Employment types available for selection.

workersCompensationClassCodestring

The worker's compensation class code.

workerCompCodeIdinteger

The identifier of the worker's comp code.

companyIdinteger

The identifier for the company.

branchIdinteger

The unique identifier for the job office or department.

frontOfficeIdinteger

The identifier for the job's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the <a href="https://developer.avionte.com/reference/getbranches">Get Branches</a> endpoint to retrieve the ID.

addressIdinteger

The identifier for the worksite address.

poIdinteger

The identifier for the purchase order.

companyNamestring

The name of the company that posted the job.

linkstring

URL to the job profile.

contactIdinteger

The identifier for the contact.

statusIdinteger

The identifier for the job status.

statusstring

The job status.

postedboolean

An indication of whether the job has been posted or not.

createdDatestring date-time

The date the job order was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

orderTypestring

The job type.

orderTypeIdinteger

The identifier for the job type.

representativeUsersinteger[]

The user IDs of the representatives for the job.

isArchivedboolean

An indication of whether the job record is archived or not.

oT_Typeinteger

The type of the overtime (1 - StraightTime, 2 - PaidAndBilledOT, 3 - PaidNotBilledOT).

enteredByUserIdinteger

The identifier for the user who entered the job record.

enteredByUserstring

The email of the user who entered the job record.

salesRepUserIdinteger

The identifier for the sales representative for the job.

salesRepUserstring

The email of the sales representative for the job.

descriptionstring

The job description.

lastUpdatedDatestring date-time

The date of the most recent update to the job record. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

latestActivityDatestring date-time

The date of the latest job activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

latestActivityNamestring

The name of the latest job activity.

hasNoEndDateboolean

An indication of whether the job has an end date or not.

payPeriodstring

The pay period for the job. Valid values are None, Weekly, BiWeekly, SemiMonthly, Monthly, Yearly, Hourly, and Daily.

placedinteger

The number of hired talent.

overtimeRuleIDinteger

The identifier for the overtime rule.

startTimeLocalstring

The start time for the job in 24-hour local time. This property is specific to Avionté 24/7.

endTimeLocalstring

The end time for the job in 24-hour local time. This property is specific to Avionté 24/7.

offerboolean

An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7.

pickListboolean

An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7.

postJobToMobileAppboolean

An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7.

originstring

The partner or vendor that originated the request.

worksiteAddressIdinteger

The identifier for the worksite address.

ownerUserIdinteger

The identifier for the user who entered the job record.

bundledboolean

An indication of whether workers can pick up one job. This property is specific to Avionté 24/7.

startOfWeekstring

The day of the week that marks the start of the job.

shiftNamestring

Description of the configured job shift.

scheduleLengthWeeksinteger

The identifier for Weeks in a Schedule.

notesstring

The job notes.

estimatedHoursinteger

The estimated amount of time the job requires.

targetBillRatenumber

The target bill rate for the job.

targetPayRatenumber

The target pay rate for the job.

expenseType'None' | 'PaidAndBilled' | 'PaidNotBilled'

The expense types available for selection for a job.

useCustomOTRatesboolean

A flag indicating custom overtime rates can be used.

overtimeBillRatenumber

The overtime bill rate value.

overtimePayRatenumber

The overtime pay rate value.

doubletimeBillRatenumber

The double time bill rate value.

doubletimePayRatenumber

The double time pay rate value.

rateType'HourlyRate' | 'DailyRate'

The rate types available for selection for a job.

weekDuration'MondayToSunday' | 'SundayToSaturday' | 'SaturdayToFriday'

The week duration options available for a job.

markupPercentagenumber

The mark-up percentage value.

billingManagerIdinteger

The identifier for the billing manager for the job.

billingNamestring

The name of the billing contact.

billingAddress1string

Billing address, line 1.

billingAddress2string

Billing address, line 2.

billingCitystring

Billing city.

billingStatestring

Billing state.

billingZipstring

Billing ZIP/postal code.

billingPhonestring

Billing contact phone.

billingEmailstring

Billing contact email.

billingTerm'DueUponReceipt' | 'Net7' | 'Net10' | 'Net15' | 'Net20' | 'Net30' | 'Net35' | 'Net45' | 'Net60' | 'Net65' | 'Net90' | 'Net120' | 'Net135'

The billing term options available for a job used for invoicing a customer. Options include "DueUponReceipt" and NetN terms, where N is the number of days in which the payment is due. For example, Net7 creates an invoice due 7 days after the date of the invoice.

placementFeenumber

The placement fee for the job.

placementPercentagenumber float

The placement percentage for the job.

positionCategoryIdinteger

The identifier for the position category.

divisionstring

The company's division.

overtimeType'StraightTime' | 'PaidAndBilledOT' | 'PaidNotBilledOT'

The overtime types available for selection for a job.

maxBillRatenumber

The maximum bill rate value.

minBillRatenumber

The minimum bill rate value.

maxPayRatenumber

The maximum pay rate value.

minPayRatenumber

The minimum pay rate value.

departmentstring

The company department name.

mobileJobTitlestring

The job title for mobile applications.

timeCaptureMethod'TIMESHEET' | 'DAILY_TIME' | 'GROUP_TIME' | 'BATCH_HOURS' | 'MOBILE_PUNCH'

The time capture method for this job. Indicates how talent should log their time.

customJobIdstring

The custom job identifier.

Example response

{
  "id": 188499,
  "positions": 5,
  "payRates": {
    "regular": 15.5,
    "overtime": 23.25,
    "doubletime": 31
  },
  "billRates": {
    "regular": 15.5,
    "overtime": 23.25,
    "doubletime": 31
  },
  "title": "Warehouse Worker",
  "costCenter": "Center A",
  "workersCompensationClassCode": "4136",
  "workerCompCode": {
    "id": 12345,
    "wcCode": "4136",
    "wcDescription": "Clerical Office Employees",
    "wcState": "CA",
    "wcCountry": "US",
    "employerId": 12345
  },
  "workerCompCodeId": 138,
  "companyId": 17845,
  "branchId": 15377,
  "frontOfficeId": 2774,
  "addressId": 17748,
  "worksiteAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  },
  "poId": 123456,
  "companyName": "Acme Corporation",
  "link": "https://abc.myavionte.com/app/#/job/123456",
  "contactId": 123456,
  "statusId": 147,
  "status": "Open",
  "posted": true,
  "orderType": "Temporary",
  "orderTypeId": 128,
  "representativeUsers": [
    123,
    456
  ],
  "oT_Type": 2,
  "enteredByUserId": 17845,
  "enteredByUser": "user@example.com",
  "salesRepUserId": 17845,
  "salesRepUser": "salesrep@example.com",
  "description": "General warehouse duties including picking, packing, and shipping.",
  "customJobDetails": [
    {
      "id": 12345,
      "jobId": 67890,
      "name": "Dress Code",
      "value": "Business Casual",
      "additionalValue": "No jeans",
      "type": "text",
      "isActive": true,
      "customJobDetailId": 54321
    }
  ],
  "latestActivityName": "On Hold",
  "payPeriod": "Weekly",
  "placed": 5,
  "overtimeRuleID": 1284,
  "startTimeLocal": "08:00",
  "endTimeLocal": "17:00",
  "shiftScheduleDays": {
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true
  },
  "postJobToMobileApp": true,
  "origin": "Partner XYZ",
  "worksiteAddressId": 1234,
  "ownerUserId": 135678,
  "startOfWeek": "Monday",
  "shiftName": "Day Shift",
  "scheduleLengthWeeks": 4,
  "scheduleShifts": [
    {
      "id": 12345,
      "shiftDay": 1,
      "duration": 480,
      "startTime": "08:00:00",
      "positions": 2,
      "createdDate": "2024-12-01T14:30:00.546Z",
      "updatedDate": "2024-12-01T14:30:00.546Z"
    }
  ],
  "notes": "This is a sample job note.",
  "estimatedHours": 40,
  "targetBillRate": 100,
  "targetPayRate": 80,
  "useCustomOTRates": true,
  "overtimeBillRate": 120,
  "overtimePayRate": 100,
  "doubletimeBillRate": 140,
  "doubletimePayRate": 120,
  "markupPercentage": 8,
  "billingManagerId": 148724,
  "billingName": "John Doe",
  "billingAddress1": "123 Main Street",
  "billingAddress2": "Suite 100",
  "billingCity": "Eagan",
  "billingState": "MN",
  "billingZip": "55121",
  "billingPhone": "651-555-1234",
  "billingEmail": "john.doe@example.com",
  "placementFee": 25,
  "placementPercentage": 5,
  "positionCategoryId": 247,
  "division": "Employer ABC",
  "maxBillRate": 150,
  "minBillRate": 100,
  "maxPayRate": 120,
  "minPayRate": 80,
  "department": "Warehouse",
  "mobileJobTitle": "Software Engineer",
  "timeCaptureMethod": "TIMESHEET",
  "customJobId": "abc-123"
}