Jump to

• Request
• Response

Interact - Transaction Line

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_interact

Use this endpoint to modify transaction line attribute values, and optionally trigger auto-update rules without committing or retrieving the latest data from the database. Since this action does not save the transaction line to the CPQ database, it does not affect how other users see the transaction line.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• docNumber(required): integer
  Unique number to be used as the sub-document identifier.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
• subDocVarName(required): string
  The variable name for the sub-document.

Body ()

Root Schema : TransactionLine-_interactRequest

Type: object

Show Source

• cacheInstanceId: string
  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.
• criteria: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• deleteRows: array delSelections
• delta: boolean
  Title: Delta

  The boolean parameter to request a delta response for data as well as state in the context of current criteria.
• displayHistoryActionVarName: string
  Title: Display Hstory Action Variable Name

  Specify the Display History action variable name in the format of ["displayHostoryActionVarName"]
• documents: object Transaction Line
  Title: Transaction Line
• focus: string
  Title: Focus

  The attribute that the user is currently editing. The format matches that of the triggerAttrVarName param. If the value of the focus param is empty string, the user will be considered to be focused on no attribute
• polling: boolean
  Title: Is Polling Request

  Boolean parameter indicating whether this is a collaborative polling request. If true, the response may be mostly empty if no users made concurrent changes.
• refreshCache: boolean
  Title: refreshCache
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.
• triggerAttrVarName: string
  Title: Trigger Attribute

  The attribute which trigger the interact action. When the trigger attribute is in current document, it is the variable name of the attribute. When the trigger attribute is in subdoc when action is invoked on maindoc, the trigger attribute will be in the format of {subdoc_varname}/{doc_num}/{subdoc_attribute_varname}

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "documents":{
            "$ref":"#/definitions/TransactionLine"
        },
        "criteria":{
            "$ref":"#/definitions/queryDef"
        },
        "triggerAttrVarName":{
            "type":"string",
            "description":"The attribute which trigger the interact action. When the trigger attribute is in current document, it is the variable name of the attribute. When the trigger attribute is in subdoc when action is invoked on maindoc, the trigger attribute will be in the format of {subdoc_varname}/{doc_num}/{subdoc_attribute_varname}",
            "title":"Trigger Attribute"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"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.",
            "title":"Cache Instance Id"
        },
        "delta":{
            "type":"boolean",
            "description":"The boolean parameter to request a delta response for data as well as state in the context of current criteria.",
            "title":"Delta"
        },
        "deleteRows":{
            "$ref":"#/definitions/delSelections"
        },
        "displayHistoryActionVarName":{
            "type":"string",
            "description":"Specify the Display History action variable name in the format of [\"displayHostoryActionVarName\"]",
            "title":"Display Hstory Action Variable Name"
        },
        "focus":{
            "type":"string",
            "description":"The attribute that the user is currently editing. The format matches that of the triggerAttrVarName param. If the value of the focus param is empty string, the user will be considered to be focused on no attribute",
            "title":"Focus"
        },
        "polling":{
            "type":"boolean",
            "description":"Boolean parameter indicating whether this is a collaborative polling request. If true, the response may be mostly empty if no users made concurrent changes.",
            "title":"Is Polling Request"
        },
        "refreshCache":{
            "type":"boolean",
            "description":"",
            "title":"refreshCache"
        }
    }
}

Nested Schema : Query Definition

Type: object

Title: Query Definition

Captures the query definition for the current resource request.

Show Source

• actions: array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs: array childDefs
• expand: array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• fields: array fields
  Array of field names that you wanted returned in a request.
• state: boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

Nested Schema : delSelections

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Transaction Line

Type: object

Title: Transaction Line

Show Source

• _availableRatePlans: object Available Rate Plans
  Title: Available Rate Plans
• _availableRatePlanSet: object TransactionLine_availableRatePlanSet-collection
• _availableRatePlanSetControl: integer
  Title: Available Rate Plan Set Control
• _bs_id: integer
  Title: _bs_id
• _chargeSet: object TransactionLine_chargeSet-collection
• _chargeSetControl: integer
  Title: Charge Set Control
• _config_attr_info: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _config_attr_text: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _config_attr_values: string
  Title: Config Attribute Values

  Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported.
• _config_attributes: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _config_extra_info: string
  Title: Config Extra Info

  Configuration Extra Information.
• _configuration_id: string
  Title: Configuration ID

  Configuration id for integrations.
• _date_added: string
  Title: _date_added
• _date_modified: string
  Title: _date_modified
• _delta_price: object Delta Price
  Title: Delta Price

  Delta Price
• _document_number: integer
  Title: _document_number
• _document_var_name: string
  Title: _document_var_name
• _group_sequence_number: string
  Title: Group Sequence Number

  Group sequence number for the subdocument.
• _id: integer
  Title: _id
• _is_bom_price: boolean
  Title: Is BOM Price

  Used to identify if the line item has BOM price. Applicable for a BOM item only
• _is_coverage: boolean
  Title: Is Coverage Product

  Indicates whether the product is of coverage type
• _is_line_item_mandatory: boolean
  Title: Is Line Item Mandatory

  Used to identify if the line item is mandatory.
• _is_part_pricing_rule_price: boolean
  Title: Is Price from Pricing Rule

  Used to identify if a line item has a part pricing rule set by a rule
• _is_recommended_price: boolean
  Title: Is Price Recommended

  Used to identify if the line item has recommended price set by a rule.
• _last_modified_date: string
  Title: Last Modified Date

  Used to Store the last modified date of the sub-document.
• _line_bom_attributes: string
  Title: Line Item BOM Attributes

  BOM attributes, stored as a JSON string.
• _line_bom_condition_index: string
  Title: Line BOM Condition Index

  The condition index of the BOM item
• _line_bom_display_name: string
  Title: Line BOM Display Name

  The display name of the BOM item
• _line_bom_effective_date: string
  Title: Line BOM Effective Date

  System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings.
• _line_bom_id: string
  Title: Line Item BOM ID

  The BOM item instance id.
• _line_bom_item_quantity: integer
  Title: Line BOM Item Quantity

  The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity.
• _line_bom_level: integer
  Title: Line BOM Level

  The BOM item depth (level) in the quote.
• _line_bom_model_path: string
  Title: Line BOM Model Path

  The model path of the BOM item; only applicable to the model line
• _line_bom_name: string
  Title: Line BOM Name

  The name of the BOM item
• _line_bom_parent_id: string
  Title: Parent Line Item BOM ID

  The parent BOM item instance id.
• _line_bom_part_number: string
  Title: Line BOM Part Number

  The part number of the BOM item. Only applicable to the model line.
• _line_bom_sequence_index: string
  Title: Line BOM Sequence Index

  The sequence index of the BOM item
• _line_bom_variable_name: string
  Title: Line BOM Variable Name

  The variable name of the BOM item
• _line_display_name: string
  Title: Line Display Name

  Display name attribute for line items.
• _line_item_comment: string
  Title: Line Item Comments

  Stores the comments for the line item.
• _line_item_spare_rule_var_name: string
  Title: Line Item Identifier

  Identifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier
• _line_item_type: string
  Title: Line Item Type

  Type attribute for line items.
• _model_attributes: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _model_base_price: object Model Base Price
  Title: Model Base Price

  Base price of the model
• _model_bom: string
  Title: Model BOM

  Model BOM Link
• _model_id: string
  Title: Model ID

  Id of the model
• _model_is_valid: boolean
  Title: Is Model Valid

  Check if model is configured or unconfigured
• _model_name: string
  Title: Model Name

  Name of the model
• _model_partner_entity_id: string
  Title: Model Partner Entity Id

  Partner entity id for the model
• _model_partner_organization_id: string
  Title: Model Partner Organization Id

  partner organization id for the model
• _model_product_line_attributes: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _model_product_line_id: string
  Title: Model Product Line ID

  Id of the Product Line to which the model belongs
• _model_product_line_name: string
  Title: Model Product Line Name

  Product Line to which the model belongs
• _model_product_line_var_name: string
  Title: Model Product Line Variable Name

  Variable name of the product line that the model belongs to.
• _model_sales_product_type: string
  Title: Model Sales Product Type

  ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.
• _model_segment_id: string
  Title: Model Segment ID

  Id of the Segment to which the model belongs
• _model_segment_name: string
  Title: Model Segment Name

  Segment to which the model belongs
• _model_segment_var_name: string
  Title: Model Segment Variable Name

  Segment to which the model belongs
• _model_supplier_company_id: string
  Title: Model Supplier Company ID

  Model supplier company id
• _model_supplier_company_name: string
  Title: Model Supplier Company Name

  Model supplier company name
• _model_variable_name: string
  Title: Model Variable Name

  Variable name of the model
• _original_document_number: string
  Title: Original Document Number

  Used to identify the document number from which the line item is copied.
• _parent_doc_number: string
  Title: Parent Document Number

  Used to identify the parent document number, if any, for this subdocument.
• _parent_line_item: string
  Title: Parent Line Item

  Used to identify the name of the parent line item, if any, for this subdocument.
• _part_base_price: object Part Base Price
  Title: Part Base Price

  Price of the part
• _part_company_associations: string
  Title: Company Associations

  Company Associations
• _part_css_enabled: string
  Title: Enable Customer Self-Service

  Customer Self-service enabled flag
• _part_default_periodicity: string
  Title: Part Price Period

  Default Price Periodicity
• _part_default_periods: string
  Title: Number of Price Periods

  Default number of price periods
• _part_default_price_type: string
  Title: Part Price Type

  Default Price Type
• _part_default_uom: string
  Title: Default UOM Code

  Default unit of measure
• _part_desc: string
  Title: Part Description

  Description of the part
• _part_direct_buy: string
  Title: Direct Buy

  Direct Buy
• _part_display_number: string
  Title: Part Display Number

  Part Display Number
• _part_drawing_position: string
  Title: Drawing Position

  Drawing Position
• _part_extended_desc_1: string
  Title: Part Extended Description 1

  Extended description of the part
• _part_extended_desc_2: string
  Title: Part Extended Description 2

  Extended description of the part
• _part_external_key1: string
  Title: External Key 1

  External system's key
• _part_external_key2: string
  Title: External Key 2

  External system's key
• _part_id: string
  Title: Part ID

  Id of the part
• _part_lead_time: string
  Title: Part Lead Time

  Lead time
• _part_number: string
  Title: Part Number

  Part Number
• _part_sale_enabled: string
  Title: Eligible to Sell

  Eligible to sell or order
• _part_sales_product_type: string
  Title: Sales Product Type

  ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.
• _part_serv_req_enabled: string
  Title: Eligible for Service

  Eligible for service
• _part_supplier_company_id: string
  Title: Part Supplier Company ID

  Id of the part supplier company
• _part_supplier_company_name: string
  Title: Part Supplier Company Name

  Name of the part supplier company
• _part_units: string
  Title: Part Units

  Units of the part
• _partner_entity_id: string
  Title: Partner Entity Id

  Partner Entity Id
• _partner_organization_id: string
  Title: Partner Organization Id

  Partner Organization Id
• _pp_id: integer
  Title: _pp_id
• _pp_name: string
  Title: _pp_name
• _price_applied_agreement_integrationId: string
  Title: Applied Agreement Integration ID

  Applied Agreement Integration Id
• _price_applied_agreement_name: string
  Title: Applied Agreement Name

  Applied Agreement Name
• _price_applied_agreement_number: string
  Title: Applied Agreement Number

  Applied Agreement Number
• _price_applied_ratePlan: string
  Title: Applied Rate Plan

  Applied Rate Plan
• _price_applied_ratePlan_integrationId: string
  Title: Applied Rate Plan Integration ID

  Applied Rate Plan Integration Id
• _price_applied_ratePlan_number: string
  Title: Applied Rate Plan Number

  Applied Rate Plan Number
• _price_book_var_name: string
  Title: Price Book Variable Name

  Variable Name of the Price Book used to get the price for this line item
• _price_calculation_info: string
  Title: Calculation Information

  JSON array of aggregated calculation information returned from advanced pricing profiles
• _price_component_prices: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _price_configurable_price: object Configurable Price
  Title: Configurable Price

  Original price as per catalog (inclusive of discount and premium)
• _price_item_price_each: object Item Price
  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.
• _price_list_price_each: object List Price
  Title: List Price

  Will usually be the same value as the Item Price, unless a recommended item price applies.
• _price_period: string
  Title: Pricing Engine Price Period

  Period for which the price will be applicable.
• _price_quantity: integer
  Title: Quantity

  Quantity
• _price_type: string
  Title: Pricing Engine Price Type

  Type of price (For example: One-time, Periodic - monthly, quarterly etc)
• _price_unit_price_each: object Unit Price
  Title: Unit Price

  Will usually be the same value as the List Price, unless a contract price applies.
• _pricing_rule_price_each: object Pricing Rule Price
  Title: Pricing Rule Price

  Currenly the customer level pricing. (Not applicable for Models)
• _prior_price: object Prior Price
  Title: Prior Price

  Prior Price
• _reconfiguration_date: string
  Title: Reconfiguration Date

  Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model.
• _revenueCategory_l: object Revenue Category
  Title: Revenue Category
• _revenueId_l: string
  Title: Revenue ID

  The ID of the Revenue Line Item in the associated opportunity.
• _rollup_delta_price: object Rollup Delta Price
  Title: Rollup Delta Price

  Rollup Delta Price
• _s_coverageLineNumber: string
  Title: Coverage Line Number

  Source line number of the coverage line for OM Integration.
• _s_coverageOrderNumber: string
  Title: Coverage Order Number

  Source order number of the coverage line for OM Integration.
• _s_freezeNegotiationFlag_l: boolean
  Title: Freeze Negotiation Flag

  Flag indicating whether price negotiation is permitted.
• _s_partID_l: string
  Title: Part ID

  Part number from the Items table.
• _sequence_number: integer
  Title: Sequence Number

  Sequence number for the subdocument.
• _state: object 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.
• _step_var_name: string
  Title: _step_var_name
• _transaction_currency_pref: string
  Title: _transaction_currency_pref
• _transactionLine_id: string
  Title: Transaction Line ID

  Unique identifier for this subdocument.
• annualCost_l: object Annual Cost
  Title: Annual Cost

  The extended cost for recurring pricing on this transaction line.
• annualDiscount_l: object Annual Discount
  Title: Annual Discount

  The annual discount on the recurring charges on this line.
• annualListValue_l: object Annual Value (List)
  Title: Annual Value (List)

  The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.
• annualMargin_l: object Annual Margin
  Title: Annual Margin

  The extended margin for recurring pricing on this transaction line.
• annualValue_l: object Annual Value (Net)
  Title: Annual Value (Net)

  The annual contract value of the recurring charges on this line.
• associatedLineId_l: string
  Title: Associated Line Id

  Document number to be associated with the subscription line.
• associatedOrderId_l: string
  Title: Associated Order Id

  Source order Id associated with the subscription line
• cancelReason_l: object Cancel Reason
  Title: Cancel Reason
• changeCode_l: object Change Code
  Title: Change Code
• changeReason_l: object Change Reason
  Title: Change Reason
• contractCost_l: object Contract Cost
  Title: Contract Cost

  The total of all contract extended costs for this line, including one-time and recurring costs.
• contractDiscount_l: object Contract Discount
  Title: Contract Discount

  The total discount of this line including all one-time and recurring charges.
• contractedPeriods_l: integer
  Title: Contracted Periods

  Number of periods the customer has contracted to receive the item.
• contractedPeriodsRollup_l: integer
  Title: Contracted Periods (Rollup)

  Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values.
• contractEndDate_l: string
  Title: Contract End Date

  Date that the customer stops to receive the service.
• contractListValue_l: object Contract Value (List)
  Title: Contract Value (List)

  The total of all contract list value of this line, including all one-time and recurring charges.
• contractListValueRollup_l: object Contract Value (List Rollup)
  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.
• contractMargin_l: object Contract Margin
  Title: Contract Margin

  The total of all contract extended margins for this line, including one-time and recurring values.
• contractStartDate_l: string
  Title: Contract Start Date

  Date that the customer starts to receive the service.
• contractValue_l: object Contract Value (Net Summable)
  Title: Contract Value (Net Summable)

  The total contract value of this line including all one-time and recurring charges.
• contractValueRollup_l: object Contract Value (Net Rollup)
  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.
• costAmount_l: object Cost Amount
  Title: Cost Amount

  The total cost of this line.
• createdBy_l: string
  Title: Created By

  The person that created the transaction line.
• createdDate_l: string
  Title: Created Date

  The date when the transaction line was created.
• customDiscountAmount_l: object Custom Discount Amount
  Title: Custom Discount Amount

  The amount by which to adjust the list price because of a custom discount.
• customDiscountType_l: object Discount Type
  Title: Discount Type
• customDiscountValue_l: number
  Title: Discount

  Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage.
• discountAmount_l: object Amount (Discount)
  Title: Amount (Discount)

  The discount amount for this line.
