Copy to Favorites

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/copyToFavorites

Use this endpoint to copy the specified line items from the transaction to the Favorites List.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Transaction-CopyToFavoritesRequest
Type: object
Show Source
  • Title: Cache Instance Id
    The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
  • Query Definition
    Title: Query Definition
    Captures the query definition for the current resource request.
  • Title: Delta
    The boolean parameter to request a delta response for data as well as state in the context of current criteria.
  • Transaction
    Title: Transaction
  • Favorite Data
    Title: Favorite Data
    List of overrides for the favorites to be created
  • Title: Revision Id
    The string parameter that contains the revision information.
  • Title: Selection Mode
    Indicating how selections content should be interpreted, supported values are: 1) ' ' - content of ' selections ' param OR 2) ' ResultSetExceptSelected ' - all entries in result set except those listed in ' selections ' param
  • selections
  • Title: skipIntegration
    If value for ' skipIntegration ' is true, integration tab logic is skipped, otherwise(value is false or absent) it is executed.
Nested Schema : Query Definition
Type: object
Title: Query Definition
Captures the query definition for the current resource request.
Show Source
Nested Schema : Transaction
Type: object
Title: Transaction
Show Source
Nested Schema : Favorite Data
Type: object
Title: Favorite Data
List of overrides for the favorites to be created
Show Source
Nested Schema : selections
Type: array
Show Source
Nested Schema : actions
Type: array
Array of actions names, whose state is requested in the state object response.
Show Source
Nested Schema : childDefs
Type: array
Show Source
Nested Schema : expand
Type: array
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
Show Source
Nested Schema : expandedDomains
Type: array
Array of field names, whose expanded domains are requested in the state object response.
Show Source
Nested Schema : fields
Type: array
Array of field names that you wanted returned in a request.
Show Source
Nested Schema : Child query criteria.
Type: object
Title: Child query criteria.
Captures the query criteria for the child resource.
Show Source
Nested Schema : _currency_pref
Type: object
Title: _currency_pref
Show Source
Nested Schema : Customer Country
Type: object
Title: Customer Country
Show Source
Nested Schema : Customer State
Type: object
Title: Customer State
Show Source
Nested Schema : CmAttachmentAttribute
Type: object
Title: CmAttachmentAttribute
Complex type that describes commerce attachment attribute
Show Source
Nested Schema : eSignature Status[eSignature Attribute Set]
Type: object
Title: eSignature Status[eSignature Attribute Set]
Show Source
Nested Schema : eSignature Status[esig Test]
Type: object
Title: eSignature Status[esig Test]
Show Source
Nested Schema : Invoice To Country
Type: object
Title: Invoice To Country
Show Source
Nested Schema : Invoice To State
Type: object
Title: Invoice To State
Show Source
Nested Schema : Commerce Composite Attribute
Type: object
Title: Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes.
Show Source
Nested Schema : Revenue Category
Type: object
Title: Revenue Category
Show Source
Nested Schema : Assigned To
Type: object
Title: Assigned To
Show Source
Nested Schema : Bill To Country
Type: object
Title: Bill To Country
Show Source
Nested Schema : Bill To State
Type: object
Title: Bill To State
Show Source
Nested Schema : Customer Status
Type: object
Title: Customer Status
Show Source
Nested Schema : Customer Visibility Identifier
Type: object
Title: Customer Visibility Identifier
Show Source
Nested Schema : Source Of Transaction
Type: object
Title: Source Of Transaction
Show Source
Nested Schema : Ship To Country
Type: object
Title: Ship To Country
Show Source
Nested Schema : Ship To State
Type: object
Title: Ship To State
Show Source
Nested Schema : Sold To Country
Type: object
Title: Sold To Country
Show Source
Nested Schema : Sold To State
Type: object
Title: Sold To State
Show Source
Nested Schema : state
Type: object
Title: state
Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
  • Actions
    Title: Actions
    Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
  • Attributes
    Title: Attributes
    Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
  • Title: Deletable
    Boolean value that specifies whether the row can be deleted.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the row itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Updatable
    Boolean value that specifies whether the row can be updated.
Nested Schema : Transaction Total (Net)
Type: object
Title: Transaction Total (Net)
The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value.
Show Source
Nested Schema : Account Type
Type: object
Title: Account Type
Show Source
Nested Schema : Account AddressType
Type: object
Title: Account AddressType
Show Source
Nested Schema : Annual Contract Value (List)
Type: object
Title: Annual Contract Value (List)
The total of contract extended values at list price within the first year, including only recurring pricing.
Show Source
Nested Schema : Approval History[Submit]
Type: array
Title: Approval History[Submit]
This attribute records approval history of a transaction.If a reason is reset, it is erased from the approval history.
Show Source
  • Approval History
    Title: Approval History
    This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Approval Status[Submit]
