Sign in
JobGroups

Get a job group line item

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

get/v1/jobGroups/{jobGroupId}/lineItems/{lineItemId}

Path parameters

jobGroupIdinteger required

The unique identifier of the job group 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 of the line item

jobIdinteger nullable

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

jobGroupIdinteger nullable

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

contactIdinteger nullable

Contact id that the costs are charged to

createdAtstring date-time

Creation date of the invoice item that this line belongs to

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

Quantity of the line item

descriptionstring

Description of the line item

taxIdinteger nullable

Id of the vat/tax rate applied to this item

taxPercentagenumber double

Percentage of tax applied to this item

unitCostnumber double nullable

Cost of the line item

unitSellingPricenumber double

Price of each individual unit associated to the line item

taxAmountnumber double nullable

Tax amount associated to the line item (GET only)

grossAmountnumber double nullable

Net price associated to the line item

nominalCodeIdinteger nullable

Id of the associated nominal code

departmentCodeIdinteger nullable

Id of the associated department code

Example response

{
  "id": 52488,
  "jobId": 52488,
  "contactId": 6547,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "lineItemType": "freeText",
  "quantity": 5,
  "description": "Copper pipe - 1m",
  "taxId": 55,
  "taxPercentage": 20,
  "unitCost": 2.5,
  "unitSellingPrice": 5.99,
  "taxAmount": 5,
  "grossAmount": 25,
  "nominalCodeId": 49,
  "departmentCodeId": 22
}