Jump to

• Request
• Response

Update a sales order line

patch

/crmRestApi/resources/11.13.18.05/salesOrderLines/{OrderLineNumber}

Request

Path Parameters

• OrderLineNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Amount: number
  Title: Net Amount

  The revenue amount associated with the sales order line item.
• ContractEndDate: string (date-time)
  Title: Line Contract End Date

  The end date of the contract associated with the sales order line on the sales order.
• ContractPeriods: integer (int64)
  Title: Line Contract Periods

  The number of contract periods associated with the sales order line.
• ContractStartDate: string (date-time)
  Title: Line Contract Start Date

  The start date of the contract associated with the sales order line on the sales order.
• ContractValue: number
  Title: Line Contract Value

  The total amount associated with a sales order line item.
• CurrencyCode: string
  Title: Line Currency

  Maximum Length: 15

  The currency code associated with the sales order line.
• DiscountPercentage: number
  Title: Line Discount

  The discount applied to the specific sales order line in percentage.
• ExternalAssetKey: string
  Title: External Asset Key

  Maximum Length: 255

  The asset key from an external system.
• ExternalOrderLineId: string
  Title: External Order Line ID

  Maximum Length: 64

  The unique identifier of the external order line.
• ExternalOrderLineNumber: string
  Title: External Line Number

  Maximum Length: 64

  The alternate identifier of the source system which created the record.
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 255

  The root asset key of the parent from an external system.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 255

  The root asset key obtained from an external system.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the inventory item.
• InventoryOrgId: integer (int64)
  Title: Inventory Organization ID

  The unique identifier of the inventory organization.
• ItemTypeCode: string
  Title: Item Type

  Maximum Length: 30

  The type of sales order line item.
• LineStatusCode: string
  Title: Line Status

  Maximum Length: 30

  The status of the sales order line record.
• MonthlyRecurringRevenue: number
  Title: Monthly Recurring Revenue

  The monthly recurring revenue for the quote line.
• MonthlyUsageRevenue: number
  Title: Monthly Usage Revenue

  The monthly usage revenue for the quote line.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The nonrecurring or one time revenue for the quote line.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity of the Order associated with the order line.
• OrderDate: string (date-time)
  Title: Line Order Date

  The date on which the order line was ordered.
• OrderHeaderId: integer (int64)
  Title: Order Header ID

  The unique identifier for Sales order record.
• OrderNumber: string
  Title: Order Number

  Maximum Length: 64

  The reference number for a fulfillment order.
• ParentExternalOrderLineNumber: string
  Title: Parent External Line Number

  Maximum Length: 64

  The public unique identifier of a parent sales order line from an external application.
• Price: number
  Title: Net Price

  The price of the sales order line item per UOM.
• PricePeriodCode: string
  Title: Line Price Period

  Maximum Length: 30

  The period for which the price associated with the sales order line item is specified.
• PriceTypeCode: string
  Title: Line Price Type

  Maximum Length: 30

  The type of pricing associated with the sales order line item.
• Quantity: number
  Title: Quantity

  The quantity associated with the sales order line item.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue for the quote line.
• RequestDate: string (date-time)
  Title: Line Request Date

  The requested date for the product on the sales order line.
• RevenueTypeCategory: string
  Title: Revenue Type Category

  Maximum Length: 30

  The revenue category type associated with the opportunity revenue line.
• RevnId: integer (int64)
  Title: Revenue ID

  The unique identifier for Revenue associated with the order line.
• RootLine: string
  Title: Root Line

  Maximum Length: 1

  Indicates whether the quote line is of type root.
• SubscriptionId: integer (int64)
  Title: Subscription Id

  The unique identifier of a subscription.
• SubscriptionLineId: integer (int64)
  Title: Subscription Line Id

  The unique identifier of the subscription line within a subscription.
• Subtotal: number
  Title: Line Subtotal

  The amount associated with a sales order line item depending on the price type.
• SummableContractAmount: number
  Title: Contract Value Detail

  The contract value for the quote line, which can be used for reporting needs.