Type: array
Title: Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction.
Show Source
Nested Schema : My Approval[Submit]
Type: array
Title: My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
Nested Schema : Cancel Reason
Type: object
Title: Cancel Reason
Show Source
Nested Schema : Contact Type
Type: object
Title: Contact Type
Show Source
Nested Schema : Currency
Type: object
Title: Currency
Show Source
Nested Schema : Fulfillment Status
Type: object
Title: Fulfillment Status
Show Source
Nested Schema : Billing Frequency
Type: object
Title: Billing Frequency
Show Source
Nested Schema : Payment Terms
Type: object
Title: Payment Terms
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : Reject Reason
Type: object
Title: Reject Reason
Show Source
Nested Schema : Renewal Process
Type: object
Title: Renewal Process
Show Source
Nested Schema : Renewal Process Used
Type: object
Title: Renewal Process Used
Show Source
Nested Schema : Sales Channel
Type: object
Title: Sales Channel
Show Source
Nested Schema : Status
Type: object
Title: Status
Show Source
Nested Schema : Annual Cost
Type: object
Title: Annual Cost
The total of recurring extended costs each year for the transaction.
Show Source
Nested Schema : Annual Contract Discount
Type: object
Title: Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction.
Show Source
Nested Schema : Annual Margin
Type: object
Title: Annual Margin
The total of recurring extended margins each year for the transaction.
Show Source
Nested Schema : Annual Contract Value(Net)
Type: object
Title: Annual Contract Value(Net)
The total value of recurring charges each year.
Show Source
Nested Schema : Total Contract Cost
Type: object
Title: Total Contract Cost
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs.
Show Source
Nested Schema : Total Contract Discount
Type: object
Title: Total Contract Discount
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract.
Show Source
Nested Schema : Total Contract Value (List)
Type: object
Title: Total Contract Value (List)
The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List).
Show Source
Nested Schema : Total Contract Margin
Type: object
Title: Total Contract Margin
The total of all contract extended margins for this transaction over the duration of the contract, including all one - time and recurring values.
Show Source
Nested Schema : Total Contract Value (Net)
Type: object
Title: Total Contract Value (Net)
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
Nested Schema : Total Monthly Cost
Type: object
Title: Total Monthly Cost
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month.
Show Source
Nested Schema : Total Discount Per Month
Type: object
Title: Total Discount Per Month
The total of discounts off monthly recurring charges.
Show Source
Nested Schema : Total (List) Per Month
Type: object
Title: Total (List) Per Month
The total of all monthly recurring list amounts on the lines.
Show Source
Nested Schema : Total Monthly Margin
Type: object
Title: Total Monthly Margin
The total of extended margins for all monthly recurring charges for the transaction.
Show Source
Nested Schema : Total (Net) Per Month
Type: object
Title: Total (Net) Per Month
The total of all monthly recurring net amounts on the lines.
Show Source
Nested Schema : Total MUR (Net)
Type: object
Title: Total MUR (Net)
The total of all monthly usage revenues net of all discounts for this transaction.
Show Source
Nested Schema : Total One-Time Cost
Type: object
Title: Total One-Time Cost
The total of extended costs for all one-time charges for the transaction.
Show Source
Nested Schema : Total Discount
Type: object
Title: Total Discount
The total of all extended discount amounts for one time??pricing/charges.
Show Source
Nested Schema : Total (List)
Type: object
Title: Total (List)
The total of all one-time charges on the lines.
Show Source
Nested Schema : Total One-Time Margin
Type: object
Title: Total One-Time Margin
The total of extended margins for all one-time charges for the transaction.
Show Source
Nested Schema : Total (Net)
Type: object
Title: Total (Net)
The total one time net charge.
Show Source
Nested Schema : Total Recurring Revenue (Net)
Type: object
Title: Total Recurring Revenue (Net)
The total recurring revenues net of all discounts for this transaction.
Show Source
Nested Schema : Total Usage Revenue (Net)
Type: object
Title: Total Usage Revenue (Net)
The total usage revenues net of all discounts for this transaction.
Show Source
Nested Schema : TransactionLine-collection
Type: object
Show Source
  • state
    Title: state
    Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Win/Loss Status
