Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

JobGroups

Gets a list of job group line items that belong to the specified job group

Retrieve a paged list of line items for a job group (required scope jobs:read)

get/v1/jobGroups/{jobGroupId}/lineItems

Path parameters

jobGroupIdinteger required

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

Query parameters

sortBy'createdAt'

JobGroupLineItemSortOptions enum<p>Possible values:</p><ul><li><b>createdAt</b>: JobGroupLineItemSortOptions CreatedAt</li></ul>

Example:createdAt

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

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": 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
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}