Service Entries

List Service Entry Line Items

Changed on

Returns a list of Line Items for a given Service Entry.

get/service_entries/{service_entry_id}/service_entry_line_items

Request

Path parameters

service_entry_idstring required

The id of the associated Service Entry

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return.

id'asc' | 'desc'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

filtered_byobject[]

The filters applied to the returned record set.

Example response

{
  "records": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "service_task": {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "subtasks": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00"
          }
        ]
      },
      "issues": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "reported_at": "2023-03-14T13:46:27-06:00",
          "due_date": "2023-03-14",
          "assigned_contacts": [
            {
              "group_hierarchy": "Group 1|Group 2|Group 3",
              "birth_date": "2023-03-14",
              "street_address": "123 Main St",
              "street_address_line_2": "Apt 1",
              "license_expiration": "2023-03-14"
            }
          ],
          "comments": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ],
          "documents": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ],
          "images": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ]
        }
      ]
    }
  ]
}

Changes

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      for the query request parameter per_page, the min was decreased from 2.00 to 1.00

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed subschema #1 from the ///// response property allOf list for the response status

    • info

      removed subschema #1 from the / response property anyOf list for the response status

    • info

      added the optional property /// to the response with the status