Type: object
Title: Win/Loss Status
Show Source
Nested Schema : Value
Type: object
Title: Value
Composite attribute value
Nested Schema : Actions
Type: object
Title: Actions
Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type: object
Title: Attributes
Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : Approval History
Type: object
Title: Approval History
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
Nested Schema : Approval Reject Status
Type: object
Title: Approval Reject Status
This attribute lists all approval and reject status details for current logged in user.
Show Source
Nested Schema : approverNames
Type: array
Title: approverNames
String value that specifies approverNames.
Show Source
Nested Schema : Approval Reject Icon
Type: object
Title: Approval Reject Icon
This attribute lists all approval and reject icon details for current logged in user.
Show Source
Nested Schema : state
Type: object
Title: state
Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
  • Actions
    Title: Actions
    Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
  • state
    Title: state
    Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
  • Focused Users
    Title: Focused Users
    Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the collection itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.
  • Title: Insertable
    Boolean value that specifies whether new rows can be inserted into the collection.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Queryable
    Boolean value that specifies whether the rows in the collection can be queried.
  • Title: Sortable
    Boolean value that specifies whether the rows in the collection can be sorted.
Nested Schema : items
Type: array
Show Source
Nested Schema : Actions
Type: object
Title: Actions
Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Focused Users
Type: object
Title: Focused Users
Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : Transaction Line
Type: object
Title: Transaction Line
Show Source
Nested Schema : Available Rate Plans
Type: object
Title: Available Rate Plans
Show Source
Nested Schema : TransactionLine_availableRatePlanSet-collection
Type: object
Show Source
  • state
    Title: state
    Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : TransactionLine_chargeSet-collection
Type: object
Show Source
  • state
    Title: state
    Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Delta Price
