Get Matching Jobs

post

https://api.avionte.com/front-office/v1/job/matching-jobs

Returns a list of jobs from the same branch with the same job title, dates, and rates.

Body Params

int32

The identifier for the job.

companyId

int32

required

The identifier for the company.

branchId

int32

required

The identifier for the company branch or department.

frontOfficeId

int32

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

int32

required

The identifier for the company contact.

worksiteAddressId

int32

required

The identifier for the worksite address.

positions

int32

required

The number of positions.

startDate

date-time

required

length ≥ 1

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

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

int32

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

enum

Information about the overtime type.

expenseType

enum

Information about the expense type.

overtimeRuleId

int32

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

enum

The rate type for the job.

weekDuration

enum

The week duration option for the job.

markupPercentage

number

The mark-up percentage value.

billingManagerId

int32

The identifier for the billing manager for the job.

billingName

string

length ≤ 255

The name of the billing contact.

billingAddress1

string

length ≤ 255

Billing address, line 1.

billingAddress2

string

length ≤ 100

Billing address, line 2.

billingCity

string

length ≤ 50

Billing city.

billingState

string

length ≤ 50

Billing state.

billingZip

string

length ≤ 50

Billing ZIP/postal code.

billingPhone

string

length ≤ 50

Billing contact phone.

billingEmail

string

length ≤ 100

Billing contact email.

billingTerm

enum

The billing term.

placementFee

number

The placement fee for the job.

placementPercentage

float

The placement percentage for the job.

title

string

required

length between 1 and 500

The title for the job.

positionCategoryId

int32

The identifier for the position category.

costCenter

string

length ≤ 50

The company's cost center.

division

string

length ≤ 50

The company's division.

department

string

length ≤ 50

The company department name.

workerCompCodeId

int32

The identifier for the worker's comp code.

statusId

int32

required

The identifier for the job order status.

orderTypeId

int32

required

The identifier for the job type.

salesRepUserId

int32

The identifier for the sales representative user for the job.

ownerUserId

int32

required

The identifier for the user who created a job.

description

string

The job description.

notes

string

The job notes.

customJobDetails

array of objects

A list of custom job details.

customJobDetails

origin

string

required

length between 1 and 50

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

Object that contains Shift Days. This property is specific to Avionté 24/7.

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

enum

The pay period available for the job.

bundled

boolean

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

scheduleLengthWeeks

int32

The identifier for Weeks in a Schedule.

scheduleShifts

array of objects

The list of Schedule Shifts per schedule weeks. This property is specific to Avionté 24/7.

scheduleShifts

mobileJobTitle

string

The job title for mobile applications.

timeCaptureMethod

string

enum

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

Allowed:

Headers

RequestId

uuid

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

FrontOfficeTenantId

integer

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

Tenant

string

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

Responses

401

Unauthorized

403

Access Denied

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

200A list of matching jobs.

400Bad Request

404Not found