Sign in
SalesOpportunities

Gets a list of sales opportunity line items that belong to the specified sales opportunity

Retrieve a paged list of line items for a sales opportunity (required scope finance:read)

get/v1/finance/salesOpportunities/{salesOpportunityId}/lineItems

Path parameters

salesOpportunityIdinteger required

The unique identifier of the sales opportunity associated with the line items

Query parameters

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": 987654,
      "salesOpportunityId": 12345,
      "contactId": 1234,
      "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
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}