Type: object
Title: Delta Price
Delta Price
Show Source
Nested Schema : Model Base Price
Type: object
Title: Model Base Price
Base price of the model
Show Source
Nested Schema : Part Base Price
Type: object
Title: Part Base Price
Price of the part
Show Source
Nested Schema : Configurable Price
Type: object
Title: Configurable Price
Original price as per catalog (inclusive of discount and premium)
Show Source
Nested Schema : Item Price
Type: object
Title: Item Price
The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices.
Show Source
Nested Schema : List Price
Type: object
Title: List Price
Will usually be the same value as the Item Price, unless a recommended item price applies.
Show Source
Nested Schema : Unit Price
Type: object
Title: Unit Price
Will usually be the same value as the List Price, unless a contract price applies.
Show Source
Nested Schema : Pricing Rule Price
Type: object
Title: Pricing Rule Price
Currenly the customer level pricing. (Not applicable for Models)
Show Source
Nested Schema : Prior Price
Type: object
Title: Prior Price
Prior Price
Show Source
Nested Schema : Revenue Category
Type: object
Title: Revenue Category
Show Source
Nested Schema : Rollup Delta Price
Type: object
Title: Rollup Delta Price
Rollup Delta Price
Show Source
Nested Schema : Annual Cost
Type: object
Title: Annual Cost
The extended cost for recurring pricing on this transaction line.
Show Source
Nested Schema : Annual Discount
Type: object
Title: Annual Discount
The annual discount on the recurring charges on this line.
Show Source
Nested Schema : Annual Value (List)
Type: object
Title: Annual Value (List)
The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.
Show Source
Nested Schema : Annual Margin
Type: object
Title: Annual Margin
The extended margin for recurring pricing on this transaction line.
Show Source
Nested Schema : Annual Value (Net)
Type: object
Title: Annual Value (Net)
The annual contract value of the recurring charges on this line.
Show Source
Nested Schema : Cancel Reason
Type: object
Title: Cancel Reason
Show Source
Nested Schema : Change Code
Type: object
Title: Change Code
Show Source
Nested Schema : Change Reason
Type: object
Title: Change Reason
Show Source
Nested Schema : Contract Cost
Type: object
Title: Contract Cost
The total of all contract extended costs for this line, including one-time and recurring costs.
Show Source
Nested Schema : Contract Discount
Type: object
Title: Contract Discount
The total discount of this line including all one-time and recurring charges.
Show Source
Nested Schema : Contract Value (List)
Type: object
Title: Contract Value (List)
The total of all contract list value of this line, including all one-time and recurring charges.
Show Source
Nested Schema : Contract Value (List Rollup)
Type: object
Title: Contract Value (List Rollup)
Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.
Show Source
Nested Schema : Contract Margin
Type: object
Title: Contract Margin
The total of all contract extended margins for this line, including one-time and recurring values.
Show Source
Nested Schema : Contract Value (Net Summable)
Type: object
Title: Contract Value (Net Summable)
The total contract value of this line including all one-time and recurring charges.
Show Source
Nested Schema : Contract Value (Net Rollup)
Type: object
Title: Contract Value (Net Rollup)
Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.
Show Source
Nested Schema : Cost Amount
Type: object
Title: Cost Amount
The total cost of this line.
Show Source
Nested Schema : Custom Discount Amount
Type: object
Title: Custom Discount Amount
The amount by which to adjust the list price because of a custom discount.
Show Source
Nested Schema : Discount Type
Type: object
Title: Discount Type
Show Source
Nested Schema : Amount (Discount)
Type: object
Title: Amount (Discount)
The discount amount for this line.
Show Source
Nested Schema : Fulfillment Status
Type: object
Title: Fulfillment Status
Show Source
Nested Schema : Line Type
Type: object
Title: Line Type
Show Source
Nested Schema : Amount (List)
Type: object
Title: Amount (List)
The extended list amount for this line.
Show Source
Nested Schema : Price (List)
Type: object
Title: Price (List)
The list price of the item.
Show Source
Nested Schema : List Price (Rollup)
Type: object
Title: List Price (Rollup)
The list price of the item or for the root model rolled up to include all child values.
Show Source
Nested Schema : Margin Amount
Type: object
Title: Margin Amount
The margin for all quoted units of this transaction line.
Show Source
Nested Schema : MRR (Rollup)
Type: object
Title: MRR (Rollup)
Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.
Show Source
Nested Schema : MRR (Summable)
Type: object
Title: MRR (Summable)
Monthly recurring revenues net of all discounts for this line.
Show Source
Nested Schema : MUR (Rollup)
Type: object
Title: MUR (Rollup)
Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.
Show Source
Nested Schema : MUR (Summable)
Type: object
Title: MUR (Summable)
Monthly usage revenues net of all discounts for this line.
Show Source
Nested Schema : Amount (Net)
Type: object
Title: Amount (Net)
The extended list amount minus any discounts for this line.
Show Source
Nested Schema : Net Amount (Rollup)
Type: object
Title: Net Amount (Rollup)
The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.
Show Source
Nested Schema : Price (Net)
Type: object
Title: Price (Net)
The price paid by the customer for the item.
Show Source
Nested Schema : Net Price (Rollup)
Type: object
Title: Net Price (Rollup)
The price paid by the customer for the individual item or for the root model rolled up to include all child values.
Show Source
Nested Schema : Non-Recurring Revenue (Rollup)
Type: object
Title: Non-Recurring Revenue (Rollup)
One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.
Show Source
Nested Schema : Non-Recurring Revenue (Summable)
Type: object
Title: Non-Recurring Revenue (Summable)
One-time revenue net of all discounts for this line.
Show Source
Nested Schema : Action Code
Type: object
Title: Action Code
Show Source
Nested Schema : Payment Terms
Type: object
Title: Payment Terms
Show Source
Nested Schema : Period
Type: object
Title: Period
Show Source
Nested Schema : Price Recurrence Frequency
Type: object
Title: Price Recurrence Frequency
Show Source
Nested Schema : Price Recurrence Frequency (Rollup)
Type: object
Title: Price Recurrence Frequency (Rollup)
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : Price Type (Rollup)
Type: object
Title: Price Type (Rollup)
Show Source
Nested Schema : Recurring Revenue (Rollup)
Type: object
Title: Recurring Revenue (Rollup)
Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.
Show Source
Nested Schema : Recurring Revenue (Summable)
Type: object
Title: Recurring Revenue (Summable)
Recurring revenue net of all discounts for this line.
Show Source
Nested Schema : Unit of Measure
Type: object
Title: Unit of Measure
Show Source
Nested Schema : Root Line
Type: object
Title: Root Line
Show Source
Nested Schema : Sales Channel
Type: object
Title: Sales Channel
Show Source
Nested Schema : Status
Type: object
Title: Status
Show Source
Nested Schema : Unit Cost
Type: object
Title: Unit Cost
The unit cost of the item.
Show Source
Nested Schema : Margin
Type: object
Title: Margin
The margin for a single unit of this transaction line.
Show Source
Nested Schema : Usage Revenue (Rollup)
Type: object
Title: Usage Revenue (Rollup)
Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.
Show Source
Nested Schema : Usage Revenue (Summable)
Type: object
Title: Usage Revenue (Summable)
Usage revenue net of all discounts for this line.
Show Source
Nested Schema : Win/Loss Status
Type: object
Title: Win/Loss Status
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Available Rate Plan Set
Type: object
Title: Available Rate Plan Set
Show Source
Nested Schema : _transaction_currency_pref
Type: object
Title: _transaction_currency_pref
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Charge Set
Type: object
Title: Charge Set
Show Source
Nested Schema : Charge Type
Type: object
Title: Charge Type
Show Source
Nested Schema : Discount Amount
Type: object
Title: Discount Amount
The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.
Show Source
Nested Schema : Discount Type
Type: object
Title: Discount Type
Show Source
Nested Schema : Net Amount
Type: object
Title: Net Amount
The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.
Show Source
Nested Schema : Net Price
Type: object
Title: Net Price
The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.
Show Source
Nested Schema : Price Period
Type: object
Title: Price Period
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : Unit Price
Type: object
Title: Unit Price
The unit price to be paid by the customer for this charge.
Show Source
Nested Schema : Usage UOM
Type: object
Title: Usage UOM
Show Source
Nested Schema : _transaction_currency_pref
Type: object
Title: _transaction_currency_pref
Show Source
Nested Schema : Favorite Override Data Definition
Type: object
Title: Favorite Override Data Definition
Favorite Override Definition
Show Source
  • Title: Description
    Description for the favorite. An empty description indicates no override.
  • Title: Document Number
    Document Number of the selected line item
  • Title: Label
    Label for the favorite. An empty label indicates no override.
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Transaction-CopyToFavoritesResponse
Type: object
Show Source
Nested Schema : Transaction
Type: object
Title: Transaction
Show Source
Nested Schema : Created Favorite Ids
Type: array
Title: Created Favorite Ids
List of created favorite root ids
Show Source
Nested Schema : warnings
Type: object
Title: warnings
warning messages
Show Source
Nested Schema : _currency_pref
Type: object
Title: _currency_pref
Show Source
Nested Schema : Customer Country
Type: object
Title: Customer Country
Show Source
Nested Schema : Customer State
Type: object
Title: Customer State
Show Source
Nested Schema : CmAttachmentAttribute
Type: object
Title: CmAttachmentAttribute
Complex type that describes commerce attachment attribute
Show Source
Nested Schema : eSignature Status[eSignature Attribute Set]
Type: object
Title: eSignature Status[eSignature Attribute Set]
Show Source
Nested Schema : eSignature Status[esig Test]
Type: object
Title: eSignature Status[esig Test]
Show Source
Nested Schema : Invoice To Country
Type: object
Title: Invoice To Country
Show Source
Nested Schema : Invoice To State
Type: object
Title: Invoice To State
Show Source
Nested Schema : Commerce Composite Attribute
Type: object
Title: Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes.
Show Source
Nested Schema : Revenue Category
Type: object
Title: Revenue Category
Show Source
Nested Schema : Assigned To
Type: object
Title: Assigned To
Show Source
Nested Schema : Bill To Country
Type: object
Title: Bill To Country
Show Source
Nested Schema : Bill To State
Type: object
Title: Bill To State
Show Source
Nested Schema : Customer Status
Type: object
Title: Customer Status
Show Source
Nested Schema : Customer Visibility Identifier
Type: object
Title: Customer Visibility Identifier
Show Source
Nested Schema : Source Of Transaction
Type: object
Title: Source Of Transaction
Show Source
Nested Schema : Ship To Country
Type: object
Title: Ship To Country
Show Source
Nested Schema : Ship To State
Type: object
Title: Ship To State
Show Source
Nested Schema : Sold To Country
Type: object
Title: Sold To Country
Show Source
Nested Schema : Sold To State
Type: object
Title: Sold To State
Show Source
Nested Schema : state
Type: object
Title: state
Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
  • Actions
    Title: Actions
    Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
  • Attributes
    Title: Attributes
    Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
  • Title: Deletable
    Boolean value that specifies whether the row can be deleted.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the row itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Updatable
    Boolean value that specifies whether the row can be updated.
