--- title: "Create a Job" method: POST path: "/v1/job" tags: ["Jobs"] --- # Create a Job `POST /v1/job` Adds a new job record to the system. ## Query parameters - `encoding` string, nullable ## Headers - `RequestId` string, uuid — The unique request identifier used to correlate request data with log entries and events, formatted as a UUID. - `FrontOfficeTenantId` integer - `Tenant` string ## Request body - JobDto - `id` integer — The identifier for the job. - `companyId` integer, required — The identifier for the company. - `branchId` integer, required — The identifier for the company branch or department. - `frontOfficeId` integer, 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 Get Branches endpoint to retrieve the ID. - `contactId` integer, required — The identifier for the company contact. - `worksiteAddressId` integer, required — The identifier for the worksite address. - `positions` integer, required — The number of positions. - `startDate` string, 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. - `endDate` string, 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. - `estimatedHours` integer — The estimated amount of time the job requires. - `targetBillRate` number — The target bill rate for the job. - `targetPayRate` number — 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. - `overtimeRuleId` integer — The identifier for the overtime rule. - `useCustomOTRates` boolean — A flag indicating custom overtime rates can be used. - `overtimeBillRate` number — The overtime bill rate value. - `overtimePayRate` number — The overtime pay rate value. - `doubletimeBillRate` number — The double time bill rate value. - `doubletimePayRate` number — The double time pay rate value. - `maxBillRate` number — The maximum bill rate value. - `minBillRate` number — The minimum bill rate value. - `maxPayRate` number — The maximum pay rate value. - `minPayRate` number — 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. - `markupPercentage` number — The mark-up percentage value. - `billingManagerId` integer — The identifier for the billing manager for the job. - `billingName` string — The name of the billing contact. - `billingAddress1` string — Billing address, line 1. - `billingAddress2` string — Billing address, line 2. - `billingCity` string — Billing city. - `billingState` string — Billing state. - `billingZip` string — Billing ZIP/postal code. - `billingPhone` string — Billing contact phone. - `billingEmail` string — 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. - `placementFee` number — The placement fee for the job. - `placementPercentage` number, float — The placement percentage for the job. - `title` string, required — The title for the job. - `positionCategoryId` integer — The identifier for the position category. - `costCenter` string — The company's cost center. - `division` string — The company's division. - `department` string — The company department name. - `workerCompCodeId` integer — The identifier for the worker's comp code. - `statusId` integer, required — The identifier for the job order status. - `orderTypeId` integer, required — The identifier for the job type. - `salesRepUserId` integer — The identifier for the sales representative user for the job. - `ownerUserId` integer, required — The identifier for the user who created a job. - `description` string — The job description. - `notes` string — The job notes. - `customJobDetails` CustomJobDetail[] — A list of custom job details. - `id` integer — The identifier for the custom job details. - `jobId` integer — The identifier for the job. - `name` string — The name of the detail. - `value` string — The value of the detail. The format of the value depends on the type of detail. If the type is 'checkbox', the value can be 'Yes' or 'No'. If the type is 'minmax', the value can be a string representing the minimum value, like '10'. If the type is 'numeric', the value can be a number like '15'. If the type is 'time', the value can be a time string like '08:00'. If the type is 'text', the value can be a string like 'Business Casual'. - `additionalValue` string — An additional value needed for the detail. If the type is 'minmax', the value can be a string representing the maximum value, like '100'. - `type` string — The type of detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'. - `isActive` boolean — An indication of whether the detail is active or not. - `customJobDetailId` integer — An identifier for the custom job detail definition. - `origin` string, required — The partner or vendor that originated the request. - `isArchived` boolean — An indication of whether the job record is archived or not. - `startTimeLocal` string — The start time for the job in 24-hour local time. This property is specific to Avionté 24/7. - `endTimeLocal` string — The end time for the job in 24-hour local time. This property is specific to Avionté 24/7. - `shiftScheduleDays` ShiftScheduleDays - `monday` boolean — An indication of whether Monday is part of a shift schedule or not. - `tuesday` boolean — An indication of whether Tuesday is part of a shift schedule or not. - `wednesday` boolean — An indication of whether Wednesday is part of a shift schedule or not. - `thursday` boolean — An indication of whether Thursday is part of a shift schedule or not. - `friday` boolean — An indication of whether Friday is part of a shift schedule or not. - `saturday` boolean — An indication of whether Saturday is part of a shift schedule or not. - `sunday` boolean — An indication of whether Sunday is part of a shift schedule or not. - `offer` boolean — An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7. - `pickList` boolean — An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7. - `postJobToMobileApp` boolean — 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' - `bundled` boolean — An indication of whether workers can pick up one job. This property is specific to Avionté 24/7. - `scheduleLengthWeeks` integer — The identifier for Weeks in a Schedule. - `scheduleShifts` JobScheduleShiftDto[] — The list of Schedule Shifts per schedule weeks. This property is specific to Avionté 24/7. - `id` integer — The identifier for the Job Schedule Shift. - `shiftDay` integer — The identifier for the shift weekday, starting with 0 for Sunday. - `duration` integer — The shift duration in minutes. - `startTime` string, duration — Hours and minutes for start time in 24-hour local time. - `positions` integer — Number of positions for the shift. - `createdDate` string, date-time — The date the shift was created. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z. - `updatedDate` string, date-time — The date the shift was last updated. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z. - `mobileJobTitle` string — 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. ## Response `201` The created job record. - Job - `id` integer — The identifier for the job. - `positions` integer — The number of job positions. - `startDate` string, 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. - `endDate` string, 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. - `payRates` Rate - `regular` number — The regular rate value. - `overtime` number — The overtime rate value. - `doubletime` number — The double time rate value. - `billRates` Rate - `regular` number — The regular rate value. - `overtime` number — The overtime rate value. - `doubletime` number — The double time rate value. - `title` string — The job title. - `standardJobTitleId` integer — The identifier for the standard job title. - `standardJobTitle` string — The standard job title. - `socCode` string — 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. - `socCodeTitle` string — 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. - `costCenter` string — The company's cost center. - `employeeType` 'Temporary' | 'Permanent' — Employment types available for selection. - `workersCompensationClassCode` string — The worker's compensation class code. - `workerCompCode` WorkerCompCode - `id` integer — The identifier for the worker's comp code. - `wcCode` string — The worker's comp code. - `wcDescription` string — Description for the worker's comp code. - `wcState` string — The state/province the worker's comp code is for. - `wcCountry` string — The country the worker's comp code is for. - `employerId` integer — The identifier for the employer the worker's comp code is for. - `officeIds` integer[] — The identifiers for the offices the worker's comp code is for. - `workerCompCodeId` integer — The identifier of the worker's comp code. - `companyId` integer — The identifier for the company. - `branchId` integer — The unique identifier for the job office or department. - `frontOfficeId` integer — 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 Get Branches endpoint to retrieve the ID. - `addressId` integer — The identifier for the worksite address. - `worksiteAddress` Address - `addressGuid` string, uuid — Unique identifier for the address, formatted as a UUID. - `street1` string, required — Street address, line 1. - `street2` string — Street address, line 2. - `city` string, required — City. - `state` string, required — Province, state, or region. - `postalCode` string, required — ZIP/postal code. - `country` string, required — A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the General Guidelines. - `poId` integer — The identifier for the purchase order. - `companyName` string — The name of the company that posted the job. - `link` string — URL to the job profile. - `contactId` integer — The identifier for the contact. - `statusId` integer — The identifier for the job status. - `status` string — The job status. - `posted` boolean — An indication of whether the job has been posted or not. - `createdDate` string, 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. - `orderType` string — The job type. - `orderTypeId` integer — The identifier for the job type. - `representativeUsers` integer[] — The user IDs of the representatives for the job. - `isArchived` boolean — An indication of whether the job record is archived or not. - `oT_Type` integer — The type of the overtime (1 - StraightTime, 2 - PaidAndBilledOT, 3 - PaidNotBilledOT). - `enteredByUserId` integer — The identifier for the user who entered the job record. - `enteredByUser` string — The email of the user who entered the job record. - `salesRepUserId` integer — The identifier for the sales representative for the job. - `salesRepUser` string — The email of the sales representative for the job. - `description` string — The job description. - `customJobDetails` CustomJobDetail[] — A list of custom job details. - `id` integer — The identifier for the custom job details. - `jobId` integer — The identifier for the job. - `name` string — The name of the detail. - `value` string — The value of the detail. The format of the value depends on the type of detail. If the type is 'checkbox', the value can be 'Yes' or 'No'. If the type is 'minmax', the value can be a string representing the minimum value, like '10'. If the type is 'numeric', the value can be a number like '15'. If the type is 'time', the value can be a time string like '08:00'. If the type is 'text', the value can be a string like 'Business Casual'. - `additionalValue` string — An additional value needed for the detail. If the type is 'minmax', the value can be a string representing the maximum value, like '100'. - `type` string — The type of detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'. - `isActive` boolean — An indication of whether the detail is active or not. - `customJobDetailId` integer — An identifier for the custom job detail definition. - `lastUpdatedDate` string, 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. - `latestActivityDate` string, 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. - `latestActivityName` string — The name of the latest job activity. - `hasNoEndDate` boolean — An indication of whether the job has an end date or not. - `payPeriod` string — The pay period for the job. Valid values are None, Weekly, BiWeekly, SemiMonthly, Monthly, Yearly, Hourly, and Daily. - `placed` integer — The number of hired talent. - `overtimeRuleID` integer — The identifier for the overtime rule. - `startTimeLocal` string — The start time for the job in 24-hour local time. This property is specific to Avionté 24/7. - `endTimeLocal` string — The end time for the job in 24-hour local time. This property is specific to Avionté 24/7. - `shiftScheduleDays` ShiftScheduleDays - `monday` boolean — An indication of whether Monday is part of a shift schedule or not. - `tuesday` boolean — An indication of whether Tuesday is part of a shift schedule or not. - `wednesday` boolean — An indication of whether Wednesday is part of a shift schedule or not. - `thursday` boolean — An indication of whether Thursday is part of a shift schedule or not. - `friday` boolean — An indication of whether Friday is part of a shift schedule or not. - `saturday` boolean — An indication of whether Saturday is part of a shift schedule or not. - `sunday` boolean — An indication of whether Sunday is part of a shift schedule or not. - `offer` boolean — An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7. - `pickList` boolean — An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7. - `postJobToMobileApp` boolean — An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7. - `origin` string — The partner or vendor that originated the request. - `worksiteAddressId` integer — The identifier for the worksite address. - `ownerUserId` integer — The identifier for the user who entered the job record. - `bundled` boolean — An indication of whether workers can pick up one job. This property is specific to Avionté 24/7. - `startOfWeek` string — The day of the week that marks the start of the job. - `shiftName` string — Description of the configured job shift. - `scheduleLengthWeeks` integer — The identifier for Weeks in a Schedule. - `scheduleShifts` JobScheduleShift[] — The list of Schedule Shifts per schedule weeks. This property is specific to Avionté 24/7. - `id` integer — The identifier for the Job Schedule Shift. - `shiftDay` integer — The identifier for the shift weekday, starting with 0 for Sunday. - `duration` integer — The shift duration in minutes. - `startTime` string, duration — Hours and minutes for start time in 24-hour local time. - `positions` integer — Number of positions for the shift. - `createdDate` string, date-time — The date the shift was created. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z. - `updatedDate` string, date-time — The date the shift was last updated. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z. - `notes` string — The job notes. - `estimatedHours` integer — The estimated amount of time the job requires. - `targetBillRate` number — The target bill rate for the job. - `targetPayRate` number — The target pay rate for the job. - `expenseType` 'None' | 'PaidAndBilled' | 'PaidNotBilled' — The expense types available for selection for a job. - `useCustomOTRates` boolean — A flag indicating custom overtime rates can be used. - `overtimeBillRate` number — The overtime bill rate value. - `overtimePayRate` number — The overtime pay rate value. - `doubletimeBillRate` number — The double time bill rate value. - `doubletimePayRate` number — 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. - `markupPercentage` number — The mark-up percentage value. - `billingManagerId` integer — The identifier for the billing manager for the job. - `billingName` string — The name of the billing contact. - `billingAddress1` string — Billing address, line 1. - `billingAddress2` string — Billing address, line 2. - `billingCity` string — Billing city. - `billingState` string — Billing state. - `billingZip` string — Billing ZIP/postal code. - `billingPhone` string — Billing contact phone. - `billingEmail` string — 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. - `placementFee` number — The placement fee for the job. - `placementPercentage` number, float — The placement percentage for the job. - `positionCategoryId` integer — The identifier for the position category. - `division` string — The company's division. - `overtimeType` 'StraightTime' | 'PaidAndBilledOT' | 'PaidNotBilledOT' — The overtime types available for selection for a job. - `maxBillRate` number — The maximum bill rate value. - `minBillRate` number — The minimum bill rate value. - `maxPayRate` number — The maximum pay rate value. - `minPayRate` number — The minimum pay rate value. - `department` string — The company department name. - `mobileJobTitle` string — 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. - `customJobId` string — The custom job identifier. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Access Denied - `404` — Not found - `405` — Unsupported method - `406` — Unsupported format(s) indicated by Accept header - `415` — Unsupported format(s) indicated by the Content-Type header - `429` — Too many requests - `500` — An unexpected error occurred - `502` — Service Unavailable - `504` — Gateway Timeout --- [API](https://skmtc.net/avionte/apis/aviont-partner-authorization-api.md) · [All operations](https://skmtc.net/avionte/apis/aviont-partner-authorization-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avionte/aviont-partner-authorization-api/versions/846b33e4e71b/schema)