Opportunity Line Item

A list of Factors contributing to the Product of an opportunity.

closeDate
string <date-time>

The date the opportunity Line item is expected to close.

createdAt
string <date-time>

The date and time the opportunity Line item was created.

custom1
string <= 32000 characters

The value of the Opportunity Line Item first custom field

custom2
string <= 32000 characters

The value of the Opportunity Line item 2nd custom field

custom3
string <= 32000 characters

The value of the Opportunity Line item 3rd custom field

custom4
string <= 32000 characters

The value of the Opportunity Line Items 4th custom field

custom5
string <= 32000 characters

The value of the Opportunity Line Item 5th custom field

custom6
string <= 32000 characters

The value of the Opportunity Line Item 6th custom field

custom7
string <= 32000 characters

The value of the Opportunity Line Item 7th custom field

custom8
string <= 32000 characters

The value of the Opportunity Line Item 8th custom field

custom9
string <= 32000 characters

The value of the Opportunity Line Item 9th custom field

custom10
string <= 32000 characters

The value of the Opportunity Line Item 10th custom field.

discount
number <float>

The discount in opportunity Line item product.

externalId
string <= 255 characters

A custom ID for the Opportunity Line Item, often referencing an ID in an external system

externalProductId
string <= 255 characters

A custom Product id for the Opportunity Line Item, often referencing an Product id in an external system

lineDescription
string <= 65535 characters

A description of the opportunity Line item.

name
string <= 255 characters

The name of the opportunity Line item.

productId
string <= 255 characters

The product id of this opportunity Line item.

quantity
number <float>

The quantity of the product

totalPrice
number <float>

The total price of opportunity Line item.

unitPrice
number <float>

The unit price of opportunity Line item.

updatedAt
string <date-time>

The date and time the opportunity Line item was updated.

{
}

Opportunity Line Item Relationships

(user (data (object) or links (object)))

The creator of the opportunity Line item. Relationship creator cannot be used as a filter.

data (object) or links (object) (opportunity)

The opportunity with who the opportunity Line item is associated. You can use only the attribute id to filter opportunity Line items by owner (e.g. filter[opportunity][id]=X).

data (object) or links (object) (user)

The user who owns the opportunity Line item. You can use only the attribute id to filter opportunity Line items by owner (e.g. filter[owner][id]=X).

(user (data (object) or links (object)))

The updater of the opportunity Line item. Relationship updater cannot be used as a filter.

{
}

Opportunity Line Item Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Opportunity Line Item Actions

Get a Collection of Opportunity Line Items

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/opportunityLineItems
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Opportunity Line Item
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/opportunityLineItems
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Opportunity Line Item by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/opportunityLineItems/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get an Opportunity Line Item by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/opportunityLineItems/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update an Opportunity Line Item
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/opportunityLineItems/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}