Nested Schema : Transaction Total (Net)
Type: object
Title: Transaction Total (Net)
The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value.
Show Source
Nested Schema : Account Type
Type: object
Title: Account Type
Show Source
Nested Schema : Account AddressType
Type: object
Title: Account AddressType
Show Source
Nested Schema : Annual Contract Value (List)
Type: object
Title: Annual Contract Value (List)
The total of contract extended values at list price within the first year, including only recurring pricing.
Show Source
Nested Schema : Approval History[Submit]
Type: array
Title: Approval History[Submit]
This attribute records approval history of a transaction.If a reason is reset, it is erased from the approval history.
Show Source
  • Approval History
    Title: Approval History
    This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Approval Status[Submit]
Type: array
Title: Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction.
Show Source
Nested Schema : My Approval[Submit]
Type: array
Title: My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
Nested Schema : Cancel Reason
Type: object
Title: Cancel Reason
Show Source
Nested Schema : Contact Type
Type: object
Title: Contact Type
Show Source
Nested Schema : Currency
Type: object
Title: Currency
Show Source
Nested Schema : Fulfillment Status
Type: object
Title: Fulfillment Status
Show Source
Nested Schema : Billing Frequency
Type: object
Title: Billing Frequency
Show Source
Nested Schema : Payment Terms
Type: object
Title: Payment Terms
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : Reject Reason
Type: object
Title: Reject Reason
Show Source
Nested Schema : Renewal Process
Type: object
Title: Renewal Process
Show Source
Nested Schema : Renewal Process Used
Type: object
Title: Renewal Process Used
Show Source
Nested Schema : Sales Channel
Type: object
Title: Sales Channel
Show Source
Nested Schema : Status
Type: object
Title: Status
Show Source
Nested Schema : Annual Cost
Type: object
Title: Annual Cost
The total of recurring extended costs each year for the transaction.
Show Source
Nested Schema : Annual Contract Discount
Type: object
Title: Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction.
Show Source
Nested Schema : Annual Margin
Type: object
Title: Annual Margin
The total of recurring extended margins each year for the transaction.
Show Source
Nested Schema : Annual Contract Value(Net)
Type: object
Title: Annual Contract Value(Net)
The total value of recurring charges each year.
Show Source
Nested Schema : Total Contract Cost
Type: object
Title: Total Contract Cost
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs.
Show Source
Nested Schema : Total Contract Discount
Type: object
Title: Total Contract Discount
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract.
Show Source
Nested Schema : Total Contract Value (List)
Type: object
Title: Total Contract Value (List)
The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List).
Show Source
Nested Schema : Total Contract Margin
Type: object
Title: Total Contract Margin
The total of all contract extended margins for this transaction over the duration of the contract, including all one - time and recurring values.
Show Source
Nested Schema : Total Contract Value (Net)
Type: object
Title: Total Contract Value (Net)
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
Nested Schema : Total Monthly Cost
Type: object
Title: Total Monthly Cost
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month.
Show Source
Nested Schema : Total Discount Per Month
Type: object
Title: Total Discount Per Month
The total of discounts off monthly recurring charges.
Show Source
Nested Schema : Total (List) Per Month
Type: object
Title: Total (List) Per Month
The total of all monthly recurring list amounts on the lines.
Show Source
Nested Schema : Total Monthly Margin
Type: object
Title: Total Monthly Margin
The total of extended margins for all monthly recurring charges for the transaction.
Show Source
Nested Schema : Total (Net) Per Month
Type: object
Title: Total (Net) Per Month
The total of all monthly recurring net amounts on the lines.
Show Source
Nested Schema : Total MUR (Net)
Type: object
Title: Total MUR (Net)
The total of all monthly usage revenues net of all discounts for this transaction.
Show Source
Nested Schema : Total One-Time Cost
Type: object
Title: Total One-Time Cost
The total of extended costs for all one-time charges for the transaction.
Show Source
Nested Schema : Total Discount
Type: object
Title: Total Discount
The total of all extended discount amounts for one time??pricing/charges.
Show Source
Nested Schema : Total (List)
Type: object
Title: Total (List)
The total of all one-time charges on the lines.
Show Source
Nested Schema : Total One-Time Margin
Type: object
Title: Total One-Time Margin
The total of extended margins for all one-time charges for the transaction.
Show Source
Nested Schema : Total (Net)
Type: object
Title: Total (Net)
The total one time net charge.
Show Source
Nested Schema : Total Recurring Revenue (Net)
Type: object
Title: Total Recurring Revenue (Net)
The total recurring revenues net of all discounts for this transaction.
Show Source
Nested Schema : Total Usage Revenue (Net)
Type: object
Title: Total Usage Revenue (Net)
The total usage revenues net of all discounts for this transaction.
Show Source
Nested Schema : TransactionLine-collection
Type: object
Show Source
  • state
    Title: state
    Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Win/Loss Status
