Sign in
Jobs

Get a list of job stocks

Retrieve a paged collection of job stocks (required scope jobs:read)

get/v1/jobs/{jobId}/stock

Path parameters

jobIdinteger required

The unique identifer of the job

Query parameters

jobStockIdinteger[]

Only return job stocks where JobStockId matches the value(s) provided (Max items: 50)

stockDetailsIdinteger[]

Only return job stocks where 'StockDetailsId' matches the value(s) provided (Max items: 50)

stockItemIdinteger[]

Only return job stocks where 'StockItemId' matches the value(s) provided (Max items: 50)

action'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>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>

Example:noMovement

Only return job stocks where 'Action' matches the value provided

isActualboolean

Only return job stocks where 'IsActual' matches the value provided

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 5514123,
      "uid": "3729C414-ED21-4849-816F-25D332265DC8",
      "typeId": 5514123,
      "typeName": "Boiler Service",
      "contactId": 5514123,
      "contactName": "Global Solutions Ltd",
      "contactAddress": "15 High Street, Lichfield, Staffordshire, WS15 3TT",
      "contactLocation": {
        "latitude": 51.31349,
        "longitude": -0.7464233
      },
      "status": "new",
      "statusModifiedAt": "2022-11-29T13:39:00.0000000+00:00",
      "plannedDuration": 90,
      "dueAt": "2022-11-29T06:00:00.0000000+00:00",
      "reference": "ABC/5514123",
      "description": "New boiler install - please remove and retain the old boiler",
      "createdAt": "2022-11-29T16:50:16.0000000+00:00",
      "orderNumber": "PAO/1312KU",
      "personId": "3729c414-ed21-4849-816f-25d332265dc8",
      "personName": "Peter Brown",
      "isConfirmed": true,
      "categoryId": 5514123,
      "categoryName": "Global Solutions Ltd",
      "resourceId": 243556,
      "resourceName": "John Smith",
      "vehicleId": 665433,
      "vehicleRegistration": "BC21 BCL",
      "plannedStartAt": "2022-11-29T12:00:00.0000000+00:00",
      "plannedEndAt": "2022-11-29T13:30:00.0000000+00:00",
      "actualStartAt": "2022-11-29T12:03:00.0000000+00:00",
      "actualEndAt": "2022-11-29T13:39:00.0000000+00:00",
      "actualDuration": 6000,
      "internalComment": "Old boiler has been moved to storage",
      "resourcesComment": "Boiler removed and stored in van",
      "contactComment": "No issues with new boiler",
      "result": "Ok",
      "jobGroupId": 123456789,
      "officeNotes": "Customer has requested a follow-up call",
      "contractId": 123456,
      "recurrenceId": 789012,
      "customFields": [
        {
          "definitionId": 5514123,
          "value": "Purple",
          "definition": {
            "caption": "Favourite colour",
            "type": "boolean",
            "listOptions": [
              "Red",
              "Blue",
              "Green",
              "Purple"
            ],
            "isRequired": true,
            "isEditable": true,
            "default": "10"
          },
          "systemListValueMetadata": {
            "label": "John Doe",
            "entityType": "resource"
          }
        }
      ],
      "siteContactIds": [
        15548440,
        9425766
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}