• discountPercent_l: number
  Title: Discount %

  The percentage of the Contract Value (List) that is discounted off of the transaction line.
• discountPercentRollup_l: number
  Title: Discount Percent (Rollup)

  The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values.
• documentNumber_l: string
  Title: Document Number

  Document number of the line.
• fulfillmentLineId_l: string
  Title: Fulfillment Line Id

  Value that uniquely identifies the fulfillment line.
• fulfillmentOrganizationCode_l: string
  Title: Fulfillment Organization Code

  Abbreviation that identifies the organization that ships the shipment.
• fulfillmentStatus_l: object Fulfillment Status
  Title: Fulfillment Status
• includedInBasePrice: boolean
  Title: Included In Base Price

  Used to identify if the line item is included in the base price. Applicable for a BOM item only.
• itemInstanceId_l: string
  Title: Instance ID

  The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created.
• itemInstanceName_l: string
  Title: Instance Name

  The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance.
• lastUpdatedBy_l: string
  Title: Last Updated By

  The person that last updated this transaction line.
• lastUpdatedDate_l: string
  Title: Last Updated

  The date and time the transaction line was last updated.
• lineNumber_l: integer
  Title: Line Number

  Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents.
• lineType_l: object Line Type
  Title: Line Type
• listAmount_l: object Amount (List)
  Title: Amount (List)

  The extended list amount for this line.
• listPrice_l: object Price (List)
  Title: Price (List)

  The list price of the item.
• listPriceRollup_l: object List Price (Rollup)
  Title: List Price (Rollup)

  The list price of the item or for the root model rolled up to include all child values.
• marginAmount_l: object Margin Amount
  Title: Margin Amount

  The margin for all quoted units of this transaction line.
• marginPercent_l: number
  Title: Margin %

  The percentage of the List price for which this transaction line's margin accounts.
• monthlyRecurRevRollup_l: object MRR (Rollup)
  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.
• monthlyRecurRevSummable_l: object MRR (Summable)
  Title: MRR (Summable)

  Monthly recurring revenues net of all discounts for this line.
• monthlyUsageRevRollup_l: object MUR (Rollup)
  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.
• monthlyUsageRevSummable_l: object MUR (Summable)
  Title: MUR (Summable)

  Monthly usage revenues net of all discounts for this line.
• netAmount_l: object Amount (Net)
  Title: Amount (Net)

  The extended list amount minus any discounts for this line.
• netAmountRollup_l: object Net Amount (Rollup)
  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.
• netPrice_l: object Price (Net)
  Title: Price (Net)

  The price paid by the customer for the item.
• netPriceRollup_l: object Net Price (Rollup)
  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.
• nonRecurRevRollup_l: object Non-Recurring Revenue (Rollup)
  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.
• nonRecurRevSummable_l: object Non-Recurring Revenue (Summable)
  Title: Non-Recurring Revenue (Summable)

  One-time revenue net of all discounts for this line.
• oRCL_ABO_ActionCode_l: object Action Code
  Title: Action Code
• oRCL_ABO_ComponentAttributes_l: string
  Title: Component Attributes

  A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed.
• oRCL_ERP_OrderNumber_l: string
  Title: Order Number

  The order number assigned by the external Order Management and ERP system.
• oRCL_SFA_InventoryItemID_l: string
  Title: Inventory Item ID

  The inventory item id of the sales product in SFA.
• oRCL_SFA_InventoryOrgID_l: string
  Title: Partner Orgnanization ID

  The inventory organization in SFA used for sales products.
• oRCL_SFA_Status_l: string
  Title: Opportunity Win/Loss Status (Line)

  The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value.
• orderDate_l: string
  Title: Order Date

  The date and time the order was placed for fulfillment.
• ownerResourceId_l: string
  Title: Owner Resource ID

  The owner of the associated Opportunity Revenue Line.
• parentAssetKey_l: string
  Title: Parent Asset Key

  The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines.
• parentDocNumber_l: string
  Title: Parent Doc Number

  Document number of the parent line item.
• paymentTerms_l: object Payment Terms
  Title: Payment Terms
• pricePeriod_l: object Period
  Title: Period
• priceRecurFrequency_l: object Price Recurrence Frequency
  Title: Price Recurrence Frequency
• priceRecurFrequencyRollup_l: object Price Recurrence Frequency (Rollup)
  Title: Price Recurrence Frequency (Rollup)
• priceScore_l: integer
  Title: Price Score

  The calculated price score for this transaction line, based on the line item's List and Net pricing.
• priceType_l: object Price Type
  Title: Price Type
• priceTypeRollup_l: object Price Type (Rollup)
  Title: Price Type (Rollup)
• priceWithinPolicy_l: boolean
  Title: Price Within Policy

  Flag which indicates if line price is within requesting user's defined pricing limits
• recurRevRollup_l: object Recurring Revenue (Rollup)
  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.
• recurringRevSummable_l: object Recurring Revenue (Summable)
  Title: Recurring Revenue (Summable)

  Recurring revenue net of all discounts for this line.
• renewDate_l: string
  Title: Renew Date

  Renewal date of a subscription service.
• requestDate_l: string
  Title: Request Date

  The date on which the user requests that fulfillment occur for this transaction line.
• requestedUnitOfMeasure_l: object Unit of Measure
  Title: Unit of Measure
• requestShipDate_l: string
  Title: Request Ship Date

  The requested ship date for the order line.
• resumeDate_l: string
  Title: Resume Date

  Resuming date of a subscription service
• rollupFlag_l: boolean
  Title: Rollup Flag

  Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price.
• rootAssetKey_l: string
  Title: RootAssetKey
• rootLine_l: object Root Line
  Title: Root Line
• salesChannel_l: object Sales Channel
  Title: Sales Channel
• status_l: object Status
  Title: Status
• subscriptionId_l: string
  Title: Subscription Id

  The unique identifier for the subscription. Used only for subscription billing-related transactions.
• subscriptionLineId_l: string
  Title: Subscription Line Id

  The unique identifier for the subscription line. Used only for subscription billing-related transactions.
• suspendDate_l: string
  Title: Suspend Date

  Suspension date of a subscription service
• transactionID_l: string
  Title: Transaction Internal ID

  The parent transaction's internal ID.
• unitCost_l: object Unit Cost
  Title: Unit Cost

  The unit cost of the item.
• unitMargin_l: object Margin
  Title: Margin

  The margin for a single unit of this transaction line.
• usageRevRollup_l: object Usage Revenue (Rollup)
  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.
• usageRevSummable_l: object Usage Revenue (Summable)
  Title: Usage Revenue (Summable)

  Usage revenue net of all discounts for this line.
• winLossStatus_l: object Win/Loss Status
  Title: Win/Loss Status