Type: object
Title: Win/Loss Status
Show Source
Nested Schema : Value
Type: object
Title: Value
Composite attribute value
Nested Schema : Actions
Type: object
Title: Actions
Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type: object
Title: Attributes
Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : Approval History
Type: object
Title: Approval History
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
Nested Schema : Approval Reject Status
Type: object
Title: Approval Reject Status
This attribute lists all approval and reject status details for current logged in user.
Show Source
Nested Schema : approverNames
Type: array
Title: approverNames
String value that specifies approverNames.
Show Source
Nested Schema : Approval Reject Icon
Type: object
Title: Approval Reject Icon
This attribute lists all approval and reject icon details for current logged in user.
Show Source
Nested Schema : state
Type: object
Title: state
Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
  • Actions
    Title: Actions
    Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
  • state
    Title: state
    Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
  • Focused Users
    Title: Focused Users
    Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the collection itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.
  • Title: Insertable
    Boolean value that specifies whether new rows can be inserted into the collection.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Queryable
    Boolean value that specifies whether the rows in the collection can be queried.
  • Title: Sortable
    Boolean value that specifies whether the rows in the collection can be sorted.
Nested Schema : items
Type: array
Show Source
Nested Schema : Actions
Type: object
Title: Actions
Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Focused Users
Type: object
Title: Focused Users
Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : Transaction Line
Type: object
Title: Transaction Line
Show Source
Nested Schema : Available Rate Plans
Type: object
Title: Available Rate Plans
Show Source
Nested Schema : TransactionLine_availableRatePlanSet-collection
Type: object
Show Source
  • state
    Title: state
    Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : TransactionLine_chargeSet-collection
