Get a Transaction Line
get
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}
This operation retrieves the specified Transaction Line.
Request
Supported Media Types
- application/x-www-form-urlencoded
Path Parameters
-
MainDocVarName: string
The variable name of the main document, the first letter must be capitalized
-
ProcessVarName: string
The variable name of the Commerce process, the first letter must be capitalized
-
_id: integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
-
subDocNumber: string
Unique document number for this sub doc to be used as document identifier in a commerce process
-
subDocVarName: string
The variable name of the sub-document
Response
Supported Media Types
- application/json
Default Response
Root Schema : commerceTransactionLine
Type:
Show Source
object-
_config_attr_info(optional):
string
Title:
Config Attribute InformationConfigurable Attribute Information is populated with variable name, attribute name, data type and menu type information. -
_config_attr_text(optional):
string
Title:
Config Attribute TextConfigurable Attribute Text format is similar Configurable Attribute.The only difference is that the values correspond to the display text of the attributes. -
_config_attributes(optional):
string
Title:
Config AttributesConfigurable Attribute is a composite attribute.This attribute is always read only. However Reconfigure action may be used to modify the values. -
_config_extra_info(optional):
string
Title:
Config Extra InfoConfiguration Extra Information. -
_date_added(optional):
string
Title:
Date AddedThe date when the transaction line record got added. -
_date_modified(optional):
string
Title:
Date Last ModifiedThe date when the transaction line record got modified. -
_document_number(optional):
integer
Title:
Document NumberUnique document number for this sub doc to be used as document identifier in a commerce process. -
_document_var_name(optional):
string
Title:
Document Variable NameThis is the document variable name.A document can either be a 'Main Document' or 'SubDocument - Transaction Line'. Variable name for the main document is 'transaction' and for the sub document, it is 'transactionLine'. Main (Header Level) Commerce Document serves as Quote/Order depending on step in process flow. -
_id(optional):
integer
Title:
Internal Transaction Line IDUnique id for a transaction line item. -
_is_line_item_mandatory(optional):
boolean
Title:
Is Line Item MandatoryUsed to identify if the line item is mandatory. -
_is_part_pricing_rule_price(optional):
boolean
Title:
Is Price from Pricing RuleUsed to identify if a line item has a part pricing rule set by a rule -
_is_recommended_price(optional):
boolean
Title:
Is Price RecommendedUsed to identify if the line item has recommended price set by a rule. -
_last_modified_date(optional):
string
Title:
Last Modified DateUsed to Store the last modified date of the sub-document. -
_line_bom_attributes(optional):
string
Title:
Line Item BOM AttributesBOM attributes, stored as a JSON string. -
_line_bom_effective_date(optional):
string
Title:
Line BOM Effective DateSystem attribute to be stored in model line effective date to drive date effectivity in all BOM mappings. -
_line_bom_id(optional):
string
Title:
Line Item BOM IDThe BOM item instance id. -
_line_bom_item_quantity(optional):
integer
Title:
Line BOM Item QuantityThe BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity. -
_line_bom_level(optional):
integer
Title:
Line BOM LevelThe BOM item depth (level) in the quote. -
_line_bom_parent_id(optional):
string
Title:
Parent Line Item BOM IDThe parent BOM item instance id. -
_line_bom_part_number(optional):
string
Title:
Line BOM Part NumberThe part number of the BOM item. Only applicable to the model line. -
_line_item_comment(optional):
string
Title:
Line Item CommentsStores the comments for the line item. -
_line_item_spare_rule_var_name(optional):
string
Title:
Line Item IdentifierIdentifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier -
_model_attributes(optional):
string
Title:
Model AttributesPlaceholder for all model attributes -
_model_base_price(optional):
object Model Base Price
Title:
Model Base PriceBase price of the model -
_model_bom(optional):
string
Title:
Model BOMModel BOM Link -
_model_id(optional):
string
Title:
Model IDId of the model -
_model_name(optional):
string
Title:
Model NameName of the model -
_model_product_line_attributes(optional):
string
Title:
Model Product Line AttributesProduct Line Attributes of Product Line to which the model belongs -
_model_product_line_id(optional):
string
Title:
Model Product Line IDId of the Product Line to which the model belongs -
_model_product_line_name(optional):
string
Title:
Model Product Line NameProduct Line to which the model belongs -
_model_product_line_var_name(optional):
string
Title:
Model Product Line Variable NameVariable name of the product line that the model belongs to. -
_model_segment_id(optional):
string
Title:
Model Segment IDId of the Segment to which the model belongs -
_model_segment_name(optional):
string
Title:
Model Segment NameSegment to which the model belongs -
_model_segment_var_name(optional):
string
Title:
Model Segment Variable NameSegment to which the model belongs -
_model_supplier_company_id(optional):
string
Title:
Model Supplier Company IDModel supplier company id -
_model_supplier_company_name(optional):
string
Title:
Model Supplier Company NameModel supplier company name -
_model_variable_name(optional):
string
Title:
Model Variable NameVariable name of the model -
_original_document_number(optional):
string
Title:
Original Document NumberUsed to identify the document number from which the line item is copied. -
_parent_doc_number(optional):
string
Title:
Parent Document NumberUsed to identify the parent document number, if any, for this subdocument. -
_parent_line_item(optional):
string
Title:
Parent Line ItemUsed to identify the name of the parent line item, if any, for this subdocument. -
_part_base_price(optional):
object Part Base Price
Title:
Part Base PricePrice of the part -
_part_company_associations(optional):
string
Title:
Company AssociationsCompany Associations -
_part_custom_field1(optional):
string
Title:
Part Custom Field1Custom Field1 -
_part_custom_field10(optional):
string
Title:
Part Custom Field10Custom Field10 -
_part_custom_field11(optional):
string
Title:
Part Custom Field11Custom Field11 -
_part_custom_field12(optional):
string
Title:
Part Custom Field12Custom Field12 -
_part_custom_field13(optional):
string
Title:
Part Custom Field13Custom Field13 -
_part_custom_field14(optional):
string
Title:
Part Custom Field14Custom Field14 -
_part_custom_field15(optional):
string
Title:
Part Custom Field15Custom Field15 -
_part_custom_field16(optional):
string
Title:
Part Custom Field16Custom Field16 -
_part_custom_field17(optional):
string
Title:
Part Custom Field17Custom Field17 -
_part_custom_field18(optional):
string
Title:
Part Custom Field18Custom Field18 -
_part_custom_field19(optional):
string
Title:
Part Custom Field19Custom Field19 -
_part_custom_field2(optional):
string
Title:
Part Custom Field2Custom Field2 -
_part_custom_field20(optional):
string
Title:
Part Custom Field20Custom Field20 -
_part_custom_field21(optional):
string
Title:
Part Custom Field21Custom Field21 -
_part_custom_field22(optional):
string
Title:
Part Custom Field22Custom Field22 -
_part_custom_field23(optional):
string
Title:
Part Custom Field23Custom Field23 -
_part_custom_field24(optional):
string
Title:
Part Custom Field24Custom Field24 -
_part_custom_field25(optional):
string
Title:
Part Custom Field25Custom Field25 -
_part_custom_field26(optional):
string
Title:
Part Custom Field26Custom Field26 -
_part_custom_field27(optional):
string
Title:
Part Custom Field27Custom Field27 -
_part_custom_field28(optional):
string
Title:
Part Custom Field28Custom Field28 -
_part_custom_field29(optional):
string
Title:
Part Custom Field29Custom Field29 -
_part_custom_field3(optional):
string
Title:
Part Custom Field3Custom Field3 -
_part_custom_field30(optional):
string
Title:
Part Custom Field30Custom Field30 -
_part_custom_field4(optional):
string
Title:
Part Custom Field4Price Period -
_part_custom_field5(optional):
number
Title:
Part Custom Field5Custom Field5 -
_part_custom_field6(optional):
number
Title:
Part Custom Field6Custom Field6 -
_part_custom_field7(optional):
number
Title:
Part Custom Field7Custom Field7 -
_part_custom_field8(optional):
string
Title:
Price TypeCustom Field8 -
_part_custom_field9(optional):
string
Title:
Part Custom Field9Custom Field9 -
_part_desc(optional):
string
Title:
Part DescriptionDescription of the part -
_part_direct_buy(optional):
string
Title:
Direct BuyDirect Buy -
_part_display_number(optional):
string
Title:
Part Display NumberPart Display Number -
_part_drawing_position(optional):
string
Title:
Drawing PositionDrawing Position -
_part_extended_desc_1(optional):
string
Title:
Part Extended Description 1Extended description of the part -
_part_extended_desc_2(optional):
string
Title:
Part Extended Description 2Extended description of the part -
_part_id(optional):
string
Title:
Part IDId of the part -
_part_lead_time(optional):
string
Title:
Part Lead TimeLead time -
_part_number(optional):
string
Title:
Part NumberPart Number -
_part_supplier_company_id(optional):
string
Title:
Part Supplier Company IDId of the part supplier company -
_part_supplier_company_name(optional):
string
Title:
Part Supplier Company NameName of the part supplier company -
_part_units(optional):
string
Title:
Part UnitsUnits of the part -
_partner_entity_id(optional):
string
Title:
Partner Entity IdPartner Entity Id -
_price_book_var_name(optional):
string
Title:
Price Book Variable NameVariable Name of the Price Book used to get the price for this line item -
_price_component_prices(optional):
string
Title:
Component PricesAdditional prices based on configuration -
_price_configurable_price(optional):
object Configurable Price
Title:
Configurable PriceOriginal price as per catalog (inclusive of discount and premium) -
_price_discount_comment(optional):
string
Title:
Discount CommentDiscount description -
_price_discount_percent(optional):
number
Title:
Discount %Discount in percentage -
_price_item_price_each(optional):
object Item Price
Title:
Item PriceThe 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(optional):
object List Price
Title:
List PriceWill usually be the same value as the Item Price, unless a recommended item price applies. -
_price_net_price(optional):
object Net Price
Title:
Net PriceNet price is subtotal minus the total discount -
_price_override_discount(optional):
object Override Discount
Title:
Override DiscountOverride original discount -
_price_override_price(optional):
object Override Price
Title:
Override PriceOverride original list price -
_price_override_quantity(optional):
boolean
Title:
Override QuantityOverride original quantity -
_price_quantity(optional):
integer
Title:
QuantityQuantity -
_price_subtotal(optional):
string
Title:
SubtotalSubtotal -
_price_total_discount(optional):
object Total Discount
Title:
Total DiscountTotal discount amount -
_price_unit_price_each(optional):
object Unit Price
Title:
Unit PriceWill usually be the same value as the List Price, unless a contract price applies. -
_pricing_rule_price_each(optional):
object Pricing Rule Price
Title:
Pricing Rule PriceCurrently the customer level pricing. (Not applicable for Models) -
_reconfiguration_date(optional):
string
Title:
Reconfiguration DateUsed to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model. -
_state(optional):
object state
Title:
stateCaptures 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(optional):
string
Title:
Transaction CurrencyThe code value for the transaction currency. -
actualAmount_l(optional):
object Actual Amount
Title:
Actual AmountThe actual amount billed to the customer. -
actualQuantity_l(optional):
integer
Title:
Actual QuantityThe actual quantity provided to the customer. -
annualDiscount_l(optional):
object Annual Discount
Title:
Annual DiscountThe annual discount on the recurring charges on this line. -
annualValue_l(optional):
object Annual Value
Title:
Annual ValueThe annual contract value of the recurring charges on this line. -
bs_id(optional):
string
Title:
Transaction IDThe unique identifier for a Transaction within a CPQ site. -
cancelReason_l(optional):
object Cancel Reason
Title:
Cancel ReasonThe reason why the customer cancelled this line. -
canChangeConfiguration_l(optional):
boolean
Title:
Can Change ConfigurationIndicates whether the fulfillment system can support a change to the configuration of this line. -
canChangeQuantity_l(optional):
boolean
Title:
Can Change QuantityIndicates whether the fulfillment system can support a change to the quantity of this line. -
contractDiscount_l(optional):
object Contract Discount
Title:
Contract DiscountThe total discount of this line including all one - time and recurring charges. -
contractedPeriods_l(optional):
integer
Title:
Contracted PeriodsNumber of periods the customer has contracted to receive the item. -
contractEndDate_l(optional):
string
Title:
Contract End DateDate that the customer stops to receive the service. -
contractStartDate_l(optional):
string
Title:
Contract Start DateDate that the customer starts to receive the service. -
contractValue_l(optional):
object Contract Value
Title:
Contract ValueThe total contract value of this line including all one - time and recurring charges. -
costAmount_l(optional):
object Cost Amount
Title:
Cost AmountThe total cost of this line. -
createdBy_l(optional):
string
Title:
Created ByThe person that created the transaction line. -
createdDate_l(optional):
string
Title:
Created DateThe date when the transaction line was created. -
customDiscountAmount_l(optional):
object Custom Discount Amount
Title:
Custom Discount AmountThe amount by which to adjust the list price because of a custom discount. -
customDiscountType_l(optional):
object Discount Type
Title:
Discount TypeThe type of custom discount to apply to this line. -
customDiscountValue_l(optional):
number
Title:
DiscountUsed to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage. -
customerItemName_l(optional):
string
Title:
Customer Item NameCustomer supplied item name.This is displayed on reports and in the UI. -
discountAmount_l(optional):
object Amount(Discount)
Title:
Amount(Discount)The discount amount for this line. -
displayedItemName_l(optional):
string
Title:
ItemEither the standard item name or the customer item name(if provided). -
firstRecurringInvoiceDate_l(optional):
string
Title:
First Recurring Invoice DateOptional - Use if the first payment is for a prorated partial period. Regular recurrence will start from this date. -
fulfillmentStatus_l(optional):
object Fulfillment Status
Title:
Fulfillment StatusThe status for this line supplied by the fulfillment system after the transaction is submitted as a sales order. -
itemInstanceId_l(optional):
string
Title:
Instance IDThe 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(optional):
string
Title:
Instance NameThe 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(optional):
string
Title:
Last Updated ByThe person that last updated this transaction line. -
lastUpdatedDate_l(optional):
string
Title:
Last UpdatedThe date and time the transaction line was last updated. -
lineID_l(optional):
string
Title:
Line IDThe unique, invariant, internal ID for a Transaction Line. This value remains static even if the user resequences the lines on a transaction. This ID is used for identifying the line being canceled. The value for this attribute defaults to the _document_number for this transaction line. -
lineNumber_l(optional):
string
Title:
Line #The line number displayed for the line. This is used to sort lines on the screen and in documents. -
listAmount_l(optional):
object Amount (List)
Title:
Amount (List)The extended list amount for this line. -
listPrice_l(optional):
object Price (List)
Title:
Price (List)The list price of the item. -
netAmount_l(optional):
object Amount (Net)
Title:
Amount (Net)The extended list amount minus any discounts for this line. -
netPrice_l(optional):
object Price (Net)
Title:
Price (Net)The price paid by the customer for the item. -
parentLineID_l(optional):
string
Title:
Parent Line IDThe unique, invariant, internal ID for the Parent Line for this Transaction Line. This is used for configured products for which child lines are associated to a parent model line. The value for this attribute remains static even if the user resequences the lines within a model. The value for this attribute defaults to the system attribute _parent_doc_number - the internal document number for the parent transaction line. -
parentLineNumber_l(optional):
string
Title:
Parent Line #The line number that is the immediate parent of this line in the configurable product sales BOM hierarchy. This is the line number displayed to the user in the UI rather than the ID for the Parent Line. -
pricePeriod_l(optional):
object Period
Title:
PeriodThe period of service purchased at this price. -
priceType_l(optional):
object Price Type
Title:
Price TypeIndicates whether the amount on this line is charged once or periodically. -
priceWithinPolicy_l(optional):
boolean
Title:
Price Within PolicyFlag which indicates if line price is within requesting user's defined pricing limits -
requestDate_l(optional):
string
Title:
Request DateThe date on which the user requests that fulfillment occur for this transaction line. -
requestedQuantity_l(optional):
integer
Title:
QuantityQuantity of associated line which is being requested. Can be user entered or set logically -
requestedUnitOfMeasure_l(optional):
object Unit of Measure
Title:
Unit of MeasureThe unit of measure of the item requested by the customer (e.g. "Cases"). -
status_l(optional):
object Status
Title:
StatusThe status of this line. -
statusDate_l(optional):
string
Title:
Status As OfDate and time when the fulfillment status changed to its current status. -
statusPartial_l(optional):
boolean
Title:
PartialIndicates whether the entire line has reached the current status. -
statusQuantity_l(optional):
integer
Title:
Status QuantityThe quantity of items that have reached the current status. -
taxExempt_l(optional):
boolean
Title:
Tax ExemptIndicates whether this transaction line is tax exempt. -
taxExemptReason_l(optional):
object Tax Exempt Reason
Title:
Tax Exempt ReasonThe reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults from the value on the transaction. -
transactionID_l(optional):
string
Title:
Transaction Internal IDThe parent transaction's internal ID. -
unitCost_l(optional):
object Unit Cost
Title:
Unit CostThe unit cost of the item.
Nested Schema : Model Base Price
Type:
objectTitle:
Model Base PriceBase price of the model
Show Source
-
currency(optional):
string
Title:
currencyCurrency code for the base price. -
value(optional):
number
Title:
valueAmount value for the base price.
Nested Schema : Part Base Price
Type:
objectTitle:
Part Base PricePrice of the part
Show Source
-
currency(optional):
string
Title:
currencyCurrency code for the part base price. -
value(optional):
number
Title:
valueAmount value for the part base price.
Nested Schema : Configurable Price
Type:
objectTitle:
Configurable PriceOriginal price as per catalog (inclusive of discount and premium)
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the configurable price. -
value(optional):
number
Title:
valueAmount value of the configurable price.
Nested Schema : Item Price
Type:
objectTitle:
Item PriceThe 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(optional):
string
Title:
currencyCurrency code of the item price. -
value(optional):
number
Title:
valueAmount value of the item price.
Nested Schema : List Price
Type:
objectTitle:
List PriceWill usually be the same value as the Item Price, unless a recommended item price applies.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the list price. -
value(optional):
number
Title:
valueAmount value of the list price.
Nested Schema : Net Price
Type:
objectTitle:
Net PriceNet price is subtotal minus the total discount
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the net price. -
value(optional):
number
Title:
valueAmount value of the net price.
Nested Schema : Override Discount
Type:
objectTitle:
Override DiscountOverride original discount
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the override original discount. -
value(optional):
string
Title:
valueValue of the override original discount.
Nested Schema : Override Price
Type:
objectTitle:
Override PriceOverride original list price
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the override price. -
value(optional):
string
Title:
valueValue of the override price.
Nested Schema : Total Discount
Type:
objectTitle:
Total DiscountTotal discount amount
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the total discount. -
value(optional):
number
Title:
valueAmount value of the total discount.
Nested Schema : Unit Price
Type:
objectTitle:
Unit PriceWill usually be the same value as the List Price, unless a contract price applies.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the unit price. -
value(optional):
number
Title:
valueAmount value of the unit price.
Nested Schema : Pricing Rule Price
Type:
objectTitle:
Pricing Rule PriceCurrently the customer level pricing. (Not applicable for Models)
Show Source
-
currency(optional):
string
Title:
currencyCurrency code for the customer level price. -
value(optional):
number
Title:
valueAmount value for the customer level price.
Nested Schema : state
Type:
objectTitle:
stateCaptures 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(optional):
object Actions
Title:
ActionsCaptures 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(optional):
object Attributes
Title:
AttributesCaptures 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(optional):
boolean
Title:
DeletableBoolean value that specifies whether the row can be deleted. -
groups(optional):
object Groups
Title:
GroupsCaptures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group. -
hasError(optional):
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning(optional):
boolean
Title:
Has WarningBoolean value that specifies whether any warning that was issued has been assigned to the row itself. - hidden(optional): boolean
-
messages(optional):
array Messages
Title:
MessagesArray of messages that have been generated for a specific object. -
updatable(optional):
boolean
Title:
UpdatableBoolean value that specifies whether the row can be updated.
Nested Schema : Actual Amount
Type:
objectTitle:
Actual AmountThe actual amount billed to the customer.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the actual amount. -
value(optional):
number
Title:
valueAmount value of the actual amount.
Nested Schema : Annual Discount
Type:
objectTitle:
Annual DiscountThe annual discount on the recurring charges on this line.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the annual discount. -
value(optional):
number
Title:
valueAmount value of the annual discount.
Nested Schema : Annual Value
Type:
objectTitle:
Annual ValueThe annual contract value of the recurring charges on this line.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the annual value. -
value(optional):
number
Title:
valueAmount value of the annual value.
Nested Schema : Cancel Reason
Type:
objectTitle:
Cancel ReasonThe reason why the customer cancelled this line.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the reason for cancelling this line. -
value(optional):
string
Title:
valueValue of the reason for cancelling this line.
Nested Schema : Contract Discount
Type:
objectTitle:
Contract DiscountThe total discount of this line including all one - time and recurring charges.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the contract discount of this line. -
value(optional):
number
Title:
valueAmount value of the contract discount of this line.
Nested Schema : Contract Value
Type:
objectTitle:
Contract ValueThe total contract value of this line including all one - time and recurring charges.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code for the contract value of this line. -
value(optional):
number
Title:
valueAmount value for the contract value of this line..
Nested Schema : Cost Amount
Type:
objectTitle:
Cost AmountThe total cost of this line.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the cost amount. -
value(optional):
number
Title:
valueAmount value of the cost amount.
Nested Schema : Custom Discount Amount
Type:
objectTitle:
Custom Discount AmountThe amount by which to adjust the list price because of a custom discount.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the discount amount. -
value(optional):
number
Title:
valueAmount value of the discount amount.
Nested Schema : Discount Type
Type:
objectTitle:
Discount TypeThe type of custom discount to apply to this line.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value for the type of custom discount to apply to this line. -
value(optional):
string
Title:
valueValue for the type of custom discount to apply to this line.
Nested Schema : Amount(Discount)
Type:
objectTitle:
Amount(Discount)The discount amount for this line.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the discount amount for this line. -
value(optional):
number
Title:
valueAmount value of the discount amount for this line.
Nested Schema : Fulfillment Status
Type:
objectTitle:
Fulfillment StatusThe status for this line supplied by the fulfillment system after the transaction is submitted as a sales order.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the Value of the fulfillment status. -
value(optional):
string
Title:
valueValue of the fulfillment status for this line.
Nested Schema : Amount (List)
Type:
objectTitle:
Amount (List)The extended list amount for this line.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the list amount for this line. -
value(optional):
number
Title:
valueAmount value of the list amount for this line.
Nested Schema : Price (List)
Type:
objectTitle:
Price (List)The list price of the item.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the list price of the item. -
value(optional):
number
Title:
valueAmount value of the list price of the item.
Nested Schema : Amount (Net)
Type:
objectTitle:
Amount (Net)The extended list amount minus any discounts for this line.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the net amount for this line. -
value(optional):
number
Title:
valueAmount value of the net amount for this line.
Nested Schema : Price (Net)
Type:
objectTitle:
Price (Net)The price paid by the customer for the item.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code of the net price for the item. -
value(optional):
number
Title:
valueAmount value of the net price for the item.
Nested Schema : Period
Type:
objectTitle:
PeriodThe period of service purchased at this price.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the period of service. -
value(optional):
string
Title:
valueValue of the period of service.
Nested Schema : Price Type
Type:
objectTitle:
Price TypeIndicates whether the amount on this line is charged once or periodically.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the price type. -
value(optional):
string
Title:
valueValue of the price type.
Nested Schema : Unit of Measure
Type:
objectTitle:
Unit of MeasureThe unit of measure of the item requested by the customer (e.g. "Cases").
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the unit of measure. -
value(optional):
string
Title:
valueValue of the unit of measure.
Nested Schema : Status
Type:
objectTitle:
StatusThe status of this line.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the status of this line. -
value(optional):
string
Title:
valueValue of the status of this line.
Nested Schema : Tax Exempt Reason
Type:
objectTitle:
Tax Exempt ReasonThe reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults from the value on the transaction.
Show Source
-
displayValue(optional):
string
Title:
displayValueDisplay value of the reason for tax exemption. -
value(optional):
string
Title:
valueValue of the reason for tax exemption.
Nested Schema : Unit Cost
Type:
objectTitle:
Unit CostThe unit cost of the item.
Show Source
-
currency(optional):
string
Title:
currencyCurrency code for the unit cost of the item. -
value(optional):
number
Title:
valueAmount value for the unit cost of the item.
Nested Schema : Actions
Type:
objectTitle:
ActionsCaptures 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:
objectTitle:
AttributesCaptures 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 : Groups
Type:
objectTitle:
GroupsCaptures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Examples
The following example shows how to access a particular line item on a Transaction by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json" https://sitename.oracle.com/rest/v7/commerceDocumentsOraclecpqoTransaction/36365444/transactionLine/2
Response Body Sample
The following example shows the contents of the response body in JSON format, including the line item:
{
"_part_custom_field29" : "",
"_price_book_var_name" : "_default_price_book",
"_model_attributes" : "",
"_model_bom" : "",
"_part_supplier_company_id" : "4118171",
"_price_item_price_each" : "199.99",
"annualValue_l" : "0",
"_price_total_discount" : "0",
"_config_attributes" : "",
"_price_list_price_each" : "199.99",
"statusQuantity_l" : null,
"_part_custom_field30" : "",
"requestedUnitOfMeasure_l" : "",
"_original_document_number" : "-1",
"status_l" : null,
"requestedQuantity_l" : "1",
"costAmount_l" : "100",
"createdDate_l" : "2016-02-25 12:19:00",
"pricePeriod_l" : "",
"_part_id" : "36285771",
"customDiscountAmount_l" : "0",
"priceType_l" : "One Time",
"_price_component_prices" : "",
"_part_supplier_company_name" : "pm",
"_document_number" : "2",
"_is_line_item_mandatory" : "false",
"_reconfiguration_date" : "1970-01-01 00:00:00",
"_price_unit_price_each" : "199.99",
"_config_attr_info" : "",
"_price_configurable_price" : "199.99",
"taxExempt_l" : "false",
"_date_added" : "2016-02-25 12:19:07.0",
"displayedItemName_l" : "Alliance Business Software",
"_document_number9" : "",
"_date_modified" : "2016-02-25 13:00:22.0",
"_parent_line_item" : "",
"_model_segment_name" : "",
"canChangeQuantity_l" : "false",
"_price_subtotal" : "199.99",
"_part_desc" : "Alliance Business Software",
"_is_part_pricing_rule_price" : "false",
"_model_id" : "",
"_partner_entity_id" : "",
"_config_attr_text" : "",
"_id" : "36365446",
"_part_units" : "",
"_model_product_line_id" : "",
"statusDate_l" : null,
"statusPartial_l" : "false",
"createdBy_l" : "Super User",
"customDiscountValue_l" : null,
"_last_modified_date" : "2016-02-25 13:00:22",
"_price_discount_comment" : "",
"_model_product_line_name" : "",
"_price_override_discount" : "None",
"_part_drawing_position" : "",
"itemInstanceId_l" : "",
"netPrice_l" : "199.99",
"_model_segment_id" : "",
"_model_product_line_var_name" : "",
"firstRecurringInvoiceDate_l" : "",
"_model_supplier_company_id" : "",
"_price_discount_percent" : "0.00",
"_model_segment_var_name" : "",
"contractStartDate_l" : "2016-02-25 00:00:00",
"unitCost_l" : "100",
"_part_direct_buy" : "1",
"_pricing_rule_price_each" : "0",
"_model_variable_name" : "",
"_part_number" : "AS00100",
"_document_var_name" : "transactionLine",
"_model_supplier_company_name" : "",
"_bs_id" : "36365444",
"_price_override_quantity" : "false",
"_price_net_price" : "199.99",
"netAmount_l" : "199.99",
"_line_item_spare_rule_var_name" : "",
"listPrice_l" : "199.99",
"customDiscountType_l" : "%",
"_part_custom_field12" : "",
"_part_custom_field13" : "No",
"taxExemptReason_l" : "",
"_part_custom_field10" : "",
"lastUpdatedBy_l" : "Super User",
"lineNumber_l" : "",
"_part_custom_field11" : "",
"_part_custom_field16" : "",
"_part_custom_field17" : "",
"_part_custom_field14" : "LAP",
"_part_custom_field15" : "",
"_model_base_price" : "",
"_line_item_comment" : "",
"_parent_doc_number" : "",
"parentLineNumber_l" : "",
"_part_custom_field2" : "",
"listAmount_l" : "199.99",
"_model_product_line_attributes" : "",
"canChangeConfiguration_l" : "false",
"_part_custom_field1" : "Software",
"_part_custom_field4" : "",
"_part_custom_field3" : "19",
"priceWithinPolicy_l" : "true",
"customerItemName_l" : "",
"_part_custom_field6" : "253209",
"_model_name" : "",
"_part_custom_field5" : "100.0",
"_part_custom_field8" : "One Time",
"_part_custom_field7" : "",
"_price_quantity" : "1",
"contractedPeriods_l" : "1",
"_part_custom_field21" : "",
"_part_custom_field22" : "",
"transactionID_l" : "CPQ-63",
"_part_custom_field23" : "",
"_part_custom_field24" : "",
"_part_custom_field25" : "",
"_part_custom_field26" : "",
"_part_custom_field27" : "",
"_part_custom_field28" : "",
"_part_custom_field9" : "38",
"lastUpdatedDate_l" : "",
"contractValue_l" : "199.99",
"_part_custom_field20" : "",
"_part_base_price" : "199.99",
"_is_recommended_price" : "false",
"_part_custom_field19" : "",
"_part_custom_field18" : "",
"_part_extended_desc_1" : "",
"_part_lead_time" : "N/A",
"_price_override_price" : "No",
"_part_extended_desc_2" : "",
"links" : [ {
"rel" : "self",
"href" : "https://sitename.oracle.com/rest/v7/commerceDocumentsOraclecpqoTransaction/36365444/transactionLine/2"
}, {
"rel" : "parent",
"href" : "https://sitename.oracle.com/rest/v7/commerceDocumentsOraclecpqoTransaction/36365444"
} ]
}