AVavionte
Jobs

Patch a VMS Job

Patches information about the specified VMS Job and related Bold Job if it exists.

patch/v1/job/vms-job/{vmsJobId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/job/vms-job/{vmsJobId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

vmsJobIdstring required

The identifier for the VMS job in BOLD.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

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

pathstring

A JSON Pointer indicating the location in the document to apply the operation.

opstring

Specifies the type of operation (e.g., add, remove, replace, move, copy, and test).

fromstring

The source path for move and copy operations.

valueobject

The value to be added, replaced, or tested (required for add, replace, and test operations).

Response

The updated VMS job.

vmsReqIdinteger

The identifier for the VMS job.

jobIdinteger

The identifier for the job.

companyIdinteger required

The identifier for the company.

branchIdinteger required

The identifier for the company branch 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.

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 phone.

billingEmailstring

Billing 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's department.

workerCompCodeIdinteger

The identifier for the worker's comp code.

statusIdinteger

The identifier for the job order status.

orderTypeIdinteger

The identifier for the job type.

salesRepUserIdinteger

The identifier for the sales representative user for the job.

ownerUserIdinteger

The identifier for the user who created a job.

descriptionstring

The job description.

descriptionHTMLstring

The HTML for 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'None' | 'Weekly' | 'BiWeekly' | 'Daily' | 'Monthly' | 'SemiMonthly' | 'Yearly' | 'Hourly'

The pay period available for a job.

vmsNotesstring

The notes related to the VMS job.

maxSubmittalinteger

The maximum number of submittals.

vendorJobReqIDstring

The string identifier for the vendor job.

vmsNamestring

VMS provider name.

vmsTypestring

VMS type.

statusNamestring

The name for the job order status.

orderTypeNamestring

The job type.

jobOwnersinteger[]

The user IDs of the job owners.

bundledboolean

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

vendorIdinteger nullable

The identifier for the vendor for the job.

jobTemplateIdinteger nullable

The identifier for the job order template to associate with this VMS job. Must belong to the same CompanyId.

Example response

{
  "vmsReqId": 123456,
  "jobId": 789012,
  "companyId": 456789,
  "branchId": 101112,
  "frontOfficeId": 123456,
  "contactId": 789012,
  "worksiteAddressId": 345678,
  "positions": 5,
  "estimatedHours": 40,
  "targetBillRate": 30,
  "targetPayRate": 25,
  "overtimeRuleId": 434,
  "useCustomOTRates": true,
  "overtimeBillRate": 45,
  "overtimePayRate": 40,
  "doubletimeBillRate": 60,
  "doubletimePayRate": 50,
  "maxBillRate": 100,
  "minBillRate": 80,
  "maxPayRate": 30,
  "minPayRate": 25,
  "markupPercentage": 8,
  "billingManagerId": 12345,
  "billingName": "John Smith",
  "billingAddress1": "123 Main St",
  "billingAddress2": "Suite 100",
  "billingCity": "Anytown",
  "billingState": "CA",
  "billingZip": "90210",
  "billingPhone": "555-123-4567",
  "billingEmail": "john.smith@example.com",
  "placementFee": 25,
  "placementPercentage": 5,
  "title": "Warehouse Worker",
  "positionCategoryId": 123,
  "costCenter": "CC12345",
  "division": "Sales",
  "department": "Logistics",
  "workerCompCodeId": 456,
  "statusId": 789,
  "orderTypeId": 101,
  "salesRepUserId": 112233,
  "ownerUserId": 123456,
  "description": "This is a sample job description for a warehouse worker position.",
  "descriptionHTML": "<p>This is a sample job description for a warehouse worker position.</p>",
  "notes": "This is a sample job note.",
  "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
  },
  "offer": true,
  "postJobToMobileApp": true,
  "vmsNotes": "This is a sample VMS note.",
  "maxSubmittal": 10,
  "vendorJobReqID": "VMS-REQ-123456",
  "vmsName": "VMS Provider Inc.",
  "vmsType": "Direct",
  "statusName": "Open",
  "jobRequirements": [
    {
      "requirementName": "Safety Training",
      "isRequired": true
    }
  ],
  "orderTypeName": "Temporary",
  "jobSkills": [
    {
      "jobSkillId": 184928,
      "jobId": 1578224,
      "descriptionId": 7735,
      "positionId": 643,
      "skillDescription": "Data Entry",
      "skillPosition": "Clerical",
      "skillTalentFacing": true
    }
  ],
  "jobSkillResponse": {
    "jobSkills": [
      {
        "jobSkillId": 184928,
        "jobId": 1578224,
        "descriptionId": 7735,
        "positionId": 643,
        "skillDescription": "Data Entry",
        "skillPosition": "Clerical",
        "skillTalentFacing": true
      }
    ]
  },
  "jobOwners": [
    123456,
    789012
  ],
  "vendorId": 12345,
  "jobTemplateId": 12345
}

Changes

No recorded changes to this operation across all 1 revision of this API.