Type: object
Show Source
  • state
    Title: state
    Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Delta Price
Type: object
Title: Delta Price
Delta Price
Show Source
Nested Schema : Model Base Price
Type: object
Title: Model Base Price
Base price of the model
Show Source
Nested Schema : Part Base Price
Type: object
Title: Part Base Price
Price of the part
Show Source
Nested Schema : Configurable Price
Type: object
Title: Configurable Price
Original price as per catalog (inclusive of discount and premium)
Show Source
Nested Schema : Item Price
Type: object
Title: Item Price
The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices.
Show Source
Nested Schema : List Price
Type: object
Title: List Price
Will usually be the same value as the Item Price, unless a recommended item price applies.
Show Source
Nested Schema : Unit Price
Type: object
Title: Unit Price
Will usually be the same value as the List Price, unless a contract price applies.
Show Source
Nested Schema : Pricing Rule Price
Type: object
Title: Pricing Rule Price
Currenly the customer level pricing. (Not applicable for Models)
Show Source
Nested Schema : Prior Price
Type: object
Title: Prior Price
Prior Price
Show Source
Nested Schema : Revenue Category
Type: object
Title: Revenue Category
Show Source
Nested Schema : Rollup Delta Price
Type: object
Title: Rollup Delta Price
Rollup Delta Price
Show Source
Nested Schema : Annual Cost
Type: object
Title: Annual Cost
The extended cost for recurring pricing on this transaction line.
Show Source
Nested Schema : Annual Discount
Type: object
Title: Annual Discount
The annual discount on the recurring charges on this line.
Show Source
Nested Schema : Annual Value (List)
Type: object
Title: Annual Value (List)
The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.
Show Source
Nested Schema : Annual Margin
Type: object
Title: Annual Margin
The extended margin for recurring pricing on this transaction line.
Show Source
Nested Schema : Annual Value (Net)
Type: object
Title: Annual Value (Net)
The annual contract value of the recurring charges on this line.
Show Source
Nested Schema : Cancel Reason
Type: object
Title: Cancel Reason
Show Source
Nested Schema : Change Code
Type: object
Title: Change Code
Show Source
Nested Schema : Change Reason
Type: object
Title: Change Reason
Show Source
Nested Schema : Contract Cost
Type: object
Title: Contract Cost
The total of all contract extended costs for this line, including one-time and recurring costs.
Show Source
Nested Schema : Contract Discount
Type: object
Title: Contract Discount
The total discount of this line including all one-time and recurring charges.
Show Source
Nested Schema : Contract Value (List)
Type: object
Title: Contract Value (List)
The total of all contract list value of this line, including all one-time and recurring charges.
Show Source
Nested Schema : Contract Value (List Rollup)
Type: object
Title: Contract Value (List Rollup)
Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.
Show Source
Nested Schema : Contract Margin
Type: object
Title: Contract Margin
The total of all contract extended margins for this line, including one-time and recurring values.
Show Source
Nested Schema : Contract Value (Net Summable)
Type: object
Title: Contract Value (Net Summable)
The total contract value of this line including all one-time and recurring charges.
Show Source
Nested Schema : Contract Value (Net Rollup)
Type: object
Title: Contract Value (Net Rollup)
Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.
Show Source
Nested Schema : Cost Amount
Type: object
Title: Cost Amount
The total cost of this line.
Show Source
Nested Schema : Custom Discount Amount
Type: object
Title: Custom Discount Amount
The amount by which to adjust the list price because of a custom discount.
Show Source
Nested Schema : Discount Type
Type: object
Title: Discount Type
Show Source
Nested Schema : Amount (Discount)
Type: object
Title: Amount (Discount)
The discount amount for this line.
Show Source
Nested Schema : Fulfillment Status
Type: object
Title: Fulfillment Status
Show Source
Nested Schema : Line Type
Type: object
Title: Line Type
Show Source
Nested Schema : Amount (List)
Type: object
Title: Amount (List)
The extended list amount for this line.
Show Source
Nested Schema : Price (List)
Type: object
Title: Price (List)
The list price of the item.
Show Source
Nested Schema : List Price (Rollup)
Type: object
Title: List Price (Rollup)
The list price of the item or for the root model rolled up to include all child values.
Show Source
Nested Schema : Margin Amount
Type: object
Title: Margin Amount
The margin for all quoted units of this transaction line.
Show Source
Nested Schema : MRR (Rollup)
Type: object
Title: MRR (Rollup)
Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.
Show Source
Nested Schema : MRR (Summable)
Type: object
Title: MRR (Summable)
Monthly recurring revenues net of all discounts for this line.
Show Source
Nested Schema : MUR (Rollup)
Type: object
Title: MUR (Rollup)
Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.
Show Source
Nested Schema : MUR (Summable)
Type: object
Title: MUR (Summable)
Monthly usage revenues net of all discounts for this line.
Show Source
Nested Schema : Amount (Net)
Type: object
Title: Amount (Net)
The extended list amount minus any discounts for this line.
Show Source
Nested Schema : Net Amount (Rollup)
Type: object
Title: Net Amount (Rollup)
The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.
Show Source
Nested Schema : Price (Net)
Type: object
Title: Price (Net)
The price paid by the customer for the item.
Show Source
Nested Schema : Net Price (Rollup)
Type: object
Title: Net Price (Rollup)
The price paid by the customer for the individual item or for the root model rolled up to include all child values.
Show Source
Nested Schema : Non-Recurring Revenue (Rollup)
Type: object
Title: Non-Recurring Revenue (Rollup)
One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.
Show Source
Nested Schema : Non-Recurring Revenue (Summable)
Type: object
Title: Non-Recurring Revenue (Summable)
One-time revenue net of all discounts for this line.
Show Source
Nested Schema : Action Code
Type: object
Title: Action Code
Show Source
Nested Schema : Payment Terms
Type: object
Title: Payment Terms
Show Source
Nested Schema : Period
Type: object
Title: Period
Show Source
Nested Schema : Price Recurrence Frequency
Type: object
Title: Price Recurrence Frequency
Show Source
Nested Schema : Price Recurrence Frequency (Rollup)
Type: object
Title: Price Recurrence Frequency (Rollup)
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : Price Type (Rollup)
Type: object
Title: Price Type (Rollup)
Show Source
Nested Schema : Recurring Revenue (Rollup)
Type: object
Title: Recurring Revenue (Rollup)
Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.
Show Source
Nested Schema : Recurring Revenue (Summable)
Type: object
Title: Recurring Revenue (Summable)
Recurring revenue net of all discounts for this line.
Show Source
Nested Schema : Unit of Measure
Type: object
Title: Unit of Measure
Show Source
Nested Schema : Root Line
Type: object
Title: Root Line
Show Source
Nested Schema : Sales Channel
Type: object
Title: Sales Channel
Show Source
Nested Schema : Status
Type: object
Title: Status
Show Source
Nested Schema : Unit Cost
Type: object
Title: Unit Cost
The unit cost of the item.
Show Source
Nested Schema : Margin
Type: object
Title: Margin
The margin for a single unit of this transaction line.
Show Source
Nested Schema : Usage Revenue (Rollup)
Type: object
Title: Usage Revenue (Rollup)
Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.
Show Source
Nested Schema : Usage Revenue (Summable)
Type: object
Title: Usage Revenue (Summable)
Usage revenue net of all discounts for this line.
Show Source
Nested Schema : Win/Loss Status
Type: object
Title: Win/Loss Status
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Available Rate Plan Set
Type: object
Title: Available Rate Plan Set
Show Source
Nested Schema : _transaction_currency_pref
Type: object
Title: _transaction_currency_pref
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Charge Set
Type: object
Title: Charge Set
Show Source
Nested Schema : Charge Type
Type: object
Title: Charge Type
Show Source
Nested Schema : Discount Amount
Type: object
Title: Discount Amount
The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.
Show Source
Nested Schema : Discount Type
Type: object
Title: Discount Type
Show Source
Nested Schema : Net Amount
Type: object
Title: Net Amount
The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.
Show Source
Nested Schema : Net Price
Type: object
Title: Net Price
The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.
Show Source
Nested Schema : Price Period
Type: object
Title: Price Period
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : Unit Price
Type: object
Title: Unit Price
The unit price to be paid by the customer for this charge.
Show Source
Nested Schema : Usage UOM
Type: object
Title: Usage UOM
Show Source
Nested Schema : _transaction_currency_pref
Type: object
Title: _transaction_currency_pref
Show Source
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Back to Top