{
    "type":"object",
    "properties":{
        "_line_bom_attributes":{
            "type":"string",
            "description":"BOM attributes, stored as a JSON string.",
            "title":"Line Item BOM Attributes"
        },
        "_availableRatePlans":{
            "type":"object",
            "title":"Available Rate Plans",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "listAmount_l":{
            "type":"object",
            "description":"The extended list amount for this line.",
            "title":"Amount (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "discountAmount_l":{
            "type":"object",
            "description":"The discount amount for this line.",
            "title":"Amount (Discount)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "rollupFlag_l":{
            "type":"boolean",
            "description":"Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price.",
            "title":"Rollup Flag"
        },
        "contractStartDate_l":{
            "type":"string",
            "description":"Date that the customer starts to receive the service.",
            "title":"Contract Start Date"
        },
        "_model_partner_entity_id":{
            "type":"string",
            "description":"Partner entity id for the model",
            "title":"Model Partner Entity Id"
        },
        "listPriceRollup_l":{
            "type":"object",
            "description":"The list price of the item or for the root model rolled up to include all child values.",
            "title":"List Price (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_config_attributes":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_part_sale_enabled":{
            "type":"string",
            "description":"Eligible to sell or order",
            "title":"Eligible to Sell"
        },
        "recurringRevSummable_l":{
            "type":"object",
            "description":"Recurring revenue net of all discounts for this line.",
            "title":"Recurring Revenue (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "fulfillmentLineId_l":{
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line.",
            "title":"Fulfillment Line Id"
        },
        "_part_display_number":{
            "type":"string",
            "description":"Part Display Number",
            "title":"Part Display Number"
        },
        "_model_attributes":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_price_list_price_each":{
            "type":"object",
            "description":"Will usually be the same value as the Item Price, unless a recommended item price applies.",
            "title":"List Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_effective_date":{
            "type":"string",
            "description":"System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings.",
            "title":"Line BOM Effective Date"
        },
        "includedInBasePrice":{
            "type":"boolean",
            "description":"Used to identify if the line item is included in the base price. Applicable for a BOM item only.",
            "title":"Included In Base Price"
        },
        "_parent_line_item":{
            "type":"string",
            "description":"Used to identify the name of the parent line item, if any, for this subdocument.",
            "title":"Parent Line Item"
        },
        "_date_modified":{
            "type":"string",
            "description":"",
            "title":"_date_modified"
        },
        "rootAssetKey_l":{
            "type":"string",
            "description":"",
            "title":"RootAssetKey"
        },
        "annualMargin_l":{
            "type":"object",
            "description":"The extended margin for recurring pricing on this transaction line.",
            "title":"Annual Margin",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_product_line_attributes":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_price_configurable_price":{
            "type":"object",
            "description":"Original price as per catalog (inclusive of discount and premium)",
            "title":"Configurable Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "costAmount_l":{
            "type":"object",
            "description":"The total cost of this line.",
            "title":"Cost Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_is_part_pricing_rule_price":{
            "type":"boolean",
            "description":"Used to identify if a line item has a part pricing rule set by a rule",
            "title":"Is Price from Pricing Rule"
        },
        "_part_default_uom":{
            "type":"string",
            "description":"Default unit of measure",
            "title":"Default UOM Code"
        },
        "discountPercent_l":{
            "type":"number",
            "description":"The percentage of the Contract Value (List) that is discounted off of the transaction line.",
            "title":"Discount %"
        },
        "_part_sales_product_type":{
            "type":"string",
            "description":"ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.",
            "title":"Sales Product Type"
        },
        "contractEndDate_l":{
            "type":"string",
            "description":"Date that the customer stops to receive the service.",
            "title":"Contract End Date"
        },
        "_last_modified_date":{
            "type":"string",
            "description":"Used to Store the last modified date of the sub-document.",
            "title":"Last Modified Date"
        },
        "_s_freezeNegotiationFlag_l":{
            "type":"boolean",
            "description":"Flag indicating whether price negotiation is permitted.",
            "title":"Freeze Negotiation Flag"
        },
        "subscriptionId_l":{
            "type":"string",
            "description":"The unique identifier for the subscription. Used only for  subscription billing-related transactions.",
            "title":"Subscription Id"
        },
        "_config_extra_info":{
            "type":"string",
            "description":"Configuration Extra Information.",
            "title":"Config Extra Info"
        },
        "suspendDate_l":{
            "type":"string",
            "description":"Suspension date of a subscription service",
            "title":"Suspend Date"
        },
        "unitMargin_l":{
            "type":"object",
            "description":"The margin for a single unit of this transaction line.",
            "title":"Margin",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "resumeDate_l":{
            "type":"string",
            "description":"Resuming date of a subscription service",
            "title":"Resume Date"
        },
        "_part_number":{
            "type":"string",
            "description":"Part Number",
            "title":"Part Number"
        },
        "_sequence_number":{
            "type":"integer",
            "description":"Sequence number for the subdocument.",
            "title":"Sequence Number"
        },
        "_line_bom_display_name":{
            "type":"string",
            "description":"The display name of the BOM item",
            "title":"Line BOM Display Name"
        },
        "unitCost_l":{
            "type":"object",
            "description":"The unit cost of the item.",
            "title":"Unit Cost",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_price_applied_agreement_integrationId":{
            "type":"string",
            "description":"Applied Agreement Integration Id",
            "title":"Applied Agreement Integration ID"
        },
        "_price_unit_price_each":{
            "type":"object",
            "description":"Will usually be the same value as the List Price, unless a contract price applies.",
            "title":"Unit Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_base_price":{
            "type":"object",
            "description":"Base price of the model",
            "title":"Model Base Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "customDiscountValue_l":{
            "type":"number",
            "description":"Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage.",
            "title":"Discount"
        },
        "_model_product_line_name":{
            "type":"string",
            "description":"Product Line to which the model belongs",
            "title":"Model Product Line Name"
        },
        "_price_item_price_each":{
            "type":"object",
            "description":"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.",
            "title":"Item Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "recurRevRollup_l":{
            "type":"object",
            "description":"Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.",
            "title":"Recurring Revenue (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "monthlyUsageRevRollup_l":{
            "type":"object",
            "description":"Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.",
            "title":"MUR (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_transaction_currency_pref":{
            "type":"string",
            "description":"",
            "title":"_transaction_currency_pref"
        },
        "oRCL_ABO_ComponentAttributes_l":{
            "type":"string",
            "description":"A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed.",
            "title":"Component Attributes"
        },
        "_price_applied_ratePlan_integrationId":{
            "type":"string",
            "description":"Applied Rate Plan Integration Id",
            "title":"Applied Rate Plan Integration ID"
        },
        "priceWithinPolicy_l":{
            "type":"boolean",
            "description":"Flag which indicates if line price is within requesting user's defined pricing limits",
            "title":"Price Within Policy"
        },
        "_part_serv_req_enabled":{
            "type":"string",
            "description":"Eligible for service",
            "title":"Eligible for Service"
        },
        "_model_supplier_company_id":{
            "type":"string",
            "description":"Model supplier company id",
            "title":"Model Supplier Company ID"
        },
        "_model_segment_id":{
            "type":"string",
            "description":"Id of the Segment to which the model belongs",
            "title":"Model Segment ID"
        },
        "_partner_entity_id":{
            "type":"string",
            "description":"Partner Entity Id",
            "title":"Partner Entity Id"
        },
        "requestDate_l":{
            "type":"string",
            "description":"The date on which the user requests that fulfillment occur for this transaction line.",
            "title":"Request Date"
        },
        "_part_base_price":{
            "type":"object",
            "description":"Price of the part",
            "title":"Part Base Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "contractMargin_l":{
            "type":"object",
            "description":"The total of all contract extended margins for this line, including one-time and recurring values.",
            "title":"Contract Margin",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "pricePeriod_l":{
            "type":"object",
            "title":"Period",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "changeCode_l":{
            "type":"object",
            "title":"Change Code",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "associatedLineId_l":{
            "type":"string",
            "description":"Document number to be associated with the subscription line.",
            "title":"Associated Line Id"
        },
        "_model_partner_organization_id":{
            "type":"string",
            "description":"partner organization id for the model",
            "title":"Model Partner Organization Id"
        },
        "_model_segment_name":{
            "type":"string",
            "description":"Segment to which the model belongs",
            "title":"Model Segment Name"
        },
        "priceType_l":{
            "type":"object",
            "title":"Price Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "nonRecurRevRollup_l":{
            "type":"object",
            "description":"One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.",
            "title":"Non-Recurring Revenue (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "oRCL_SFA_Status_l":{
            "type":"string",
            "description":"The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value.",
            "title":"Opportunity Win/Loss Status (Line)"
        },
        "_config_attr_info":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_s_partID_l":{
            "type":"string",
            "description":"Part number from the Items table.",
            "title":"Part ID"
        },
        "contractListValueRollup_l":{
            "type":"object",
            "description":"Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.",
            "title":"Contract Value (List Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "contractValue_l":{
            "type":"object",
            "description":"The total contract value of this line including all one-time and recurring charges.",
            "title":"Contract Value (Net Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "netAmountRollup_l":{
            "type":"object",
            "description":"The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.",
            "title":"Net Amount (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_prior_price":{
            "type":"object",
            "description":"Prior Price",
            "title":"Prior Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "customDiscountAmount_l":{
            "type":"object",
            "description":"The amount by which to adjust the list price because of a custom discount.",
            "title":"Custom Discount Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_parent_doc_number":{
            "type":"string",
            "description":"Used to identify the parent document number, if any, for this subdocument.",
            "title":"Parent Document Number"
        },
        "requestShipDate_l":{
            "type":"string",
            "description":"The requested ship date for the order line.",
            "title":"Request Ship Date"
        },
        "_reconfiguration_date":{
            "type":"string",
            "description":"Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model.",
            "title":"Reconfiguration Date"
        },
        "annualCost_l":{
            "type":"object",
            "description":"The extended cost for recurring pricing on this transaction line.",
            "title":"Annual Cost",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_part_desc":{
            "type":"string",
            "description":"Description of the part",
            "title":"Part Description"
        },
        "_chargeSetControl":{
            "type":"integer",
            "description":"",
            "title":"Charge Set Control"
        },
        "_pp_id":{
            "type":"integer",
            "description":"",
            "title":"_pp_id"
        },
        "_document_number":{
            "type":"integer",
            "description":"",
            "title":"_document_number"
        },
        "parentAssetKey_l":{
            "type":"string",
            "description":"The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines.",
            "title":"Parent Asset Key"
        },
        "_rollup_delta_price":{
            "type":"object",
            "description":"Rollup Delta Price",
            "title":"Rollup Delta Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_is_bom_price":{
            "type":"boolean",
            "description":"Used to identify if the line item has BOM price. Applicable for a BOM item only",
            "title":"Is BOM Price"
        },
        "winLossStatus_l":{
            "type":"object",
            "title":"Win/Loss Status",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_price_calculation_info":{
            "type":"string",
            "description":"JSON array of aggregated calculation information returned from advanced pricing profiles",
            "title":"Calculation Information"
        },
        "associatedOrderId_l":{
            "type":"string",
            "description":"Source order Id associated with the subscription line",
            "title":"Associated Order Id"
        },
        "_price_applied_ratePlan":{
            "type":"string",
            "description":"Applied Rate Plan",
            "title":"Applied Rate Plan"
        },
        "_price_component_prices":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "discountPercentRollup_l":{
            "type":"number",
            "description":"The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values.",
            "title":"Discount Percent (Rollup)"
        },
        "_part_supplier_company_id":{
            "type":"string",
            "description":"Id of the part supplier company",
            "title":"Part Supplier Company ID"
        },
        "_original_document_number":{
            "type":"string",
            "description":"Used to identify the document number from which the line item is copied.",
            "title":"Original Document Number"
        },
        "contractListValue_l":{
            "type":"object",
            "description":"The total of all contract list value of this line, including all one-time and recurring charges.",
            "title":"Contract Value (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_item_spare_rule_var_name":{
            "type":"string",
            "description":"Identifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier",
            "title":"Line Item Identifier"
        },
        "_price_applied_agreement_name":{
            "type":"string",
            "description":"Applied Agreement Name",
            "title":"Applied Agreement Name"
        },
        "_revenueCategory_l":{
            "type":"object",
            "title":"Revenue Category",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_part_id":{
            "type":"string",
            "description":"Id of the part",
            "title":"Part ID"
        },
        "_part_company_associations":{
            "type":"string",
            "description":"Company Associations",
            "title":"Company Associations"
        },
        "_part_default_periods":{
            "type":"string",
            "description":"Default number of price periods",
            "title":"Number of Price Periods"
        },
        "marginPercent_l":{
            "type":"number",
            "description":"The percentage of the List price for which this transaction line's margin accounts.",
            "title":"Margin %"
        },
        "_price_book_var_name":{
            "type":"string",
            "description":"Variable Name of the Price Book used to get the price for this line item",
            "title":"Price Book Variable Name"
        },
        "customDiscountType_l":{
            "type":"object",
            "title":"Discount Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_model_sales_product_type":{
            "type":"string",
            "description":"ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.",
            "title":"Model Sales Product Type"
        },
        "_group_sequence_number":{
            "type":"string",
            "description":"Group sequence number for the subdocument.",
            "title":"Group Sequence Number"
        },
        "_price_applied_ratePlan_number":{
            "type":"string",
            "description":"Applied Rate Plan Number",
            "title":"Applied Rate Plan Number"
        },
        "lastUpdatedDate_l":{
            "type":"string",
            "description":"The date and time the transaction line was last updated.",
            "title":"Last Updated"
        },
        "_price_quantity":{
            "type":"integer",
            "description":"Quantity",
            "title":"Quantity"
        },
        "paymentTerms_l":{
            "type":"object",
            "title":"Payment Terms",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "lastUpdatedBy_l":{
            "type":"string",
            "description":"The person that last updated this transaction line.",
            "title":"Last Updated By"
        },
        "_part_supplier_company_name":{
            "type":"string",
            "description":"Name of the part supplier company",
            "title":"Part Supplier Company Name"
        },
        "_document_var_name":{
            "type":"string",
            "description":"",
            "title":"_document_var_name"
        },
        "_part_default_price_type":{
            "type":"string",
            "description":"Default Price Type",
            "title":"Part Price Type"
        },
        "createdDate_l":{
            "type":"string",
            "description":"The date when the transaction line was created.",
            "title":"Created Date"
        },
        "contractCost_l":{
            "type":"object",
            "description":"The total of all contract extended costs for this line, including one-time and recurring costs.",
            "title":"Contract Cost",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "contractDiscount_l":{
            "type":"object",
            "description":"The total discount of this line including all one-time and recurring charges.",
            "title":"Contract Discount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_name":{
            "type":"string",
            "description":"The name of the BOM item",
            "title":"Line BOM Name"
        },
        "oRCL_ERP_OrderNumber_l":{
            "type":"string",
            "description":"The order number assigned by the external Order Management and ERP system.",
            "title":"Order Number"
        },
        "_model_is_valid":{
            "type":"boolean",
            "description":"Check if model is configured or unconfigured",
            "title":"Is Model Valid"
        },
        "_part_external_key2":{
            "type":"string",
            "description":"External system's key",
            "title":"External Key 2"
        },
        "_part_external_key1":{
            "type":"string",
            "description":"External system's key",
            "title":"External Key 1"
        },
        "changeReason_l":{
            "type":"object",
            "title":"Change Reason",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_config_attr_text":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "itemInstanceName_l":{
            "type":"string",
            "description":"The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance.",
            "title":"Instance Name"
        },
        "priceRecurFrequencyRollup_l":{
            "type":"object",
            "title":"Price Recurrence Frequency (Rollup)",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_price_applied_agreement_number":{
            "type":"string",
            "description":"Applied Agreement Number",
            "title":"Applied Agreement Number"
        },
        "_line_bom_model_path":{
            "type":"string",
            "description":"The model path of the BOM item; only applicable to the model line",
            "title":"Line BOM Model Path"
        },
        "_model_id":{
            "type":"string",
            "description":"Id of the model",
            "title":"Model ID"
        },
        "_availableRatePlanSetControl":{
            "type":"integer",
            "description":"",
            "title":"Available Rate Plan Set Control"
        },
        "_date_added":{
            "type":"string",
            "description":"",
            "title":"_date_added"
        },
        "_model_product_line_id":{
            "type":"string",
            "description":"Id of the Product Line to which the model belongs",
            "title":"Model Product Line ID"
        },
        "requestedUnitOfMeasure_l":{
            "type":"object",
            "title":"Unit of Measure",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "usageRevSummable_l":{
            "type":"object",
            "description":"Usage revenue net of all discounts for this line.",
            "title":"Usage Revenue (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "monthlyRecurRevRollup_l":{
            "type":"object",
            "description":"Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.",
            "title":"MRR (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_configuration_id":{
            "type":"string",
            "description":"Configuration id for integrations.",
            "title":"Configuration ID"
        },
        "_model_bom":{
            "type":"string",
            "description":"Model BOM Link",
            "title":"Model BOM"
        },
        "contractedPeriods_l":{
            "type":"integer",
            "description":"Number of periods the customer has contracted to receive the item.",
            "title":"Contracted Periods"
        },
        "createdBy_l":{
            "type":"string",
            "description":"The person that created the transaction line.",
            "title":"Created By"
        },
        "parentDocNumber_l":{
            "type":"string",
            "description":"Document number of the parent line item.",
            "title":"Parent Doc Number"
        },
        "fulfillmentStatus_l":{
            "type":"object",
            "title":"Fulfillment Status",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_model_variable_name":{
            "type":"string",
            "description":"Variable name of the model",
            "title":"Model Variable Name"
        },
        "monthlyRecurRevSummable_l":{
            "type":"object",
            "description":"Monthly recurring revenues net of all discounts for this line.",
            "title":"MRR (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_product_line_var_name":{
            "type":"string",
            "description":"Variable name of the product line that the model belongs to.",
            "title":"Model Product Line Variable Name"
        },
        "_is_recommended_price":{
            "type":"boolean",
            "description":"Used to identify if the line item has recommended price set by a rule.",
            "title":"Is Price Recommended"
        },
        "_transactionLine_id":{
            "type":"string",
            "description":"Unique identifier for this subdocument.",
            "title":"Transaction Line ID"
        },
        "annualListValue_l":{
            "type":"object",
            "description":"The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.",
            "title":"Annual Value (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_id":{
            "type":"string",
            "description":"The BOM item instance id.",
            "title":"Line Item BOM ID"
        },
        "_model_supplier_company_name":{
            "type":"string",
            "description":"Model supplier company name",
            "title":"Model Supplier Company Name"
        },
        "rootLine_l":{
            "type":"object",
            "title":"Root Line",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "lineType_l":{
            "type":"object",
            "title":"Line Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "transactionID_l":{
            "type":"string",
            "description":"The parent transaction's internal ID.",
            "title":"Transaction Internal ID"
        },
        "_line_bom_part_number":{
            "type":"string",
            "description":"The part number of the BOM item. Only applicable to the model line.",
            "title":"Line BOM Part Number"
        },
        "usageRevRollup_l":{
            "type":"object",
            "description":"Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.",
            "title":"Usage Revenue (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "itemInstanceId_l":{
            "type":"string",
            "description":"The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created.",
            "title":"Instance ID"
        },
        "_s_coverageOrderNumber":{
            "type":"string",
            "description":"Source order number of the coverage line for OM Integration.",
            "title":"Coverage Order Number"
        },
        "_s_coverageLineNumber":{
            "type":"string",
            "description":"Source line number of the coverage line for OM Integration.",
            "title":"Coverage Line Number"
        },
        "_line_bom_item_quantity":{
            "type":"integer",
            "description":"The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity.",
            "title":"Line BOM Item Quantity"
        },
        "annualDiscount_l":{
            "type":"object",
            "description":"The annual discount on the recurring charges on this line.",
            "title":"Annual Discount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_segment_var_name":{
            "type":"string",
            "description":"Segment to which the model belongs",
            "title":"Model Segment Variable Name"
        },
        "_line_bom_level":{
            "type":"integer",
            "description":"The BOM item depth (level) in the quote.",
            "title":"Line BOM Level"
        },
        "_bs_id":{
            "type":"integer",
            "description":"",
            "title":"_bs_id"
        },
        "netAmount_l":{
            "type":"object",
            "description":"The extended list amount minus any discounts for this line.",
            "title":"Amount (Net)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "orderDate_l":{
            "type":"string",
            "description":"The date and time the order was placed for fulfillment.",
            "title":"Order Date"
        },
        "_part_units":{
            "type":"string",
            "description":"Units of the part",
            "title":"Part Units"
        },
        "_part_direct_buy":{
            "type":"string",
            "description":"Direct Buy",
            "title":"Direct Buy"
        },
        "salesChannel_l":{
            "type":"object",
            "title":"Sales Channel",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "oRCL_SFA_InventoryItemID_l":{
            "type":"string",
            "description":"The inventory item id of the sales product in SFA.",
            "title":"Inventory Item ID"
        },
        "oRCL_ABO_ActionCode_l":{
            "type":"object",
            "title":"Action Code",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "priceRecurFrequency_l":{
            "type":"object",
            "title":"Price Recurrence Frequency",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_line_bom_parent_id":{
            "type":"string",
            "description":"The parent BOM item instance id.",
            "title":"Parent Line Item BOM ID"
        },
        "priceScore_l":{
            "type":"integer",
            "description":"The calculated price score for this transaction line, based on the line item's List and Net pricing.",
            "title":"Price Score"
        },
        "_line_item_type":{
            "type":"string",
            "description":"Type attribute for line items.",
            "title":"Line Item Type"
        },
        "_part_default_periodicity":{
            "type":"string",
            "description":"Default Price Periodicity",
            "title":"Part Price Period"
        },
        "_delta_price":{
            "type":"object",
            "description":"Delta Price",
            "title":"Delta Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_display_name":{
            "type":"string",
            "description":"Display name attribute for line items.",
            "title":"Line Display Name"
        },
        "netPrice_l":{
            "type":"object",
            "description":"The price paid by the customer for the item.",
            "title":"Price (Net)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_revenueId_l":{
            "type":"string",
            "description":"The ID of the Revenue Line Item in the associated opportunity.",
            "title":"Revenue ID"
        },
        "renewDate_l":{
            "type":"string",
            "description":"Renewal date of a subscription service.",
            "title":"Renew Date"
        },
        "_price_type":{
            "type":"string",
            "description":"Type of price (For example: One-time, Periodic - monthly, quarterly etc)",
            "title":"Pricing Engine Price Type"
        },
        "listPrice_l":{
            "type":"object",
            "description":"The list price of the item.",
            "title":"Price (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_part_extended_desc_2":{
            "type":"string",
            "description":"Extended description of the part",
            "title":"Part Extended Description 2"
        },
        "documentNumber_l":{
            "type":"string",
            "description":"Document number of the line.",
            "title":"Document Number"
        },
        "_part_extended_desc_1":{
            "type":"string",
            "description":"Extended description of the part",
            "title":"Part Extended Description 1"
        },
        "nonRecurRevSummable_l":{
            "type":"object",
            "description":"One-time revenue net of all discounts for this line.",
            "title":"Non-Recurring Revenue (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "priceTypeRollup_l":{
            "type":"object",
            "title":"Price Type (Rollup)",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "contractedPeriodsRollup_l":{
            "type":"integer",
            "description":"Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values.",
            "title":"Contracted Periods (Rollup)"
        },
        "_is_line_item_mandatory":{
            "type":"boolean",
            "description":"Used to identify if the line item is mandatory.",
            "title":"Is Line Item Mandatory"
        },
        "_price_period":{
            "type":"string",
            "description":"Period for which the price will be applicable.",
            "title":"Pricing Engine Price Period"
        },
        "ownerResourceId_l":{
            "type":"string",
            "description":"The owner of the associated Opportunity Revenue Line.",
            "title":"Owner Resource ID"
        },
        "_id":{
            "type":"integer",
            "description":"",
            "title":"_id"
        },
        "_is_coverage":{
            "type":"boolean",
            "description":"Indicates whether the product is of coverage type",
            "title":"Is Coverage Product"
        },
        "_part_lead_time":{
            "type":"string",
            "description":"Lead time",
            "title":"Part Lead Time"
        },
        "lineNumber_l":{
            "type":"integer",
            "description":"Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents.",
            "title":"Line Number"
        },
        "_part_css_enabled":{
            "type":"string",
            "description":"Customer Self-service enabled flag",
            "title":"Enable Customer Self-Service"
        },
        "subscriptionLineId_l":{
            "type":"string",
            "description":"The unique identifier for the subscription line. Used only for  subscription billing-related transactions.",
            "title":"Subscription Line Id"
        },
        "cancelReason_l":{
            "type":"object",
            "title":"Cancel Reason",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "status_l":{
            "type":"object",
            "title":"Status",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_line_item_comment":{
            "type":"string",
            "description":"Stores the comments for the line item.",
            "title":"Line Item Comments"
        },
        "contractValueRollup_l":{
            "type":"object",
            "description":"Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.",
            "title":"Contract Value (Net Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_sequence_index":{
            "type":"string",
            "description":"The sequence index of the BOM item",
            "title":"Line BOM Sequence Index"
        },
        "_step_var_name":{
            "type":"string",
            "description":"",
            "title":"_step_var_name"
        },
        "_model_name":{
            "type":"string",
            "description":"Name of the model",
            "title":"Model Name"
        },
        "_config_attr_values":{
            "type":"string",
            "description":"Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported.",
            "title":"Config Attribute Values"
        },
        "_part_drawing_position":{
            "type":"string",
            "description":"Drawing Position",
            "title":"Drawing Position"
        },
        "fulfillmentOrganizationCode_l":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that ships the shipment.",
            "title":"Fulfillment Organization Code"
        },
        "_pricing_rule_price_each":{
            "type":"object",
            "description":"Currenly the customer level pricing. (Not applicable for Models)",
            "title":"Pricing Rule Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "monthlyUsageRevSummable_l":{
            "type":"object",
            "description":"Monthly usage revenues net of all discounts for this line.",
            "title":"MUR (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_variable_name":{
            "type":"string",
            "description":"The variable name of the BOM item",
            "title":"Line BOM Variable Name"
        },
        "marginAmount_l":{
            "type":"object",
            "description":"The margin for all quoted units of this transaction line.",
            "title":"Margin Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_partner_organization_id":{
            "type":"string",
            "description":"Partner Organization Id",
            "title":"Partner Organization Id"
        },
        "netPriceRollup_l":{
            "type":"object",
            "description":"The price paid by the customer for the individual item or for the root model rolled up to include all child values.",
            "title":"Net Price (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "annualValue_l":{
            "type":"object",
            "description":"The annual contract value of the recurring charges on this line.",
            "title":"Annual Value (Net)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_pp_name":{
            "type":"string",
            "description":"",
            "title":"_pp_name"
        },
        "oRCL_SFA_InventoryOrgID_l":{
            "type":"string",
            "description":"The inventory organization in SFA used for sales products.",
            "title":"Partner Orgnanization ID"
        },
        "_line_bom_condition_index":{
            "type":"string",
            "description":"The condition index of the BOM item",
            "title":"Line BOM Condition Index"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        },
        "_availableRatePlanSet":{
            "$ref":"#/definitions/TransactionLine_availableRatePlanSet-collection"
        },
        "_chargeSet":{
            "$ref":"#/definitions/TransactionLine_chargeSet-collection"
        }
    },
    "title":"Transaction Line"
}

Nested Schema : actions

Type: array

Array of actions names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : childDefs

Type: array

Show Source

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/childQueryDef"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomains

Type: array

Array of field names, whose expanded domains are requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : fields

Type: array

Array of field names that you wanted returned in a request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Child query criteria.

Type: object

Title: Child query criteria.

Captures the query criteria for the child resource.

Show Source

• name: string
  Rest alias name of the child resource this query belongs to.
• queryDef: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive: boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}

Nested Schema : Available Rate Plans

Type: object

Title: Available Rate Plans

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Available Rate Plans",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : TransactionLine_availableRatePlanSet-collection

Type: object

Show Source

• _state: object 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.
• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionLine_availableRatePlanSet"
            }
        },
        "_state":{
            "$ref":"#/definitions/resourceCollectionState"
        }
    }
}

Nested Schema : TransactionLine_chargeSet-collection

Type: object

Show Source

• _state: object 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.
• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionLine_chargeSet"
            }
        },
        "_state":{
            "$ref":"#/definitions/resourceCollectionState"
        }
    }
}

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

• value: object Value
  Title: Value

  Composite attribute value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"object",
            "description":"Composite attribute value",
            "title":"Value"
        }
    },
    "title":"Commerce Composite Attribute",
    "description":"Composite attribute is used to display one or more fields belonging to a family of attributes."
}

Nested Schema : Delta Price

Type: object

Title: Delta Price

Delta Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Delta Price",
    "title":"Delta Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Model Base Price

Type: object

Title: Model Base Price

Base price of the model

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Base price of the model",
    "title":"Model Base Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Part Base Price

Type: object

Title: Part Base Price

Price of the part

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Price of the part",
    "title":"Part Base Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Configurable Price

Type: object

Title: Configurable Price

Original price as per catalog (inclusive of discount and premium)

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Original price as per catalog (inclusive of discount and premium)",
    "title":"Configurable Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"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.",
    "title":"Item Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Will usually be the same value as the Item Price, unless a recommended item price applies.",
    "title":"List Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Will usually be the same value as the List Price, unless a contract price applies.",
    "title":"Unit Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Pricing Rule Price

Type: object

Title: Pricing Rule Price

Currenly the customer level pricing. (Not applicable for Models)

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Currenly the customer level pricing. (Not applicable for Models)",
    "title":"Pricing Rule Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Prior Price

Type: object

Title: Prior Price

Prior Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Prior Price",
    "title":"Prior Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Revenue Category

Type: object

Title: Revenue Category

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Revenue Category",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Rollup Delta Price

Type: object

Title: Rollup Delta Price

Rollup Delta Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Rollup Delta Price",
    "title":"Rollup Delta Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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: object 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: object 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.
• deletable: boolean
  Title: Deletable

  Boolean value that specifies whether the row can be deleted.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the row itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• updatable: boolean
  Title: Updatable

  Boolean value that specifies whether the row can be updated.

{
    "type":"object",
    "properties":{
        "updatable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be updated.",
            "title":"Updatable"
        },
        "deletable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be deleted.",
            "title":"Deletable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the row itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the row itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"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.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "attributes":{
            "type":"object",
            "description":"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":"Attributes"
        }
    },
    "title":"state",
    "description":"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."
}

Nested Schema : Annual Cost

Type: object

Title: Annual Cost

The extended cost for recurring pricing on this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended cost for recurring pricing on this transaction line.",
    "title":"Annual Cost",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Annual Discount

Type: object

Title: Annual Discount

The annual discount on the recurring charges on this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The annual discount on the recurring charges on this line.",
    "title":"Annual Discount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.",
    "title":"Annual Value (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Annual Margin

Type: object

Title: Annual Margin

The extended margin for recurring pricing on this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended margin for recurring pricing on this transaction line.",
    "title":"Annual Margin",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Annual Value (Net)

Type: object

Title: Annual Value (Net)

The annual contract value of the recurring charges on this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The annual contract value of the recurring charges on this line.",
    "title":"Annual Value (Net)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Cancel Reason

Type: object

Title: Cancel Reason

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Cancel Reason",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Change Code

Type: object

Title: Change Code

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Change Code",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Change Reason

Type: object

Title: Change Reason

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Change Reason",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total of all contract extended costs for this line, including one-time and recurring costs.",
    "title":"Contract Cost",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Contract Discount

Type: object

Title: Contract Discount

The total discount of this line including all one-time and recurring charges.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total discount of this line including all one-time and recurring charges.",
    "title":"Contract Discount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total of all contract list value of this line, including all one-time and recurring charges.",
    "title":"Contract Value (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.",
    "title":"Contract Value (List Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total of all contract extended margins for this line, including one-time and recurring values.",
    "title":"Contract Margin",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total contract value of this line including all one-time and recurring charges.",
    "title":"Contract Value (Net Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.",
    "title":"Contract Value (Net Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Cost Amount

Type: object

Title: Cost Amount

The total cost of this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total cost of this line.",
    "title":"Cost Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The amount by which to adjust the list price because of a custom discount.",
    "title":"Custom Discount Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Discount Type

Type: object

Title: Discount Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Discount Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Amount (Discount)

Type: object

Title: Amount (Discount)

The discount amount for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The discount amount for this line.",
    "title":"Amount (Discount)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Fulfillment Status

Type: object

Title: Fulfillment Status

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Fulfillment Status",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Line Type

Type: object

Title: Line Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Line Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Amount (List)

Type: object

Title: Amount (List)

The extended list amount for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended list amount for this line.",
    "title":"Amount (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price (List)

Type: object

Title: Price (List)

The list price of the item.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The list price of the item.",
    "title":"Price (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The list price of the item or for the root model rolled up to include all child values.",
    "title":"List Price (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Margin Amount

Type: object

Title: Margin Amount

The margin for all quoted units of this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The margin for all quoted units of this transaction line.",
    "title":"Margin Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.",
    "title":"MRR (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : MRR (Summable)

Type: object

Title: MRR (Summable)

Monthly recurring revenues net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly recurring revenues net of all discounts for this line.",
    "title":"MRR (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.",
    "title":"MUR (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : MUR (Summable)

Type: object

Title: MUR (Summable)

Monthly usage revenues net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly usage revenues net of all discounts for this line.",
    "title":"MUR (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Amount (Net)

Type: object

Title: Amount (Net)

The extended list amount minus any discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended list amount minus any discounts for this line.",
    "title":"Amount (Net)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.",
    "title":"Net Amount (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price (Net)

Type: object

Title: Price (Net)

The price paid by the customer for the item.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The price paid by the customer for the item.",
    "title":"Price (Net)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The price paid by the customer for the individual item or for the root model rolled up to include all child values.",
    "title":"Net Price (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.",
    "title":"Non-Recurring Revenue (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"One-time revenue net of all discounts for this line.",
    "title":"Non-Recurring Revenue (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Action Code

Type: object

Title: Action Code

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Action Code",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Payment Terms

Type: object

Title: Payment Terms

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Payment Terms",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Period

Type: object

Title: Period

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Period",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Recurrence Frequency

Type: object

Title: Price Recurrence Frequency

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Recurrence Frequency",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Recurrence Frequency (Rollup)

Type: object

Title: Price Recurrence Frequency (Rollup)

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Recurrence Frequency (Rollup)",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Type (Rollup)

Type: object

Title: Price Type (Rollup)

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Type (Rollup)",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.",
    "title":"Recurring Revenue (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Recurring Revenue (Summable)

Type: object

Title: Recurring Revenue (Summable)

Recurring revenue net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Recurring revenue net of all discounts for this line.",
    "title":"Recurring Revenue (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Unit of Measure

Type: object

Title: Unit of Measure

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Unit of Measure",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Root Line

Type: object

Title: Root Line

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Root Line",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Sales Channel

Type: object

Title: Sales Channel

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Sales Channel",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Status",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Unit Cost

Type: object

Title: Unit Cost

The unit cost of the item.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The unit cost of the item.",
    "title":"Unit Cost",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Margin

Type: object

Title: Margin

The margin for a single unit of this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The margin for a single unit of this transaction line.",
    "title":"Margin",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.",
    "title":"Usage Revenue (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Usage Revenue (Summable)

Type: object

Title: Usage Revenue (Summable)

Usage revenue net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Usage revenue net of all discounts for this line.",
    "title":"Usage Revenue (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Win/Loss Status

Type: object

Title: Win/Loss Status

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Win/Loss Status",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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: object 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.
• defaultRowState: object 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.
• focus: object 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.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the collection itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.
• insertable: boolean
  Title: Insertable

  Boolean value that specifies whether new rows can be inserted into the collection.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• queryable: boolean
  Title: Queryable

  Boolean value that specifies whether the rows in the collection can be queried.
• sortable: boolean
  Title: Sortable

  Boolean value that specifies whether the rows in the collection can be sorted.

{
    "type":"object",
    "properties":{
        "insertable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether new rows can be inserted into the collection.",
            "title":"Insertable"
        },
        "queryable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the rows in the collection can be queried.",
            "title":"Queryable"
        },
        "sortable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the rows in the collection can be sorted.",
            "title":"Sortable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the collection itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"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.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "defaultRowState":{
            "$ref":"#/definitions/resourceRowState"
        },
        "focus":{
            "type":"object",
            "description":"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":"Focused Users"
        }
    },
    "title":"state",
    "description":"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."
}

Nested Schema : items

Type: array

Show Source

• Array of: object Available Rate Plan Set
  Title: Available Rate Plan Set

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionLine_availableRatePlanSet"
    }
}

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

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Nested Schema : Available Rate Plan Set

Type: object

Title: Available Rate Plan Set

Show Source

• _availableRatePlanSet_rate_plan_integration_id: string
  Title: Available Rate Plan Integration Id

  Rate Plan Integration ID
• _availableRatePlanSet_rate_plan_name: string
  Title: Available Rate Plan Name

  Rate plan name
• _availableRatePlanSet_rate_plan_number: string
  Title: Available Rate Plan Number

  Rate Plan Number
• _bs_id: integer
  Title: _bs_id

  _bs_id
• _document_number: integer
  Title: _document_number

  _document_number
• _row_number: integer
  Title: _row_number

  _row_number
• _sequence_number: integer
  Title: _sequence_number

  _sequence_number
• _state: object 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.
• _transaction_currency_pref: object _transaction_currency_pref
  Title: _transaction_currency_pref

{
    "type":"object",
    "properties":{
        "_sequence_number":{
            "type":"integer",
            "description":"_sequence_number",
            "title":"_sequence_number"
        },
        "_document_number":{
            "type":"integer",
            "description":"_document_number",
            "title":"_document_number"
        },
        "_availableRatePlanSet_rate_plan_integration_id":{
            "type":"string",
            "description":"Rate Plan Integration ID",
            "title":"Available Rate Plan Integration Id"
        },
        "_availableRatePlanSet_rate_plan_name":{
            "type":"string",
            "description":"Rate plan name",
            "title":"Available Rate Plan Name"
        },
        "_bs_id":{
            "type":"integer",
            "description":"_bs_id",
            "title":"_bs_id"
        },
        "_row_number":{
            "type":"integer",
            "description":"_row_number",
            "title":"_row_number"
        },
        "_transaction_currency_pref":{
            "type":"object",
            "description":"",
            "title":"_transaction_currency_pref",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the currency  resource.",
                    "title":"Id"
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "_availableRatePlanSet_rate_plan_number":{
            "type":"string",
            "description":"Rate Plan Number",
            "title":"Available Rate Plan Number"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        }
    },
    "title":"Available Rate Plan Set"
}

Nested Schema : _transaction_currency_pref

Type: object

Title: _transaction_currency_pref

Show Source

• currencyCode: string
  Title: Currency Code

  Unique currency code for the currency.
• id: integer
  Title: Id

  Primary Key of the currency resource.

{
    "type":"object",
    "description":"",
    "title":"_transaction_currency_pref",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the currency  resource.",
            "title":"Id"
        },
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Charge Set
  Title: Charge Set

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionLine_chargeSet"
    }
}

Nested Schema : Charge Set

Type: object

Title: Charge Set

Show Source

• _bs_id: integer
  Title: _bs_id

  _bs_id
• _chargeSet_calculationInfo: string
  Title: Calculation Information

  A JSON array of the Price Models used in calculating this charge's price.
• _chargeSet_chargeDefinition: string
  Title: Charge Definition

  The display label of the charge definition.
• _chargeSet_chargeDefinitionCode: string
  Title: Charge Definition Code

  The code of the charge definition.
• _chargeSet_chargeDefIntegrationId: string
  Title: Charge Definition Integration ID

  The charge definition code in the integrated order management system.
• _chargeSet_chargeType: object Charge Type
  Title: Charge Type
• _chargeSet_discountAmount: object Discount Amount
  Title: Discount Amount

  The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.
• _chargeSet_discountType: object Discount Type
  Title: Discount Type
• _chargeSet_discountValue: number
  Title: Discount Value

  The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge.
• _chargeSet_dynamicPricingType: string
  Title: Dynamic Pricing Type

  The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced.
• _chargeSet_netAmount: object Net Amount
  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.
• _chargeSet_netPrice: object Net Price
  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.
• _chargeSet_pricePeriod: object Price Period
  Title: Price Period
• _chargeSet_priceType: object Price Type
  Title: Price Type
• _chargeSet_rateCardInHTML: string
  Title: Rate Card In HTML

  The HTML-formatted rate card data
• _chargeSet_rateCardName: string
  Title: Rate Card

  Display label for the Rate Card applied in calculating this charge's price.
• _chargeSet_rateCardStructure: string
  Title: Rate Card Structure

  The rate card used to calculate this charge's price.
• _chargeSet_rateCardVariableName: string
  Title: Rate Card Variable Name

  Variable Name for the Rate Card applied in calculating this charge's price.
• _chargeSet_unitPrice: object Unit Price
  Title: Unit Price

  The unit price to be paid by the customer for this charge.
• _chargeSet_usageUOM: object Usage UOM
  Title: Usage UOM
• _document_number: integer
  Title: _document_number

  _document_number
• _row_number: integer
  Title: _row_number

  _row_number
• _sequence_number: integer
  Title: _sequence_number

  _sequence_number
• _state: object 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.
• _transaction_currency_pref: object _transaction_currency_pref
  Title: _transaction_currency_pref

{
    "type":"object",
    "properties":{
        "_document_number":{
            "type":"integer",
            "description":"_document_number",
            "title":"_document_number"
        },
        "_chargeSet_chargeType":{
            "type":"object",
            "title":"Charge Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_sequence_number":{
            "type":"integer",
            "description":"_sequence_number",
            "title":"_sequence_number"
        },
        "_chargeSet_calculationInfo":{
            "type":"string",
            "description":"A JSON array of the Price Models used in calculating this charge's price.",
            "title":"Calculation Information"
        },
        "_chargeSet_netAmount":{
            "type":"object",
            "description":"The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.",
            "title":"Net Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_chargeSet_rateCardInHTML":{
            "type":"string",
            "description":"The HTML-formatted rate card data",
            "title":"Rate Card In HTML"
        },
        "_chargeSet_chargeDefinitionCode":{
            "type":"string",
            "description":"The code of the charge definition.",
            "title":"Charge Definition Code"
        },
        "_chargeSet_pricePeriod":{
            "type":"object",
            "title":"Price Period",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_discountValue":{
            "type":"number",
            "description":"The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge.",
            "title":"Discount Value"
        },
        "_row_number":{
            "type":"integer",
            "description":"_row_number",
            "title":"_row_number"
        },
        "_chargeSet_rateCardName":{
            "type":"string",
            "description":"Display label for the Rate Card applied in calculating this charge's price.",
            "title":"Rate Card"
        },
        "_chargeSet_usageUOM":{
            "type":"object",
            "title":"Usage UOM",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_rateCardStructure":{
            "type":"string",
            "description":"The rate card used to calculate this charge's price.",
            "title":"Rate Card Structure"
        },
        "_chargeSet_netPrice":{
            "type":"object",
            "description":"The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.",
            "title":"Net Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_chargeSet_dynamicPricingType":{
            "type":"string",
            "description":"The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced.",
            "title":"Dynamic Pricing Type"
        },
        "_chargeSet_discountType":{
            "type":"object",
            "title":"Discount Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_rateCardVariableName":{
            "type":"string",
            "description":"Variable Name for the Rate Card applied in calculating this charge's price.",
            "title":"Rate Card Variable Name"
        },
        "_transaction_currency_pref":{
            "type":"object",
            "description":"",
            "title":"_transaction_currency_pref",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the currency  resource.",
                    "title":"Id"
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "_chargeSet_chargeDefinition":{
            "type":"string",
            "description":"The display label of the charge definition.",
            "title":"Charge Definition"
        },
        "_chargeSet_chargeDefIntegrationId":{
            "type":"string",
            "description":"The charge definition code in the integrated order management system.",
            "title":"Charge Definition Integration ID"
        },
        "_chargeSet_discountAmount":{
            "type":"object",
            "description":"The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.",
            "title":"Discount Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_chargeSet_priceType":{
            "type":"object",
            "title":"Price Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_unitPrice":{
            "type":"object",
            "description":"The unit price to be paid by the customer for this charge.",
            "title":"Unit Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_bs_id":{
            "type":"integer",
            "description":"_bs_id",
            "title":"_bs_id"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        }
    },
    "title":"Charge Set"
}

Nested Schema : Charge Type

Type: object

Title: Charge Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Charge Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.",
    "title":"Discount Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Discount Type

Type: object

Title: Discount Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Discount Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.",
    "title":"Net Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.",
    "title":"Net Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price Period

Type: object

Title: Price Period

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Period",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Unit Price

Type: object

Title: Unit Price

The unit price to be paid by the customer for this charge.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The unit price to be paid by the customer for this charge.",
    "title":"Unit Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Usage UOM

Type: object

Title: Usage UOM

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Usage UOM",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : _transaction_currency_pref

Type: object

Title: _transaction_currency_pref

Show Source

• currencyCode: string
  Title: Currency Code

  Unique currency code for the currency.
• id: integer
  Title: Id

  Primary Key of the currency resource.

{
    "type":"object",
    "description":"",
    "title":"_transaction_currency_pref",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the currency  resource.",
            "title":"Id"
        },
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

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

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : TransactionLine-_interactResponse

Type: object

Show Source

• cacheInstanceId: string
  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.
• documents: object Transaction Line
  Title: Transaction Line
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "documents":{
            "$ref":"#/definitions/TransactionLine"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"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.",
            "title":"Cache Instance Id"
        }
    }
}

Nested Schema : Transaction Line

Type: object

Title: Transaction Line

Show Source

• _availableRatePlans: object Available Rate Plans
  Title: Available Rate Plans
• _availableRatePlanSet: object TransactionLine_availableRatePlanSet-collection
• _availableRatePlanSetControl: integer
  Title: Available Rate Plan Set Control
• _bs_id: integer
  Title: _bs_id
• _chargeSet: object TransactionLine_chargeSet-collection
• _chargeSetControl: integer
  Title: Charge Set Control
• _config_attr_info: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _config_attr_text: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _config_attr_values: string
  Title: Config Attribute Values

  Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported.
• _config_attributes: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _config_extra_info: string
  Title: Config Extra Info

  Configuration Extra Information.
• _configuration_id: string
  Title: Configuration ID

  Configuration id for integrations.
• _date_added: string
  Title: _date_added
• _date_modified: string
  Title: _date_modified
• _delta_price: object Delta Price
  Title: Delta Price

  Delta Price
• _document_number: integer
  Title: _document_number
• _document_var_name: string
  Title: _document_var_name
• _group_sequence_number: string
  Title: Group Sequence Number

  Group sequence number for the subdocument.
• _id: integer
  Title: _id
• _is_bom_price: boolean
  Title: Is BOM Price

  Used to identify if the line item has BOM price. Applicable for a BOM item only
• _is_coverage: boolean
  Title: Is Coverage Product

  Indicates whether the product is of coverage type
• _is_line_item_mandatory: boolean
  Title: Is Line Item Mandatory

  Used to identify if the line item is mandatory.
• _is_part_pricing_rule_price: boolean
  Title: Is Price from Pricing Rule

  Used to identify if a line item has a part pricing rule set by a rule
• _is_recommended_price: boolean
  Title: Is Price Recommended

  Used to identify if the line item has recommended price set by a rule.
• _last_modified_date: string
  Title: Last Modified Date

  Used to Store the last modified date of the sub-document.
• _line_bom_attributes: string
  Title: Line Item BOM Attributes

  BOM attributes, stored as a JSON string.
• _line_bom_condition_index: string
  Title: Line BOM Condition Index

  The condition index of the BOM item
• _line_bom_display_name: string
  Title: Line BOM Display Name

  The display name of the BOM item
• _line_bom_effective_date: string
  Title: Line BOM Effective Date

  System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings.
• _line_bom_id: string
  Title: Line Item BOM ID

  The BOM item instance id.
• _line_bom_item_quantity: integer
  Title: Line BOM Item Quantity

  The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity.
• _line_bom_level: integer
  Title: Line BOM Level

  The BOM item depth (level) in the quote.
• _line_bom_model_path: string
  Title: Line BOM Model Path

  The model path of the BOM item; only applicable to the model line
• _line_bom_name: string
  Title: Line BOM Name

  The name of the BOM item
• _line_bom_parent_id: string
  Title: Parent Line Item BOM ID

  The parent BOM item instance id.
• _line_bom_part_number: string
  Title: Line BOM Part Number

  The part number of the BOM item. Only applicable to the model line.
• _line_bom_sequence_index: string
  Title: Line BOM Sequence Index

  The sequence index of the BOM item
• _line_bom_variable_name: string
  Title: Line BOM Variable Name

  The variable name of the BOM item
• _line_display_name: string
  Title: Line Display Name

  Display name attribute for line items.
• _line_item_comment: string
  Title: Line Item Comments

  Stores the comments for the line item.
• _line_item_spare_rule_var_name: string
  Title: Line Item Identifier

  Identifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier
• _line_item_type: string
  Title: Line Item Type

  Type attribute for line items.
• _model_attributes: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _model_base_price: object Model Base Price
  Title: Model Base Price

  Base price of the model
• _model_bom: string
  Title: Model BOM

  Model BOM Link
• _model_id: string
  Title: Model ID

  Id of the model
• _model_is_valid: boolean
  Title: Is Model Valid

  Check if model is configured or unconfigured
• _model_name: string
  Title: Model Name

  Name of the model
• _model_partner_entity_id: string
  Title: Model Partner Entity Id

  Partner entity id for the model
• _model_partner_organization_id: string
  Title: Model Partner Organization Id

  partner organization id for the model
• _model_product_line_attributes: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _model_product_line_id: string
  Title: Model Product Line ID

  Id of the Product Line to which the model belongs
• _model_product_line_name: string
  Title: Model Product Line Name

  Product Line to which the model belongs
• _model_product_line_var_name: string
  Title: Model Product Line Variable Name

  Variable name of the product line that the model belongs to.
• _model_sales_product_type: string
  Title: Model Sales Product Type

  ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.
• _model_segment_id: string
  Title: Model Segment ID

  Id of the Segment to which the model belongs
• _model_segment_name: string
  Title: Model Segment Name

  Segment to which the model belongs
• _model_segment_var_name: string
  Title: Model Segment Variable Name

  Segment to which the model belongs
• _model_supplier_company_id: string
  Title: Model Supplier Company ID

  Model supplier company id
• _model_supplier_company_name: string
  Title: Model Supplier Company Name

  Model supplier company name
• _model_variable_name: string
  Title: Model Variable Name

  Variable name of the model
• _original_document_number: string
  Title: Original Document Number

  Used to identify the document number from which the line item is copied.
• _parent_doc_number: string
  Title: Parent Document Number

  Used to identify the parent document number, if any, for this subdocument.
• _parent_line_item: string
  Title: Parent Line Item

  Used to identify the name of the parent line item, if any, for this subdocument.
• _part_base_price: object Part Base Price
  Title: Part Base Price

  Price of the part
• _part_company_associations: string
  Title: Company Associations

  Company Associations
• _part_css_enabled: string
  Title: Enable Customer Self-Service

  Customer Self-service enabled flag
• _part_default_periodicity: string
  Title: Part Price Period

  Default Price Periodicity
• _part_default_periods: string
  Title: Number of Price Periods

  Default number of price periods
• _part_default_price_type: string
  Title: Part Price Type

  Default Price Type
• _part_default_uom: string
  Title: Default UOM Code

  Default unit of measure
• _part_desc: string
  Title: Part Description

  Description of the part
• _part_direct_buy: string
  Title: Direct Buy

  Direct Buy
• _part_display_number: string
  Title: Part Display Number

  Part Display Number
• _part_drawing_position: string
  Title: Drawing Position

  Drawing Position
• _part_extended_desc_1: string
  Title: Part Extended Description 1

  Extended description of the part
• _part_extended_desc_2: string
  Title: Part Extended Description 2

  Extended description of the part
• _part_external_key1: string
  Title: External Key 1

  External system's key
• _part_external_key2: string
  Title: External Key 2

  External system's key
• _part_id: string
  Title: Part ID

  Id of the part
• _part_lead_time: string
  Title: Part Lead Time

  Lead time
• _part_number: string
  Title: Part Number

  Part Number
• _part_sale_enabled: string
  Title: Eligible to Sell

  Eligible to sell or order
• _part_sales_product_type: string
  Title: Sales Product Type

  ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.
• _part_serv_req_enabled: string
  Title: Eligible for Service

  Eligible for service
• _part_supplier_company_id: string
  Title: Part Supplier Company ID

  Id of the part supplier company
• _part_supplier_company_name: string
  Title: Part Supplier Company Name

  Name of the part supplier company
• _part_units: string
  Title: Part Units

  Units of the part
• _partner_entity_id: string
  Title: Partner Entity Id

  Partner Entity Id
• _partner_organization_id: string
  Title: Partner Organization Id

  Partner Organization Id
• _pp_id: integer
  Title: _pp_id
• _pp_name: string
  Title: _pp_name
• _price_applied_agreement_integrationId: string
  Title: Applied Agreement Integration ID

  Applied Agreement Integration Id
• _price_applied_agreement_name: string
  Title: Applied Agreement Name

  Applied Agreement Name
• _price_applied_agreement_number: string
  Title: Applied Agreement Number

  Applied Agreement Number
• _price_applied_ratePlan: string
  Title: Applied Rate Plan

  Applied Rate Plan
• _price_applied_ratePlan_integrationId: string
  Title: Applied Rate Plan Integration ID

  Applied Rate Plan Integration Id
• _price_applied_ratePlan_number: string
  Title: Applied Rate Plan Number

  Applied Rate Plan Number
• _price_book_var_name: string
  Title: Price Book Variable Name

  Variable Name of the Price Book used to get the price for this line item
• _price_calculation_info: string
  Title: Calculation Information

  JSON array of aggregated calculation information returned from advanced pricing profiles
• _price_component_prices: object Commerce Composite Attribute
  Title: Commerce Composite Attribute

  Composite attribute is used to display one or more fields belonging to a family of attributes.
• _price_configurable_price: object Configurable Price
  Title: Configurable Price

  Original price as per catalog (inclusive of discount and premium)
• _price_item_price_each: object Item Price
  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.
• _price_list_price_each: object List Price
  Title: List Price

  Will usually be the same value as the Item Price, unless a recommended item price applies.
• _price_period: string
  Title: Pricing Engine Price Period

  Period for which the price will be applicable.
• _price_quantity: integer
  Title: Quantity

  Quantity
• _price_type: string
  Title: Pricing Engine Price Type

  Type of price (For example: One-time, Periodic - monthly, quarterly etc)
• _price_unit_price_each: object Unit Price
  Title: Unit Price

  Will usually be the same value as the List Price, unless a contract price applies.
• _pricing_rule_price_each: object Pricing Rule Price
  Title: Pricing Rule Price

  Currenly the customer level pricing. (Not applicable for Models)
• _prior_price: object Prior Price
  Title: Prior Price

  Prior Price
• _reconfiguration_date: string
  Title: Reconfiguration Date

  Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model.
• _revenueCategory_l: object Revenue Category
  Title: Revenue Category
• _revenueId_l: string
  Title: Revenue ID

  The ID of the Revenue Line Item in the associated opportunity.
• _rollup_delta_price: object Rollup Delta Price
  Title: Rollup Delta Price

  Rollup Delta Price
• _s_coverageLineNumber: string
  Title: Coverage Line Number

  Source line number of the coverage line for OM Integration.
• _s_coverageOrderNumber: string
  Title: Coverage Order Number

  Source order number of the coverage line for OM Integration.
• _s_freezeNegotiationFlag_l: boolean
  Title: Freeze Negotiation Flag

  Flag indicating whether price negotiation is permitted.
• _s_partID_l: string
  Title: Part ID

  Part number from the Items table.
• _sequence_number: integer
  Title: Sequence Number

  Sequence number for the subdocument.
• _state: object 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.
• _step_var_name: string
  Title: _step_var_name
• _transaction_currency_pref: string
  Title: _transaction_currency_pref
• _transactionLine_id: string
  Title: Transaction Line ID

  Unique identifier for this subdocument.
• annualCost_l: object Annual Cost
  Title: Annual Cost

  The extended cost for recurring pricing on this transaction line.
• annualDiscount_l: object Annual Discount
  Title: Annual Discount

  The annual discount on the recurring charges on this line.
• annualListValue_l: object Annual Value (List)
  Title: Annual Value (List)

  The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.
• annualMargin_l: object Annual Margin
  Title: Annual Margin

  The extended margin for recurring pricing on this transaction line.
• annualValue_l: object Annual Value (Net)
  Title: Annual Value (Net)

  The annual contract value of the recurring charges on this line.
• associatedLineId_l: string
  Title: Associated Line Id

  Document number to be associated with the subscription line.
• associatedOrderId_l: string
  Title: Associated Order Id

  Source order Id associated with the subscription line
• cancelReason_l: object Cancel Reason
  Title: Cancel Reason
• changeCode_l: object Change Code
  Title: Change Code
• changeReason_l: object Change Reason
  Title: Change Reason
• contractCost_l: object Contract Cost
  Title: Contract Cost

  The total of all contract extended costs for this line, including one-time and recurring costs.
• contractDiscount_l: object Contract Discount
  Title: Contract Discount

  The total discount of this line including all one-time and recurring charges.
• contractedPeriods_l: integer
  Title: Contracted Periods

  Number of periods the customer has contracted to receive the item.
• contractedPeriodsRollup_l: integer
  Title: Contracted Periods (Rollup)

  Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values.
• contractEndDate_l: string
  Title: Contract End Date

  Date that the customer stops to receive the service.
• contractListValue_l: object Contract Value (List)
  Title: Contract Value (List)

  The total of all contract list value of this line, including all one-time and recurring charges.
• contractListValueRollup_l: object Contract Value (List Rollup)
  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.
• contractMargin_l: object Contract Margin
  Title: Contract Margin

  The total of all contract extended margins for this line, including one-time and recurring values.
• contractStartDate_l: string
  Title: Contract Start Date

  Date that the customer starts to receive the service.
• contractValue_l: object Contract Value (Net Summable)
  Title: Contract Value (Net Summable)

  The total contract value of this line including all one-time and recurring charges.
• contractValueRollup_l: object Contract Value (Net Rollup)
  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.
• costAmount_l: object Cost Amount
  Title: Cost Amount

  The total cost of this line.
• createdBy_l: string
  Title: Created By

  The person that created the transaction line.
• createdDate_l: string
  Title: Created Date

  The date when the transaction line was created.
• customDiscountAmount_l: object Custom Discount Amount
  Title: Custom Discount Amount

  The amount by which to adjust the list price because of a custom discount.
• customDiscountType_l: object Discount Type
  Title: Discount Type
• customDiscountValue_l: number
  Title: Discount

  Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage.
• discountAmount_l: object Amount (Discount)
  Title: Amount (Discount)

  The discount amount for this line.
• discountPercent_l: number
  Title: Discount %

  The percentage of the Contract Value (List) that is discounted off of the transaction line.
• discountPercentRollup_l: number
  Title: Discount Percent (Rollup)

  The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values.
• documentNumber_l: string
  Title: Document Number

  Document number of the line.
• fulfillmentLineId_l: string
  Title: Fulfillment Line Id

  Value that uniquely identifies the fulfillment line.
• fulfillmentOrganizationCode_l: string
  Title: Fulfillment Organization Code

  Abbreviation that identifies the organization that ships the shipment.
• fulfillmentStatus_l: object Fulfillment Status
  Title: Fulfillment Status
• includedInBasePrice: boolean
  Title: Included In Base Price

  Used to identify if the line item is included in the base price. Applicable for a BOM item only.
• itemInstanceId_l: string
  Title: Instance ID

  The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created.
• itemInstanceName_l: string
  Title: Instance Name

  The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance.
• lastUpdatedBy_l: string
  Title: Last Updated By

  The person that last updated this transaction line.
• lastUpdatedDate_l: string
  Title: Last Updated

  The date and time the transaction line was last updated.
• lineNumber_l: integer
  Title: Line Number

  Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents.
• lineType_l: object Line Type
  Title: Line Type
• listAmount_l: object Amount (List)
  Title: Amount (List)

  The extended list amount for this line.
• listPrice_l: object Price (List)
  Title: Price (List)

  The list price of the item.
• listPriceRollup_l: object List Price (Rollup)
  Title: List Price (Rollup)

  The list price of the item or for the root model rolled up to include all child values.
• marginAmount_l: object Margin Amount
  Title: Margin Amount

  The margin for all quoted units of this transaction line.
• marginPercent_l: number
  Title: Margin %

  The percentage of the List price for which this transaction line's margin accounts.
• monthlyRecurRevRollup_l: object MRR (Rollup)
  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.
• monthlyRecurRevSummable_l: object MRR (Summable)
  Title: MRR (Summable)

  Monthly recurring revenues net of all discounts for this line.
• monthlyUsageRevRollup_l: object MUR (Rollup)
  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.
• monthlyUsageRevSummable_l: object MUR (Summable)
  Title: MUR (Summable)

  Monthly usage revenues net of all discounts for this line.
• netAmount_l: object Amount (Net)
  Title: Amount (Net)

  The extended list amount minus any discounts for this line.
• netAmountRollup_l: object Net Amount (Rollup)
  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.
• netPrice_l: object Price (Net)
  Title: Price (Net)

  The price paid by the customer for the item.
• netPriceRollup_l: object Net Price (Rollup)
  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.
• nonRecurRevRollup_l: object Non-Recurring Revenue (Rollup)
  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.
• nonRecurRevSummable_l: object Non-Recurring Revenue (Summable)
  Title: Non-Recurring Revenue (Summable)

  One-time revenue net of all discounts for this line.
• oRCL_ABO_ActionCode_l: object Action Code
  Title: Action Code
• oRCL_ABO_ComponentAttributes_l: string
  Title: Component Attributes

  A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed.
• oRCL_ERP_OrderNumber_l: string
  Title: Order Number

  The order number assigned by the external Order Management and ERP system.
• oRCL_SFA_InventoryItemID_l: string
  Title: Inventory Item ID

  The inventory item id of the sales product in SFA.
• oRCL_SFA_InventoryOrgID_l: string
  Title: Partner Orgnanization ID

  The inventory organization in SFA used for sales products.
• oRCL_SFA_Status_l: string
  Title: Opportunity Win/Loss Status (Line)

  The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value.
• orderDate_l: string
  Title: Order Date

  The date and time the order was placed for fulfillment.
• ownerResourceId_l: string
  Title: Owner Resource ID

  The owner of the associated Opportunity Revenue Line.
• parentAssetKey_l: string
  Title: Parent Asset Key

  The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines.
• parentDocNumber_l: string
  Title: Parent Doc Number

  Document number of the parent line item.
• paymentTerms_l: object Payment Terms
  Title: Payment Terms
• pricePeriod_l: object Period
  Title: Period
• priceRecurFrequency_l: object Price Recurrence Frequency
  Title: Price Recurrence Frequency
• priceRecurFrequencyRollup_l: object Price Recurrence Frequency (Rollup)
  Title: Price Recurrence Frequency (Rollup)
• priceScore_l: integer
  Title: Price Score

  The calculated price score for this transaction line, based on the line item's List and Net pricing.
• priceType_l: object Price Type
  Title: Price Type
• priceTypeRollup_l: object Price Type (Rollup)
  Title: Price Type (Rollup)
• priceWithinPolicy_l: boolean
  Title: Price Within Policy

  Flag which indicates if line price is within requesting user's defined pricing limits
• recurRevRollup_l: object Recurring Revenue (Rollup)
  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.
• recurringRevSummable_l: object Recurring Revenue (Summable)
  Title: Recurring Revenue (Summable)

  Recurring revenue net of all discounts for this line.
• renewDate_l: string
  Title: Renew Date

  Renewal date of a subscription service.
• requestDate_l: string
  Title: Request Date

  The date on which the user requests that fulfillment occur for this transaction line.
• requestedUnitOfMeasure_l: object Unit of Measure
  Title: Unit of Measure
• requestShipDate_l: string
  Title: Request Ship Date

  The requested ship date for the order line.
• resumeDate_l: string
  Title: Resume Date

  Resuming date of a subscription service
• rollupFlag_l: boolean
  Title: Rollup Flag

  Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price.
• rootAssetKey_l: string
  Title: RootAssetKey
• rootLine_l: object Root Line
  Title: Root Line
• salesChannel_l: object Sales Channel
  Title: Sales Channel
• status_l: object Status
  Title: Status
• subscriptionId_l: string
  Title: Subscription Id

  The unique identifier for the subscription. Used only for subscription billing-related transactions.
• subscriptionLineId_l: string
  Title: Subscription Line Id

  The unique identifier for the subscription line. Used only for subscription billing-related transactions.
• suspendDate_l: string
  Title: Suspend Date

  Suspension date of a subscription service
• transactionID_l: string
  Title: Transaction Internal ID

  The parent transaction's internal ID.
• unitCost_l: object Unit Cost
  Title: Unit Cost

  The unit cost of the item.
• unitMargin_l: object Margin
  Title: Margin

  The margin for a single unit of this transaction line.
• usageRevRollup_l: object Usage Revenue (Rollup)
  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.
• usageRevSummable_l: object Usage Revenue (Summable)
  Title: Usage Revenue (Summable)

  Usage revenue net of all discounts for this line.
• winLossStatus_l: object Win/Loss Status
  Title: Win/Loss Status

{
    "type":"object",
    "properties":{
        "_line_bom_attributes":{
            "type":"string",
            "description":"BOM attributes, stored as a JSON string.",
            "title":"Line Item BOM Attributes"
        },
        "_availableRatePlans":{
            "type":"object",
            "title":"Available Rate Plans",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "listAmount_l":{
            "type":"object",
            "description":"The extended list amount for this line.",
            "title":"Amount (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "discountAmount_l":{
            "type":"object",
            "description":"The discount amount for this line.",
            "title":"Amount (Discount)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "rollupFlag_l":{
            "type":"boolean",
            "description":"Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price.",
            "title":"Rollup Flag"
        },
        "contractStartDate_l":{
            "type":"string",
            "description":"Date that the customer starts to receive the service.",
            "title":"Contract Start Date"
        },
        "_model_partner_entity_id":{
            "type":"string",
            "description":"Partner entity id for the model",
            "title":"Model Partner Entity Id"
        },
        "listPriceRollup_l":{
            "type":"object",
            "description":"The list price of the item or for the root model rolled up to include all child values.",
            "title":"List Price (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_config_attributes":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_part_sale_enabled":{
            "type":"string",
            "description":"Eligible to sell or order",
            "title":"Eligible to Sell"
        },
        "recurringRevSummable_l":{
            "type":"object",
            "description":"Recurring revenue net of all discounts for this line.",
            "title":"Recurring Revenue (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "fulfillmentLineId_l":{
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line.",
            "title":"Fulfillment Line Id"
        },
        "_part_display_number":{
            "type":"string",
            "description":"Part Display Number",
            "title":"Part Display Number"
        },
        "_model_attributes":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_price_list_price_each":{
            "type":"object",
            "description":"Will usually be the same value as the Item Price, unless a recommended item price applies.",
            "title":"List Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_effective_date":{
            "type":"string",
            "description":"System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings.",
            "title":"Line BOM Effective Date"
        },
        "includedInBasePrice":{
            "type":"boolean",
            "description":"Used to identify if the line item is included in the base price. Applicable for a BOM item only.",
            "title":"Included In Base Price"
        },
        "_parent_line_item":{
            "type":"string",
            "description":"Used to identify the name of the parent line item, if any, for this subdocument.",
            "title":"Parent Line Item"
        },
        "_date_modified":{
            "type":"string",
            "description":"",
            "title":"_date_modified"
        },
        "rootAssetKey_l":{
            "type":"string",
            "description":"",
            "title":"RootAssetKey"
        },
        "annualMargin_l":{
            "type":"object",
            "description":"The extended margin for recurring pricing on this transaction line.",
            "title":"Annual Margin",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_product_line_attributes":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_price_configurable_price":{
            "type":"object",
            "description":"Original price as per catalog (inclusive of discount and premium)",
            "title":"Configurable Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "costAmount_l":{
            "type":"object",
            "description":"The total cost of this line.",
            "title":"Cost Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_is_part_pricing_rule_price":{
            "type":"boolean",
            "description":"Used to identify if a line item has a part pricing rule set by a rule",
            "title":"Is Price from Pricing Rule"
        },
        "_part_default_uom":{
            "type":"string",
            "description":"Default unit of measure",
            "title":"Default UOM Code"
        },
        "discountPercent_l":{
            "type":"number",
            "description":"The percentage of the Contract Value (List) that is discounted off of the transaction line.",
            "title":"Discount %"
        },
        "_part_sales_product_type":{
            "type":"string",
            "description":"ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.",
            "title":"Sales Product Type"
        },
        "contractEndDate_l":{
            "type":"string",
            "description":"Date that the customer stops to receive the service.",
            "title":"Contract End Date"
        },
        "_last_modified_date":{
            "type":"string",
            "description":"Used to Store the last modified date of the sub-document.",
            "title":"Last Modified Date"
        },
        "_s_freezeNegotiationFlag_l":{
            "type":"boolean",
            "description":"Flag indicating whether price negotiation is permitted.",
            "title":"Freeze Negotiation Flag"
        },
        "subscriptionId_l":{
            "type":"string",
            "description":"The unique identifier for the subscription. Used only for  subscription billing-related transactions.",
            "title":"Subscription Id"
        },
        "_config_extra_info":{
            "type":"string",
            "description":"Configuration Extra Information.",
            "title":"Config Extra Info"
        },
        "suspendDate_l":{
            "type":"string",
            "description":"Suspension date of a subscription service",
            "title":"Suspend Date"
        },
        "unitMargin_l":{
            "type":"object",
            "description":"The margin for a single unit of this transaction line.",
            "title":"Margin",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "resumeDate_l":{
            "type":"string",
            "description":"Resuming date of a subscription service",
            "title":"Resume Date"
        },
        "_part_number":{
            "type":"string",
            "description":"Part Number",
            "title":"Part Number"
        },
        "_sequence_number":{
            "type":"integer",
            "description":"Sequence number for the subdocument.",
            "title":"Sequence Number"
        },
        "_line_bom_display_name":{
            "type":"string",
            "description":"The display name of the BOM item",
            "title":"Line BOM Display Name"
        },
        "unitCost_l":{
            "type":"object",
            "description":"The unit cost of the item.",
            "title":"Unit Cost",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_price_applied_agreement_integrationId":{
            "type":"string",
            "description":"Applied Agreement Integration Id",
            "title":"Applied Agreement Integration ID"
        },
        "_price_unit_price_each":{
            "type":"object",
            "description":"Will usually be the same value as the List Price, unless a contract price applies.",
            "title":"Unit Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_base_price":{
            "type":"object",
            "description":"Base price of the model",
            "title":"Model Base Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "customDiscountValue_l":{
            "type":"number",
            "description":"Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage.",
            "title":"Discount"
        },
        "_model_product_line_name":{
            "type":"string",
            "description":"Product Line to which the model belongs",
            "title":"Model Product Line Name"
        },
        "_price_item_price_each":{
            "type":"object",
            "description":"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.",
            "title":"Item Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "recurRevRollup_l":{
            "type":"object",
            "description":"Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.",
            "title":"Recurring Revenue (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "monthlyUsageRevRollup_l":{
            "type":"object",
            "description":"Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.",
            "title":"MUR (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_transaction_currency_pref":{
            "type":"string",
            "description":"",
            "title":"_transaction_currency_pref"
        },
        "oRCL_ABO_ComponentAttributes_l":{
            "type":"string",
            "description":"A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed.",
            "title":"Component Attributes"
        },
        "_price_applied_ratePlan_integrationId":{
            "type":"string",
            "description":"Applied Rate Plan Integration Id",
            "title":"Applied Rate Plan Integration ID"
        },
        "priceWithinPolicy_l":{
            "type":"boolean",
            "description":"Flag which indicates if line price is within requesting user's defined pricing limits",
            "title":"Price Within Policy"
        },
        "_part_serv_req_enabled":{
            "type":"string",
            "description":"Eligible for service",
            "title":"Eligible for Service"
        },
        "_model_supplier_company_id":{
            "type":"string",
            "description":"Model supplier company id",
            "title":"Model Supplier Company ID"
        },
        "_model_segment_id":{
            "type":"string",
            "description":"Id of the Segment to which the model belongs",
            "title":"Model Segment ID"
        },
        "_partner_entity_id":{
            "type":"string",
            "description":"Partner Entity Id",
            "title":"Partner Entity Id"
        },
        "requestDate_l":{
            "type":"string",
            "description":"The date on which the user requests that fulfillment occur for this transaction line.",
            "title":"Request Date"
        },
        "_part_base_price":{
            "type":"object",
            "description":"Price of the part",
            "title":"Part Base Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "contractMargin_l":{
            "type":"object",
            "description":"The total of all contract extended margins for this line, including one-time and recurring values.",
            "title":"Contract Margin",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "pricePeriod_l":{
            "type":"object",
            "title":"Period",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "changeCode_l":{
            "type":"object",
            "title":"Change Code",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "associatedLineId_l":{
            "type":"string",
            "description":"Document number to be associated with the subscription line.",
            "title":"Associated Line Id"
        },
        "_model_partner_organization_id":{
            "type":"string",
            "description":"partner organization id for the model",
            "title":"Model Partner Organization Id"
        },
        "_model_segment_name":{
            "type":"string",
            "description":"Segment to which the model belongs",
            "title":"Model Segment Name"
        },
        "priceType_l":{
            "type":"object",
            "title":"Price Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "nonRecurRevRollup_l":{
            "type":"object",
            "description":"One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.",
            "title":"Non-Recurring Revenue (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "oRCL_SFA_Status_l":{
            "type":"string",
            "description":"The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value.",
            "title":"Opportunity Win/Loss Status (Line)"
        },
        "_config_attr_info":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "_s_partID_l":{
            "type":"string",
            "description":"Part number from the Items table.",
            "title":"Part ID"
        },
        "contractListValueRollup_l":{
            "type":"object",
            "description":"Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.",
            "title":"Contract Value (List Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "contractValue_l":{
            "type":"object",
            "description":"The total contract value of this line including all one-time and recurring charges.",
            "title":"Contract Value (Net Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "netAmountRollup_l":{
            "type":"object",
            "description":"The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.",
            "title":"Net Amount (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_prior_price":{
            "type":"object",
            "description":"Prior Price",
            "title":"Prior Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "customDiscountAmount_l":{
            "type":"object",
            "description":"The amount by which to adjust the list price because of a custom discount.",
            "title":"Custom Discount Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_parent_doc_number":{
            "type":"string",
            "description":"Used to identify the parent document number, if any, for this subdocument.",
            "title":"Parent Document Number"
        },
        "requestShipDate_l":{
            "type":"string",
            "description":"The requested ship date for the order line.",
            "title":"Request Ship Date"
        },
        "_reconfiguration_date":{
            "type":"string",
            "description":"Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model.",
            "title":"Reconfiguration Date"
        },
        "annualCost_l":{
            "type":"object",
            "description":"The extended cost for recurring pricing on this transaction line.",
            "title":"Annual Cost",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_part_desc":{
            "type":"string",
            "description":"Description of the part",
            "title":"Part Description"
        },
        "_chargeSetControl":{
            "type":"integer",
            "description":"",
            "title":"Charge Set Control"
        },
        "_pp_id":{
            "type":"integer",
            "description":"",
            "title":"_pp_id"
        },
        "_document_number":{
            "type":"integer",
            "description":"",
            "title":"_document_number"
        },
        "parentAssetKey_l":{
            "type":"string",
            "description":"The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines.",
            "title":"Parent Asset Key"
        },
        "_rollup_delta_price":{
            "type":"object",
            "description":"Rollup Delta Price",
            "title":"Rollup Delta Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_is_bom_price":{
            "type":"boolean",
            "description":"Used to identify if the line item has BOM price. Applicable for a BOM item only",
            "title":"Is BOM Price"
        },
        "winLossStatus_l":{
            "type":"object",
            "title":"Win/Loss Status",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_price_calculation_info":{
            "type":"string",
            "description":"JSON array of aggregated calculation information returned from advanced pricing profiles",
            "title":"Calculation Information"
        },
        "associatedOrderId_l":{
            "type":"string",
            "description":"Source order Id associated with the subscription line",
            "title":"Associated Order Id"
        },
        "_price_applied_ratePlan":{
            "type":"string",
            "description":"Applied Rate Plan",
            "title":"Applied Rate Plan"
        },
        "_price_component_prices":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "discountPercentRollup_l":{
            "type":"number",
            "description":"The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values.",
            "title":"Discount Percent (Rollup)"
        },
        "_part_supplier_company_id":{
            "type":"string",
            "description":"Id of the part supplier company",
            "title":"Part Supplier Company ID"
        },
        "_original_document_number":{
            "type":"string",
            "description":"Used to identify the document number from which the line item is copied.",
            "title":"Original Document Number"
        },
        "contractListValue_l":{
            "type":"object",
            "description":"The total of all contract list value of this line, including all one-time and recurring charges.",
            "title":"Contract Value (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_item_spare_rule_var_name":{
            "type":"string",
            "description":"Identifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier",
            "title":"Line Item Identifier"
        },
        "_price_applied_agreement_name":{
            "type":"string",
            "description":"Applied Agreement Name",
            "title":"Applied Agreement Name"
        },
        "_revenueCategory_l":{
            "type":"object",
            "title":"Revenue Category",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_part_id":{
            "type":"string",
            "description":"Id of the part",
            "title":"Part ID"
        },
        "_part_company_associations":{
            "type":"string",
            "description":"Company Associations",
            "title":"Company Associations"
        },
        "_part_default_periods":{
            "type":"string",
            "description":"Default number of price periods",
            "title":"Number of Price Periods"
        },
        "marginPercent_l":{
            "type":"number",
            "description":"The percentage of the List price for which this transaction line's margin accounts.",
            "title":"Margin %"
        },
        "_price_book_var_name":{
            "type":"string",
            "description":"Variable Name of the Price Book used to get the price for this line item",
            "title":"Price Book Variable Name"
        },
        "customDiscountType_l":{
            "type":"object",
            "title":"Discount Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_model_sales_product_type":{
            "type":"string",
            "description":"ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc.",
            "title":"Model Sales Product Type"
        },
        "_group_sequence_number":{
            "type":"string",
            "description":"Group sequence number for the subdocument.",
            "title":"Group Sequence Number"
        },
        "_price_applied_ratePlan_number":{
            "type":"string",
            "description":"Applied Rate Plan Number",
            "title":"Applied Rate Plan Number"
        },
        "lastUpdatedDate_l":{
            "type":"string",
            "description":"The date and time the transaction line was last updated.",
            "title":"Last Updated"
        },
        "_price_quantity":{
            "type":"integer",
            "description":"Quantity",
            "title":"Quantity"
        },
        "paymentTerms_l":{
            "type":"object",
            "title":"Payment Terms",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "lastUpdatedBy_l":{
            "type":"string",
            "description":"The person that last updated this transaction line.",
            "title":"Last Updated By"
        },
        "_part_supplier_company_name":{
            "type":"string",
            "description":"Name of the part supplier company",
            "title":"Part Supplier Company Name"
        },
        "_document_var_name":{
            "type":"string",
            "description":"",
            "title":"_document_var_name"
        },
        "_part_default_price_type":{
            "type":"string",
            "description":"Default Price Type",
            "title":"Part Price Type"
        },
        "createdDate_l":{
            "type":"string",
            "description":"The date when the transaction line was created.",
            "title":"Created Date"
        },
        "contractCost_l":{
            "type":"object",
            "description":"The total of all contract extended costs for this line, including one-time and recurring costs.",
            "title":"Contract Cost",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "contractDiscount_l":{
            "type":"object",
            "description":"The total discount of this line including all one-time and recurring charges.",
            "title":"Contract Discount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_name":{
            "type":"string",
            "description":"The name of the BOM item",
            "title":"Line BOM Name"
        },
        "oRCL_ERP_OrderNumber_l":{
            "type":"string",
            "description":"The order number assigned by the external Order Management and ERP system.",
            "title":"Order Number"
        },
        "_model_is_valid":{
            "type":"boolean",
            "description":"Check if model is configured or unconfigured",
            "title":"Is Model Valid"
        },
        "_part_external_key2":{
            "type":"string",
            "description":"External system's key",
            "title":"External Key 2"
        },
        "_part_external_key1":{
            "type":"string",
            "description":"External system's key",
            "title":"External Key 1"
        },
        "changeReason_l":{
            "type":"object",
            "title":"Change Reason",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_config_attr_text":{
            "$ref":"#/definitions/cmCompositeAttribute"
        },
        "itemInstanceName_l":{
            "type":"string",
            "description":"The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance.",
            "title":"Instance Name"
        },
        "priceRecurFrequencyRollup_l":{
            "type":"object",
            "title":"Price Recurrence Frequency (Rollup)",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_price_applied_agreement_number":{
            "type":"string",
            "description":"Applied Agreement Number",
            "title":"Applied Agreement Number"
        },
        "_line_bom_model_path":{
            "type":"string",
            "description":"The model path of the BOM item; only applicable to the model line",
            "title":"Line BOM Model Path"
        },
        "_model_id":{
            "type":"string",
            "description":"Id of the model",
            "title":"Model ID"
        },
        "_availableRatePlanSetControl":{
            "type":"integer",
            "description":"",
            "title":"Available Rate Plan Set Control"
        },
        "_date_added":{
            "type":"string",
            "description":"",
            "title":"_date_added"
        },
        "_model_product_line_id":{
            "type":"string",
            "description":"Id of the Product Line to which the model belongs",
            "title":"Model Product Line ID"
        },
        "requestedUnitOfMeasure_l":{
            "type":"object",
            "title":"Unit of Measure",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "usageRevSummable_l":{
            "type":"object",
            "description":"Usage revenue net of all discounts for this line.",
            "title":"Usage Revenue (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "monthlyRecurRevRollup_l":{
            "type":"object",
            "description":"Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.",
            "title":"MRR (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_configuration_id":{
            "type":"string",
            "description":"Configuration id for integrations.",
            "title":"Configuration ID"
        },
        "_model_bom":{
            "type":"string",
            "description":"Model BOM Link",
            "title":"Model BOM"
        },
        "contractedPeriods_l":{
            "type":"integer",
            "description":"Number of periods the customer has contracted to receive the item.",
            "title":"Contracted Periods"
        },
        "createdBy_l":{
            "type":"string",
            "description":"The person that created the transaction line.",
            "title":"Created By"
        },
        "parentDocNumber_l":{
            "type":"string",
            "description":"Document number of the parent line item.",
            "title":"Parent Doc Number"
        },
        "fulfillmentStatus_l":{
            "type":"object",
            "title":"Fulfillment Status",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_model_variable_name":{
            "type":"string",
            "description":"Variable name of the model",
            "title":"Model Variable Name"
        },
        "monthlyRecurRevSummable_l":{
            "type":"object",
            "description":"Monthly recurring revenues net of all discounts for this line.",
            "title":"MRR (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_product_line_var_name":{
            "type":"string",
            "description":"Variable name of the product line that the model belongs to.",
            "title":"Model Product Line Variable Name"
        },
        "_is_recommended_price":{
            "type":"boolean",
            "description":"Used to identify if the line item has recommended price set by a rule.",
            "title":"Is Price Recommended"
        },
        "_transactionLine_id":{
            "type":"string",
            "description":"Unique identifier for this subdocument.",
            "title":"Transaction Line ID"
        },
        "annualListValue_l":{
            "type":"object",
            "description":"The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.",
            "title":"Annual Value (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_id":{
            "type":"string",
            "description":"The BOM item instance id.",
            "title":"Line Item BOM ID"
        },
        "_model_supplier_company_name":{
            "type":"string",
            "description":"Model supplier company name",
            "title":"Model Supplier Company Name"
        },
        "rootLine_l":{
            "type":"object",
            "title":"Root Line",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "lineType_l":{
            "type":"object",
            "title":"Line Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "transactionID_l":{
            "type":"string",
            "description":"The parent transaction's internal ID.",
            "title":"Transaction Internal ID"
        },
        "_line_bom_part_number":{
            "type":"string",
            "description":"The part number of the BOM item. Only applicable to the model line.",
            "title":"Line BOM Part Number"
        },
        "usageRevRollup_l":{
            "type":"object",
            "description":"Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.",
            "title":"Usage Revenue (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "itemInstanceId_l":{
            "type":"string",
            "description":"The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created.",
            "title":"Instance ID"
        },
        "_s_coverageOrderNumber":{
            "type":"string",
            "description":"Source order number of the coverage line for OM Integration.",
            "title":"Coverage Order Number"
        },
        "_s_coverageLineNumber":{
            "type":"string",
            "description":"Source line number of the coverage line for OM Integration.",
            "title":"Coverage Line Number"
        },
        "_line_bom_item_quantity":{
            "type":"integer",
            "description":"The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity.",
            "title":"Line BOM Item Quantity"
        },
        "annualDiscount_l":{
            "type":"object",
            "description":"The annual discount on the recurring charges on this line.",
            "title":"Annual Discount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_model_segment_var_name":{
            "type":"string",
            "description":"Segment to which the model belongs",
            "title":"Model Segment Variable Name"
        },
        "_line_bom_level":{
            "type":"integer",
            "description":"The BOM item depth (level) in the quote.",
            "title":"Line BOM Level"
        },
        "_bs_id":{
            "type":"integer",
            "description":"",
            "title":"_bs_id"
        },
        "netAmount_l":{
            "type":"object",
            "description":"The extended list amount minus any discounts for this line.",
            "title":"Amount (Net)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "orderDate_l":{
            "type":"string",
            "description":"The date and time the order was placed for fulfillment.",
            "title":"Order Date"
        },
        "_part_units":{
            "type":"string",
            "description":"Units of the part",
            "title":"Part Units"
        },
        "_part_direct_buy":{
            "type":"string",
            "description":"Direct Buy",
            "title":"Direct Buy"
        },
        "salesChannel_l":{
            "type":"object",
            "title":"Sales Channel",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "oRCL_SFA_InventoryItemID_l":{
            "type":"string",
            "description":"The inventory item id of the sales product in SFA.",
            "title":"Inventory Item ID"
        },
        "oRCL_ABO_ActionCode_l":{
            "type":"object",
            "title":"Action Code",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "priceRecurFrequency_l":{
            "type":"object",
            "title":"Price Recurrence Frequency",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_line_bom_parent_id":{
            "type":"string",
            "description":"The parent BOM item instance id.",
            "title":"Parent Line Item BOM ID"
        },
        "priceScore_l":{
            "type":"integer",
            "description":"The calculated price score for this transaction line, based on the line item's List and Net pricing.",
            "title":"Price Score"
        },
        "_line_item_type":{
            "type":"string",
            "description":"Type attribute for line items.",
            "title":"Line Item Type"
        },
        "_part_default_periodicity":{
            "type":"string",
            "description":"Default Price Periodicity",
            "title":"Part Price Period"
        },
        "_delta_price":{
            "type":"object",
            "description":"Delta Price",
            "title":"Delta Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_display_name":{
            "type":"string",
            "description":"Display name attribute for line items.",
            "title":"Line Display Name"
        },
        "netPrice_l":{
            "type":"object",
            "description":"The price paid by the customer for the item.",
            "title":"Price (Net)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_revenueId_l":{
            "type":"string",
            "description":"The ID of the Revenue Line Item in the associated opportunity.",
            "title":"Revenue ID"
        },
        "renewDate_l":{
            "type":"string",
            "description":"Renewal date of a subscription service.",
            "title":"Renew Date"
        },
        "_price_type":{
            "type":"string",
            "description":"Type of price (For example: One-time, Periodic - monthly, quarterly etc)",
            "title":"Pricing Engine Price Type"
        },
        "listPrice_l":{
            "type":"object",
            "description":"The list price of the item.",
            "title":"Price (List)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_part_extended_desc_2":{
            "type":"string",
            "description":"Extended description of the part",
            "title":"Part Extended Description 2"
        },
        "documentNumber_l":{
            "type":"string",
            "description":"Document number of the line.",
            "title":"Document Number"
        },
        "_part_extended_desc_1":{
            "type":"string",
            "description":"Extended description of the part",
            "title":"Part Extended Description 1"
        },
        "nonRecurRevSummable_l":{
            "type":"object",
            "description":"One-time revenue net of all discounts for this line.",
            "title":"Non-Recurring Revenue (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "priceTypeRollup_l":{
            "type":"object",
            "title":"Price Type (Rollup)",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "contractedPeriodsRollup_l":{
            "type":"integer",
            "description":"Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values.",
            "title":"Contracted Periods (Rollup)"
        },
        "_is_line_item_mandatory":{
            "type":"boolean",
            "description":"Used to identify if the line item is mandatory.",
            "title":"Is Line Item Mandatory"
        },
        "_price_period":{
            "type":"string",
            "description":"Period for which the price will be applicable.",
            "title":"Pricing Engine Price Period"
        },
        "ownerResourceId_l":{
            "type":"string",
            "description":"The owner of the associated Opportunity Revenue Line.",
            "title":"Owner Resource ID"
        },
        "_id":{
            "type":"integer",
            "description":"",
            "title":"_id"
        },
        "_is_coverage":{
            "type":"boolean",
            "description":"Indicates whether the product is of coverage type",
            "title":"Is Coverage Product"
        },
        "_part_lead_time":{
            "type":"string",
            "description":"Lead time",
            "title":"Part Lead Time"
        },
        "lineNumber_l":{
            "type":"integer",
            "description":"Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents.",
            "title":"Line Number"
        },
        "_part_css_enabled":{
            "type":"string",
            "description":"Customer Self-service enabled flag",
            "title":"Enable Customer Self-Service"
        },
        "subscriptionLineId_l":{
            "type":"string",
            "description":"The unique identifier for the subscription line. Used only for  subscription billing-related transactions.",
            "title":"Subscription Line Id"
        },
        "cancelReason_l":{
            "type":"object",
            "title":"Cancel Reason",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "status_l":{
            "type":"object",
            "title":"Status",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_line_item_comment":{
            "type":"string",
            "description":"Stores the comments for the line item.",
            "title":"Line Item Comments"
        },
        "contractValueRollup_l":{
            "type":"object",
            "description":"Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.",
            "title":"Contract Value (Net Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_sequence_index":{
            "type":"string",
            "description":"The sequence index of the BOM item",
            "title":"Line BOM Sequence Index"
        },
        "_step_var_name":{
            "type":"string",
            "description":"",
            "title":"_step_var_name"
        },
        "_model_name":{
            "type":"string",
            "description":"Name of the model",
            "title":"Model Name"
        },
        "_config_attr_values":{
            "type":"string",
            "description":"Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported.",
            "title":"Config Attribute Values"
        },
        "_part_drawing_position":{
            "type":"string",
            "description":"Drawing Position",
            "title":"Drawing Position"
        },
        "fulfillmentOrganizationCode_l":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that ships the shipment.",
            "title":"Fulfillment Organization Code"
        },
        "_pricing_rule_price_each":{
            "type":"object",
            "description":"Currenly the customer level pricing. (Not applicable for Models)",
            "title":"Pricing Rule Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "monthlyUsageRevSummable_l":{
            "type":"object",
            "description":"Monthly usage revenues net of all discounts for this line.",
            "title":"MUR (Summable)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_line_bom_variable_name":{
            "type":"string",
            "description":"The variable name of the BOM item",
            "title":"Line BOM Variable Name"
        },
        "marginAmount_l":{
            "type":"object",
            "description":"The margin for all quoted units of this transaction line.",
            "title":"Margin Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_partner_organization_id":{
            "type":"string",
            "description":"Partner Organization Id",
            "title":"Partner Organization Id"
        },
        "netPriceRollup_l":{
            "type":"object",
            "description":"The price paid by the customer for the individual item or for the root model rolled up to include all child values.",
            "title":"Net Price (Rollup)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "annualValue_l":{
            "type":"object",
            "description":"The annual contract value of the recurring charges on this line.",
            "title":"Annual Value (Net)",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_pp_name":{
            "type":"string",
            "description":"",
            "title":"_pp_name"
        },
        "oRCL_SFA_InventoryOrgID_l":{
            "type":"string",
            "description":"The inventory organization in SFA used for sales products.",
            "title":"Partner Orgnanization ID"
        },
        "_line_bom_condition_index":{
            "type":"string",
            "description":"The condition index of the BOM item",
            "title":"Line BOM Condition Index"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        },
        "_availableRatePlanSet":{
            "$ref":"#/definitions/TransactionLine_availableRatePlanSet-collection"
        },
        "_chargeSet":{
            "$ref":"#/definitions/TransactionLine_chargeSet-collection"
        }
    },
    "title":"Transaction Line"
}

Nested Schema : Available Rate Plans

Type: object

Title: Available Rate Plans

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Available Rate Plans",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : TransactionLine_availableRatePlanSet-collection

Type: object

Show Source

• _state: object 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.
• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionLine_availableRatePlanSet"
            }
        },
        "_state":{
            "$ref":"#/definitions/resourceCollectionState"
        }
    }
}

Nested Schema : TransactionLine_chargeSet-collection

Type: object

Show Source

• _state: object 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.
• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionLine_chargeSet"
            }
        },
        "_state":{
            "$ref":"#/definitions/resourceCollectionState"
        }
    }
}

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

• value: object Value
  Title: Value

  Composite attribute value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"object",
            "description":"Composite attribute value",
            "title":"Value"
        }
    },
    "title":"Commerce Composite Attribute",
    "description":"Composite attribute is used to display one or more fields belonging to a family of attributes."
}

Nested Schema : Delta Price

Type: object

Title: Delta Price

Delta Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Delta Price",
    "title":"Delta Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Model Base Price

Type: object

Title: Model Base Price

Base price of the model

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Base price of the model",
    "title":"Model Base Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Part Base Price

Type: object

Title: Part Base Price

Price of the part

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Price of the part",
    "title":"Part Base Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Configurable Price

Type: object

Title: Configurable Price

Original price as per catalog (inclusive of discount and premium)

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Original price as per catalog (inclusive of discount and premium)",
    "title":"Configurable Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"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.",
    "title":"Item Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Will usually be the same value as the Item Price, unless a recommended item price applies.",
    "title":"List Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Will usually be the same value as the List Price, unless a contract price applies.",
    "title":"Unit Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Pricing Rule Price

Type: object

Title: Pricing Rule Price

Currenly the customer level pricing. (Not applicable for Models)

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Currenly the customer level pricing. (Not applicable for Models)",
    "title":"Pricing Rule Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Prior Price

Type: object

Title: Prior Price

Prior Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Prior Price",
    "title":"Prior Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Revenue Category

Type: object

Title: Revenue Category

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Revenue Category",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Rollup Delta Price

Type: object

Title: Rollup Delta Price

Rollup Delta Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Rollup Delta Price",
    "title":"Rollup Delta Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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: object 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: object 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.
• deletable: boolean
  Title: Deletable

  Boolean value that specifies whether the row can be deleted.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the row itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• updatable: boolean
  Title: Updatable

  Boolean value that specifies whether the row can be updated.

{
    "type":"object",
    "properties":{
        "updatable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be updated.",
            "title":"Updatable"
        },
        "deletable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be deleted.",
            "title":"Deletable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the row itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the row itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"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.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "attributes":{
            "type":"object",
            "description":"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":"Attributes"
        }
    },
    "title":"state",
    "description":"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."
}

Nested Schema : Annual Cost

Type: object

Title: Annual Cost

The extended cost for recurring pricing on this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended cost for recurring pricing on this transaction line.",
    "title":"Annual Cost",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Annual Discount

Type: object

Title: Annual Discount

The annual discount on the recurring charges on this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The annual discount on the recurring charges on this line.",
    "title":"Annual Discount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.",
    "title":"Annual Value (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Annual Margin

Type: object

Title: Annual Margin

The extended margin for recurring pricing on this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended margin for recurring pricing on this transaction line.",
    "title":"Annual Margin",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Annual Value (Net)

Type: object

Title: Annual Value (Net)

The annual contract value of the recurring charges on this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The annual contract value of the recurring charges on this line.",
    "title":"Annual Value (Net)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Cancel Reason

Type: object

Title: Cancel Reason

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Cancel Reason",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Change Code

Type: object

Title: Change Code

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Change Code",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Change Reason

Type: object

Title: Change Reason

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Change Reason",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total of all contract extended costs for this line, including one-time and recurring costs.",
    "title":"Contract Cost",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Contract Discount

Type: object

Title: Contract Discount

The total discount of this line including all one-time and recurring charges.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total discount of this line including all one-time and recurring charges.",
    "title":"Contract Discount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total of all contract list value of this line, including all one-time and recurring charges.",
    "title":"Contract Value (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.",
    "title":"Contract Value (List Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total of all contract extended margins for this line, including one-time and recurring values.",
    "title":"Contract Margin",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total contract value of this line including all one-time and recurring charges.",
    "title":"Contract Value (Net Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.",
    "title":"Contract Value (Net Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Cost Amount

Type: object

Title: Cost Amount

The total cost of this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The total cost of this line.",
    "title":"Cost Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The amount by which to adjust the list price because of a custom discount.",
    "title":"Custom Discount Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Discount Type

Type: object

Title: Discount Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Discount Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Amount (Discount)

Type: object

Title: Amount (Discount)

The discount amount for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The discount amount for this line.",
    "title":"Amount (Discount)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Fulfillment Status

Type: object

Title: Fulfillment Status

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Fulfillment Status",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Line Type

Type: object

Title: Line Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Line Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Amount (List)

Type: object

Title: Amount (List)

The extended list amount for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended list amount for this line.",
    "title":"Amount (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price (List)

Type: object

Title: Price (List)

The list price of the item.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The list price of the item.",
    "title":"Price (List)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The list price of the item or for the root model rolled up to include all child values.",
    "title":"List Price (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Margin Amount

Type: object

Title: Margin Amount

The margin for all quoted units of this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The margin for all quoted units of this transaction line.",
    "title":"Margin Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.",
    "title":"MRR (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : MRR (Summable)

Type: object

Title: MRR (Summable)

Monthly recurring revenues net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly recurring revenues net of all discounts for this line.",
    "title":"MRR (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.",
    "title":"MUR (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : MUR (Summable)

Type: object

Title: MUR (Summable)

Monthly usage revenues net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Monthly usage revenues net of all discounts for this line.",
    "title":"MUR (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Amount (Net)

Type: object

Title: Amount (Net)

The extended list amount minus any discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended list amount minus any discounts for this line.",
    "title":"Amount (Net)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.",
    "title":"Net Amount (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price (Net)

Type: object

Title: Price (Net)

The price paid by the customer for the item.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The price paid by the customer for the item.",
    "title":"Price (Net)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The price paid by the customer for the individual item or for the root model rolled up to include all child values.",
    "title":"Net Price (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.",
    "title":"Non-Recurring Revenue (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"One-time revenue net of all discounts for this line.",
    "title":"Non-Recurring Revenue (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Action Code

Type: object

Title: Action Code

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Action Code",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Payment Terms

Type: object

Title: Payment Terms

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Payment Terms",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Period

Type: object

Title: Period

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Period",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Recurrence Frequency

Type: object

Title: Price Recurrence Frequency

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Recurrence Frequency",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Recurrence Frequency (Rollup)

Type: object

Title: Price Recurrence Frequency (Rollup)

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Recurrence Frequency (Rollup)",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Type (Rollup)

Type: object

Title: Price Type (Rollup)

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Type (Rollup)",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.",
    "title":"Recurring Revenue (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Recurring Revenue (Summable)

Type: object

Title: Recurring Revenue (Summable)

Recurring revenue net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Recurring revenue net of all discounts for this line.",
    "title":"Recurring Revenue (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Unit of Measure

Type: object

Title: Unit of Measure

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Unit of Measure",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Root Line

Type: object

Title: Root Line

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Root Line",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Sales Channel

Type: object

Title: Sales Channel

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Sales Channel",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Status",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Unit Cost

Type: object

Title: Unit Cost

The unit cost of the item.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The unit cost of the item.",
    "title":"Unit Cost",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Margin

Type: object

Title: Margin

The margin for a single unit of this transaction line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The margin for a single unit of this transaction line.",
    "title":"Margin",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.",
    "title":"Usage Revenue (Rollup)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Usage Revenue (Summable)

Type: object

Title: Usage Revenue (Summable)

Usage revenue net of all discounts for this line.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Usage revenue net of all discounts for this line.",
    "title":"Usage Revenue (Summable)",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Win/Loss Status

Type: object

Title: Win/Loss Status

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Win/Loss Status",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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: object 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.
• defaultRowState: object 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.
• focus: object 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.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the collection itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.
• insertable: boolean
  Title: Insertable

  Boolean value that specifies whether new rows can be inserted into the collection.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• queryable: boolean
  Title: Queryable

  Boolean value that specifies whether the rows in the collection can be queried.
• sortable: boolean
  Title: Sortable

  Boolean value that specifies whether the rows in the collection can be sorted.

{
    "type":"object",
    "properties":{
        "insertable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether new rows can be inserted into the collection.",
            "title":"Insertable"
        },
        "queryable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the rows in the collection can be queried.",
            "title":"Queryable"
        },
        "sortable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the rows in the collection can be sorted.",
            "title":"Sortable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the collection itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"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.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "defaultRowState":{
            "$ref":"#/definitions/resourceRowState"
        },
        "focus":{
            "type":"object",
            "description":"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":"Focused Users"
        }
    },
    "title":"state",
    "description":"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."
}

Nested Schema : items

Type: array

Show Source

• Array of: object Available Rate Plan Set
  Title: Available Rate Plan Set

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionLine_availableRatePlanSet"
    }
}

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

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Nested Schema : Available Rate Plan Set

Type: object

Title: Available Rate Plan Set

Show Source

• _availableRatePlanSet_rate_plan_integration_id: string
  Title: Available Rate Plan Integration Id

  Rate Plan Integration ID
• _availableRatePlanSet_rate_plan_name: string
  Title: Available Rate Plan Name

  Rate plan name
• _availableRatePlanSet_rate_plan_number: string
  Title: Available Rate Plan Number

  Rate Plan Number
• _bs_id: integer
  Title: _bs_id

  _bs_id
• _document_number: integer
  Title: _document_number

  _document_number
• _row_number: integer
  Title: _row_number

  _row_number
• _sequence_number: integer
  Title: _sequence_number

  _sequence_number
• _state: object 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.
• _transaction_currency_pref: object _transaction_currency_pref
  Title: _transaction_currency_pref

{
    "type":"object",
    "properties":{
        "_sequence_number":{
            "type":"integer",
            "description":"_sequence_number",
            "title":"_sequence_number"
        },
        "_document_number":{
            "type":"integer",
            "description":"_document_number",
            "title":"_document_number"
        },
        "_availableRatePlanSet_rate_plan_integration_id":{
            "type":"string",
            "description":"Rate Plan Integration ID",
            "title":"Available Rate Plan Integration Id"
        },
        "_availableRatePlanSet_rate_plan_name":{
            "type":"string",
            "description":"Rate plan name",
            "title":"Available Rate Plan Name"
        },
        "_bs_id":{
            "type":"integer",
            "description":"_bs_id",
            "title":"_bs_id"
        },
        "_row_number":{
            "type":"integer",
            "description":"_row_number",
            "title":"_row_number"
        },
        "_transaction_currency_pref":{
            "type":"object",
            "description":"",
            "title":"_transaction_currency_pref",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the currency  resource.",
                    "title":"Id"
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "_availableRatePlanSet_rate_plan_number":{
            "type":"string",
            "description":"Rate Plan Number",
            "title":"Available Rate Plan Number"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        }
    },
    "title":"Available Rate Plan Set"
}

Nested Schema : _transaction_currency_pref

Type: object

Title: _transaction_currency_pref

Show Source

• currencyCode: string
  Title: Currency Code

  Unique currency code for the currency.
• id: integer
  Title: Id

  Primary Key of the currency resource.

{
    "type":"object",
    "description":"",
    "title":"_transaction_currency_pref",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the currency  resource.",
            "title":"Id"
        },
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Charge Set
  Title: Charge Set

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionLine_chargeSet"
    }
}

Nested Schema : Charge Set

Type: object

Title: Charge Set

Show Source

• _bs_id: integer
  Title: _bs_id

  _bs_id
• _chargeSet_calculationInfo: string
  Title: Calculation Information

  A JSON array of the Price Models used in calculating this charge's price.
• _chargeSet_chargeDefinition: string
  Title: Charge Definition

  The display label of the charge definition.
• _chargeSet_chargeDefinitionCode: string
  Title: Charge Definition Code

  The code of the charge definition.
• _chargeSet_chargeDefIntegrationId: string
  Title: Charge Definition Integration ID

  The charge definition code in the integrated order management system.
• _chargeSet_chargeType: object Charge Type
  Title: Charge Type
• _chargeSet_discountAmount: object Discount Amount
  Title: Discount Amount

  The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.
• _chargeSet_discountType: object Discount Type
  Title: Discount Type
• _chargeSet_discountValue: number
  Title: Discount Value

  The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge.
• _chargeSet_dynamicPricingType: string
  Title: Dynamic Pricing Type

  The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced.
• _chargeSet_netAmount: object Net Amount
  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.
• _chargeSet_netPrice: object Net Price
  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.
• _chargeSet_pricePeriod: object Price Period
  Title: Price Period
• _chargeSet_priceType: object Price Type
  Title: Price Type
• _chargeSet_rateCardInHTML: string
  Title: Rate Card In HTML

  The HTML-formatted rate card data
• _chargeSet_rateCardName: string
  Title: Rate Card

  Display label for the Rate Card applied in calculating this charge's price.
• _chargeSet_rateCardStructure: string
  Title: Rate Card Structure

  The rate card used to calculate this charge's price.
• _chargeSet_rateCardVariableName: string
  Title: Rate Card Variable Name

  Variable Name for the Rate Card applied in calculating this charge's price.
• _chargeSet_unitPrice: object Unit Price
  Title: Unit Price

  The unit price to be paid by the customer for this charge.
• _chargeSet_usageUOM: object Usage UOM
  Title: Usage UOM
• _document_number: integer
  Title: _document_number

  _document_number
• _row_number: integer
  Title: _row_number

  _row_number
• _sequence_number: integer
  Title: _sequence_number

  _sequence_number
• _state: object 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.
• _transaction_currency_pref: object _transaction_currency_pref
  Title: _transaction_currency_pref

{
    "type":"object",
    "properties":{
        "_document_number":{
            "type":"integer",
            "description":"_document_number",
            "title":"_document_number"
        },
        "_chargeSet_chargeType":{
            "type":"object",
            "title":"Charge Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_sequence_number":{
            "type":"integer",
            "description":"_sequence_number",
            "title":"_sequence_number"
        },
        "_chargeSet_calculationInfo":{
            "type":"string",
            "description":"A JSON array of the Price Models used in calculating this charge's price.",
            "title":"Calculation Information"
        },
        "_chargeSet_netAmount":{
            "type":"object",
            "description":"The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.",
            "title":"Net Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_chargeSet_rateCardInHTML":{
            "type":"string",
            "description":"The HTML-formatted rate card data",
            "title":"Rate Card In HTML"
        },
        "_chargeSet_chargeDefinitionCode":{
            "type":"string",
            "description":"The code of the charge definition.",
            "title":"Charge Definition Code"
        },
        "_chargeSet_pricePeriod":{
            "type":"object",
            "title":"Price Period",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_discountValue":{
            "type":"number",
            "description":"The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge.",
            "title":"Discount Value"
        },
        "_row_number":{
            "type":"integer",
            "description":"_row_number",
            "title":"_row_number"
        },
        "_chargeSet_rateCardName":{
            "type":"string",
            "description":"Display label for the Rate Card applied in calculating this charge's price.",
            "title":"Rate Card"
        },
        "_chargeSet_usageUOM":{
            "type":"object",
            "title":"Usage UOM",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_rateCardStructure":{
            "type":"string",
            "description":"The rate card used to calculate this charge's price.",
            "title":"Rate Card Structure"
        },
        "_chargeSet_netPrice":{
            "type":"object",
            "description":"The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.",
            "title":"Net Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_chargeSet_dynamicPricingType":{
            "type":"string",
            "description":"The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced.",
            "title":"Dynamic Pricing Type"
        },
        "_chargeSet_discountType":{
            "type":"object",
            "title":"Discount Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_rateCardVariableName":{
            "type":"string",
            "description":"Variable Name for the Rate Card applied in calculating this charge's price.",
            "title":"Rate Card Variable Name"
        },
        "_transaction_currency_pref":{
            "type":"object",
            "description":"",
            "title":"_transaction_currency_pref",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the currency  resource.",
                    "title":"Id"
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "_chargeSet_chargeDefinition":{
            "type":"string",
            "description":"The display label of the charge definition.",
            "title":"Charge Definition"
        },
        "_chargeSet_chargeDefIntegrationId":{
            "type":"string",
            "description":"The charge definition code in the integrated order management system.",
            "title":"Charge Definition Integration ID"
        },
        "_chargeSet_discountAmount":{
            "type":"object",
            "description":"The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.",
            "title":"Discount Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_chargeSet_priceType":{
            "type":"object",
            "title":"Price Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_chargeSet_unitPrice":{
            "type":"object",
            "description":"The unit price to be paid by the customer for this charge.",
            "title":"Unit Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "_bs_id":{
            "type":"integer",
            "description":"_bs_id",
            "title":"_bs_id"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        }
    },
    "title":"Charge Set"
}

Nested Schema : Charge Type

Type: object

Title: Charge Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Charge Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.",
    "title":"Discount Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Discount Type

Type: object

Title: Discount Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Discount Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.",
    "title":"Net Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.",
    "title":"Net Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price Period

Type: object

Title: Price Period

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Period",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Price Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : Unit Price

Type: object

Title: Unit Price

The unit price to be paid by the customer for this charge.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"The unit price to be paid by the customer for this charge.",
    "title":"Unit Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Usage UOM

Type: object

Title: Usage UOM

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Usage UOM",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : _transaction_currency_pref

Type: object

Title: _transaction_currency_pref

Show Source

• currencyCode: string
  Title: Currency Code

  Unique currency code for the currency.
• id: integer
  Title: Id

  Primary Key of the currency resource.

{
    "type":"object",
    "description":"",
    "title":"_transaction_currency_pref",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the currency  resource.",
            "title":"Id"
        },
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

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

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Back to Top