Sign in
Jobs

Get a job line item

Retrieve the details of a single line item (required scope jobs:read)

get/v1/jobs/{jobId}/lineItems/{lineItemId}

Path parameters

jobIdinteger required

The unique identifier of the job associated with the line item

lineItemIdinteger required

The unique identifier of the line item

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier associated with the job line item

jobIdinteger nullable

The unique identifier of the job associated with the job line item

jobGroupIdinteger nullable

The unique identifier of the job group associated with the job line item

contactIdinteger nullable

The unique identifier of the contact associated with the job line item

createdAtstring date-time

The date and time when the job line item was created

lineItemType'freeText' | 'predefined' | 'stockItem' | 'worksheet' | 'drivingPlanned' | 'drivingActual' | 'workPlanned' | 'workActual' | 'expense' | 'invoice' | 'stock' | 'ratingTable'

Represents the type of a purchase order line item<p>Possible values:</p><ul><li><b>freeText</b>: A free text line item</li><li><b>predefined</b>: A predefined invoicing item</li><li><b>stockItem</b>: A stock item line item</li><li><b>worksheet</b>: A worksheet line item</li><li><b>drivingPlanned</b>: A driving planned line item</li><li><b>drivingActual</b>: A driving actual line item</li><li><b>workPlanned</b>: A work planned line item</li><li><b>workActual</b>: A work actual line item</li><li><b>expense</b>: An expense line item</li><li><b>invoice</b>: An invoice line item</li><li><b>stock</b>: A stock line item</li><li><b>ratingTable</b>: A rating table line item</li></ul>

quantitynumber double

The quantity of the line item

descriptionstring

Description of the job line item

taxIdinteger nullable

VAT / Tax identifier associated with the line item

taxPercentagenumber double

Tax percentage applied to the line item (GET only, never null). Defaults to 0 when no tax is applied

unitCostnumber double nullable

Unit cost of the item (cannot be negative)

unitSellingPricenumber double

Unit selling price of the item (cannot be negative)

taxAmountnumber double nullable

Tax amount for the line item (GET only)

grossAmountnumber double nullable

Gross amount (formerly NetPrice internal) of the line item (GET only)

nominalCodeIdinteger nullable

Nominal code identifier

departmentCodeIdinteger nullable

Department code identifier

Example response

{
  "id": 12345,
  "jobId": 54321,
  "lineItemType": "freeText",
  "quantity": 5,
  "description": "Replacement filter cartridge",
  "taxId": 1001,
  "taxPercentage": 20,
  "unitCost": 5.5,
  "unitSellingPrice": 10.99,
  "taxAmount": 2.2,
  "grossAmount": 13.19,
  "nominalCodeId": 50001,
  "departmentCodeId": 20002
}