v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB

Invoices

Get invoice line items by invoice Id

get/1.0/invoices/{invoiceId}/lines

Path parameters

invoiceIdinteger required

Unique identifier of the invoice

Query parameters

pageSizenumber

Example:100

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageTokenstring

Example:59c12a42-dd10-11ed-afa1-0242ac120002

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "invoiceLineItemId": 123,
      "description": "Development services for Q1",
      "quantity": 10,
      "unitPrice": 100,
      "amount": 1000,
      "sourceId": 456,
      "sourceType": "PROJECT",
      "taxCode": {
        "taxCodeId": 456,
        "taxCodeName": "GST 18%",
        "taxCodeRate": 18,
        "taxCodeAmount": 180
      },
      "taxComponents": [
        {
          "taxComponentId": 123,
          "taxComponentName": "GST",
          "taxComponentRate": 18,
          "taxComponentAmount": 180,
          "taxComponentType": "GST"
        }
      ]
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/invoices/123/lines?pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}