Sign in
SalesOpportunities

Create a sales opportunity line item

Create a new sales opportunity line item (required scope finance:write)

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

Path parameters

salesOpportunityIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

contactIdinteger nullable

The unique identifier of the contact associated with this sales opportunity line item

quantitynumber double required

The quantity of the sales opportunity line item

descriptionstring

Description of the sales opportunity line item

taxIdinteger nullable

Tax identifier (must exist and not be deleted for customer). Nullable

unitCostnumber double nullable

Unit cost (nullable, non-negative)

unitSellingPricenumber double

Unit selling price (non-negative)

nominalCodeIdinteger nullable

Nominal code identifier (must exist and not be deleted for customer)

departmentCodeIdinteger nullable

Department code identifier (must exist and not be deleted for customer)

Example request

{
  "contactId": 54321,
  "quantity": 1,
  "description": "Replacement filter cartridge",
  "taxId": 1001,
  "unitCost": 5.5,
  "unitSellingPrice": 10.99,
  "nominalCodeId": 50001,
  "departmentCodeId": 20002
}

Response

Created

idinteger

Identifier of the newly created record