Sign in
Jobs

Get a job stock

Retrieve the details of a single job stock (required scope jobs:read)

get/v1/jobs/{jobId}/stock/{jobStockId}

Path parameters

jobIdinteger required

The unique identifier of the job stock

jobStockIdinteger required

The unique identifier of the job stock

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier for each planned stock usage record

jobIdinteger

The identifier of the job associated with the planned stock usage

stockDetailsIdinteger

The identifier of the type of stock associated with the planned stock usage on the job

stockItemIdinteger nullable

The identifier of the specific stock item associated with the planned stock usage on the job

action'Unknown' | 'noMovement' | 'broughtAndLeft' | 'broughtAndTakenBack' | 'broughtToSwap' | 'onSiteAndTakenBack' | 'onSiteAndLeft' | 'usedInStock'

Represents the actions that can be performed on a job stock<p>Possible values:</p><ul><li><b>unknown</b>: Unknown action</li><li><b>noMovement</b>: No movement</li><li><b>broughtAndLeft</b>: Brought to job and left at location</li><li><b>broughtAndTakenBack</b>: Brought to job and taken back</li><li><b>broughtToSwap</b>: Brought to job to swap with other stock item</li><li><b>onSiteAndTakenBack</b>: Taken from job location</li><li><b>onSiteAndLeft</b>: Already on site and left at location</li><li><b>usedInStock</b>: Used on equipment</li></ul>

quantityPlannednumber double

The anticipated quantity of stock units that will be used on a job

pickupContactIdinteger nullable

The identifier for the contact at the pickup location during the planned stock usage. If set, allowed actions are 'BroughtAndLeft', 'BroughtAndTakenBack' and 'UsedInStock'. Null value indicates that the stock will be on the vehicle relating to the job

dropOffContactIdinteger nullable

The identifier for contact at the drop-off location during the planned stock usage. If set, allowed actions are 'BroughtAndTakenBack' and 'OnSiteAndTakenBack'. Null value indicates that the stock will be on the vehicle relating to the job

isDeliveredToBeSoldboolean

A flag indicating whether the stock is delivered to be sold

isEquipmentAtDropOffboolean

A flag indicating whether the stock equipment is at the drop-off location

quantityActualnumber double

The actual quantity of stock units that were used on a job

makestring nullable

Make of a stock item used in a job

modelstring

Model of a stock item used in a job. Usually used in conjunction with the Make for generic identification

serialNumberstring nullable

Used as a unique reference field for a stock item to track specific unit. Doesn't have to be set when a job is initialised

dropOffStockItemIdinteger nullable

The identifier for the specific item of stock that is planned to be dropped at off or delivered to

Example response

{
  "id": 123,
  "jobId": 3334,
  "stockDetailsId": 7775,
  "stockItemId": 5954,
  "action": "Unknown",
  "quantityPlanned": 10.5,
  "pickupContactId": 1234,
  "dropOffContactId": 676,
  "isDeliveredToBeSold": true,
  "isEquipmentAtDropOff": true,
  "quantityActual": 2.5,
  "make": "Samsung",
  "model": "Smart Fridge V100",
  "serialNumber": "SN001/200/500",
  "dropOffStockItemId": 12345,
  "worksheets": [
    {
      "worksheetId": 1234,
      "worksheetAnswersEntityId": 4321
    }
  ]
}