Sign in
SalesOpportunities

Get a sales opportunity line item

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

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

Path parameters

salesOpportunityIdinteger required

The unique identifier of the sales opportunity

lineItemIdinteger required

The unique identifier of the sales opportunity line item

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the sales opportunity line item

salesOpportunityIdinteger nullable

The sales opportunity id associated with the line item

contactIdinteger nullable

The contact id associated with the line item

createdAtstring date-time

The date and time when the sales opportunity line item was created

quantitynumber double

The quantity of the line item

descriptionstring

Description of the sales opportunity line item

taxIdinteger nullable

VAT / Tax identifier associated with the line item

taxPercentagenumber double

Tax percentage applied to the line item (GET only, never null). Defaults to 0 when no tax is applied

unitCostnumber double nullable

Unit cost of the item (cannot be negative)

unitSellingPricenumber double

Unit selling price of the item (cannot be negative)

taxAmountnumber double nullable

Tax amount for the line item (GET only)

grossAmountnumber double nullable

Gross amount of the line item (GET only)

nominalCodeIdinteger nullable

Nominal code identifier

departmentCodeIdinteger nullable

Department code identifier

Example response

{
  "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
}