• SummableNonRecurringRevenue: number
  Title: Nonrecurring Revenue Detail

  The nonrecurring revenue for the quote line, which can be used for reporting needs.
• SummableRecurringRevenue: number
  Title: Recurring Revenue Detail

  The recurring revenue for the quote line, which can be used for reporting needs.
• SummableUsageRevenue: number
  Title: Usage Revenue Detail

  The usage revenue for the quote line, which can be used for reporting needs.
• UnitListPrice: number
  Title: Unit List Price

  The unit list price for the quote line item.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure used to sell the product.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue for the quote line.
• WinLossStatusCode: string
  Title: Line Win Loss Status

  Maximum Length: 30

  Indicates the current win or loss status of an order line.

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Net Amount",
            "type":"number",
            "description":"The revenue amount associated with the sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractEndDate":{
            "title":"Line Contract End Date",
            "type":"string",
            "description":"The end date of the contract associated with the sales order line on the sales order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContractPeriods":{
            "title":"Line Contract Periods",
            "type":"integer",
            "description":"The number of contract periods associated with the sales order line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContractStartDate":{
            "title":"Line Contract Start Date",
            "type":"string",
            "description":"The start date of the contract associated with the sales order line on the sales order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContractValue":{
            "title":"Line Contract Value",
            "type":"number",
            "description":"The total amount associated with a sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Line Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the sales order line.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountPercentage":{
            "title":"Line Discount",
            "type":"number",
            "description":"The discount applied to the specific sales order line in percentage.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The asset key from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalOrderLineId":{
            "title":"External Order Line ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the external order line.",
            "nullable":true
        },
        "ExternalOrderLineNumber":{
            "title":"External Line Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the source system which created the record.",
            "nullable":true
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The root asset key of the parent from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The root asset key obtained from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ItemTypeCode":{
            "title":"Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "LineStatusCode":{
            "title":"Line Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the sales order line record.",
            "nullable":true
        },
        "MonthlyRecurringRevenue":{
            "title":"Monthly Recurring Revenue",
            "type":"number",
            "description":"The monthly recurring revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyUsageRevenue":{
            "title":"Monthly Usage Revenue",
            "type":"number",
            "description":"The monthly usage revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The nonrecurring or one time revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity of the Order associated with the order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrderDate":{
            "title":"Line Order Date",
            "type":"string",
            "description":"The date on which the order line was ordered.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrderHeaderId":{
            "title":"Order Header ID",
            "type":"integer",
            "description":"The unique identifier for Sales order record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number for a fulfillment order.",
            "nullable":true
        },
        "ParentExternalOrderLineNumber":{
            "title":"Parent External Line Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of a parent sales order line from an external application.",
            "nullable":true,
            "x-queryable":false
        },
        "Price":{
            "title":"Net Price",
            "type":"number",
            "description":"The price of the sales order line item per UOM.",
            "nullable":true,
            "x-queryable":false
        },
        "PricePeriodCode":{
            "title":"Line Price Period",
            "maxLength":30,
            "type":"string",
            "description":"The period for which the price associated with the sales order line item is specified.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTypeCode":{
            "title":"Line Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing associated with the sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity associated with the sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestDate":{
            "title":"Line Request Date",
            "type":"string",
            "description":"The requested date for the product on the sales order line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RevenueTypeCategory":{
            "title":"Revenue Type Category",
            "maxLength":30,
            "type":"string",
            "description":"The revenue category type associated with the opportunity revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevnId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier for Revenue associated with the order line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RootLine":{
            "title":"Root Line",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the quote line is of type root.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription Id",
            "type":"integer",
            "description":"The unique identifier of a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionLineId":{
            "title":"Subscription Line Id",
            "type":"integer",
            "description":"The unique identifier of the subscription line within a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Subtotal":{
            "title":"Line Subtotal",
            "type":"number",
            "description":"The amount associated with a sales order line item depending on the price type.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableContractAmount":{
            "title":"Contract Value Detail",
            "type":"number",
            "description":"The contract value for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableNonRecurringRevenue":{
            "title":"Nonrecurring Revenue Detail",
            "type":"number",
            "description":"The nonrecurring revenue for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableRecurringRevenue":{
            "title":"Recurring Revenue Detail",
            "type":"number",
            "description":"The recurring revenue for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableUsageRevenue":{
            "title":"Usage Revenue Detail",
            "type":"number",
            "description":"The usage revenue for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure used to sell the product.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitListPrice":{
            "title":"Unit List Price",
            "type":"number",
            "description":"The unit list price for the quote line item.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "WinLossStatusCode":{
            "title":"Line Win Loss Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current win or loss status of an order line.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : salesOrderLines-item-response

Type: object

Show Source

• Amount: number
  Title: Net Amount

  The revenue amount associated with the sales order line item.
• ContractEndDate: string (date-time)
  Title: Line Contract End Date

  The end date of the contract associated with the sales order line on the sales order.
• ContractPeriods: integer (int64)
  Title: Line Contract Periods

  The number of contract periods associated with the sales order line.
• ContractStartDate: string (date-time)
  Title: Line Contract Start Date

  The start date of the contract associated with the sales order line on the sales order.
• ContractValue: number
  Title: Line Contract Value

  The total amount associated with a sales order line item.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The label indicates the current win or loss status of an order line.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurrencyCode: string
  Title: Line Currency

  Maximum Length: 15

  The currency code associated with the sales order line.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the user has access to delete the record.
• Description: string
  Title: Product Name

  Read Only: true

  Maximum Length: 240

  The name of the product associated with order line.
• DiscountPercentage: number
  Title: Line Discount

  The discount applied to the specific sales order line in percentage.
• ExternalAssetKey: string
  Title: External Asset Key

  Maximum Length: 255

  The asset key from an external system.
• ExternalOrderLineId: string
  Title: External Order Line ID

  Maximum Length: 64

  The unique identifier of the external order line.
• ExternalOrderLineNumber: string
  Title: External Line Number

  Maximum Length: 64

  The alternate identifier of the source system which created the record.
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 255

  The root asset key of the parent from an external system.
• ExternalQuoteNumber: string
  Title: Quote ID

  Read Only: true

  Maximum Length: 30

  The identifier of the source system that created the Quote.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 255

  The root asset key obtained from an external system.
• ExtReferenceNumber: string
  Title: Reference Number

  Read Only: true

  Maximum Length: 64

  The identifier for the External Quote or Order.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the inventory item.
• InventoryOrgId: integer (int64)
  Title: Inventory Organization ID

  The unique identifier of the inventory organization.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The item number of the product associated with the sales order line.
• ItemTypeCode: string
  Title: Item Type

  Maximum Length: 30

  The type of sales order line item.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the order line record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the order line record.
• LineStatusCode: string
  Title: Line Status

  Maximum Length: 30

  The status of the sales order line record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MonthlyRecurringRevenue: number
  Title: Monthly Recurring Revenue

  The monthly recurring revenue for the quote line.
• MonthlyUsageRevenue: number
  Title: Monthly Usage Revenue

  The monthly usage revenue for the quote line.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The nonrecurring or one time revenue for the quote line.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity of the Order associated with the order line.
• OrderDate: string (date-time)
  Title: Line Order Date

  The date on which the order line was ordered.
• OrderHeaderId: integer (int64)
  Title: Order Header ID

  The unique identifier for Sales order record.
• OrderHeaderName: string
  Title: Order Header Name

  Read Only: true

  Maximum Length: 275

  The name of the order associated with the order line.
• OrderHeaderNumber: string
  Title: Quote or Order Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the order associated with the order line.
• OrderLineId: integer (int64)
  Title: Order Line ID

  The unique identifier for the Sales Order Line.
• OrderLineNumber: string
  Title: Order Line Number

  Maximum Length: 30

  The sales order line number.
• OrderNumber: string
  Title: Order Number

  Maximum Length: 64

  The reference number for a fulfillment order.
• ParentExternalOrderLineNumber: string
  Title: Parent External Line Number

  Maximum Length: 64

  The public unique identifier of a parent sales order line from an external application.
• Price: number
  Title: Net Price

  The price of the sales order line item per UOM.
• PricePeriodCode: string
  Title: Line Price Period

  Maximum Length: 30

  The period for which the price associated with the sales order line item is specified.
• PriceTypeCode: string
  Title: Line Price Type

  Maximum Length: 30

  The type of pricing associated with the sales order line item.
• Quantity: number
  Title: Quantity

  The quantity associated with the sales order line item.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue for the quote line.
• RequestDate: string (date-time)
  Title: Line Request Date

  The requested date for the product on the sales order line.
• RevenueTypeCategory: string
  Title: Revenue Type Category

  Maximum Length: 30

  The revenue category type associated with the opportunity revenue line.
• RevnId: integer (int64)
  Title: Revenue ID

  The unique identifier for Revenue associated with the order line.
• RootLine: string
  Title: Root Line

  Maximum Length: 1

  Indicates whether the quote line is of type root.
• SalesAccountId: integer (int64)
  Title: Account ID

  Read Only: true

  The unique identifier of the Sales Account of the Order associated with the order line.
• SoldContactPartyId: integer (int64)
  Title: Contact ID

  Read Only: true

  The unique identifier of the contact of the Order associated with the order line.
• SoldCustPartyId: integer (int64)
  Title: Customer ID

  Read Only: true

  The unique identifier of the account of the Order associated with the order line.
• SoldPartySiteId: integer (int64)
  Title: Customer ID

  Read Only: true

  The unique identifier of the customer address of the Order associated with the order line.
• SubscriptionId: integer (int64)
  Title: Subscription Id

  The unique identifier of a subscription.
• SubscriptionLineId: integer (int64)
  Title: Subscription Line Id

  The unique identifier of the subscription line within a subscription.
• Subtotal: number
  Title: Line Subtotal

  The amount associated with a sales order line item depending on the price type.
• SummableContractAmount: number
  Title: Contract Value Detail

  The contract value for the quote line, which can be used for reporting needs.
• SummableNonRecurringRevenue: number
  Title: Nonrecurring Revenue Detail

  The nonrecurring revenue for the quote line, which can be used for reporting needs.
• SummableRecurringRevenue: number
  Title: Recurring Revenue Detail

  The recurring revenue for the quote line, which can be used for reporting needs.
• SummableUsageRevenue: number
  Title: Usage Revenue Detail

  The usage revenue for the quote line, which can be used for reporting needs.
• UnitListPrice: number
  Title: Unit List Price

  The unit list price for the quote line item.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure used to sell the product.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the user has access to update the record.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue for the quote line.
• WinLossStatusCode: string
  Title: Line Win Loss Status

  Maximum Length: 30

  Indicates the current win or loss status of an order line.

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Net Amount",
            "type":"number",
            "description":"The revenue amount associated with the sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractEndDate":{
            "title":"Line Contract End Date",
            "type":"string",
            "description":"The end date of the contract associated with the sales order line on the sales order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContractPeriods":{
            "title":"Line Contract Periods",
            "type":"integer",
            "description":"The number of contract periods associated with the sales order line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContractStartDate":{
            "title":"Line Contract Start Date",
            "type":"string",
            "description":"The start date of the contract associated with the sales order line on the sales order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContractValue":{
            "title":"Line Contract Value",
            "type":"number",
            "description":"The total amount associated with a sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The label indicates the current win or loss status of an order line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Line Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the sales order line.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Product Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the product associated with order line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountPercentage":{
            "title":"Line Discount",
            "type":"number",
            "description":"The discount applied to the specific sales order line in percentage.",
            "nullable":true,
            "x-queryable":false
        },
        "ExtReferenceNumber":{
            "title":"Reference Number",
            "maxLength":64,
            "type":"string",
            "description":"The identifier for the External Quote or Order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The asset key from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalOrderLineId":{
            "title":"External Order Line ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the external order line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalOrderLineNumber":{
            "title":"External Line Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the source system which created the record.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The root asset key of the parent from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalQuoteNumber":{
            "title":"Quote ID",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the source system that created the Quote.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The root asset key obtained from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The item number of the product associated with the sales order line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemTypeCode":{
            "title":"Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the order line record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the order line record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineStatusCode":{
            "title":"Line Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the sales order line record.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthlyRecurringRevenue":{
            "title":"Monthly Recurring Revenue",
            "type":"number",
            "description":"The monthly recurring revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyUsageRevenue":{
            "title":"Monthly Usage Revenue",
            "type":"number",
            "description":"The monthly usage revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The nonrecurring or one time revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity of the Order associated with the order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderDate":{
            "title":"Line Order Date",
            "type":"string",
            "description":"The date on which the order line was ordered.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrderHeaderId":{
            "title":"Order Header ID",
            "type":"integer",
            "description":"The unique identifier for Sales order record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderHeaderName":{
            "title":"Order Header Name",
            "maxLength":275,
            "type":"string",
            "description":"The name of the order associated with the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderHeaderNumber":{
            "title":"Quote or Order Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the order associated with the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderLineId":{
            "title":"Order Line ID",
            "type":"integer",
            "description":"The unique identifier for the Sales Order Line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderLineNumber":{
            "title":"Order Line Number",
            "maxLength":30,
            "type":"string",
            "description":"The sales order line number.",
            "nullable":false,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number for a fulfillment order.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentExternalOrderLineNumber":{
            "title":"Parent External Line Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of a parent sales order line from an external application.",
            "nullable":true,
            "x-queryable":false
        },
        "Price":{
            "title":"Net Price",
            "type":"number",
            "description":"The price of the sales order line item per UOM.",
            "nullable":true,
            "x-queryable":false
        },
        "PricePeriodCode":{
            "title":"Line Price Period",
            "maxLength":30,
            "type":"string",
            "description":"The period for which the price associated with the sales order line item is specified.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTypeCode":{
            "title":"Line Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing associated with the sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity associated with the sales order line item.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestDate":{
            "title":"Line Request Date",
            "type":"string",
            "description":"The requested date for the product on the sales order line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RevenueTypeCategory":{
            "title":"Revenue Type Category",
            "maxLength":30,
            "type":"string",
            "description":"The revenue category type associated with the opportunity revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevnId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier for Revenue associated with the order line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RootLine":{
            "title":"Root Line",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the quote line is of type root.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesAccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the Sales Account of the Order associated with the order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SoldContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact of the Order associated with the order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SoldCustPartyId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the account of the Order associated with the order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SoldPartySiteId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the customer address of the Order associated with the order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionId":{
            "title":"Subscription Id",
            "type":"integer",
            "description":"The unique identifier of a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionLineId":{
            "title":"Subscription Line Id",
            "type":"integer",
            "description":"The unique identifier of the subscription line within a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Subtotal":{
            "title":"Line Subtotal",
            "type":"number",
            "description":"The amount associated with a sales order line item depending on the price type.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableContractAmount":{
            "title":"Contract Value Detail",
            "type":"number",
            "description":"The contract value for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableNonRecurringRevenue":{
            "title":"Nonrecurring Revenue Detail",
            "type":"number",
            "description":"The nonrecurring revenue for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableRecurringRevenue":{
            "title":"Recurring Revenue Detail",
            "type":"number",
            "description":"The recurring revenue for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "SummableUsageRevenue":{
            "title":"Usage Revenue Detail",
            "type":"number",
            "description":"The usage revenue for the quote line, which can be used for reporting needs.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure used to sell the product.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitListPrice":{
            "title":"Unit List Price",
            "type":"number",
            "description":"The unit list price for the quote line item.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue for the quote line.",
            "nullable":true,
            "x-queryable":false
        },
        "WinLossStatusCode":{
            "title":"Line Win Loss Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current win or loss status of an order line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

RevenueTypeCategoryPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RevenueTypeCategory}%2CBindLookupType%3DORA_MOO_REVN_CATEGORY_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: RevenueTypeCategory; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top