Update a sales order line
patch
/crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine/{OrderLineId}
Request
Path Parameters
-
OrderHeaderId(required): integer(int64)
The unique identifier for the quote or order.
-
OrderLineId(required): integer(int64)
The unique identifier for the Sales Order Line.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Amount: number
Title:
Net Amount
The revenue amount associated with the sales order line item. -
ContractEndDate: string
(date-time)
Title:
Line Contract End Date
The end date of the contract associated with the sales order line on the sales order. -
ContractPeriods: integer
(int64)
Title:
Line Contract Periods
The number of contract periods associated with the sales order line. -
ContractStartDate: string
(date-time)
Title:
Line Contract Start Date
The start date of the contract associated with the sales order line on the sales order. -
ContractValue: number
Title:
Line Contract Value
The total amount associated with a sales order line item. -
CurrencyCode: string
Title:
Line Currency
Maximum Length:15
The currency code associated with the sales order line. -
DiscountPercentage: number
Title:
Line Discount
The discount applied to the specific sales order line in percentage. -
ExternalAssetKey: string
Title:
External Asset Key
Maximum Length:255
The asset key from an external system. -
ExternalOrderLineId: string
Title:
External Order Line ID
Maximum Length:64
The unique identifier of the external order line. -
ExternalOrderLineNumber: string
Title:
External Line Number
Maximum Length:64
The alternate identifier of the source system which created the record. -
ExternalParentAssetKey: string
Title:
External Parent Asset Key
Maximum Length:255
The root asset key of the parent from an external system. -
ExternalRootAssetKey: string
Title:
External Root Asset Key
Maximum Length:255
The root asset key obtained from an external system. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the inventory item. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization. -
ItemTypeCode: string
Title:
Item Type
Maximum Length:30
The type of sales order line item. -
LineStatusCode: string
Title:
Line Status
Maximum Length:30
The status of the sales order line record. -
MonthlyRecurringRevenue: number
Title:
Monthly Recurring Revenue
The monthly recurring revenue for the quote line. -
MonthlyUsageRevenue: number
Title:
Monthly Usage Revenue
The monthly usage revenue for the quote line. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring or one time revenue for the quote line. -
OptyId: integer
(int64)
The unique identifier of the opportunity of the Order associated with the order line.
-
OrderDate: string
(date-time)
Title:
Line Order Date
The date on which the order line was ordered. -
OrderHeaderId: integer
(int64)
Title:
Order Header ID
The unique identifier for Sales order record. -
OrderNumber: string
Title:
Order Number
Maximum Length:64
The reference number for a fulfillment order. -
ParentExternalOrderLineNumber: string
Title:
Parent External Line Number
Maximum Length:64
The public unique ID of a parent sales order line from an external application. -
Price: number
Title:
Net Price
The price of the sales order line item per UOM. -
PricePeriodCode: string
Title:
Line Price Period
Maximum Length:30
The period for which the price associated with the sales order line item is specified. -
PriceTypeCode: string
Title:
Line Price Type
Maximum Length:30
The type of pricing associated with the sales order line item. -
Quantity: number
Title:
Quantity
The quantity associated with the sales order line item. -
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue for the quote line. -
RequestDate: string
(date-time)
Title:
Line Request Date
The requested date for the product on the sales order line. -
RevenueTypeCategory: string
Title:
Revenue Type Category
Maximum Length:30
The Revenue category type of the opportunity revenue line. -
RevnId: integer
(int64)
Title:
Revenue ID
The unique identifier for Revenue associated with the order line. -
RootLine: string
Title:
Root Line
Maximum Length:1
Indicates whether the quote line is of type root. -
SubscriptionId: integer
(int64)
Title:
Subscription Id
The unique identifier of a subscription. -
SubscriptionLineId: integer
(int64)
Title:
Subscription Line Id
The unique identifier of the subscription line within a subscription. -
Subtotal: number
Title:
Line Subtotal
The amount associated with a sales order line item depending on the price type. -
SummableContractAmount: number
Title:
Contract Value Detail
The contract value for the quote line, which can be aggregated and used for reporting needs. -
SummableNonRecurringRevenue: number
Title:
Nonrecurring Revenue Detail
The non recurring revenue for the quote line, which can be aggregated and used for reporting needs. -
SummableRecurringRevenue: number
Title:
Recurring Revenue Detail
The recurring revenue for the quote line, which can be aggregated and used for reporting needs. -
SummableUsageRevenue: number
Title:
Usage Revenue Detail
The usage revenue for the quote line, which can be aggregated and used for reporting needs. -
UnitListPrice: number
Title:
Unit List Price
The unit list price for the quote line item. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure used to sell the product. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue for the quote line. -
WinLossStatusCode: string
Title:
Line Win Loss Status
Maximum Length:30
Indicates the current win or loss status of an order line.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : salesOrders-SalesOrderLine-item-response
Type:
Show Source
object
-
Amount: number
Title:
Net Amount
The revenue amount associated with the sales order line item. -
ContractEndDate: string
(date-time)
Title:
Line Contract End Date
The end date of the contract associated with the sales order line on the sales order. -
ContractPeriods: integer
(int64)
Title:
Line Contract Periods
The number of contract periods associated with the sales order line. -
ContractStartDate: string
(date-time)
Title:
Line Contract Start Date
The start date of the contract associated with the sales order line on the sales order. -
ContractValue: number
Title:
Line Contract Value
The total amount associated with a sales order line item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The label indicates the current win or loss status of an order line. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurrencyCode: string
Title:
Line Currency
Maximum Length:15
The currency code associated with the sales order line. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the user has access to delete the record. -
Description: string
Title:
Product Name
Read Only:true
Maximum Length:240
The name of the product associated with order line. -
DiscountPercentage: number
Title:
Line Discount
The discount applied to the specific sales order line in percentage. -
ExternalAssetKey: string
Title:
External Asset Key
Maximum Length:255
The asset key from an external system. -
ExternalOrderLineId: string
Title:
External Order Line ID
Maximum Length:64
The unique identifier of the external order line. -
ExternalOrderLineNumber: string
Title:
External Line Number
Maximum Length:64
The alternate identifier of the source system which created the record. -
ExternalParentAssetKey: string
Title:
External Parent Asset Key
Maximum Length:255
The root asset key of the parent from an external system. -
ExternalQuoteNumber: string
Title:
Quote ID
Read Only:true
Maximum Length:30
The identifier of the source system that created the Quote. -
ExternalRootAssetKey: string
Title:
External Root Asset Key
Maximum Length:255
The root asset key obtained from an external system. -
ExtReferenceNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:64
The identifier for the External Quote or Order. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the inventory item. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
The item number of the product associated with the sales order line. -
ItemTypeCode: string
Title:
Item Type
Maximum Length:30
The type of sales order line item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the order line record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the order line record. -
LineStatusCode: string
Title:
Line Status
Maximum Length:30
The status of the sales order line record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MonthlyRecurringRevenue: number
Title:
Monthly Recurring Revenue
The monthly recurring revenue for the quote line. -
MonthlyUsageRevenue: number
Title:
Monthly Usage Revenue
The monthly usage revenue for the quote line. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring or one time revenue for the quote line. -
OptyId: integer
(int64)
The unique identifier of the opportunity of the Order associated with the order line.
-
OrderDate: string
(date-time)
Title:
Line Order Date
The date on which the order line was ordered. -
OrderHeaderId: integer
(int64)
Title:
Order Header ID
The unique identifier for Sales order record. -
OrderHeaderName: string
Title:
Order Header Name
Read Only:true
Maximum Length:275
The name of the order associated with the order line. -
OrderHeaderNumber: string
Title:
Quote or Order Number
Read Only:true
Maximum Length:30
The public unique identifier of the order associated with the order line. -
OrderLineId: integer
(int64)
Title:
Order Line ID
The unique identifier for the Sales Order Line. -
OrderLineNumber: string
Title:
Order Line Number
Maximum Length:30
The sales order line number. -
OrderNumber: string
Title:
Order Number
Maximum Length:64
The reference number for a fulfillment order. -
ParentExternalOrderLineNumber: string
Title:
Parent External Line Number
Maximum Length:64
The public unique ID of a parent sales order line from an external application. -
Price: number
Title:
Net Price
The price of the sales order line item per UOM. -
PricePeriodCode: string
Title:
Line Price Period
Maximum Length:30
The period for which the price associated with the sales order line item is specified. -
PriceTypeCode: string
Title:
Line Price Type
Maximum Length:30
The type of pricing associated with the sales order line item. -
Quantity: number
Title:
Quantity
The quantity associated with the sales order line item. -
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue for the quote line. -
RequestDate: string
(date-time)
Title:
Line Request Date
The requested date for the product on the sales order line. -
RevenueTypeCategory: string
Title:
Revenue Type Category
Maximum Length:30
The Revenue category type of the opportunity revenue line. -
RevnId: integer
(int64)
Title:
Revenue ID
The unique identifier for Revenue associated with the order line. -
RootLine: string
Title:
Root Line
Maximum Length:1
Indicates whether the quote line is of type root. -
SalesAccountId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the Sales Account of the Order associated with the order line. -
SoldContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the contact of the Order associated with the order line. -
SoldCustPartyId: integer
(int64)
Title:
Customer ID
Read Only:true
The unique identifier of the account of the Order associated with the order line. -
SoldPartySiteId: integer
(int64)
Title:
Customer ID
Read Only:true
The unique identifier of the customer address of the Order associated with the order line. -
SubscriptionId: integer
(int64)
Title:
Subscription Id
The unique identifier of a subscription. -
SubscriptionLineId: integer
(int64)
Title:
Subscription Line Id
The unique identifier of the subscription line within a subscription. -
Subtotal: number
Title:
Line Subtotal
The amount associated with a sales order line item depending on the price type. -
SummableContractAmount: number
Title:
Contract Value Detail
The contract value for the quote line, which can be aggregated and used for reporting needs. -
SummableNonRecurringRevenue: number
Title:
Nonrecurring Revenue Detail
The non recurring revenue for the quote line, which can be aggregated and used for reporting needs. -
SummableRecurringRevenue: number
Title:
Recurring Revenue Detail
The recurring revenue for the quote line, which can be aggregated and used for reporting needs. -
SummableUsageRevenue: number
Title:
Usage Revenue Detail
The usage revenue for the quote line, which can be aggregated and used for reporting needs. -
UnitListPrice: number
Title:
Unit List Price
The unit list price for the quote line item. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure used to sell the product. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the user has access to update the record. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue for the quote line. -
WinLossStatusCode: string
Title:
Line Win Loss Status
Maximum Length:30
Indicates the current win or loss status of an order line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- RevenueTypeCategoryPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RevenueTypeCategory}%2CBindLookupType%3DORA_MOO_REVN_CATEGORY_TYPE
The list of values for revenue category type, such as New, Renew , Expansion, and Do not renew.
The following properties are defined on the LOV link relation:- Source Attribute: RevenueTypeCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: