Update a quote
patch
/crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}
Request
Path Parameters
-
OrderHeaderId(required): integer(int64)
The unique identifier for the quote or order.
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
-
AccountBasedQuoteFlag: boolean
Title:
Account Based Quote
Maximum Length:1
Indicates if this quote record is an account based quote or not. -
ActiveVersionFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the sales order is active or not. It has values as true or false. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
The Business Unit or Internal Organization to which this Quote belongs. -
ContractEndDate: string
(date-time)
Title:
Contract End Date
The latest end date for all the line items within the quote. -
ContractStartDate: string
(date-time)
Title:
Contract Start Date
The earliest start date for all the items within the quote. -
CrmConversionRate: number
Title:
Currency Conversion Rate
The currency conversion rate for transactions associated with the sales order. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the sales order. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
Description: string
Title:
Description
Maximum Length:360
The description of the order. -
ExpirationDate: string
(date-time)
Title:
Valid to Date
The date when the sales order expires. -
ExternalHostName: string
Title:
CPQ Host Name
Maximum Length:255
The name of the CPQ site. -
ExternalProcessName: string
Title:
CPQ Process Name
Maximum Length:255
The name of the process for a CPQ site. -
ExternalQuoteNumber: string
Title:
Quote ID
Maximum Length:30
The unique identifier from source system that created this quote. -
ExternalReferenceNumber: string
Title:
Reference Number
Maximum Length:64
The external reference number of a quote from an external source system. -
ExternalSystemReferenceCode: string
Title:
Reference Code
Maximum Length:30
The external reference (third party) type for the quote or order; big machines will pass BMQUOTE. -
LastOptySyncDate: string
(date-time)
Title:
Last Synchronized
The last date when the opportunity can be synchronized for the quote to identify the active version of the quote for the opportunity. -
Name: string
Title:
Name
Maximum Length:275
The name of the quote or order. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OrderTotal: number
Title:
Total Contract Value
The total amount of the quote or order. -
Owner: string
Title:
Quote Descriptor
Maximum Length:360
The owner of the order. -
OwnerResourcePartyId: integer
(int64)
Title:
Owner Resource Party Id
The resource identifier of the owner party. -
PlacedOnDate: string
(date-time)
Title:
Placed On
The date on which order was placed. -
ProposalExistFlag: boolean
Title:
Proposal
Maximum Length:1
Indicates if proposal document has been generated for the Quote, such as Y or N. There is no default value. -
QuoteTypeCategory: string
Title:
Quote Type Category
Maximum Length:30
Indicates if the quote is new, renewal, or an expansion. -
RenewalProcess: string
Title:
Renewal Process
Maximum Length:30
The renewal process that is used to renew the Quote. -
SalesAccountId: integer
(int64)
Title:
Account ID
The unique identifier for the customer account associated with the sales order. -
SalesOrderActiveVersionVA: array
Sales Orders Active Version
Title:
Sales Orders Active Version
The sales orders active versions resource lists all active sales order versions. -
SalesOrderLine: array
Quote and Order Lines
Title:
Quote and Order Lines
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data. -
SalesOrderRollup: array
Quote Rollups
Title:
Quote Rollups
The quote rollups resource is used to view quote rollup information. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SoldContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the customer contact party. -
SoldCustomerPartyId: integer
(int64)
Title:
Customer ID
The unique identifier of the customer party. -
SoldPartySiteId: integer
(int64)
Title:
Address ID
The unique identifier of the customer site. -
Status: string
Title:
Status
Maximum Length:255
The exact quote status sent by the BM. -
TotalMonthlyRecurringRevenue: number
Title:
Total Monthly Recurring Revenue
The total monthly recurring revenue for the quote. -
TotalMonthlyUsageRevenue: number
Title:
Total Monthly Usage Revenue
The total monthly usage revenue for the quote. -
TotalNonRecurringRevenue: number
Title:
Total Nonrecurring Revenue
The total non recurring revenue for the quote. -
TotalRecurringRevenue: number
Title:
Total Recurring Revenue
The total recurring revenue for the quote. -
TotalUsageRevenue: number
Title:
Total Usage Revenue
The total usage revenue for the quote. -
VersionNumber: integer
(int64)
Title:
Version
The version number of the quote or order. -
WinStatusCode: string
Title:
Win Status
Maximum Length:30
Default Value:ZCA_IN_PROGRESS
The code indicating the status of the win. For example, ZCA_WIN, ZCA_LOST, ZCA_IN_PROGRESS, ZCA_DELETED, or ZCA_ALTERNATE_VERSION. The valid values are listed in ORA_ZCA_WIN_STATUS. The aggregate status of quote or sales order defines the aggregate status of each quote or sales order for filtering and analytics.
Nested Schema : Sales Orders Active Version
Type:
array
Title:
Sales Orders Active Version
The sales orders active versions resource lists all active sales order versions.
Show Source
Nested Schema : Quote and Order Lines
Type:
array
Title:
Quote and Order Lines
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data.
Show Source
Nested Schema : Quote Rollups
Type:
array
Title:
Quote Rollups
The quote rollups resource is used to view quote rollup information.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : salesOrders-SalesOrderLine-item-patch-request
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.
Nested Schema : salesOrders-smartActions-item-patch-request
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether the action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : salesOrders-smartActions-UserActionRequestPayload-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : salesOrders-smartActions-UserActionURLBinding-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
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-item-response
Type:
Show Source
object
-
AccountBasedQuoteFlag: boolean
Title:
Account Based Quote
Maximum Length:1
Indicates if this quote record is an account based quote or not. -
ActiveVersionFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the sales order is active or not. It has values as true or false. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
The Business Unit or Internal Organization to which this Quote belongs. -
ContactPartyName: string
Title:
Contact
Read Only:true
Maximum Length:360
The name of the primary contact for the quote or sales order. -
ContractEndDate: string
(date-time)
Title:
Contract End Date
The latest end date for all the line items within the quote. -
ContractStartDate: string
(date-time)
Title:
Contract Start Date
The earliest start date for all the items within the quote. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the sales order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the sales order was created. -
CrmConversionRate: number
Title:
Currency Conversion Rate
The currency conversion rate for transactions associated with the sales order. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the sales order. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the user has access to delete the record. -
Description: string
Title:
Description
Maximum Length:360
The description of the order. -
ExpirationDate: string
(date-time)
Title:
Valid to Date
The date when the sales order expires. -
ExternalHostName: string
Title:
CPQ Host Name
Maximum Length:255
The name of the CPQ site. -
ExternalProcessName: string
Title:
CPQ Process Name
Maximum Length:255
The name of the process for a CPQ site. -
ExternalQuoteNumber: string
Title:
Quote ID
Maximum Length:30
The unique identifier from source system that created this quote. -
ExternalReferenceNumber: string
Title:
Reference Number
Maximum Length:64
The external reference number of a quote from an external source system. -
ExternalSystemReferenceCode: string
Title:
Reference Code
Maximum Length:30
The external reference (third party) type for the quote or order; big machines will pass BMQUOTE. -
LastOptySyncDate: string
(date-time)
Title:
Last Synchronized
The last date when the opportunity can be synchronized for the quote to identify the active version of the quote for the opportunity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the sales order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:275
The name of the quote or order. -
OpportunityName: string
Title:
Opportunity
Read Only:true
Maximum Length:275
The name of the opportunity associated to the quote or sales order. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Read Only:true
Maximum Length:30
The opportunity number associated with the sales order. -
OptyStatusCd: string
Title:
Opportunity Status
Read Only:true
Maximum Length:30
The status of the opportunity associated with the sales order. The valid values are listed in MOO_OPTY_STATUS lookup type. -
OrderHeaderId: integer
(int64)
Title:
ID
The unique identifier for the quote or order. -
OrderHeaderNumber: string
Title:
Quote or Order Number
Maximum Length:30
The alternate key identifier for a sales order. -
OrderTotal: number
Title:
Total Contract Value
The total amount of the quote or order. -
Owner: string
Title:
Quote Descriptor
Maximum Length:360
The owner of the order. -
OwnerResourcePartyId: integer
(int64)
Title:
Owner Resource Party Id
The resource identifier of the owner party. -
OwnerResourcePartyName: string
Title:
Owner Party Name
Read Only:true
Maximum Length:360
The party name of the owner. -
PlacedOnDate: string
(date-time)
Title:
Placed On
The date on which order was placed. -
ProposalExistFlag: boolean
Title:
Proposal
Maximum Length:1
Indicates if proposal document has been generated for the Quote, such as Y or N. There is no default value. -
ProposalUrl: string
Title:
Proposal URL
Read Only:true
The URL to fetch quote proposal document. -
QuoteTypeCategory: string
Title:
Quote Type Category
Maximum Length:30
Indicates if the quote is new, renewal, or an expansion. -
RenewalProcess: string
Title:
Renewal Process
Maximum Length:30
The renewal process that is used to renew the Quote. -
SalesAccountId: integer
(int64)
Title:
Account ID
The unique identifier for the customer account associated with the sales order. -
SalesAccountUniqueName: string
Title:
Customer
Read Only:true
Maximum Length:900
The name of the customer account. -
SalesOrderActiveVersionVA: array
Sales Orders Active Version
Title:
Sales Orders Active Version
The sales orders active versions resource lists all active sales order versions. -
SalesOrderLine: array
Quote and Order Lines
Title:
Quote and Order Lines
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data. -
SalesOrderRollup: array
Quote Rollups
Title:
Quote Rollups
The quote rollups resource is used to view quote rollup information. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SoldContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the customer contact party. -
SoldContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The unique identifier of the contact associated with the sales order. -
SoldCustomerPartyId: integer
(int64)
Title:
Customer ID
The unique identifier of the customer party. -
SoldCustomerPartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The customer party unique name. -
SoldCustPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The unique identifier of the account associated with the sales order. -
SoldPartySiteId: integer
(int64)
Title:
Address ID
The unique identifier of the customer site. -
Status: string
Title:
Status
Maximum Length:255
The exact quote status sent by the BM. -
TotalMonthlyRecurringRevenue: number
Title:
Total Monthly Recurring Revenue
The total monthly recurring revenue for the quote. -
TotalMonthlyUsageRevenue: number
Title:
Total Monthly Usage Revenue
The total monthly usage revenue for the quote. -
TotalNonRecurringRevenue: number
Title:
Total Nonrecurring Revenue
The total non recurring revenue for the quote. -
TotalRecurringRevenue: number
Title:
Total Recurring Revenue
The total recurring revenue for the quote. -
TotalUsageRevenue: number
Title:
Total Usage Revenue
The total usage revenue for the quote. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the user has access to update the record. -
VersionNumber: integer
(int64)
Title:
Version
The version number of the quote or order. -
WinStatusCode: string
Title:
Win Status
Maximum Length:30
Default Value:ZCA_IN_PROGRESS
The code indicating the status of the win. For example, ZCA_WIN, ZCA_LOST, ZCA_IN_PROGRESS, ZCA_DELETED, or ZCA_ALTERNATE_VERSION. The valid values are listed in ORA_ZCA_WIN_STATUS. The aggregate status of quote or sales order defines the aggregate status of each quote or sales order for filtering and analytics.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sales Orders Active Version
Type:
array
Title:
Sales Orders Active Version
The sales orders active versions resource lists all active sales order versions.
Show Source
Nested Schema : Quote and Order Lines
Type:
array
Title:
Quote and Order Lines
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data.
Show Source
Nested Schema : Quote Rollups
Type:
array
Title:
Quote Rollups
The quote rollups resource is used to view quote rollup information.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
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.
Nested Schema : salesOrders-SalesOrderActiveVersionVA-item-response
Type:
Show Source
object
-
ActiveVersion: string
Read Only:
true
Maximum Length:255
The active version number of the order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderHeaderId: integer
Read Only:
true
The unique identifier for the order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : salesOrders-SalesOrderRollup-item-response
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Corporate Currency Code
Read Only:true
Maximum Length:15
The corporate currency code for the Quotes Rollups. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderHeaderId: integer
(int64)
Title:
Order Header ID
Read Only:true
Indicates the ID of a quote rollup header associated with an order line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrders-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether the action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
array
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : salesOrders-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrders-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- OptyRenewalProcessPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RenewalProcess}%2CBindLookupType%3DORA_MOO_OPTY_RENEWAL_PROCESS
The list of values indicating the renewal process which can be manual, do not renew, or automatic renewal.
The following properties are defined on the LOV link relation:- Source Attribute: RenewalProcess; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OptyStatusZbsLookupValuesVA
-
Parameters:
- finder:
StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: OptyStatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- QuoteTypeCategoryPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{QuoteTypeCategory}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_TYPE
The list of values indicating the different types of quotes such as new, renewal, and expansion.
The following properties are defined on the LOV link relation:- Source Attribute: QuoteTypeCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesOrderActiveVersionVA
-
Operation: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderActiveVersionVAParameters:
- OrderHeaderId:
$request.path.OrderHeaderId
The sales orders active versions resource lists all active sales order versions. - OrderHeaderId:
- SalesOrderLine
-
Parameters:
- OrderHeaderId:
$request.path.OrderHeaderId
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data. - OrderHeaderId:
- SalesOrderRollup
-
Parameters:
- OrderHeaderId:
$request.path.OrderHeaderId
The quote rollups resource is used to view quote rollup information. - OrderHeaderId:
- StatusLookupPVO
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZCA_SO_STATUS
The list of values indicating the status of the sales order, such as Created, Cancelled etc.
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- WinStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_ZCA_WIN_STATUS
The list of values indicating the overall status of a quote or sales order, such as Won and In progress.
The following properties are defined on the LOV link relation:- Source Attribute: WinStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the sales order is active or not, having values true and false.
The following properties are defined on the LOV link relation:- Source Attribute: ActiveVersionFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- smartActions
-
Parameters:
- OrderHeaderId:
$request.path.OrderHeaderId
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - OrderHeaderId:
Examples
The following example shows how to update a quote by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesOrders/300100090895614s
Example of Request Body
The following shows an example of the request body in JSON format.
{ "Status": "Completed" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "CurrencyCode": "USD", "ExpirationDate": null, "ExternalReferenceNumber": null, "LastOptySyncDate": "2014-04-20T10:00:00-07:00", "LastUpdateDate": "2016-12-19T23:33:06-08:00", "Name": "DP_WS_AutoRuna4052376911", "OptyId": 999997817606460, "OrderHeaderId": 300100090895614, "OrderTotal": 3500, "ProposalExistFlag": true, "SoldContactPartyId": null, "SoldCustomerPartyId": 999997550844629, "SoldPartySiteId": null, "VersionNumber": 1, "Owner": null, "Description": "Description of order by name:DP_WS_AutoRuna4052376911", "ExternalSystemReferenceCode": null, "Status": "Completed", "WinStatusCode": "ZCA_IN_PROGRESS", "PlacedOnDate": null, "CrmConversionRate": 1, "SalesAccountId": 999997550844629, ... }