REST API for Oracle Fusion Cloud SCM

Get all sales orders

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub

Request

Query Parameters

expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey: Finds a sales order according to the header identifier.
  Finder Variables:
  - HeaderId; integer; Value that uniquely identifies the sales order header.
- findByHeaderId: Finds a sales order according to the sales order header.
  Finder Variables:
  - HeaderId; string; Value that uniquely identifies the sales order header.
- findByOrderKey: Finds a sales order according to the source transaction system and source transaction number.
  Finder Variables:
  - OrderKey; string; Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
- findByOrderNumber: Finds a sales order according to the order number.
  Finder Variables:
  - OrderNumber; string; Order number of the sales order.
- findByOrderedDate: Finds sales orders ordered within a date range.
  Finder Variables:
  - FromDate; string; Date that occurs immediately after the user created the sales order.
  - ToDate; string; Date that occurs immediately before the user created the sales order.
- findBySourceOrderNumberAndSystem: Finds a sales order according to the source transaction number and source transaction system.
  Finder Variables:
  - SourceTransactionNumber; string; Value that uniquely identifies the transaction number.
  - SourceTransactionSystem; string; Application that placed the request for fulfillment.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AgreementHeaderId; integer; Value that uniquely identifies the sales agreement on the order header.
- AgreementNumber; string; Number of the sales agreement on the order header.
- AgreementVersionNumber; integer; Version number of the sales agreement on the order header.
- AppliedCurrencyCode; string; Abbreviation that identifies the currency that pricing applied.
- BusinessUnitId; integer; Value that uniquely identifies the business unit that sold the sales order. The application also uses the business unit to implement data security and determine each sales order that the user can access.
- BuyingPartyContactId; integer; Value that uniquely identifies the person who placed the sales order or the sold-to contact to contact for the sales order.
- BuyingPartyId; integer; Value that uniquely identifies the sold-to customer. This value contains the person, company, or organization who placed the sales order. This value references the party identifier with usage of CUSTOMER.
- CanceledFlag; boolean; Contains one of the following values: true or false. If true, then sales order canceled. If false, then sales order is not canceled. The default value is false.
- CreatedBy; string; User who added the sales order.
- CreationDate; string; Date and time when the user added the sales order.
- CustomerPONumber; string; Number that the customer sends for this purchase order.
- EarliestAcceptableShipDate; string; Earliest date when the customer is willing to receive the shipment.
- HeaderId; integer; Value that uniquely identifies the sales order header. The application creates this value when it creates the sales order.
- LastUpdateDate; string; Date and time when the user most recently updated the sales order.
- LastUpdatedBy; string; User who performed the most recent update on the sales order.
- LatestAcceptableArrivalDate; string; Date when the customer is willing to receive the item.
- LatestAcceptableShipDate; string; Date when the customer is willing to allow the warehouse to ship the item.
- MessageText; string; Message that indicates the processing status of the sales order.
- OnHoldFlag; boolean; Contains one of the following values: true or false. If true, then sales order is on hold. If false, then sales order is not on hold. The default value is false. This attribute is read-only.
- OpenFlag; boolean; Contains one of the following values: true or false. If true, then sales order is open. If false, then sales order is closed. The default value is true. This attribute is read-only.
- OrderKey; string; Value that uniquely identifies the sales order. It can have the following formats.
  
  - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
  Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
  
  - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
  Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
  
  When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
- OrderNumber; string; Number that identifies the sales order. The profile Retain Sales Order Number For Orchestration Order Number determines whether to use the source transaction number as the order number for each imported source order. If you use the source transaction number as the order number, then this transaction number must be unique in the source application.
- OrigSystemDocumentReference; string; Original reference for the source order from the source application.
- PackingInstructions; string; Text that describes how to pack the item.
- PartialShipAllowedFlag; boolean; Contains one of the following values: true or false. If true, then ship items on the sales order in more than one shipment. If false, then do not ship these items in one shipment. The default value is false.
- PreferredSoldToContactPointId; integer; Value that uniquely identifies the preferred contact point for the sold-to contact. This value identifies the preferred email contact.
- PricedOn; string; Date when pricing priced the sales order. This attribute contains the system date at the beginning of the price calculation.
- PricingSegment; string; Name of the pricing segment.
- RequestedArrivalDate; string; Date when the customer requested the item to arrive.
- RequestedCancelDate; string; Date when the customer canceled the order line.
- RequestedFulfillmentOrganizationId; integer; Value that uniquely identifies the organization that ships the shipment.
- RequestedShipDate; string; Date when the customer requested to ship the item.
- RequestingBusinessUnitId; integer; Value that uniquely identifies the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.
- RequestingLegalEntityId; integer; Value that uniquely identifies the legal entity who formed a contract with the customer. The contracting party on the order is the legal entity.
- RevisionSourceSystem; string; Source application that sent a revision of the sales order.
- SalesChannelCode; string; Abbreviation that identifies the sales channel. For example, web or phone. A list of accepted values is defined in the lookup type ORA_QP_CHANNEL_METHODS.
- SalespersonId; integer; Value that uniquely identifies the primary sales person.
- ShippingInstructions; string; Text that includes details about how to ship the item.
- ShipsetFlag; boolean; Contains one of the following values: true or false. If true, then ship a group of order lines in the sales order together from a single location to a single destination, and ship them all on the same scheduled ship date. If false, then do not ship them as a group. This attribute does not have a default value.
- SourceTransactionId; string; Value that uniquely identifies the transaction in the source application. If the source application does not contain a unique value for the transaction, then you can set this attribute to a user key that the source application contains, such as an order number or quote number. The application uses this attribute and the source transaction to uniquely identify the transaction and create the composite key for a change order. You must make sure that each change order uses the same value that the new sales order used.
- SourceTransactionNumber; string; Value that uniquely identifies the transaction in the source application. The source application assigns this value as the order number. If your implementation interfaces to a quote and converts the quote to a sales order, then this attribute references the quote number.
- SourceTransactionRevisionNumber; integer; Revision number of the transaction.
- SourceTransactionSystem; string; Source system that created the order. You use the Manage Trading Community Source Systems and Manage Upstream and Fulfillment Source Systems tasks to setup the source application.
- StatusCode; string; Abbreviation that identifies the status of the sales order.
- SubmittedBy; string; User who submitted the sales order.
- SubmittedDate; string; Date and time when the user submitted the sales order.
- SubmittedFlag; boolean; Contains one of the following values: true or false. If true, then the application validated and submitted the sales order. If false, then the application did not validate and submit. The sales order is in draft status. The default value is false.
- SubstituteAllowedFlag; boolean; Contains one of the following values: true or false. If true, then you can substitute items on the fulfillment line for various reasons, such as shortage of material, or as a goodwill gesture to the customer. If false, then you cannot make these substitutions. This attribute does not have a default value.
- SupplierSiteId; integer; Value that uniquely identifies the supplier who supplies the item.
- TransactionDocumentTypeCode; string; Abbreviation that identifies whether the request is a sales order, purchase order or internal material transfer.
- TransactionOn; string; Date and time when the transaction started. The date occurs when the customer commits to purchase the items that the sales order contains. The date can occur in the past or future, depending on when the customer placed the sales order.
- TransactionTypeCode; string; Abbreviation that identifies the type of transaction. A list of accepted values is defined in the lookup type ORA_DOO_ORDER_TYPES. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task.
- TransactionalCurrencyCode; string; Abbreviation that identifies the currency that pricing used to price the transaction.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context(required):

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(required):

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : salesOrdersForOrderHub

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"OrderManagement",
        "usage":"BusinessObject",
        "isCompactViewByDefault":true,
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object salesOrdersForOrderHub-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-item-response"
    }
}

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 : salesOrdersForOrderHub-item-response

Type: object

Show Source

additionalInformation: array Details

Title: Details

The Additional Details resource manages details that flexfields store for the sales order.
AgreementHeaderId: integer (int64)

Value that uniquely identifies the sales agreement on the order header.
AgreementNumber: string

Maximum Length: 255

Number of the sales agreement on the order header.
AgreementVersionNumber: integer (int64)

Read Only: true

Version number of the sales agreement on the order header.
AllowCurrencyOverrideFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then you can override the currency. If false, then you cannot override. The default value is true.
AppliedCurrencyCode: string

Read Only: true

Maximum Length: 15

Abbreviation that identifies the currency that pricing applied.
AppliedCurrencyName: string

Read Only: true

Maximum Length: 255

Name that identifies the currency that pricing applied.
attachments: array Attachments

Title: Attachments

The Attachments resource manages attachments for the order header and order line.
billToCustomer: array Bill-to Customers

Title: Bill-to Customers

The Bill-to Customers resource manages the bill-to customer that the sales order header references.
BusinessUnitId: integer (int64)

Value that uniquely identifies the business unit that sold the sales order. The application also uses the business unit to implement data security and determine each sales order that the user can access.
BusinessUnitName: string

Maximum Length: 255

Name of the business unit that sold the sales order.
BuyingPartyContactFirstName: string

Maximum Length: 255

First name of the person who placed the sales order or who is the person to contact for the sales order.
BuyingPartyContactId: integer (int64)

Value that uniquely identifies the person who placed the sales order or the sold-to contact to contact for the sales order.
BuyingPartyContactLastName: string

Maximum Length: 255

Last name of the person who placed the sales order or who is the person to contact for the sales order.
BuyingPartyContactMiddleName: string

Maximum Length: 255

Middle name of the person who placed the sales order or who is the person to contact for the sales order.
BuyingPartyContactName: string

Maximum Length: 255

Name of the person who placed the sales order or the sold-to contact to contact for the sales order.
BuyingPartyContactNameSuffix: string

Maximum Length: 255

Suffix of the name of the person who placed the sales order or who is the person to contact for the sales order.
BuyingPartyContactNumber: string

Maximum Length: 255

Number of the person who placed the sales order or the sold-to contact to contact for the sales order.
BuyingPartyContactTitle: string

Maximum Length: 255

Title of the person who placed the sales order or who is the person to contact for the sales order.
BuyingPartyId: integer (int64)

Value that uniquely identifies the sold-to customer. This value contains the person, company, or organization who placed the sales order. This value references the party identifier with usage of CUSTOMER.
BuyingPartyName: string

Maximum Length: 255

Name of the person or organization party who placed the sales order. This value identifies the sold-to customer. This points to the party name with usage of CUSTOMER.
BuyingPartyNumber: string

Maximum Length: 255

Number of the person or organization party who placed the sales order. This value identifies the sold-to customer. This value references the party name with usage of CUSTOMER.
BuyingPartyPersonFirstName: string

Maximum Length: 255

If a person placed the sales order, then this attribute contains the first name of the person.
BuyingPartyPersonLastName: string

Maximum Length: 255

If a person placed the sales order, then this attribute contains the last name of the person.
BuyingPartyPersonMiddleName: string

Maximum Length: 255

If a person placed the sales order, then this attribute contains the middle name of the person.
BuyingPartyPersonNameSuffix: string

Maximum Length: 255

If a person placed the sales order, then this attribute contains the name suffix of the person.
BuyingPartyPersonTitle: string

Maximum Length: 255

If a person placed the sales order, then this attribute contains the title of the person.
CanceledFlag: boolean

Title: Canceled

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then sales order canceled. If false, then sales order is not canceled. The default value is false.
CancelReason: string

Maximum Length: 255

Reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
CancelReasonCode: string

Maximum Length: 255

Abbreviation that identifies the reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
Comments: string

Maximum Length: 2000

Comments that the user enters on the sales order.
copyOrderReference: array Copy Orders

Title: Copy Orders

The Copy Orders resource manages details about the original sales order that order management used when creating a copy for a sales order.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who added the sales order.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date and time when the user added the sales order.
CurrencyConversionDate: string (date-time)

Date when the foreign exchange rate is valid.
CurrencyConversionRate: number

Foreign exchange conversion rate that pricing used to convert the transaction currency into the item currency.
CurrencyConversionType: string

Maximum Length: 30

Describes the type of the conversion rate that the application uses when it converts currency.
CustomerPONumber: string

Title: Purchase Order

Maximum Length: 50

Number that the customer sends for this purchase order.
DemandClass: string

Maximum Length: 255

Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
DemandClassCode: string

Maximum Length: 255

Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
EarliestAcceptableShipDate: string (date-time)

Earliest date when the customer is willing to receive the shipment.
FOBPoint: string

Maximum Length: 255

Freight on board. Identifies the ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FOBPointCode: string

Maximum Length: 255

Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FreezePriceFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then price the sales order. If false, then do not price. The default value is true.
FreezeShippingChargeFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then recalculate shipping charges for the sales order. If false, then do not recalculate. The default value is true.
FreezeTaxFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then calculate taxes for the sales. If false, then do not calculate. The default value is true.
FreightTerms: string

Maximum Length: 255

Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FreightTermsCode: string

Maximum Length: 255

Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
HeaderId: integer (int64)

Value that uniquely identifies the sales order header. The application creates this value when it creates the sales order.
holds: array Holds

Title: Holds

The Holds resource manages active and released holds on the order line.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

Date and time when the user most recently updated the sales order.
LastUpdatedBy: string

Title: Updated By

Read Only: true

Maximum Length: 64

User who performed the most recent update on the sales order.
LatestAcceptableArrivalDate: string (date-time)

Date when the customer is willing to receive the item.
LatestAcceptableShipDate: string (date-time)

Date when the customer is willing to allow the warehouse to ship the item.
lines: array Order Lines

Title: Order Lines

The Order Lines resource manages details about the order line, such as item and quantity.
links: array Links

Title: Links

The link relations associated with the resource instance.
MessageText: string

Read Only: true

Message that indicates the processing status of the sales order.
OnHoldFlag: boolean

Title: On Hold

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then sales order is on hold. If false, then sales order is not on hold. The default value is false. This attribute is read-only.
OpenFlag: boolean

Title: Open

Read Only: true

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then sales order is open. If false, then sales order is closed. The default value is true. This attribute is read-only.
OrderKey: string

Maximum Length: 255

Value that uniquely identifies the sales order. It can have the following formats.

- Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".

- Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.

When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
OrderNumber: string

Title: Orchestration Order

Read Only: true

Maximum Length: 50

Default Value: -1

Number that identifies the sales order. The profile Retain Sales Order Number For Orchestration Order Number determines whether to use the source transaction number as the order number for each imported source order. If you use the source transaction number as the order number, then this transaction number must be unique in the source application.
OrigSystemDocumentReference: string

Maximum Length: 50

Original reference for the source order from the source application.
PackingInstructions: string

Maximum Length: 1000

Text that describes how to pack the item.
PartialShipAllowedFlag: boolean

Title: Allow Split Shipments

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then ship items on the sales order in more than one shipment. If false, then do not ship these items in one shipment. The default value is false.
payments: array Payments

Title: Payments

The Payments resource manages payment details of the order.
PaymentTerms: string

Maximum Length: 255

Payment terms to apply to collect payment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Receivables Payment Terms task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
PaymentTermsCode: integer (int64)

Abbreviation that identifies the payment terms. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Receivables Payment Terms task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
PreCreditCheckedFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then allow an application outside Oracle Fusion to perform credit check. If false, then do not allow. The default value is false.
PreferredSoldToContactPointId: integer (int64)

Value that uniquely identifies the preferred contact point for the sold-to contact. This value identifies the preferred email contact.
PricedOn: string (date-time)

Date when pricing priced the sales order. This attribute contains the system date at the beginning of the price calculation.
PricingSegment: string

Read Only: true

Maximum Length: 255

Name of the pricing segment.
PricingSegmentCode: string

Maximum Length: 30

Abbreviation that identifies the pricing segment.
PricingSegmentExplanation: string

Maximum Length: 1000

Explanation of why pricing applied the pricing segment.
PricingStrategyExplanation: string

Maximum Length: 1000

Explanation of why pricing applied the pricing strategy.
PricingStrategyId: integer (int64)

Value that uniquely identifies the pricing strategy.
PricingStrategyName: string

Maximum Length: 255

Name of the pricing strategy.
RequestedArrivalDate: string (date-time)

Date when the customer requested the item to arrive.
RequestedCancelDate: string (date-time)

Date when the customer canceled the order line.
RequestedFulfillmentOrganizationCode: string

Maximum Length: 255

Abbreviation that identifies the organization that ships the shipment.
RequestedFulfillmentOrganizationId: integer (int64)

Value that uniquely identifies the organization that ships the shipment.
RequestedFulfillmentOrganizationName: string

Maximum Length: 255

Name of the organization that ships the shipment.
RequestedShipDate: string (date-time)

Date when the customer requested to ship the item.
RequestingBusinessUnitId: integer (int64)

Value that uniquely identifies the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.
RequestingBusinessUnitName: string

Maximum Length: 255

Name of the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.
RequestingLegalEntity: string

Maximum Length: 255

Legal entity who formed a contract with the customer for the sales order. The contracting party on the order is the legal entity.
RequestingLegalEntityId: integer (int64)

Value that uniquely identifies the legal entity who formed a contract with the customer. The contracting party on the order is the legal entity.
RevisionSourceSystem: string

Maximum Length: 30

Source application that sent a revision of the sales order.
SalesChannel: string

Maximum Length: 255

Name of the sales channel. For example, web or phone. A list of accepted values is defined in the lookup type ORA_QP_CHANNEL_METHODS.
SalesChannelCode: string

Maximum Length: 30

Abbreviation that identifies the sales channel. For example, web or phone. A list of accepted values is defined in the lookup type ORA_QP_CHANNEL_METHODS.
salesCredits: array Sales Credits

Title: Sales Credits

The Sales Credits resource manages sales credits for each salesperson on the sales order.
Salesperson: string

Maximum Length: 255

Name of the primary sales person.
SalespersonId: integer (int64)

Value that uniquely identifies the primary sales person.
SegmentExplanationMessageName: string

Maximum Length: 30

Name of the message for the pricing segment strategy. You can use the message name to get the message text.
ShipmentPriority: string

Maximum Length: 255

Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source, or use Load Planning Data from Flat Files.
ShipmentPriorityCode: string

Maximum Length: 255

Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
ShippingCarrier: string

Maximum Length: 255

Carrier who delivered the item.
ShippingCarrierId: integer (int64)

Value that uniquely identifies the carrier who delivered the item.
ShippingInstructions: string

Maximum Length: 1000

Text that includes details about how to ship the item.
ShippingMode: string

Maximum Length: 255

Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the V task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippingModeCode: string

Maximum Length: 255

Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippingServiceLevel: string

Maximum Length: 255

Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippingServiceLevelCode: string

Maximum Length: 255

Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShipsetFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then ship a group of order lines in the sales order together from a single location to a single destination, and ship them all on the same scheduled ship date. If false, then do not ship them as a group. This attribute does not have a default value.
shipToCustomer: array Ship-to Customers

Title: Ship-to Customers

The Ship-to Customers resource manages the ship-to customer that the sales order header references.
SourceTransactionId: string

Maximum Length: 50

Value that uniquely identifies the transaction in the source application. If the source application does not contain a unique value for the transaction, then you can set this attribute to a user key that the source application contains, such as an order number or quote number. The application uses this attribute and the source transaction to uniquely identify the transaction and create the composite key for a change order. You must make sure that each change order uses the same value that the new sales order used.
SourceTransactionNumber: string

Title: Source Order

Maximum Length: 50

Value that uniquely identifies the transaction in the source application. The source application assigns this value as the order number. If your implementation interfaces to a quote and converts the quote to a sales order, then this attribute references the quote number.
SourceTransactionRevisionNumber: integer (int64)

Revision number of the transaction.
SourceTransactionSystem: string

Title: Source Order System

Maximum Length: 50

Source system that created the order. You use the Manage Trading Community Source Systems and Manage Upstream and Fulfillment Source Systems tasks to setup the source application.
Status: string

Read Only: true

Maximum Length: 255

Status of the sales order.
StatusCode: string

Read Only: true

Maximum Length: 30

Default Value: OPEN

Abbreviation that identifies the status of the sales order.
StrategyExplanationMessageName: string

Maximum Length: 30

Name of the pricing strategy message. You can use the message name to get the message text.
SubmittedBy: string

Read Only: true

Maximum Length: 64

User who submitted the sales order.
SubmittedDate: string (date-time)

Read Only: true

Date and time when the user submitted the sales order.
SubmittedFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then the application validated and submitted the sales order. If false, then the application did not validate and submit. The sales order is in draft status. The default value is false.
SubstituteAllowedFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then you can substitute items on the fulfillment line for various reasons, such as shortage of material, or as a goodwill gesture to the customer. If false, then you cannot make these substitutions. This attribute does not have a default value.
SupplierId: integer (int64)

Value that uniquely identifies the supplier who supplies the item. You can use a supplier according to the contractual obligations in drop ship.
SupplierName: string

Maximum Length: 255

Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.
SupplierSiteId: integer

Value that uniquely identifies the supplier who supplies the item.
SupplierSiteName: string

Maximum Length: 255

Name of the supplier site for the purchase order. Interface tables don't currently support this column. So, this attribute can't be used when the REST service is used for file-based data import (FBDI). It can be used only when the REST service is directly invoked.
totals: array Totals

Title: Totals

The Totals resource manages details for the total price of a sales order.
TradeComplianceResult: string

Read Only: true

Maximum Length: 255

Name that identifies the result of the trade compliance screening for the order.
TradeComplianceResultCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the result of the trade compliance screening for the order lines.
TransactionalCurrencyCode: string

Title: Currency

Maximum Length: 15

Abbreviation that identifies the currency that pricing used to price the transaction.
TransactionalCurrencyName: string

Maximum Length: 255

Name of the currency that pricing used to price the transaction.
TransactionDocumentTypeCode: string

Maximum Length: 50

Abbreviation that identifies whether the request is a sales order, purchase order or internal material transfer.
TransactionOn: string (date-time)

Title: Ordered Date

Date and time when the transaction started. The date occurs when the customer commits to purchase the items that the sales order contains. The date can occur in the past or future, depending on when the customer placed the sales order.
TransactionType: string

Maximum Length: 255

Name of the type of sales order.
TransactionTypeCode: string

Title: Order Type

Maximum Length: 30

Abbreviation that identifies the type of transaction. A list of accepted values is defined in the lookup type ORA_DOO_ORDER_TYPES. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user added the sales order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application validated and submitted the sales order. If false, then the application did not validate and submit. The sales order is in draft status. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RequestedArrivalDate":{
            "type":"string",
            "description":"Date when the customer requested the item to arrive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDocumentTypeCode":{
            "maxLength":50,
            "type":"string",
            "description":"Abbreviation that identifies whether the request is a sales order, purchase order or internal material transfer.",
            "nullable":true,
            "x-queryable":true
        },
        "BuyingPartyContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person who placed the sales order or who is the person to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceResult":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the result of the trade compliance screening for the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PricingSegmentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the pricing segment.",
            "nullable":true,
            "x-queryable":false
        },
        "ShippingInstructions":{
            "maxLength":1000,
            "type":"string",
            "description":"Text that includes details about how to ship the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Orchestration Order",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the sales order. The profile Retain Sales Order Number For Orchestration Order Number determines whether to use the source transaction number as the order number for each imported source order. If you use the source transaction number as the order number, then this transaction number must be unique in the source application.",
            "nullable":false,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "BuyingPartyPersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"If a person placed the sales order, then this attribute contains the name suffix of the person.",
            "nullable":true,
            "x-queryable":false
        },
        "BuyingPartyPersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"If a person placed the sales order, then this attribute contains the title of the person.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionSystem":{
            "title":"Source Order System",
            "maxLength":50,
            "type":"string",
            "description":"Source system that created the order. You use the Manage Trading Community Source Systems and Manage Upstream and Fulfillment Source Systems tasks to setup the source application.",
            "nullable":false,
            "x-queryable":true
        },
        "BuyingPartyContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person who placed the sales order or who is the person to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedCancelDate":{
            "type":"string",
            "description":"Date when the customer canceled the order line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTypeCode":{
            "title":"Order Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of transaction. A list of accepted values is defined in the lookup type ORA_DOO_ORDER_TYPES. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales agreement on the order header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuyingPartyPersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person placed the sales order, then this attribute contains the first name of the person.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the sales order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization that ships the shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who added the sales order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who submitted the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippingModeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "PricedOn":{
            "type":"string",
            "description":"Date when pricing priced the sales order. This attribute contains the system date at the beginning of the price calculation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BuyingPartyContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the person who placed the sales order or the sold-to contact to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "FreezeShippingChargeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then recalculate shipping charges for the sales order. If false, then do not recalculate. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "SourceTransactionNumber":{
            "title":"Source Order",
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application. The source application assigns this value as the order number. If your implementation interfaces to a quote and converts the quote to a sales order, then this attribute references the quote number.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesChannelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the sales channel. For example, web or phone. A list of accepted values is defined in the lookup type ORA_QP_CHANNEL_METHODS.",
            "nullable":true,
            "x-queryable":true
        },
        "billToCustomer":{
            "title":"Bill-to Customers",
            "type":"array",
            "description":"The Bill-to Customers resource manages the bill-to customer that the sales order header references.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-billToCustomer-item-response"
            },
            "x-cardinality":"1"
        },
        "BuyingPartyNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the person or organization party who placed the sales order. This value identifies the sold-to customer. This value references the party name with usage of CUSTOMER.",
            "nullable":true,
            "x-queryable":false
        },
        "AgreementVersionNumber":{
            "type":"integer",
            "description":"Version number of the sales agreement on the order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CancelReasonCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "OrderKey":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the sales order. It can have the following formats.<br><br>- Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the \"links\" section point to the latest version of the sales order and the corresponding child objects.<br>Example:  /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId \"R13_Sample_Order\" in the SourceOrderSystem \"LEG\".<br><br>- Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the \"links\" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.<br>Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.<br><br>When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format &lt;sourceOrderSystem&gt;:&lt;SourceTransactionId&gt; whereas reference orders have OrderKey in the format of HeaderId.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages attachments for the order header and order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-attachments-item-response"
            }
        },
        "payments":{
            "title":"Payments",
            "type":"array",
            "description":"The Payments resource manages payment details of the order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-payments-item-response"
            }
        },
        "OpenFlag":{
            "title":"Open",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then sales order is open. If false, then sales order is closed. The default value is true. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "SupplierSiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier site for the purchase order. Interface tables don't currently support this column. So, this attribute can't be used when the REST service is used for file-based data import (FBDI). It can be used only when the REST service is directly invoked.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionalCurrencyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency that pricing used to price the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentPriorityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerPONumber":{
            "title":"Purchase Order",
            "maxLength":50,
            "type":"string",
            "description":"Number that the customer sends for this purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionRevisionNumber":{
            "type":"integer",
            "description":"Revision number of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrigSystemDocumentReference":{
            "maxLength":50,
            "type":"string",
            "description":"Original reference for the source order from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "BuyingPartyContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person who placed the sales order or who is the person to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary sales person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "shipToCustomer":{
            "title":"Ship-to Customers",
            "type":"array",
            "description":"The Ship-to Customers resource manages the ship-to customer that the sales order header references.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-shipToCustomer-item-response"
            },
            "x-cardinality":"1"
        },
        "PricingSegment":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the pricing segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyingPartyContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Suffix of the name of the person who placed the sales order or who is the person to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "PreCreditCheckedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow an application outside Oracle Fusion to perform credit check. If false, then do not allow. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AgreementNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the sales agreement on the order header.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"Foreign exchange conversion rate that pricing used to convert the transaction currency into the item currency.",
            "nullable":true,
            "x-queryable":false
        },
        "BuyingPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sold-to customer. This value contains the person, company, or organization who placed the sales order. This value references the party identifier with usage of CUSTOMER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FreezeTaxFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then calculate taxes for the sales. If false, then do not calculate. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "FreezePriceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then price the sales order. If false, then do not price. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ShippingServiceLevel":{
            "maxLength":255,
            "type":"string",
            "description":"Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "AppliedCurrencyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the currency that pricing applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PreferredSoldToContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the preferred contact point for the sold-to contact. This value identifies the preferred email contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShippingServiceLevelCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionOn":{
            "title":"Ordered Date",
            "type":"string",
            "description":"Date and time when the transaction started. The date occurs when the customer commits to purchase the items that the sales order contains. The date can occur in the past or future, depending on when the customer placed the sales order.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PricingStrategyExplanation":{
            "maxLength":1000,
            "type":"string",
            "description":"Explanation of why pricing applied the pricing strategy.",
            "nullable":true,
            "x-queryable":false
        },
        "PackingInstructions":{
            "maxLength":1000,
            "type":"string",
            "description":"Text that describes how to pack the item.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":255,
            "type":"string",
            "description":"Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "ShippingCarrier":{
            "maxLength":255,
            "type":"string",
            "description":"Carrier who delivered the item.",
            "nullable":true,
            "x-queryable":false
        },
        "copyOrderReference":{
            "title":"Copy Orders",
            "type":"array",
            "description":"The Copy Orders resource manages details about the original sales order that order management used when creating a copy for a sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-copyOrderReference-item-response"
            },
            "x-cardinality":"1"
        },
        "BuyingPartyContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who placed the sales order or the sold-to contact to contact for the sales order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "holds":{
            "title":"Holds",
            "type":"array",
            "description":"The Holds resource manages active and released holds on the order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-holds-item-response"
            }
        },
        "RequestedShipDate":{
            "type":"string",
            "description":"Date when the customer requested to ship the item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FreightTerms":{
            "maxLength":255,
            "type":"string",
            "description":"Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the sales order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the sales order.",
            "nullable":false,
            "readOnly":true,
            "default":"OPEN",
            "x-queryable":true
        },
        "RequestingLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity who formed a contract with the customer. The contracting party on the order is the legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuyingPartyContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who placed the sales order or the sold-to contact to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "BuyingPartyContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person who placed the sales order or who is the person to contact for the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "ShippingMode":{
            "maxLength":255,
            "type":"string",
            "description":"Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the V task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShippingCarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier who delivered the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "RequestedFulfillmentOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization that ships the shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceResultCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the result of the trade compliance screening for the order lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LatestAcceptableShipDate":{
            "type":"string",
            "description":"Date when the customer is willing to allow the warehouse to ship the item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "additionalInformation":{
            "title":"Details",
            "type":"array",
            "description":"The Additional Details resource manages details that flexfields store for the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-additionalInformation-item-response"
            },
            "x-cardinality":"1"
        },
        "TransactionalCurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that pricing used to price the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestingLegalEntity":{
            "maxLength":255,
            "type":"string",
            "description":"Legal entity who formed a contract with the customer for the sales order. The contracting party on the order is the legal entity.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that sold the sales order. The application also uses the business unit to implement data security and determine each sales order that the user can access.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that ships the shipment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestingBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FOBPoint":{
            "maxLength":255,
            "type":"string",
            "description":"Freight on board. Identifies the ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who supplies the item. You can use a supplier according to the contractual obligations in drop ship.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "BuyingPartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person or organization party who placed the sales order. This value identifies the sold-to customer. This points to the party name with usage of CUSTOMER.",
            "nullable":true,
            "x-queryable":false
        },
        "PartialShipAllowedFlag":{
            "title":"Allow Split Shipments",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then ship items on the sales order in more than one shipment. If false, then do not ship these items in one shipment. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CancelReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "StrategyExplanationMessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the pricing strategy message. You can use the message name to get the message text.",
            "nullable":true,
            "x-queryable":false
        },
        "Salesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the primary sales person.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "FOBPointCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyConversionType":{
            "maxLength":30,
            "type":"string",
            "description":"Describes the type of the conversion rate that the application uses when it converts currency.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order header. The application creates this value when it creates the sales order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ShipsetFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then ship a group of order lines in the sales order together from a single location to a single destination, and ship them all on the same scheduled ship date. If false, then do not ship them as a group. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSegmentExplanation":{
            "maxLength":1000,
            "type":"string",
            "description":"Explanation of why pricing applied the pricing segment.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTerms":{
            "maxLength":255,
            "type":"string",
            "description":"Payment terms to apply to collect payment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Receivables Payment Terms task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyConversionDate":{
            "type":"string",
            "description":"Date when the foreign exchange rate is valid.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date and time when the user submitted the sales order.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OnHoldFlag":{
            "title":"On Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then sales order is on hold. If false, then sales order is not on hold. The default value is false. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "BuyingPartyPersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person placed the sales order, then this attribute contains the middle name of the person.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesChannel":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the sales channel. For example, web or phone. A list of accepted values is defined in the lookup type ORA_QP_CHANNEL_METHODS.",
            "nullable":true,
            "x-queryable":false
        },
        "EarliestAcceptableShipDate":{
            "type":"string",
            "description":"Earliest date when the customer is willing to receive the shipment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LatestAcceptableArrivalDate":{
            "type":"string",
            "description":"Date when the customer is willing to receive the item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AppliedCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that pricing applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyingPartyPersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person placed the sales order, then this attribute contains the last name of the person.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowCurrencyOverrideFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then you can override the currency. If false, then you cannot override. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application. If the source application does not contain a unique value for the transaction, then you can set this attribute to a user key that the source application contains, such as an order number or quote number. The application uses this attribute and the source transaction to uniquely identify the transaction and create the composite key for a change order. You must make sure that each change order uses the same value that the new sales order used.",
            "nullable":false,
            "x-queryable":true
        },
        "CanceledFlag":{
            "title":"Canceled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then sales order canceled. If false, then sales order is not canceled. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit that sold the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "lines":{
            "title":"Order Lines",
            "type":"array",
            "description":"The Order Lines resource manages details about the order line, such as item and quantity.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-item-response"
            }
        },
        "PricingStrategyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing strategy.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentExplanationMessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the message for the pricing segment strategy. You can use the message name to get the message text.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments that the user enters on the sales order.",
            "nullable":true,
            "x-queryable":false
        },
        "RevisionSourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"Source application that sent a revision of the sales order.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageText":{
            "type":"string",
            "description":"Message that indicates the processing status of the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totals":{
            "title":"Totals",
            "type":"array",
            "description":"The Totals resource manages details for the total price of a sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-totals-item-response"
            }
        },
        "SubstituteAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then you can substitute items on the fulfillment line for various reasons, such as shortage of material, or as a goodwill gesture to the customer. If false, then you cannot make these substitutions. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTermsCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the payment terms. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Receivables Payment Terms task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The Sales Credits resource manages sales credits for each salesperson on the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-salesCredits-item-response"
            }
        },
        "RequestingBusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingStrategyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the pricing strategy.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentPriority":{
            "maxLength":255,
            "type":"string",
            "description":"Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source, or use Load Planning Data from Flat Files.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.",
            "nullable":true,
            "x-queryable":false
        },
        "DemandClassCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        },
        "FreightTermsCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

The Additional Details resource manages details that flexfields store for the sales order.

Show Source

Array of: object Discriminator: Category

Discriminator: { "propertyName":"Category", "mapping":{ "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response" } }

{
    "title":"Details",
    "type":"array",
    "description":"The Additional Details resource manages details that flexfields store for the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-additionalInformation-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages attachments for the order header and order line.

Show Source

Array of: object salesOrdersForOrderHub-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages attachments for the order header and order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-attachments-item-response"
    }
}

Nested Schema : Bill-to Customers

Type: array

Title: Bill-to Customers

The Bill-to Customers resource manages the bill-to customer that the sales order header references.

Show Source

Array of: object salesOrdersForOrderHub-billToCustomer-item-response

{
    "title":"Bill-to Customers",
    "type":"array",
    "description":"The Bill-to Customers resource manages the bill-to customer that the sales order header references.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-billToCustomer-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Copy Orders

Type: array

Title: Copy Orders

The Copy Orders resource manages details about the original sales order that order management used when creating a copy for a sales order.

Show Source

Array of: object salesOrdersForOrderHub-copyOrderReference-item-response

{
    "title":"Copy Orders",
    "type":"array",
    "description":"The Copy Orders resource manages details about the original sales order that order management used when creating a copy for a sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-copyOrderReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Holds

Type: array

Title: Holds

The Holds resource manages active and released holds on the order line.

Show Source

Array of: object salesOrdersForOrderHub-holds-item-response

{
    "title":"Holds",
    "type":"array",
    "description":"The Holds resource manages active and released holds on the order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-holds-item-response"
    }
}

Nested Schema : Order Lines

Type: array

Title: Order Lines

The Order Lines resource manages details about the order line, such as item and quantity.

Show Source

Array of: object salesOrdersForOrderHub-lines-item-response

{
    "title":"Order Lines",
    "type":"array",
    "description":"The Order Lines resource manages details about the order line, such as item and quantity.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-item-response"
    }
}

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 : Payments

Type: array

Title: Payments

The Payments resource manages payment details of the order.

Show Source

Array of: object salesOrdersForOrderHub-payments-item-response

{
    "title":"Payments",
    "type":"array",
    "description":"The Payments resource manages payment details of the order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-payments-item-response"
    }
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The Sales Credits resource manages sales credits for each salesperson on the sales order.

Show Source

Array of: object salesOrdersForOrderHub-salesCredits-item-response

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The Sales Credits resource manages sales credits for each salesperson on the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-salesCredits-item-response"
    }
}

Nested Schema : Ship-to Customers

Type: array

Title: Ship-to Customers

The Ship-to Customers resource manages the ship-to customer that the sales order header references.

Show Source

Array of: object salesOrdersForOrderHub-shipToCustomer-item-response

{
    "title":"Ship-to Customers",
    "type":"array",
    "description":"The Ship-to Customers resource manages the ship-to customer that the sales order header references.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-shipToCustomer-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Totals

Type: array

Title: Totals

The Totals resource manages details for the total price of a sales order.

Show Source

Array of: object salesOrdersForOrderHub-totals-item-response

{
    "title":"Totals",
    "type":"array",
    "description":"The Totals resource manages details for the total price of a sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-totals-item-response"
    }
}

Nested Schema : Discriminator: Category

Type: object

Discriminator: Category

Discriminator Values

DOO_HEADERS_ADD_INFO

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    ]
}

Match One Schema

Show Source

DOO_HEADERS_ADD_INFO - object oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response

Type: object

Show Source

Category: string

Maximum Length: 240

Default Value: DOO_HEADERS_ADD_INFO

Category of the flexfield.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who created the additional information.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date and time when the user created the additional information.
HeaderId: integer (int64)

Value that uniquely identifies the sales order that contains the additional information.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

Date and time when the user most recently updated the order line.
LastUpdatedBy: string

Title: Updated By

Read Only: true

Maximum Length: 64

User who most recently updated the additional information.
LastUpdateLogin: string

Title: Last Updated Login

Read Only: true

Maximum Length: 32

Login that user used when updating the additional information.
links: array Links

Title: Links

The link relations associated with the resource instance.
ObjectVersionNumber: integer (int32)

Number that determines whether some other session updated the row. The application increments this value every time it updates a row. It compares this number at the start and at the end of each transaction to determine whether another session updated the row since the last time the application queried the row.
SourceTransactionIdentifier: string

Maximum Length: 255

Value that uniquely identifies the transaction in the source application.
SourceTransactionSystem: string

Maximum Length: 255

Source application that placed the request.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the additional information.",
            "nullable":false,
            "readOnly":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the additional information.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the additional information.",
            "nullable":false,
            "readOnly":true
        },
        "Category":{
            "maxLength":240,
            "type":"string",
            "description":"Category of the flexfield.",
            "nullable":true,
            "default":"DOO_HEADERS_ADD_INFO"
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that determines whether some other session updated the row. The application increments this value every time it updates a row. It compares this number at the start and at the end of each transaction to determine whether another session updated the row since the last time the application queried the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SourceTransactionIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application.",
            "nullable":true
        },
        "SourceTransactionSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Source application that placed the request.",
            "nullable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that contains the additional information.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the order line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"Login that user used when updating the additional information.",
            "nullable":true,
            "readOnly":true
        }
    }
}

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."
        }
    }
}

Nested Schema : salesOrdersForOrderHub-attachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

An identifier used for tracking the uploaded files.
AttachedDocumentId: integer (int64)

Title: Attached Document Id

Value that uniquely identifies the attachment.
CategoryName: string

Title: Category

Maximum Length: 30

Name of the attachment category.
ContentRepositoryFileShared: boolean

Title: Shared

Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

User who created the attachment.
CreatedByUserName: string

Title: Created By User Name

Read Only: true

Login that the user used when creating the attachment.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date and time when the user created the attachment.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

Abbreviation that identifies the data type of the attachment.
Description: string

Title: Description

Maximum Length: 255

Description of the attachment.
DmDocumentId: string

Maximum Length: 255

Value that uniquely identifies the attached document.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

Path to the folder that contains the attachment.
DmVersionNumber: string

Maximum Length: 255

Number that identifies the version of the attached document.
DownloadInfo: string

Title: DownloadInfo

JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

Abbreviation that identifies the status of the attachment upload.
ErrorStatusMessage: string

Title: Error Status Message

Error message encountered while uploading attachment.
ExpirationDate: string (date-time)

Title: Expiration Date

Date when the attachment expires.
FileContents: string (byte)

Title: File Contents

Contents of the attachment file.
FileName: string

Title: File Name

Maximum Length: 2048

File name of the attachment.
FileUrl: string

Title: File Url

URL (Uniform Resource Locator) that locates the attachment file.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date and time when the user most recently updated the attachment.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

User who most recently updated the attachment.
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true

Login that the user used when updating the attachment.
links: array Links

Title: Links

The link relations associated with the resource instance.
Title: string

Title: Title

Title of the attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

Type of the attachment file.
UploadedFileLength: integer

Title: File Size

Length of the attachment file.
UploadedFileName: string

Title: Uploaded File Name

Name of the attachment file.
UploadedText: string

Title: Uploaded Text

Text that the attachment contains.
Uri: string

Title: Uri

Maximum Length: 4000

URI (Uniform Resource Identifier) that identifies the attachment file.
Url: string

Title: Url

Maximum Length: 4000

URL (Uniform Resource Locator) that locates the attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

User who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message encountered while uploading attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the status of the attachment upload.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path to the folder that contains the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text that the attachment contains.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : salesOrdersForOrderHub-billToCustomer-item-response

Type: object

Show Source

AccountNumber: string

Maximum Length: 255

Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
Address1: string

Maximum Length: 255

First line of the bill-to customer address.
Address2: string

Maximum Length: 255

Second line of the bill-to customer address.
Address3: string

Maximum Length: 255

Third line of the bill-to customer address.
Address4: string

Maximum Length: 255

Fourth line of the bill-to customer address.
AddressId: integer (int64)

Read Only: true

Value that uniquely identifies the bill-to customer address.
City: string

Maximum Length: 255

City of the bill-to customer address.
ContactFirstName: string

Maximum Length: 255

First name of the person to contact at the bill-to customer site.
ContactId: integer (int64)

Value that uniquely identifies the contact for the billing account.
ContactLastName: string

Maximum Length: 255

Last name of the person to contact at the bill-to customer site.
ContactMiddleName: string

Maximum Length: 255

Middle name of the person to contact at the bill-to customer site.
ContactName: string

Maximum Length: 255

Person to contact at the bill-to customer site.
ContactNameSuffix: string

Maximum Length: 255

Name suffix of the person to contact at the bill-to customer site.
ContactNumber: string

Maximum Length: 255

Telephone number of the person to contact at the bill-to customer site.
ContactTitle: string

Maximum Length: 255

Title of the person to contact at the bill-to customer site.
Country: string

Maximum Length: 255

Country of the bill-to customer address.
County: string

Maximum Length: 255

County of the bill-to customer address.
CustomerAccountId: integer (int64)

Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyName: string

Maximum Length: 255

Name of the party who is legally responsible for payment.
PersonFirstName: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the first name of the person.
PersonLastName: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the last name of the person.
PersonMiddleName: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the middle name of the person.
PersonNameSuffix: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
PersonTitle: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the title of the person.
PostalCode: string

Maximum Length: 255

Postal code of the bill-to customer address.
PreferredContactPointId: integer (int64)

Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
Province: string

Maximum Length: 255

Province of the bill-to customer address.
SiteUseId: integer (int64)

Value that uniquely identifies the account site that is legally responsible for payment.
SourceAddressId: string

Maximum Length: 255

Value that uniquely identifies the bill-to customer address. Value is 1.
State: string

Maximum Length: 255

State of the bill-to customer address.

{
    "type":"object",
    "properties":{
        "SiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account site that is legally responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the name suffix of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the party who is legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact for the billing account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":255,
            "type":"string",
            "description":"County of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the title of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Telephone number of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the last name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":255,
            "type":"string",
            "description":"Second line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the first name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":255,
            "type":"string",
            "description":"First line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"City of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"State of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAddressId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer address. Value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-copyOrderReference-item-response

Type: object

Show Source

DocumentSystemReferenceId: integer (int64)

Value that uniquely identifies the document system reference when the user copies a sales order.
links: array Links

Title: Links

The link relations associated with the resource instance.
OriginalHeaderId: integer

Read Only: true

Header value that identifies the source sales order when the user copies a sales order.
OriginalOrderChangeVersionNumber: integer

Read Only: true

Change version number from the source sales order when the user copies a sales order.
OriginalOrderNumber: string

Maximum Length: 150

Order number from the source sales order when the user copies a sales order.

{
    "type":"object",
    "properties":{
        "OriginalOrderChangeVersionNumber":{
            "type":"integer",
            "description":"Change version number from the source sales order when the user copies a sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentSystemReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document system reference when the user copies a sales order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OriginalOrderNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Order number from the source sales order when the user copies a sales order.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OriginalHeaderId":{
            "type":"integer",
            "description":"Header value that identifies the source sales order when the user copies a sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-holds-item-response

Type: object

Show Source

ActiveFlag: boolean

Title: Active

Maximum Length: 1

Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.
ApplyDate: string (date-time)

Title: Hold Date

Read Only: true

Date when the user applied the hold.
ApplySystem: string

Maximum Length: 30

Application that requested to apply the hold.
ApplyUser: string

Read Only: true

Maximum Length: 255

Name of the user who applied the hold.
HoldCode: string

Read Only: true

Maximum Length: 255

Abbreviation that identifies the hold.
HoldComments: string

Title: Comments

Maximum Length: 240

Comments that the user added when placing the hold.
HoldInstanceId: integer (int64)

Value that uniquely identifies the hold.
HoldName: string

Read Only: true

Maximum Length: 255

Name of the hold.
HoldReleaseComments: string

Title: Release Comments

Maximum Length: 240

Comments that the user added when releasing the hold.
HoldReleaseReason: string

Read Only: true

Maximum Length: 255

Reason for releasing the hold.
HoldReleaseReasonCode: string

Title: Release Reason

Maximum Length: 30

Abbreviation that identifies the reason for releasing the hold.
links: array Links

Title: Links

The link relations associated with the resource instance.
ReleaseDate: string (date-time)

Title: Release Date

Date when the user released the hold.
ReleaseUser: string

Read Only: true

Maximum Length: 255

Name of the user who released the hold.
SourceRequestId: string

Maximum Length: 50

Value that identifies the source application that requested the hold.

{
    "type":"object",
    "properties":{
        "HoldInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hold.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplyUser":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who applied the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReleaseReasonCode":{
            "title":"Release Reason",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for releasing the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplySystem":{
            "maxLength":30,
            "type":"string",
            "description":"Application that requested to apply the hold.",
            "nullable":false,
            "x-queryable":false
        },
        "SourceRequestId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the source application that requested the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "ReleaseDate":{
            "title":"Release Date",
            "type":"string",
            "description":"Date when the user released the hold.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyDate":{
            "title":"Hold Date",
            "type":"string",
            "description":"Date when the user applied the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReleaseComments":{
            "title":"Release Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments that the user added when releasing the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "HoldName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseUser":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who released the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HoldComments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments that the user added when placing the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "HoldReleaseReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for releasing the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-item-response

Type: object

Show Source

AccountingRule: string

Maximum Length: 255

Accounting rule that determines the accounting timeframe or timeframes to use when distributing revenue for an invoice line.
AccountingRuleCode: string

Maximum Length: 255

Abbreviation that identifies the accounting rule.
ActionType: string

Maximum Length: 255

Value that identifies the type of the action with respect to the coverage or the subscription product on fulfillment line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
ActionTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of action with respect to the coverage or the subscription product on fulfillment line. Say Add, Update, Renew in case of coverage. Resume, Suspend, terminate in case of subscriptions. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
ActualCompletionDate: string (date-time)

Title: Actual Completion Date

Read Only: true

Date when the application fulfilled the fulfillment line.
ActualShipDate: string (date-time)

Title: Actual Ship Date

Read Only: true

Date when the application sent the shipment.
additionalInformation: array Details

Title: Details

The Additional Details resource manages details that flexfields store for the sales order.
AgreementHeaderId: integer (int64)

Value that uniquely identifies the sales agreement on the order line.
AgreementLineId: integer (int64)

Read Only: true

Value that uniquely identifies the sales agreement line on the order line.
AgreementLineNumber: string

Read Only: true

Maximum Length: 255

Number of the sales agreement line on the order line.
AgreementNumber: string

Maximum Length: 255

Number that identifies the sales agreement on the order line.
AgreementVersionNumber: integer (int64)

Read Only: true

Version number of the sales agreement on the order line.
amendSubscriptionReferences: array Amend Subscription References

Title: Amend Subscription References

The Amend Subscription References resource manages details about unique references to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_AMEND, this information is used for ending the old subscription lines in Subscription Management that are replaced by the new subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
AppliedPriceListId: integer (int64)

Read Only: true

Value that identifies the price list that pricing applied.
AppliedPriceListName: string

Read Only: true

Maximum Length: 255

Name of the price list that pricing applied.
AssessableValue: number

Price that a tax authority uses to value, and then tax the item.
AssetGroupNumber: string

Maximum Length: 30

Value that groups customer assets into different categories.
AssetTrackedFlag: boolean

Maximum Length: 1

Abbreviation that identifies whether the fulfill line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. This attribute is not currently used.
AssetTracking: string

Read Only: true

Maximum Length: 255

Value that identifies whether the fulfillment line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing.
AssetTrackingCode: string

Maximum Length: 1

Abbreviation that identifies whether the fulfill line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. A list of accepted values is defined in the lookup type ORA_EGP_ASSET_TRACKING.
assetTransactionDetails: array Asset Transaction Details

Title: Asset Transaction Details

The Asset Transaction Details resource manages the asset transaction details to support license migration orders. This resource is not currently used.
associatedProductReferences: array Associated Product Items

Title: Associated Product Items

The Associated Product Items resource manages details about the product item that is associated with the subscription item on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
attachments: array Attachments

Title: Attachments

The Attachments resource manages attachments for the order header and order line.
billingPlans: array Billing Plans

Title: Billing Plans

The Billing Plans resource manages the billing plan for the sales order.
BillingTransactionTypeId: integer (int64)

Value that identifies the billing type.
BillingTransactionTypeName: string

Maximum Length: 255

Name of the billing type.
billToCustomer: array Bill-to Customers

Title: Bill-to Customers

The Bill-to Customers resource manages the bill-to customer that the sales order header references.
BusinessUnitId: integer (int64)

Read Only: true

Value that identifies the business unit for the fulfillment line.
BusinessUnitName: string

Read Only: true

Maximum Length: 255

Name of the business unit for the fulfillment line.
BuyerFirstName: string

Read Only: true

Maximum Length: 255

First name of the buyer for the item on the purchase order.
BuyerId: integer (int64)

Buyer details for a schedule. This attribute references the Buyer Public View that the application publishes for the item on the purchase order.
BuyerLastName: string

Read Only: true

Maximum Length: 255

Last name of the buyer for the item on the purchase order.
BuyerMiddleName: string

Read Only: true

Maximum Length: 255

Middle name of the buyer for the item on the purchase order.
BuyerName: string

Read Only: true

Maximum Length: 255

Full name of the buyer for the item on the purchase order.
CanceledFlag: boolean

Title: Canceled

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application canceled the sales order line. If false, then not canceled. The default value is false.
CanceledQuantity: number

Title: Canceled Quantity

Read Only: true

Canceled quantity.
CancelReason: string

Maximum Length: 255

Reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
CancelReasonCode: string

Maximum Length: 255

Abbreviation that identifies the reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
channelPrograms: array Channel Programs

Title: Channel Programs

The Channel Programs resource manages the channel programs of a sales order line.
charges: array Charges

Title: Charges

The Charges resource manages price details for the sales order.
Comments: string

Title: Comments

Maximum Length: 2000

Comments for the order line.
ComponentIdPath: string

Maximum Length: 2000

Value that identifies the path from the inventory item to the parent of this configured item on the order line.
ConfigCreationDate: string (date-time)

Date when the user created the configured item.
ConfigHeaderId: integer (int64)

Value that identifies the order header of the sales order that contains the configured item.
ConfigInventoryItemDescription: string

Read Only: true

Maximum Length: 255

Item description of the shippable assemble-to-order (ATO) configuration.
ConfigInventoryItemId: integer (int64)

Inventory item for an assemble-to-order, configured item that the application can ship. A contract or a sales agreement is an example of an item that the application cannot ship.
ConfigInventoryItemNumber: string

Read Only: true

Maximum Length: 255

Item number of the shippable assemble-to-order (ATO) configuration.
ConfigItemReference: string

Maximum Length: 1200

Reference to the finished configured item.
ConfigRevisionNumber: integer (int64)

Revision number of the configured item. The configurator sets the value of this attribute to the configured item. It does not set it to a configure option.
ConfigTradeComplianceResult: string

Read Only: true

Maximum Length: 255

Value that identifies the result of trade compliance screening for the configured item.
ConfigTradeComplianceResultCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the result of trade compliance screening for the configured item.
ConfiguratorPath: string

Maximum Length: 2000

Path that identifies the inventory item for the configure option. Path format is ".", separated by inventory item identifier. The format uses [] to specify configure options that occur in more than one instance.
ContractEndDate: string (date)

End date of the contract, according to the start date and duration. You can use Manage Time Units Mappings to map time units to the units of measure that the application uses.
ContractEndDateTime: string (date-time)

Date and time when the contract will end, according to the contract start date and time and duration. Review and update the value to map time units to the units of measure that the application uses using the Setup and Maintenance work area, and the Manage Time Units Mappings task.
ContractStartDate: string (date)

Start date of the contract.
ContractStartDateTime: string (date-time)

Date and time when the contract is effective.
coverageReferences: array Coverage Items

Title: Coverage Items

The Coverage Items resource manages details about each coverage item that covers a covered item on an order line.
coveredAssetReference: array Covered Assets

Title: Covered Assets

The Covered Assets resource manages details about Asset that a coverage item covers. This is available for use with the Integrate Order Management with Subscription Management to Process Coverages feature.
CoveredCustomerProductDescription: string

Maximum Length: 240

Description of the customer item that the coverage item covers.
CoveredCustomerProductId: integer (int64)

Value that uniquely identifies the customer item that the coverage item covers.
CoveredCustomerProductNumber: string

Maximum Length: 150

Number that identifies the customer item that the coverage item covers.
CoveredProductDescription: string

Maximum Length: 240

Description of the inventory item that the coverage item covers.
CoveredProductId: integer (int64)

Value that uniquely identifies the inventory item that the coverage item covers.
CoveredProductNumber: string

Maximum Length: 300

Number that identifies the inventory item that the coverage item covers.
coveredProductReferences: array Covered Items

Title: Covered Items

The Covered Items resource manages details about each covered item that a coverage item covers on an order line.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who created the order line.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date and time when the user created the order line.
CreditCheckAuthExpiryDate: string (date-time)

Date when the approved credit authorization expires.
CreditCheckAuthorizationNumber: string

Maximum Length: 240

Value that uniquely identifies the approved credit authorization that the credit management system created on the authorized amount for the customer account. This attribute applies on credit checks only for authorization or reauthorization.
CustomerPOLineNumber: string

Title: Customer PO Line

Maximum Length: 50

Value that uniquely identifies the purchase order line. The purchase order line describes the item or service, and it includes the price and quantity ordered.
CustomerPONumber: string

Title: Customer PO

Maximum Length: 50

Number that identifies the purchase order that the application uses to request that the seller supply the item or service in return for payment.
CustomerPOScheduleNumber: string

Maximum Length: 50

Number that identifies the schedule for the shipment that ships the purchase order. This is an optional attribute that the user can specify when submitting the sales order.
CustomerProductDescription: string

Maximum Length: 255

Description of the customer item.
CustomerProductId: integer (int64)

Value that uniquely identifies the customer item.
CustomerProductNumber: string

Maximum Length: 255

Number of the customer item.
DefaultTaxationCountry: string

Maximum Length: 2

Country that the tax authority uses to calculate tax.
DefaultTaxationCountryShortName: string

Maximum Length: 255

Short name of the country that the tax authority uses to calculate tax.
DemandClass: string

Maximum Length: 255

Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
DemandClassCode: string

Maximum Length: 255

Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
DemandSourceLineReference: string

Maximum Length: 400

Value that uniquely identifies demand, such as the order line in a shopping cart on a web store or in an ecommerce application. For example, you create a sales order in a web store. Then the web store sends a request to Oracle Fusion Cloud Global Order Promising to schedule it. Oracle Global Order Promising schedules the demand and sends a reply to the web store. The web store then sends the sales order to Oracle Fusion Cloud Order Management. Finally, Oracle Order Management manages the order through fulfilment.
DemandSourceScheduledFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

This attribute applies to a transaction that starts in a web store or ecommerce store. It contains the values Y or N. If Y, Oracle Fusion Cloud Order Management creates a sales order and sends DEMAND_SOURCE_LINE_REFERENCE to Oracle Fusion Cloud Global Order Promising. When Oracle Global Order Promising successfully schedules the demand, Oracle Order Management receives a response from Oracle Global Order Promising and then sets DEMAND_SOURCE_SCHEDULED_FLAG to Y. It does this during the first scheduling interaction that it has with Oracle Global Order Promising. You can???t modify the value for DEMAND_SOURCE_SCHEDULED_FLAG after it contains Y. If N, Oracle Global Order Promising doesn???t successfully schedule the demand, or the line doesn???t contain DEMAND_SOURCE_LINE_REFERENCE.
DestinationLocationId: integer (int64)

Value that identifies the destination location where the application ships the item.
DestinationShippingOrganizationCode: string

Abbreviation that identifies the destination organization where the application ships the item.
DestinationShippingOrganizationId: integer (int64)

Value that identifies the destination organization where the application ships the item.
DestinationShippingOrganizationName: string

Name of the destination organization where the application ships the item.
DisplayLineNumber: string

Read Only: true

Number that the order management work area displays to identify the order line.
DocumentSubtype: string

Maximum Length: 240

Tax classification for tax reporting. This attribute depends on the requirements for each country.
DocumentSubtypeName: string

Maximum Length: 255

Name of the tax classification for tax reporting. This attribute depends on the requirements for each country.
dropShipPurchaseOrderReference: array Drop Ships

Title: Drop Ships

The Drop Ships resource manages the purchase order when order management uses drop ship to ship the sales order.
dropShipRequisitionReference: array Drop Ship Requisitions

Title: Drop Ship Requisitions

The Drop Ship Requisitions resource manages the requisition when order management uses drop ship to ship the sales order.
EarliestAcceptableShipDate: string (date-time)

Title: Earliest Acceptable Ship Date

Earliest date when the customer is willing to receive shipment.
EndCreditMethod: string

Maximum Length: 255

Value that identifies the credit method used for ending or closing the subscription. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EndCreditMethodCode: string

Maximum Length: 30

Abbreviation that identifies the credit method used for ending or closing the subscription. A list of accepted values is defined in the lookup type ORA_OSS_CLOSE_CREDIT_METHOD. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EndDate: string (date-time)

Date when the subscription ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EndReason: string

Maximum Length: 255

Value that identifies the reason for ending or closing the subscription. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EndReasonCode: string

Maximum Length: 30

Abbreviation that identifies the reason for ending or closing the subscription. A list of accepted values is defined in the lookup type ORA_OSS_CLOSE_REASONS. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EstimateFulfillmentCost: number

Estimated cost to deliver the fulfillment line to the customer. This value includes item cost and shipping cost.
EstimateMargin: number

Estimated margin expected when shipping the fulfillment line.
ExemptionCertificateNumber: string

Maximum Length: 80

Certification number that the taxing authority provides for tax exemption for each customer who is eligible for tax exemption.
ExtendedAmount: number

Title: Extended Amount

Monetary amount of the order line.
externalAssetReference: array External Asset References

Title: External Asset References

The External Asset References resource manages details about asset keys from an external application that are associated with subscription items on an order line when ActionTypeCode is null or ORA_ADD. The External Asset References resource also manages details about unique references to the subscription product in Oracle Subscription Management Cloud when ActionTypeCode is ORA_END. When ActionTypeCode is ORA_END, this information is used for ending the subscription in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
externalFulfillmentSalesOrderReference: array Fulfillment Orders

Title: Fulfillment Orders

The Fulfillment Orders resource manages the fulfillment order in the fulfillment system that fulfills the sales order that order management submitted to the fulfillment system.
ExternalPriceBookName: string

Maximum Length: 80

Name of the price book or price list in the external pricing application. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
FinalDischargeLocationAddressCity: string

City of the final destination location for the purchase.
FinalDischargeLocationAddressCountry: string

Country of the final destination location for the purchase.
FinalDischargeLocationAddressCounty: string

County of the final destination location for the purchase.
FinalDischargeLocationAddressLine1: string

First line of the final destination location for the purchase.
FinalDischargeLocationAddressLine2: string

Second line of the final destination location for the purchase.
FinalDischargeLocationAddressLine3: string

Third line of the final destination location for the purchase.
FinalDischargeLocationAddressLine4: string

Fourth line of the final destination location for the purchase.
FinalDischargeLocationAddressPostalCode: string

Postal code of the final destination location for the purchase.
FinalDischargeLocationAddressProvince: string

Province of the final destination location for the purchase.
FinalDischargeLocationAddressState: string

State of the final destination location for the purchase.
FinalDischargeLocationId: integer (int64)

Value that identifies the final destination location for the purchase.
FirstPartyTaxRegistration: integer (int64)

Registration number that the application provides to the supplier. The supplier uses this number to tax the transaction.
FirstPartyTaxRegistrationNumber: string

Maximum Length: 255

Value that identifies registration number.
FOBPoint: string

Maximum Length: 255

Freight on board. Identifies ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FOBPointCode: string

Maximum Length: 255

Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FreightTerms: string

Maximum Length: 255

Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FreightTermsCode: string

Maximum Length: 255

Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
FulfilledQuantity: number

Title: Fulfilled Quantity

Read Only: true

Quantity the application uses to fulfill the order line.
FulfillInstanceId: integer (int64)

Read Only: true

Value that uniquely identifies the fulfillment instance that fulfills this fulfillment line.
FulfillLineId: integer (int64)

Read Only: true

Value that uniquely identifies the fulfillment line.
FulfillLineNumber: string

Title: Fulfillment Line

Read Only: true

Maximum Length: 9

Default Value: 1

Numerical value for the fulfillment line. The default value is 1. It increments in integers when the fulfillment line splits.
FulfillmentDate: string (date-time)

Title: Actual Fulfillment Date

Read Only: true

Date when the application fulfills the order line. Fulfillment includes item shipped, hardware installed, and so on.
FulfillmentMode: string

Read Only: true

Maximum Length: 30

Fulfillment mode, such as regular, dropship, or back-to-back.
FulfillmentSplitReferenceId: integer (int64)

Read Only: true

Value that uniquely identifies the source fulfillment line when the fulfillment line splits.
GopReferenceId: string

Read Only: true

Maximum Length: 300

Value that identifies the cross-reference to the recommendation that global order promising creates for the split fulfillment line.
GopRequestRegion: string

Read Only: true

Maximum Length: 255

Region details for the promising request that global order promising provides.
HeaderId: integer (int64)

Read Only: true

Value that uniquely identifies the header of the sales order that contains the order line.
holds: array Holds

Title: Holds

The Holds resource manages active and released holds on the order line.
IntegrateSubscriptionFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true then Oracle Fusion Cloud Order Management sends the fulfillment line to Oracle Fusion Cloud Subscription Management. If false then it doesn't. The default value is false.
IntendedUseClassificationId: integer (int64)

Value that uniquely identifies intended use of the item. For tax calculation.
IntendedUseClassificationName: string

Maximum Length: 255

Classification name for the intended use of the item. For tax calculation.
internalOrderReference: array Internal Sales Orders

Title: Internal Sales Orders

The Internal Sales Orders resource manages sales orders that are internal to order management.
InventoryInterfacedFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then Oracle Order Management Cloud successfully interfaced the fulfillment line to Oracle Inventory Management Cloud. If false, then Order Management didn???t interface the fulfillment line. The default value is false.
InventoryOrganizationCode: string

Read Only: true

Maximum Length: 255

Abbreviation that identifies the inventory organization where the application assigns the item. The application also uses this value for the item validation organization when the customer places the sales order.
InventoryOrganizationId: integer (int64)

Read Only: true

Value that uniquely identifies the inventory organization where the application assigns the item. The application also uses this value for the item validation organization when the customer places the sales order.
InventoryOrganizationName: string

Read Only: true

Maximum Length: 255

Name of the inventory organization.
InventoryTransactionFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then Oracle Order Management Cloud sends a request to Oracle Inventory Management Cloud to perform an inventory transaction when fulfilling the order line instead of using the pick wave, pick, pack, and ship flow. If false, then Order Management uses the pick wave, pick, pack, and ship flow to fulfill the order line. The default value is false.
InvoiceableItemFlag: boolean

Title: Billable

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the fulfillment line includes the item that the application enabled for billing or invoicing. If false, then the fulfillment line does not include this item. The default value is set based on the item setup. This attribute is read-only.
InvoiceEnabledFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the order line qualifies for billing. If false, then the order line does not qualify for billing. The default value is set based on the item setup. This attribute is read-only.
InvoiceInterfacedFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application sent the order line to the billing system. If false, then the application did not send the order line to the billing application. The default value is false. This attribute is read-only.
InvoicingRule: string

Maximum Length: 255

Invoicing rule that determines when to recognize a receivable for invoice.
InvoicingRuleCode: string

Maximum Length: 255

Abbreviation that identifies invoicing rules that determine when to recognize a receivable for invoice.
ItemSubType: string

Read Only: true

Maximum Length: 255

Name of the item sub type.
ItemSubTypeCode: string

Read Only: true

Maximum Length: 30

Subgroup for ITEM_TYPE_CODE. It provides details for each configured item or service, such as assemble-to-order.
ItemTypeCode: string

Title: Item Type

Read Only: true

Maximum Length: 30

Group items according attributes.
JeopardyPriority: string

Read Only: true

Maximum Length: 255

Name of the priority for the jeopardy score of order line.
JeopardyPriorityCode: string

Read Only: true

Maximum Length: 255

Abbreviation that identifies the priority for the jeopardy score of order line. A list of possible values is defined in the lookup type DOO_JEOPARDY_PRIORITY_CODE.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

Date and time when the user most recently updated the order line.
LastUpdatedBy: string

Title: Updated By

Read Only: true

Maximum Length: 64

User who performed the most recent update on the order line.
LastUpdateLogin: string

Title: Last Updated Login

Read Only: true

Maximum Length: 32

Login that user who most recently updated the order line used.
LatestAcceptableArrivalDate: string (date-time)

Title: Latest Acceptable Arrival Date

Latest date when the customer is willing to receive the item.
LatestAcceptableShipDate: string (date-time)

Title: Latest Acceptable Ship Date

Latest date when the customer is willing to allow the warehouse to ship the item.
lineDetails: array Line Details

Title: Line Details

The Line Details resource manages shipping and billing details for the order line.
LineId: integer (int64)

Read Only: true

Value that uniquely identifies the order line.
LineNumber: integer (int32)

Title: Orchestration Order Line

Read Only: true

Default Value: 1

Number that identifies the order line.
links: array Links

Title: Links

The link relations associated with the resource instance.
lotSerials: array Lot Serials

Title: Lot Serials

The Lot Serials resource manages the lot serial details for returns and inventory transaction order lines.
manualPriceAdjustments: array Manual Price Adjustments

Title: Manual Price Adjustments

The Manual Price Adjustments resource manages manual price adjustments that the Order Entry Specialist applies for each order line.
OnHoldFlag: boolean

Title: On Hold

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then fulfillment lines will accept more processing. If false, then fulfillment lines will not accept more processing. The default value is false. This attribute is read-only.
OpenFlag: boolean

Title: Open

Read Only: true

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then status of the fulfillment line is not closed. If false, then status of the fulfillment line is closed. The default value is true. This attribute is read-only.
OrchestrationProcessName: string

Maximum Length: 80

Name of the orchestration process to assign to the line.
OrderedQuantity: number

Title: Ordered Quantity

Quantity of the item or service on the fulfillment line.
OrderedUOM: string

Maximum Length: 255

Unit of measure for the ordered quantity. For example, length, time, heat, value, and so on.
OrderedUOMCode: string

Title: UOM

Maximum Length: 3

Abbreviation that identifies the unit of measure for the ordered quantity.
originalOrderReference: array Original Orders

Title: Original Orders

The Original Orders resource manages the original order for a return sales order.
OriginalProductDescription: string

Maximum Length: 255

Description of the inventory item that the fulfillment line contained before the application substituted the item.
OriginalProductId: integer (int64)

Value that uniquely identifies the inventory item that the fulfillment line contained before the application substituted the item.
OriginalProductNumber: string

Maximum Length: 255

Number of the inventory item that the fulfillment line contained before the application substituted the item.
OrigSystemDocumentLineReference: string

Maximum Length: 50

Original document reference of the order line in the source application.
OrigSystemDocumentReference: string

Maximum Length: 50

Original document reference of the source order in the source application.
OverFulfillmentTolerance: number

Read Only: true

Percent of quantity that can be fulfilled above the ordered quantity.
OverrideScheduleDateFlag: boolean

Title: Override Schedule

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the user can manually override the schedule date. If false, then user cannot override. The default value is false.
OwnerId: integer (int64)

User who is responsible for the order line.
PackingInstructions: string

Title: Packing Instructions

Maximum Length: 1000

Document that contains packing details for the item.
ParentFulfillLineId: integer (int64)

Read Only: true

Value that uniquely identifies the parent fulfillment line. This value describes the fulfillment line hierarchy for a configured item.
ParentSourceTransactionLineId: string

Maximum Length: 255

Value that uniquely identifies the parent transaction line from the source application. This value describes the transaction line hierarchy for a configured item.
PartialShipAllowedFlag: boolean

Title: Allow Split Shipments

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then ship items in the sales order in more than one shipment. If false, then ship items in the sales order in one shipment. The default value is false.
payments: array Payments

Title: Payments

The Payments resource manages payment details of the order.
PaymentTerms: string

Maximum Length: 255

Payment terms to use to collect payment.
PaymentTermsCode: integer (int64)

Abbreviation that identifies payment terms.
POStatusCode: string

Maximum Length: 30

Status of the purchase order.
priceAdjustments: array Price Adjustments

Title: Price Adjustments

The Price Adjustments resource manages price adjustments, such as discounts.
PricedOn: string (date-time)

Date when pricing priced the order line. The application sets this date to the system date when pricing begins pricing the order line.
PriceUsingSecondaryUOMFlag: boolean

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then Oracle Order Management Cloud uses the secondary ordered quantity and the secondary unit of measure to price the order line. If false or empty, then Order Management uses the ordered quantity and the ordered unit of measure to price the order line. This attribute does not have a default value. This attribute is read-only. If the item is dual-UOM controlled, then the value of this attribute will be either true or false depending upon the pricing measure setup for the item in Oracle Product Lifecycle Management Cloud. If the item is not dual-UOM controlled, then the value of this attribute will be NULL.
priceValidations: array Price Validations

Title: Price Validations

The Price Validations resource manages price validations and price violations that occur when pricing prices a sales order.
ProcessNumber: string

Read Only: true

Maximum Length: 50

Number that identifies the orchestration process.
ProductCategory: string

Maximum Length: 240

Item classification that the tax authority uses to tax the item.
ProductCategoryName: string

Maximum Length: 255

Classifies the item for tax. Order management uses this attribute when you do not install Oracle Fusion Inventory in your deployment, or when you installed it but you do not use it to classify items for tax.
ProductDescription: string

Maximum Length: 255

Description of the item that the application fulfills.
ProductFiscalCategory: string

Maximum Length: 255

Tax classification of the item that the tax authority uses to tax the item.
ProductFiscalCategoryId: integer (int64)

Value that uniquely identifies the tax classification.
ProductId: integer (int64)

Value that uniquely identifies the inventory item.
ProductNumber: string

Maximum Length: 255

Stock keeping unit for the item that the application fulfills.
ProductType: string

Maximum Length: 240

Type of item classification in Oracle Fusion Tax. The value of the item type specifies whether the transaction line is for an item or service, or whether it is a memo line.
ProductTypeName: string

Maximum Length: 255

Name of the item classification in Oracle Fusion Tax. The value of the item type specifies whether the transaction line is for an item or service, or whether it is a memo line.
project: array Projects

Title: Projects

The Projects resource manages the project details of a sales order line.
PromiseArrivalDate: string (date-time)

Title: Promised Arrival Date

Date when global order promising promised to the customer that the item will arrive.
PromiseShipDate: string (date-time)

Title: Promised Ship Date

Date when global order promising promised to the customer that the item will ship.
PurchasingEnabledFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the purchase order can include the item on the fulfillment line. If false, then the purchase order cannot include the item on the fulfillment line. The default value is set based on the item setup. This attribute is read-only.
PurchasingUOM: string

Maximum Length: 255

Unit of measure that procurement set on the purchase order for the supplier.
PurchasingUOMCode: string

Maximum Length: 3

Abbreviation that identifies the unit of measure that procurement set on the purchase order for the supplier.
QuantityForEachModel: number

Quantity for a configure option on a single configured item.
RatePlanDocument: string (byte)

Rate plan document in JSON format encoded using Base64. The rate plan document will be desupported from release 23C.
RatePlanDocumentId: integer (int64)

Read Only: true

Value that uniquely identifies the JSON document for a rate plan in Oracle Fusion Pricing Cloud.
RatePlanId: integer (int64)

Read Only: true

Value that uniquely identifies a rate plan in Oracle Fusion Pricing Cloud.
RatePlanName: string

Read Only: true

Name of the rate plan in Oracle Fusion Pricing Cloud.
RatePlanNumber: string

Read Only: true

Number that identifies a rate plan in Oracle Fusion Pricing Cloud.
ReceivablesOrgId: integer (int64)

Receivables business unit.
ReceivablesOrgName: string

Read Only: true

Maximum Length: 255

Name of the receivables business unit.
RemnantFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application partially fulfilled a configured item. If false, then the application did not partially fulfill a configured item. The default value is false. This attribute is read-only.
renewSubscriptionReference: array Renew Subscription References

Title: Renew Subscription References

The Renew Subscription References resource manages details about unique reference to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_RENEW, this information is used for associating the old subscription line in Subscription Management that is replaced by the renewed subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
RequestedArrivalDate: string (date-time)

Title: Requested Arrival Date

Original date when the customer requested for the item to arrive.
RequestedCancelDate: string (date-time)

Date when the customer canceled the order line.
RequestedFulfillmentOrganizationAddress1: string

Read Only: true

Maximum Length: 255

First address line of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationAddress2: string

Read Only: true

Maximum Length: 255

Second address line of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationAddress3: string

Read Only: true

Maximum Length: 255

Third address line of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationAddress4: string

Read Only: true

Maximum Length: 255

Fourth address line of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationCity: string

Read Only: true

Maximum Length: 255

City of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationCode: string

Maximum Length: 255

Abbreviation that identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.
RequestedFulfillmentOrganizationCountry: string

Read Only: true

Maximum Length: 255

Country of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationCounty: string

Read Only: true

Maximum Length: 255

County of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationId: integer (int64)

Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.
RequestedFulfillmentOrganizationName: string

Maximum Length: 255

Name of the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.
RequestedFulfillmentOrganizationPostalCode: string

Read Only: true

Maximum Length: 255

Postal code of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationProvince: string

Read Only: true

Maximum Length: 255

Province of the fulfillment organization from where the product was shipped.
RequestedFulfillmentOrganizationState: string

Read Only: true

Maximum Length: 255

State of the fulfillment organization from where the product was shipped.
RequestedRatePlanId: integer (int64)

Value that uniquely identifies the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions and Rate Usage With Events features.
RequestedRatePlanName: string

Read Only: true

Name of the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing.
RequestedRatePlanNumber: string

Number that identifies the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions and Rate Usage With Events features.
RequestedShipDate: string (date-time)

Title: Requested Ship Date

Original date when the customer requested for the item to ship.
RequestingBusinessUnitId: integer (int64)

Read Only: true

Value that uniquely identifies the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.
RequestingBusinessUnitName: string

Read Only: true

Maximum Length: 255

Name of the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.
RequiredFulfillmentDate: string (date-time)

Date when the customer requires fulfillment.
RequisitionBusinessUnitId: integer (int64)

Read Only: true

Value that identifies the requisition business unit.
RequisitionBusinessUnitName: string

Read Only: true

Maximum Length: 255

Name of the requisition business unit.
RequisitionInventoryOrganizationCode: string

Read Only: true

Maximum Length: 255

Name of the requisition organization.
RequisitionInventoryOrganizationId: integer (int64)

Read Only: true

Value that identifies the requisition organization.
RequisitionInventoryOrganizationName: string

Read Only: true

Maximum Length: 255

Abbreviation that identifies the requisition organization.
ReservableFlag: boolean

Title: Reservable

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application can reserve the item on the fulfillment line. If false, then the application cannot reserve. The default value is set based on the item setup. This attribute is read-only.
ReservationId: integer (int64)

Read Only: true

Value that uniquely identifies the reservation.
ReservedQuantity: number

Title: Reserved Quantity

Read Only: true

Quantity of the item that the application reserved in the warehouse to fulfill the fulfillment line.
ReturnableFlag: boolean

Title: Return Allowed

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application can return the item to the supplier. If false, then the application cannot return the item to the supplier. The default value is set based on the item setup. This attribute is read-only.
ReturnReason: string

Maximum Length: 255

Reason that the customer provided to return the item.
ReturnReasonCode: string

Maximum Length: 255

Abbreviation that identifies the reason to return an item.
RMADeliveredQuantity: number

Title: Delivered Quantity

Read Only: true

Quantity delivered for the receipt line.
RootParentFulfillLineId: integer (int64)

Read Only: true

Description of the fulfillment line hierarchy for a configured item. It identifies the highest fulfillment line in the hierarchy.
salesCredits: array Sales Credits

Title: Sales Credits

The Sales Credits resource manages sales credits for each salesperson on the sales order.
Salesperson: string

Maximum Length: 255

Person who is responsible for the sale of the sales order.
SalespersonId: integer (int64)

Value that identifies the primary salesperson.
SalesProductType: string

Read Only: true

Maximum Length: 255

Name of the sales type of the item on the fulfillment line.
SalesProductTypeCode: string

Read Only: true

Maximum Length: 30

Sales type of the item on the fulfillment line.
ScheduleArrivalDate: string (date-time)

Title: Scheduled Arrival Date

Date when the application scheduled the shipment to arrive.
ScheduleShipDate: string (date-time)

Title: Scheduled Ship Date

Date when the application scheduled the shipment to ship.
SchedulingReason: string

Value of the scheduling reason.
SchedulingReasonCode: string

Maximum Length: 30

Abbreviation that identifies the scheduling reason.
SecondaryFulfilledQuantity: number

Read Only: true

Quantity on the fulfillment line for the item or service in the secondary unit of measure that the application uses to fulfill the sales order line. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SecondaryOrderedQuantity: number

Read Only: true

Ordered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SecondaryRMADeliveredQuantity: number

Read Only: true

Delivered quantity on the fulfillment line for the returned item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SecondaryShippedQuantity: number

Read Only: true

Shipped quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SecondaryUOM: string

Maximum Length: 255

Secondary unit of measure for the ordered quantity on the fulfillment line. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SecondaryUOMCode: string

Read Only: true

Maximum Length: 3

Abbreviation that identifies the secondary unit of measure for the ordered quantity on the fulfillment line. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SellingProfitCenterBusinessUnitId: integer (int64)

Value that uniquely identifies the selling profit center business unit.
SellingProfitCenterBusinessUnitName: string

Maximum Length: 255

Name of the selling profit center business unit.
ServiceCancelDate: string (date-time)

Date when the customer canceled the coverage item or subscription item on the fulfillment line.
ServiceDuration: number

Duration for the coverage item or subscription item on the fulfillment line.
ServiceDurationPeriodCode: string

Maximum Length: 10

Abbreviation that identifies the unit of measure for the coverage item or subscription item on the fulfillment line.
ServiceDurationPeriodName: string

Maximum Length: 255

Name of the unit of measure for the coverage item or subscription item on the fulfillment line.
ShipmentPriority: string

Maximum Length: 255

Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShipmentPriorityCode: string

Maximum Length: 255

Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippableFlag: boolean

Title: Shippable

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application can ship the order line to the customer. For example, the application can typically ship a computer, but cannot typically ship a service. If false, then the application cannot ship the order line. The default value is set based on the item setup. This attribute is read-only.
ShippedQuantity: number

Title: Shipment Quantity

Read Only: true

Quantity of the item on the order line that shipped.
ShippedUOM: string

Read Only: true

Maximum Length: 255

Unit of measure for the quantity shipped.
ShippedUOMCode: string

Read Only: true

Maximum Length: 3

Abbreviation that identifies the unit of measure for the quantity shipped.
ShippingCarrier: string

Maximum Length: 255

Carrier who delivers the item.
ShippingCarrierId: integer (int64)

Abbreviation that identifies the carrier who delivers the item.
ShippingInstructions: string

Title: Shipping Instructions

Maximum Length: 1000

Detailed instructions about cargo and other requirements for shipping.
ShippingMode: string

Maximum Length: 255

Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippingModeCode: string

Maximum Length: 255

Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippingServiceLevel: string

Maximum Length: 255

Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShippingServiceLevelCode: string

Maximum Length: 255

Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
ShipSetName: string

Title: Shipment Set

Maximum Length: 50

Group of order lines in the sales order that must ship together from one location to one destination, and that use the same scheduled ship date.
shipToCustomer: array Ship-to Customers

Title: Ship-to Customers

The Ship-to Customers resource manages the ship-to customer that the sales order header references.
ShowInSales: integer (int32)

Specifies how to display a configured item on the Sales Summary page and on the Configurator summary page. You can set this attribute to one of the following values. Yes: display the configured item, but do not display the configure options. This is the default value. Hide Self: display the configure options, but do not display the configured item. Hide Self and Descendants: do not display the configured item or the configure options. You define this attribute for the configure options in Oracle Product Lifecycle Management Cloud. This attribute controls only the display. It does not filter items from the configurator.
SourceScheduleNumber: string

Title: Source Schedule Number

Maximum Length: 50

Number that the source application assigns for the schedule, shipment, or subline.
SourceTransactionId: string

Read Only: true

Maximum Length: 50

Value that uniquely identifies the transaction in the source application.
SourceTransactionLineId: string

Maximum Length: 50

Value that uniquely identifies the transaction line from the source application.
SourceTransactionLineNumber: string

Title: Source Order Line

Maximum Length: 100

Number of the transaction line from the source application.
SourceTransactionNumber: string

Title: Source Order

Read Only: true

Maximum Length: 50

Number that identifies the transaction in the source application.
SourceTransactionRevisionNumber: integer (int64)

Default Value: 0

Revision number of the transaction in the source application.
SourceTransactionScheduleId: string

Maximum Length: 50

Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.
SourceTransactionSystem: string

Title: Source System

Read Only: true

Maximum Length: 30

Source application that placed the request.
SplitFromFlineId: integer (int64)

Read Only: true

Reference to the fulfillment line that exists before the fulfillment line split.
Status: string

Read Only: true

Maximum Length: 255

Status of the fulfillment line.
StatusCode: string

Read Only: true

Maximum Length: 30

Default Value: CREATED

Abbreviation that identifies the status of the fulfillment line.
Subinventory: string

Maximum Length: 255

Physical or logical location of the item.
SubinventoryCode: string

Maximum Length: 10

Abbreviation that identifies the physical or logical location of the item.
SubscriptionInterfacedFlag: boolean

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the fulfillment line is interfaced to Oracle Subscription Management Cloud. If false, then the fulfillment line isn't interfaced to Subscription Management. The default value is false. This attribute is read-only.
SubscriptionProfileId: integer (int64)

Value that uniquely identifies the subscription profile. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
SubscriptionProfileName: string

Maximum Length: 300

Name of the subscription profile. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
subscriptionReferences: array Subscription Items

Title: Subscription Items

The Subscription Items resource manages details about subscription items that are associated with product items on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
subscriptionTerm: array Subscription Terms

Title: Subscription Terms

The Subscription Terms resource manages details about pricing term definitions for subscriptions. When the pricing term is enabled, subscription generates the billing schedule for the duration of the pricing term, for both evergreen and termed lines based of the pricing method. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
SubstitutionAllowedFlag: boolean

Title: Allow Item Substitution

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then allow the application to substitute an item on the fulfillment line for some reason, such as shortage of material or goodwill gesture to the customer. If false, then do not allow the application to substitute. This attribute does not have a default value.
SubstitutionReason: string

Maximum Length: 255

Describes why the application substituted the item on the fulfillment line.
SubstitutionReasonCode: string

Title: Substitution Reason

Maximum Length: 30

Abbreviation that describes why the application substituted the item on the fulfillment line.
SupplierAddress1: string

Read Only: true

Maximum Length: 255

First address line of the supplier who supplies the item.
SupplierAddress2: string

Read Only: true

Maximum Length: 255

Second address line of the supplier who supplies the item.
SupplierAddress3: string

Read Only: true

Maximum Length: 255

Third address line of the supplier who supplies the item.
SupplierAddress4: string

Read Only: true

Maximum Length: 255

Fourth address line of the supplier who supplies the item.
SupplierCity: string

Read Only: true

Maximum Length: 255

City of the supplier who supplies the item.
SupplierCountry: string

Read Only: true

Maximum Length: 255

Country of the supplier who supplies the item.
SupplierCounty: string

Read Only: true

Maximum Length: 255

County of the supplier who supplies the item.
SupplierId: integer

Supplier for the purchase order.
SupplierName: string

Maximum Length: 255

Name of the supplier that the application requested.
SupplierPostalCode: string

Read Only: true

Maximum Length: 255

Postal code of the supplier who supplies the item.
SupplierProvince: string

Read Only: true

Maximum Length: 255

Province of the supplier who supplies the item.
SupplierSiteId: integer

Supplier site for the purchase order.
SupplierSiteName: string

Maximum Length: 255

Name of the supplier site for the purchase order. Interface tables don't currently support this column. So, this attribute can't be used when the REST service is used for file-based data import (FBDI). It can be used only when the REST service is directly invoked.
SupplierState: string

Read Only: true

Maximum Length: 255

State of the supplier who supplies the item.
supplyOrderReference: array Supply Orders

Title: Supply Orders

The Supply Orders resource manages the supply that order management uses to supply the item.
SupplyStatusCode: string

Maximum Length: 30

Status of the supply for the fulfillment line.
TaxClassification: string

Maximum Length: 255

Group of taxes for reporting and processing.
TaxClassificationCode: string

Maximum Length: 255

Abbreviation that identifies a group of taxes.
TaxExempt: string

Read Only: true

Maximum Length: 255

Value that identifies whether the fulfillment line is exempt from tax.
TaxExemptCode: string

Maximum Length: 1

Default Value: S

Abbreviation that identifies whether the fulfillment line is exempt from tax. Valid values include S and E. If S, then calculate standard tax. If E, then exempt from tax. A list of accepted values is defined in the lookup type ZX_EXEMPTION_CONTROL.
TaxExemptFlag: boolean

Maximum Length: 1

Default Value: false

Abbreviation that identifies the tax exemption. This attribute is not currently used.
TaxExemptReason: string

Maximum Length: 255

Reason for the tax exemption.
TaxExemptReasonCode: string

Maximum Length: 255

Abbreviation that identifies the reason for the tax exemption.
TaxInvoiceDate: string (date)

Tax invoice date that tax reporting uses depending on the requirements of different countries.
TaxInvoiceNumber: string

Maximum Length: 150

Invoice number that tax reporting uses depending on the requirements of different countries.
ThirdPartyTaxRegistration: integer (int64)

Registration number that the customer specifies in the purchase order.
ThirdPartyTaxRegistrationNumber: string

Maximum Length: 255

Customer registration number that the customer specifies in the purchase order.
TotalContractAmount: number

Total amount for the contract duration according to the total contract quantity.
TotalContractQuantity: number

Total quantity for the contract duration including the number of timeframes for recurring billing.
TradeComplianceDate: string (date-time)

Read Only: true

Most recent date when the application screened the order line for trade compliance.
TradeComplianceResult: string

Read Only: true

Maximum Length: 255

Result of the trade compliance screening for the order lines.
TradeComplianceResultCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the result of trade compliance screening.
TransactionBusinessCategory: string

Maximum Length: 240

Tax classification that the tax authority requires.
TransactionBusinessCategoryName: string

Maximum Length: 255

Name of the tax classification that the tax authority requires.
TransactionCategoryCode: string

Title: Category

Maximum Length: 30

Default Value: ORDER

Abbreviation that identifies whether the line is a return. Values include RETURN or ORDER.
transactionItemAttributes: array Transaction Item Attributes

Title: Transaction Item Attributes

The Transaction Item Attributes resource manages transaction item attributes for each item on each order line.
TransactionLineType: string

Maximum Length: 255

Defines behavior for the fulfillment line. For example, required values, default values, display values, and so on.
TransactionLineTypeCode: string

Maximum Length: 30

Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.
TransformFromLineId: integer (int64)

Read Only: true

Value that identifies order line received from order capture application from which this particular line id is derived.
TransportationPlannedFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the transportation planning system plans the fulfillment line. If false, then the transportation planning system does not plan the fulfillment line. The default value is false.
TransportationPlannedStatusCode: string

Maximum Length: 1

Abbreviation that indicates that a transportation planning application plans the fulfillment line. A list of accepted values is defined in the lookup type ORA_DOO_TP_STATUS.
TransportationPlanningOrder: string

Read Only: true

Maximum Length: 255

Transportation order number from transportation planning application that processed the fulfillment line.
UnderFulfillmentTolerance: number

Read Only: true

Percent of quantity that can be fulfilled below the ordered quantity.
UnitListPrice: number

Title: Unit List Price

Selling price for each unit of the item before applying discounts.
UnitQuantity: number

Number of units for the item.
UnitSellingPrice: number

Title: Unit Selling Price

Price that the buyer pays for one unit of the item.
UnreferencedReturnFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the returned order line does not include a reference order. If false, then the returned order line includes a reference order. The default value is set by the application. This attribute is read-only.
UserDefinedFiscalClass: string

Maximum Length: 30

Tax classification that the user defines.
UserDefinedFiscalClassName: string

Maximum Length: 255

Name of the tax classification that the user defines.
ValidConfigurationFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the configured item is valid. If false, then the configured item is not valid. The default value is set only for root lines based on configuration validation. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "InvoiceableItemFlag":{
            "title":"Billable",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the fulfillment line includes the item that the application enabled for billing or invoicing. If false, then the fulfillment line does not include this item. The default value is set based on the item setup. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShipSetName":{
            "title":"Shipment Set",
            "maxLength":50,
            "type":"string",
            "description":"Group of order lines in the sales order that must ship together from one location to one destination, and that use the same scheduled ship date.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShippingInstructions":{
            "title":"Shipping Instructions",
            "maxLength":1000,
            "type":"string",
            "description":"Detailed instructions about cargo and other requirements for shipping.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationState":{
            "maxLength":255,
            "type":"string",
            "description":"State of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IntendedUseClassificationName":{
            "maxLength":255,
            "type":"string",
            "description":"Classification name for the intended use of the item. For tax calculation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EndReason":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the reason for ending or closing the subscription. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DestinationShippingOrganizationId":{
            "type":"integer",
            "description":"Value that identifies the destination organization where the application ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "RequiredFulfillmentDate":{
            "type":"string",
            "description":"Date when the customer requires fulfillment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceTransactionSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"Source application that placed the request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OverFulfillmentTolerance":{
            "type":"number",
            "description":"Percent of quantity that can be fulfilled above the ordered quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EstimateFulfillmentCost":{
            "type":"number",
            "description":"Estimated cost to deliver the fulfillment line to the customer. This value includes item cost and shipping cost.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PurchasingUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that procurement set on the purchase order for the supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DemandSourceLineReference":{
            "maxLength":400,
            "type":"string",
            "description":"Value that uniquely identifies demand, such as the order line in a shopping cart on a web store or in an ecommerce application. For example, you create a sales order in a web store. Then the web store sends a request to Oracle Fusion Cloud Global Order Promising to schedule it. Oracle Global Order Promising schedules the demand and sends a reply to the web store. The web store then sends the sales order to Oracle Fusion Cloud Order Management. Finally, Oracle Order Management manages the order through fulfilment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the order line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierProvince":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "coveredProductReferences":{
            "title":"Covered Items",
            "type":"array",
            "description":"The Covered Items resource manages details about each covered item that a coverage item covers on an order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-coveredProductReferences-item-response"
            },
            "x-cardinality":"1"
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the order line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OrderedUOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the ordered quantity.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UserDefinedFiscalClass":{
            "maxLength":30,
            "type":"string",
            "description":"Tax classification that the user defines.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProductType":{
            "maxLength":240,
            "type":"string",
            "description":"Type of item classification in Oracle Fusion Tax. The value of the item type specifies whether the transaction line is for an item or service, or whether it is a memo line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ConfigTradeComplianceResult":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the result of trade compliance screening for the configured item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PricedOn":{
            "type":"string",
            "description":"Date when pricing priced the order line. The application sets this date to the system date when pricing begins pricing the order line.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "QuantityForEachModel":{
            "type":"number",
            "description":"Quantity for a configure option on a single configured item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReturnReasonCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the reason to return an item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShippingModeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CoveredCustomerProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer item that the coverage item covers.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierCity":{
            "maxLength":255,
            "type":"string",
            "description":"City of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProductTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item classification in Oracle Fusion Tax. The value of the item type specifies whether the transaction line is for an item or service, or whether it is a memo line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceTransactionNumber":{
            "title":"Source Order",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the transaction in the source application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ConfiguratorPath":{
            "maxLength":2000,
            "type":"string",
            "description":"Path that identifies the inventory item for the configure option. Path format is \".\", separated by inventory item identifier. The format uses [<instance number>] to specify configure options that occur in more than one instance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShippedUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The Charges resource manages price details for the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-item-response"
            }
        },
        "DefaultTaxationCountry":{
            "maxLength":2,
            "type":"string",
            "description":"Country that the tax authority uses to calculate tax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaxExemptFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Abbreviation that identifies the tax exemption. This attribute is not currently used.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AgreementVersionNumber":{
            "type":"integer",
            "description":"Version number of the sales agreement on the order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ExemptionCertificateNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Certification number that the taxing authority provides for tax exemption for each customer who is eligible for tax exemption.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "priceValidations":{
            "title":"Price Validations",
            "type":"array",
            "description":"The Price Validations resource manages price validations and price violations that occur when pricing prices a sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-priceValidations-item-response"
            }
        },
        "CancelReasonCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"Login that user who most recently updated the order line used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ContractStartDate":{
            "type":"string",
            "description":"Start date of the contract.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaxExemptReasonCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the tax exemption.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaxInvoiceDate":{
            "type":"string",
            "description":"Tax invoice date that tax reporting uses depending on the requirements of different countries.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages attachments for the order header and order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-attachments-item-response"
            }
        },
        "InventoryOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "lineDetails":{
            "title":"Line Details",
            "type":"array",
            "description":"The Line Details resource manages shipping and billing details for the order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-lineDetails-item-response"
            }
        },
        "lotSerials":{
            "title":"Lot Serials",
            "type":"array",
            "description":"The Lot Serials resource manages the lot serial details for returns and inventory transaction order lines.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-lotSerials-item-response"
            }
        },
        "FinalDischargeLocationAddressPostalCode":{
            "type":"string",
            "description":"Postal code of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierSiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier site for the purchase order. Interface tables don't currently support this column. So, this attribute can't be used when the REST service is used for file-based data import (FBDI). It can be used only when the REST service is directly invoked.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OverrideScheduleDateFlag":{
            "title":"Override Schedule",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user can manually override the schedule date. If false, then user cannot override. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShipmentPriorityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CustomerPONumber":{
            "title":"Customer PO",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the purchase order that the application uses to request that the seller supply the item or service in return for payment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "manualPriceAdjustments":{
            "title":"Manual Price Adjustments",
            "type":"array",
            "description":"The Manual Price Adjustments resource manages manual price adjustments that the Order Entry Specialist applies for each order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-manualPriceAdjustments-item-response"
            }
        },
        "ConfigHeaderId":{
            "type":"integer",
            "description":"Value that identifies the order header of the sales order that contains the configured item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "SourceTransactionRevisionNumber":{
            "type":"integer",
            "description":"Revision number of the transaction in the source application.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "priceAdjustments":{
            "title":"Price Adjustments",
            "type":"array",
            "description":"The Price Adjustments resource manages price adjustments, such as discounts.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-priceAdjustments-item-response"
            }
        },
        "ServiceDurationPeriodName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the unit of measure for the coverage item or subscription item on the fulfillment line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Supplier site for the purchase order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "renewSubscriptionReference":{
            "title":"Renew Subscription References",
            "type":"array",
            "description":"The Renew Subscription References resource manages details about unique reference to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_RENEW, this information is used for associating the old subscription line in Subscription Management that is replaced by the renewed subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-renewSubscriptionReference-item-response"
            },
            "x-cardinality":"1"
        },
        "AgreementNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the sales agreement on the order line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BuyerMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the buyer for the item on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TransactionCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies whether the line is a return. Values include RETURN or ORDER.",
            "nullable":false,
            "default":"ORDER",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContractEndDate":{
            "type":"string",
            "description":"End date of the contract, according to the start date and duration. You can use Manage Time Units Mappings to map time units to the units of measure that the application uses.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShowInSales":{
            "type":"integer",
            "description":"Specifies how to display a configured item on the Sales Summary page and on the Configurator summary page. You can set this attribute to one of the following values. Yes: display the configured item, but do not display the configure options. This is the default value. Hide Self: display the configure options, but do not display the configured item. Hide Self and Descendants: do not display the configured item or the configure options. You define this attribute for the configure options in Oracle Product Lifecycle Management Cloud. This attribute controls only the display. It does not filter items from the configurator.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":9
            }
        },
        "CustomerProductDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the customer item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShippedQuantity":{
            "title":"Shipment Quantity",
            "type":"number",
            "description":"Quantity of the item on the order line that shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JeopardyPriorityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the priority for the jeopardy score of order line. A list of possible values is defined in the lookup type DOO_JEOPARDY_PRIORITY_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OriginalProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item that the fulfillment line contained before the application substituted the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ShippingServiceLevelCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProductCategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Classifies the item for tax. Order management uses this attribute when you do not install Oracle Fusion Inventory in your deployment, or when you installed it but you do not use it to classify items for tax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "subscriptionTerm":{
            "title":"Subscription Terms",
            "type":"array",
            "description":"The Subscription Terms resource manages details about pricing term definitions for subscriptions. When the pricing term is enabled, subscription generates the billing schedule for the duration of the pricing term, for both evergreen and termed lines based of the pricing method. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-subscriptionTerm-item-response"
            },
            "x-cardinality":"1"
        },
        "OrchestrationProcessName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the orchestration process to assign to the line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the subscription ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShippedUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShippingCarrier":{
            "maxLength":255,
            "type":"string",
            "description":"Carrier who delivers the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaxExempt":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies whether the fulfillment line is exempt from tax.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ItemTypeCode":{
            "title":"Item Type",
            "maxLength":30,
            "type":"string",
            "description":"Group items according attributes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "amendSubscriptionReferences":{
            "title":"Amend Subscription References",
            "type":"array",
            "description":"The Amend Subscription References resource manages details about unique references to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_AMEND, this information is used for ending the old subscription lines in Subscription Management that are replaced by the new subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-amendSubscriptionReferences-item-response"
            }
        },
        "ServiceDuration":{
            "type":"number",
            "description":"Duration for the coverage item or subscription item on the fulfillment line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "holds":{
            "title":"Holds",
            "type":"array",
            "description":"The Holds resource manages active and released holds on the order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-holds-item-response"
            }
        },
        "ConfigRevisionNumber":{
            "type":"integer",
            "description":"Revision number of the configured item. The configurator sets the value of this attribute to the configured item. It does not set it to a configure option.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the order line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecondaryUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Secondary unit of measure for the ordered quantity on the fulfillment line. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FulfillmentMode":{
            "maxLength":30,
            "type":"string",
            "description":"Fulfillment mode, such as regular, dropship, or back-to-back.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "project":{
            "title":"Projects",
            "type":"array",
            "description":"The Projects resource manages the project details of a sales order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-project-item-response"
            }
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "FulfillmentDate":{
            "title":"Actual Fulfillment Date",
            "type":"string",
            "description":"Date when the application fulfills the order line. Fulfillment includes item shipped, hardware installed, and so on.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequisitionInventoryOrganizationId":{
            "type":"integer",
            "description":"Value that identifies the requisition organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the fulfillment line.",
            "nullable":false,
            "readOnly":true,
            "default":"CREATED",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BillingTransactionTypeId":{
            "type":"integer",
            "description":"Value that identifies the billing type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationShippingOrganizationName":{
            "type":"string",
            "description":"Name of the destination organization where the application ships the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubscriptionProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subscription profile. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "RatePlanDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the JSON document for a rate plan in Oracle Fusion Pricing Cloud.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "UnitListPrice":{
            "title":"Unit List Price",
            "type":"number",
            "description":"Selling price for each unit of the item before applying discounts.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EndCreditMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the credit method used for ending or closing the subscription. A list of accepted values is defined in the lookup type ORA_OSS_CLOSE_CREDIT_METHOD. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where the application assigns the item. The application also uses this value for the item validation organization when the customer places the sales order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "CoveredProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item that the coverage item covers.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryInterfacedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then Oracle Order Management Cloud successfully interfaced the fulfillment line to Oracle Inventory Management Cloud. If false, then Order Management didn???t interface the fulfillment line. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShippingMode":{
            "maxLength":255,
            "type":"string",
            "description":"Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceTransactionScheduleId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShippingCarrierId":{
            "type":"integer",
            "description":"Abbreviation that identifies the carrier who delivers the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":255
            }
        },
        "TradeComplianceResultCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the result of trade compliance screening.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DemandSourceScheduledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"This attribute applies to a transaction that starts in a web store or ecommerce store. It contains the values Y or N. If Y, Oracle Fusion Cloud Order Management creates a sales order and sends DEMAND_SOURCE_LINE_REFERENCE to Oracle Fusion Cloud Global Order Promising. When Oracle Global Order Promising successfully schedules the demand, Oracle Order Management receives a response from Oracle Global Order Promising and then sets DEMAND_SOURCE_SCHEDULED_FLAG to Y. It does this during the first scheduling interaction that it has with Oracle Global Order Promising. You can???t modify the value for DEMAND_SOURCE_SCHEDULED_FLAG after it contains Y. If N, Oracle Global Order Promising doesn???t successfully schedule the demand, or the line doesn???t contain DEMAND_SOURCE_LINE_REFERENCE.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LatestAcceptableShipDate":{
            "title":"Latest Acceptable Ship Date",
            "type":"string",
            "description":"Latest date when the customer is willing to allow the warehouse to ship the item.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OriginalProductNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the inventory item that the fulfillment line contained before the application substituted the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TransportationPlanningOrder":{
            "maxLength":255,
            "type":"string",
            "description":"Transportation order number from transportation planning application that processed the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AccountingRule":{
            "maxLength":255,
            "type":"string",
            "description":"Accounting rule that determines the accounting timeframe or timeframes to use when distributing revenue for an invoice line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "additionalInformation":{
            "title":"Details",
            "type":"array",
            "description":"The Additional Details resource manages details that flexfields store for the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-additionalInformation-item-response"
            },
            "x-cardinality":"1"
        },
        "AssetTrackedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Abbreviation that identifies whether the fulfill line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ItemSubTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Subgroup for ITEM_TYPE_CODE. It provides details for each configured item or service, such as assemble-to-order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AssetTrackingCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that identifies whether the fulfill line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. A list of accepted values is defined in the lookup type ORA_EGP_ASSET_TRACKING.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that identifies the business unit for the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "InvoicingRuleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies invoicing rules that determine when to recognize a receivable for invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CoveredCustomerProductNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the customer item that the coverage item covers.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaxInvoiceNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Invoice number that tax reporting uses depending on the requirements of different countries.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "channelPrograms":{
            "title":"Channel Programs",
            "type":"array",
            "description":"The Channel Programs resource manages the channel programs of a sales order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-channelPrograms-item-response"
            }
        },
        "BuyerLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the buyer for the item on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SplitFromFlineId":{
            "type":"integer",
            "description":"Reference to the fulfillment line that exists before the fulfillment line split.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "RequestedRatePlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions and Rate Usage With Events features.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "RequestedRatePlanName":{
            "type":"string",
            "description":"Name of the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestedFulfillmentOrganizationAddress3":{
            "maxLength":255,
            "type":"string",
            "description":"Third address line of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CustomerPOScheduleNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the schedule for the shipment that ships the purchase order. This is an optional attribute that the user can specify when submitting the sales order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationAddress4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth address line of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationPostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Supplier for the purchase order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationAddress1":{
            "maxLength":255,
            "type":"string",
            "description":"First address line of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationAddress2":{
            "maxLength":255,
            "type":"string",
            "description":"Second address line of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CustomerProductNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the customer item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UnreferencedReturnFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the returned order line does not include a reference order. If false, then the returned order line includes a reference order. The default value is set by the application. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProductCategory":{
            "maxLength":240,
            "type":"string",
            "description":"Item classification that the tax authority uses to tax the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaxClassificationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies a group of taxes.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssessableValue":{
            "type":"number",
            "description":"Price that a tax authority uses to value, and then tax the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CoveredProductNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the inventory item that the coverage item covers.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TotalContractAmount":{
            "type":"number",
            "description":"Total amount for the contract duration according to the total contract quantity.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationCity":{
            "maxLength":255,
            "type":"string",
            "description":"City of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecondaryShippedQuantity":{
            "type":"number",
            "description":"Shipped quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SalesProductType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the sales type of the item on the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PurchasingUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure that procurement set on the purchase order for the supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TransactionLineTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RatePlanNumber":{
            "type":"string",
            "description":"Number that identifies a rate plan in Oracle Fusion Pricing Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PaymentTerms":{
            "maxLength":255,
            "type":"string",
            "description":"Payment terms to use to collect payment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the physical or logical location of the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OnHoldFlag":{
            "title":"On Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then fulfillment lines will accept more processing. If false, then fulfillment lines will not accept more processing. The default value is false. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ItemSubType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item sub type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SalesProductTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Sales type of the item on the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "associatedProductReferences":{
            "title":"Associated Product Items",
            "type":"array",
            "description":"The Associated Product Items resource manages details about the product item that is associated with the subscription item on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-associatedProductReferences-item-response"
            }
        },
        "originalOrderReference":{
            "title":"Original Orders",
            "type":"array",
            "description":"The Original Orders resource manages the original order for a return sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-originalOrderReference-item-response"
            },
            "x-cardinality":"1"
        },
        "ValidConfigurationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the configured item is valid. If false, then the configured item is not valid. The default value is set only for root lines based on configuration validation. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceTransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CanceledFlag":{
            "title":"Canceled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application canceled the sales order line. If false, then not canceled. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriceUsingSecondaryUOMFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then Oracle Order Management Cloud uses the secondary ordered quantity and the secondary unit of measure to price the order line. If false or empty, then Order Management uses the ordered quantity and the ordered unit of measure to price the order line. This attribute does not have a default value. This attribute is read-only. If the item is dual-UOM controlled, then the value of this attribute will be either true or false depending upon the pricing measure setup for the item in Oracle Product Lifecycle Management Cloud. If the item is not dual-UOM controlled, then the value of this attribute will be NULL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PurchasingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the purchase order can include the item on the fulfillment line. If false, then the purchase order cannot include the item on the fulfillment line. The default value is set based on the item setup. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Date when the application fulfilled the fulfillment line.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContractStartDateTime":{
            "type":"string",
            "description":"Date and time when the contract is effective.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FinalDischargeLocationAddressCity":{
            "type":"string",
            "description":"City of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "billingPlans":{
            "title":"Billing Plans",
            "type":"array",
            "description":"The Billing Plans resource manages the billing plan for the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-billingPlans-item-response"
            }
        },
        "TransformFromLineId":{
            "type":"integer",
            "description":"Value that identifies order line received from order capture application from which this particular line id is derived.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationLocationId":{
            "type":"integer",
            "description":"Value that identifies the destination location where the application ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "InventoryOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization where the application assigns the item. The application also uses this value for the item validation organization when the customer places the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequisitionBusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the requisition business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AgreementLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the sales agreement line on the order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InvoiceInterfacedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application sent the order line to the billing system. If false, then the application did not send the order line to the billing application. The default value is false. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProductFiscalCategory":{
            "maxLength":255,
            "type":"string",
            "description":"Tax classification of the item that the tax authority uses to tax the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ScheduleArrivalDate":{
            "title":"Scheduled Arrival Date",
            "type":"string",
            "description":"Date when the application scheduled the shipment to arrive.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UnitQuantity":{
            "type":"number",
            "description":"Number of units for the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequisitionBusinessUnitId":{
            "type":"integer",
            "description":"Value that identifies the requisition business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "SchedulingReason":{
            "type":"string",
            "description":"Value of the scheduling reason.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubstitutionAllowedFlag":{
            "title":"Allow Item Substitution",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the application to substitute an item on the fulfillment line for some reason, such as shortage of material or goodwill gesture to the customer. If false, then do not allow the application to substitute. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TotalContractQuantity":{
            "type":"number",
            "description":"Total quantity for the contract duration including the number of timeframes for recurring billing.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ParentSourceTransactionLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the parent transaction line from the source application. This value describes the transaction line hierarchy for a configured item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TransactionBusinessCategory":{
            "maxLength":240,
            "type":"string",
            "description":"Tax classification that the tax authority requires.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "internalOrderReference":{
            "title":"Internal Sales Orders",
            "type":"array",
            "description":"The Internal Sales Orders resource manages sales orders that are internal to order management.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-internalOrderReference-item-response"
            },
            "x-cardinality":"1"
        },
        "IntendedUseClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies intended use of the item. For tax calculation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "CoveredCustomerProductDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the customer item that the coverage item covers.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierCounty":{
            "maxLength":255,
            "type":"string",
            "description":"County of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UserDefinedFiscalClassName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the tax classification that the user defines.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProductDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item that the application fulfills.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreditCheckAuthorizationNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the approved credit authorization that the credit management system created on the authorized amount for the customer account. This attribute applies on credit checks only for authorization or reauthorization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceScheduleNumber":{
            "title":"Source Schedule Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that the source application assigns for the schedule, shipment, or subline.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the order line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedArrivalDate":{
            "title":"Requested Arrival Date",
            "type":"string",
            "description":"Original date when the customer requested for the item to arrive.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ComponentIdPath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the path from the inventory item to the parent of this configured item on the order line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubstitutionReasonCode":{
            "title":"Substitution Reason",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that describes why the application substituted the item on the fulfillment line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SellingProfitCenterBusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the selling profit center business unit.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubscriptionProfileName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the subscription profile. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TradeComplianceResult":{
            "maxLength":255,
            "type":"string",
            "description":"Result of the trade compliance screening for the order lines.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReceivablesOrgId":{
            "type":"integer",
            "description":"Receivables business unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "TaxExemptReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for the tax exemption.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ExtendedAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"Monetary amount of the order line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JeopardyPriority":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the priority for the jeopardy score of order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationCounty":{
            "maxLength":255,
            "type":"string",
            "description":"County of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UnderFulfillmentTolerance":{
            "type":"number",
            "description":"Percent of quantity that can be fulfilled below the ordered quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ThirdPartyTaxRegistrationNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Customer registration number that the customer specifies in the purchase order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OriginalProductDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the inventory item that the fulfillment line contained before the application substituted the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedCancelDate":{
            "type":"string",
            "description":"Date when the customer canceled the order line.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EndCreditMethod":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the credit method used for ending or closing the subscription. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales agreement line on the order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales agreement on the order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the order line qualifies for billing. If false, then the order line does not qualify for billing. The default value is set based on the item setup. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AppliedPriceListName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price list that pricing applied.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequisitionInventoryOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the requisition organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FinalDischargeLocationAddressLine3":{
            "type":"string",
            "description":"Third line of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssetGroupNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Value that groups customer assets into different categories.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FinalDischargeLocationAddressLine4":{
            "type":"string",
            "description":"Fourth line of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FinalDischargeLocationAddressLine1":{
            "type":"string",
            "description":"First line of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DefaultTaxationCountryShortName":{
            "maxLength":255,
            "type":"string",
            "description":"Short name of the country that the tax authority uses to calculate tax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FinalDischargeLocationAddressLine2":{
            "type":"string",
            "description":"Second line of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ExternalPriceBookName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the price book or price list in the external pricing application. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ServiceCancelDate":{
            "type":"string",
            "description":"Date when the customer canceled the coverage item or subscription item on the fulfillment line.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecondaryRMADeliveredQuantity":{
            "type":"number",
            "description":"Delivered quantity on the fulfillment line for the returned item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TransactionBusinessCategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the tax classification that the tax authority requires.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustomerPOLineNumber":{
            "title":"Customer PO Line",
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the purchase order line. The purchase order line describes the item or service, and it includes the price and quantity ordered.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FulfillmentSplitReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source fulfillment line when the fulfillment line splits.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "billToCustomer":{
            "title":"Bill-to Customers",
            "type":"array",
            "description":"The Bill-to Customers resource manages the bill-to customer that the sales order header references.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-billToCustomer-item-response"
            },
            "x-cardinality":"1"
        },
        "supplyOrderReference":{
            "title":"Supply Orders",
            "type":"array",
            "description":"The Supply Orders resource manages the supply that order management uses to supply the item.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-supplyOrderReference-item-response"
            },
            "x-cardinality":"1"
        },
        "ScheduleShipDate":{
            "title":"Scheduled Ship Date",
            "type":"string",
            "description":"Date when the application scheduled the shipment to ship.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ServiceDurationPeriodCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the coverage item or subscription item on the fulfillment line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ParentFulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent fulfillment line. This value describes the fulfillment line hierarchy for a configured item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason that the customer provided to return the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SupplierState":{
            "maxLength":255,
            "type":"string",
            "description":"State of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DestinationShippingOrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the destination organization where the application ships the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RootParentFulfillLineId":{
            "type":"integer",
            "description":"Description of the fulfillment line hierarchy for a configured item. It identifies the highest fulfillment line in the hierarchy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionLineType":{
            "maxLength":255,
            "type":"string",
            "description":"Defines behavior for the fulfillment line. For example, required values, default values, display values, and so on.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GopReferenceId":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the cross-reference to the recommendation that global order promising creates for the split fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ConfigCreationDate":{
            "type":"string",
            "description":"Date when the user created the configured item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "dropShipRequisitionReference":{
            "title":"Drop Ship Requisitions",
            "type":"array",
            "description":"The Drop Ship Requisitions resource manages the requisition when order management uses drop ship to ship the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-dropShipRequisitionReference-item-response"
            },
            "x-cardinality":"1"
        },
        "payments":{
            "title":"Payments",
            "type":"array",
            "description":"The Payments resource manages payment details of the order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-payments-item-response"
            }
        },
        "ConfigTradeComplianceResultCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the result of trade compliance screening for the configured item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestedFulfillmentOrganizationProvince":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OpenFlag":{
            "title":"Open",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then status of the fulfillment line is not closed. If false, then status of the fulfillment line is closed. The default value is true. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationCountry":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the fulfillment organization from where the product was shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Orchestration Order Line",
            "type":"integer",
            "description":"Number that identifies the order line.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "includeInCompactView":true,
                "precision":9
            },
            "x-queryable":true
        },
        "SchedulingReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the scheduling reason.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"User who is responsible for the order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "OrigSystemDocumentReference":{
            "maxLength":50,
            "type":"string",
            "description":"Original document reference of the source order in the source application.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "BuyerFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the buyer for the item on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that identifies the primary salesperson.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "shipToCustomer":{
            "title":"Ship-to Customers",
            "type":"array",
            "description":"The Ship-to Customers resource manages the ship-to customer that the sales order header references.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-shipToCustomer-item-response"
            },
            "x-cardinality":"1"
        },
        "CustomerProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ShippingServiceLevel":{
            "maxLength":255,
            "type":"string",
            "description":"Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "coveredAssetReference":{
            "title":"Covered Assets",
            "type":"array",
            "description":"The Covered Assets resource manages details about Asset that a coverage item covers. This is available for use with the Integrate Order Management with Subscription Management to Process Coverages feature.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-coveredAssetReference-item-response"
            },
            "x-cardinality":"1"
        },
        "CreditCheckAuthExpiryDate":{
            "type":"string",
            "description":"Date when the approved credit authorization expires.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "transactionItemAttributes":{
            "title":"Transaction Item Attributes",
            "type":"array",
            "description":"The Transaction Item Attributes resource manages transaction item attributes for each item on each order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-transactionItemAttributes-item-response"
            }
        },
        "ActualShipDate":{
            "title":"Actual Ship Date",
            "type":"string",
            "description":"Date when the application sent the shipment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":255,
            "type":"string",
            "description":"Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PackingInstructions":{
            "title":"Packing Instructions",
            "maxLength":1000,
            "type":"string",
            "description":"Document that contains packing details for the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PromiseArrivalDate":{
            "title":"Promised Arrival Date",
            "type":"string",
            "description":"Date when global order promising promised to the customer that the item will arrive.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CoveredProductDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the inventory item that the coverage item covers.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "externalAssetReference":{
            "title":"External Asset References",
            "type":"array",
            "description":"The External Asset References resource manages details about asset keys from an external application that are associated with subscription items on an order line when ActionTypeCode is null or ORA_ADD. The External Asset References resource also manages details about unique references to the subscription product in Oracle Subscription Management Cloud when ActionTypeCode is ORA_END. When ActionTypeCode is ORA_END, this information is used for ending the subscription in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-externalAssetReference-item-response"
            },
            "x-cardinality":"1"
        },
        "OrderedQuantity":{
            "title":"Ordered Quantity",
            "type":"number",
            "description":"Quantity of the item or service on the fulfillment line.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AccountingRuleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the accounting rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RatePlanName":{
            "type":"string",
            "description":"Name of the rate plan in Oracle Fusion Pricing Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestedShipDate":{
            "title":"Requested Ship Date",
            "type":"string",
            "description":"Original date when the customer requested for the item to ship.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReturnableFlag":{
            "title":"Return Allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application can return the item to the supplier. If false, then the application cannot return the item to the supplier. The default value is set based on the item setup. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceTransactionLineId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction line from the source application.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FreightTerms":{
            "maxLength":255,
            "type":"string",
            "description":"Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FinalDischargeLocationAddressProvince":{
            "type":"string",
            "description":"Province of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "externalFulfillmentSalesOrderReference":{
            "title":"Fulfillment Orders",
            "type":"array",
            "description":"The Fulfillment Orders resource manages the fulfillment order in the fulfillment system that fulfills the sales order that order management submitted to the fulfillment system.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-externalFulfillmentSalesOrderReference-item-response"
            },
            "x-cardinality":"1"
        },
        "ContractEndDateTime":{
            "type":"string",
            "description":"Date and time when the contract will end, according to the contract start date and time and duration. Review and update the value to map time units to the units of measure that the application uses using the Setup and Maintenance work area, and the Manage Time Units Mappings task.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "assetTransactionDetails":{
            "title":"Asset Transaction Details",
            "type":"array",
            "description":"The Asset Transaction Details resource manages the asset transaction details to support license migration orders. This resource is not currently used.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-assetTransactionDetails-item-response"
            }
        },
        "GopRequestRegion":{
            "maxLength":255,
            "type":"string",
            "description":"Region details for the promising request that global order promising provides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceTransactionLineNumber":{
            "title":"Source Order Line",
            "maxLength":100,
            "type":"string",
            "description":"Number of the transaction line from the source application.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the type of the action with respect to the coverage or the subscription product on fulfillment line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FulfilledQuantity":{
            "title":"Fulfilled Quantity",
            "type":"number",
            "description":"Quantity the application uses to fulfill the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FinalDischargeLocationAddressState":{
            "type":"string",
            "description":"State of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TransportationPlannedStatusCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that indicates that a transportation planning application plans the fulfillment line. A list of accepted values is defined in the lookup type ORA_DOO_TP_STATUS.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShippableFlag":{
            "title":"Shippable",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application can ship the order line to the customer. For example, the application can typically ship a computer, but cannot typically ship a service. If false, then the application cannot ship the order line. The default value is set based on the item setup. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TradeComplianceDate":{
            "type":"string",
            "description":"Most recent date when the application screened the order line for trade compliance.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedRatePlanNumber":{
            "type":"string",
            "description":"Number that identifies the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions and Rate Usage With Events features.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProcessNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the orchestration process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SupplierAddress4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth address line of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OrigSystemDocumentLineReference":{
            "maxLength":50,
            "type":"string",
            "description":"Original document reference of the order line in the source application.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BuyerName":{
            "maxLength":255,
            "type":"string",
            "description":"Full name of the buyer for the item on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierAddress1":{
            "maxLength":255,
            "type":"string",
            "description":"First address line of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierAddress3":{
            "maxLength":255,
            "type":"string",
            "description":"Third address line of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierAddress2":{
            "maxLength":255,
            "type":"string",
            "description":"Second address line of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReceivablesOrgName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the receivables business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryTransactionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then Oracle Order Management Cloud sends a request to Oracle Inventory Management Cloud to perform an inventory transaction when fulfilling the order line instead of using the pick wave, pick, pack, and ship flow. If false, then Order Management uses the pick wave, pick, pack, and ship flow to fulfill the order line. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FirstPartyTaxRegistrationNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies registration number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestingBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "RemnantFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application partially fulfilled a configured item. If false, then the application did not partially fulfill a configured item. The default value is false. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProductNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Stock keeping unit for the item that the application fulfills.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IntegrateSubscriptionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true then Oracle Fusion Cloud Order Management sends the fulfillment line to Oracle Fusion Cloud Subscription Management. If false then it doesn't. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FOBPoint":{
            "maxLength":255,
            "type":"string",
            "description":"Freight on board. Identifies ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ConfigInventoryItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Item description of the shippable assemble-to-order (ATO) configuration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RatePlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies a rate plan in Oracle Fusion Pricing Cloud.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "PromiseShipDate":{
            "title":"Promised Ship Date",
            "type":"string",
            "description":"Date when global order promising promised to the customer that the item will ship.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OrderedUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the ordered quantity. For example, length, time, heat, value, and so on.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CancelReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PartialShipAllowedFlag":{
            "title":"Allow Split Shipments",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then ship items in the sales order in more than one shipment. If false, then ship items in the sales order in one shipment. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EndReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for ending or closing the subscription. A list of accepted values is defined in the lookup type ORA_OSS_CLOSE_REASONS. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CanceledQuantity":{
            "title":"Canceled Quantity",
            "type":"number",
            "description":"Canceled quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SupplierCountry":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InvoicingRule":{
            "maxLength":255,
            "type":"string",
            "description":"Invoicing rule that determines when to recognize a receivable for invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FulfillLineNumber":{
            "title":"Fulfillment Line",
            "maxLength":9,
            "type":"string",
            "description":"Numerical value for the fulfillment line. The default value is 1. It increments in integers when the fulfillment line splits.",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of action with respect to the coverage or the subscription product on fulfillment line. Say Add, Update, Renew in case of  coverage. Resume, Suspend, terminate in case of subscriptions. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaxExemptCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that identifies whether the fulfillment line is exempt from tax. Valid values include S and E. If S, then calculate standard tax. If E, then exempt from tax. A list of accepted values is defined in the lookup type ZX_EXEMPTION_CONTROL.",
            "nullable":true,
            "default":"S",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequisitionInventoryOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the requisition organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FinalDischargeLocationAddressCounty":{
            "type":"string",
            "description":"County of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecondaryOrderedQuantity":{
            "type":"number",
            "description":"Ordered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReservableFlag":{
            "title":"Reservable",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application can reserve the item on the fulfillment line. If false, then the application cannot reserve. The default value is set based on the item setup. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaxClassification":{
            "maxLength":255,
            "type":"string",
            "description":"Group of taxes for reporting and processing.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Salesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Person who is responsible for the sale of the sales order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentSubtype":{
            "maxLength":240,
            "type":"string",
            "description":"Tax classification for tax reporting. This attribute depends on the requirements for each country.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ThirdPartyTaxRegistration":{
            "type":"integer",
            "description":"Registration number that the customer specifies in the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "FOBPointCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "subscriptionReferences":{
            "title":"Subscription Items",
            "type":"array",
            "description":"The Subscription Items resource manages details about subscription items that are associated with product items on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-subscriptionReferences-item-response"
            }
        },
        "AppliedPriceListId":{
            "type":"integer",
            "description":"Value that identifies the price list that pricing applied.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "DocumentSubtypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the tax classification for tax reporting. This attribute depends on the requirements for each country.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header of the sales order that contains the order line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierPostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code of the supplier who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "coverageReferences":{
            "title":"Coverage Items",
            "type":"array",
            "description":"The Coverage Items resource manages details about each coverage item that covers a covered item on an order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-coverageReferences-item-response"
            }
        },
        "ConfigInventoryItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the shippable assemble-to-order (ATO) configuration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EarliestAcceptableShipDate":{
            "title":"Earliest Acceptable Ship Date",
            "type":"string",
            "description":"Earliest date when the customer is willing to receive shipment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReservationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reservation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "BuyerId":{
            "type":"integer",
            "description":"Buyer details for a schedule. This attribute references the Buyer Public View that the application publishes for the item on the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LatestAcceptableArrivalDate":{
            "title":"Latest Acceptable Arrival Date",
            "type":"string",
            "description":"Latest date when the customer is willing to receive the item.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BillingTransactionTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the billing type.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure for the ordered quantity on the fulfillment line. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FulfillInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment instance that fulfills this fulfillment line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "BusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit for the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TransportationPlannedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the transportation planning system plans the fulfillment line. If false, then the transportation planning system does not plan the fulfillment line. The default value is false.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SellingProfitCenterBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the selling profit center business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ConfigItemReference":{
            "maxLength":1200,
            "type":"string",
            "description":"Reference to the finished configured item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SupplyStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the supply for the fulfillment line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Comments for the order line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EstimateMargin":{
            "type":"number",
            "description":"Estimated margin expected when shipping the fulfillment line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReservedQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Quantity of the item that the application reserved in the warehouse to fulfill the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubstitutionReason":{
            "maxLength":255,
            "type":"string",
            "description":"Describes why the application substituted the item on the fulfillment line.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FinalDischargeLocationId":{
            "type":"integer",
            "description":"Value that identifies the final destination location for the purchase.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ProductFiscalCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tax classification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "FinalDischargeLocationAddressCountry":{
            "type":"string",
            "description":"Country of the final destination location for the purchase.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisplayLineNumber":{
            "type":"string",
            "description":"Number that the order management work area displays to identify the order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PaymentTermsCode":{
            "type":"integer",
            "description":"Abbreviation that identifies payment terms.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":255
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The Sales Credits resource manages sales credits for each salesperson on the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-salesCredits-item-response"
            }
        },
        "RequestingBusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ShipmentPriority":{
            "maxLength":255,
            "type":"string",
            "description":"Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier that the application requested.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RMADeliveredQuantity":{
            "title":"Delivered Quantity",
            "type":"number",
            "description":"Quantity delivered for the receipt line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DemandClassCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FreightTermsCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "POStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the purchase order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":255,
            "type":"string",
            "description":"Physical or logical location of the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FirstPartyTaxRegistration":{
            "type":"integer",
            "description":"Registration number that the application provides to the supplier. The supplier uses this number to tax the transaction.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AssetTracking":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies whether the fulfillment line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ConfigInventoryItemId":{
            "type":"integer",
            "description":"Inventory item for an assemble-to-order, configured item that the application can ship. A contract or a sales agreement is an example of an item that the application cannot ship.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "RatePlanDocument":{
            "type":"string",
            "description":"Rate plan document in JSON format encoded using Base64. The rate plan document will be desupported from release 23C.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryFulfilledQuantity":{
            "type":"number",
            "description":"Quantity on the fulfillment line for the item or service in the secondary unit of measure that the application uses to fulfill the sales order line. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UnitSellingPrice":{
            "title":"Unit Selling Price",
            "type":"number",
            "description":"Price that the buyer pays for one unit of the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "dropShipPurchaseOrderReference":{
            "title":"Drop Ships",
            "type":"array",
            "description":"The Drop Ships resource manages the purchase order when order management uses drop ship to ship the sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-dropShipPurchaseOrderReference-item-response"
            },
            "x-cardinality":"1"
        },
        "SubscriptionInterfacedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the fulfillment line is interfaced to Oracle Subscription Management Cloud. If false, then the fulfillment line isn't interfaced to Subscription Management. The default value is false. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

The Additional Details resource manages details that flexfields store for the sales order.

Show Source

Array of: object Discriminator: Category

Discriminator: { "propertyName":"Category", "mapping":{ "DOO_FULFILL_LINES_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response" } }

{
    "title":"Details",
    "type":"array",
    "description":"The Additional Details resource manages details that flexfields store for the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-additionalInformation-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Amend Subscription References

Type: array

Title: Amend Subscription References

The Amend Subscription References resource manages details about unique references to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_AMEND, this information is used for ending the old subscription lines in Subscription Management that are replaced by the new subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

Array of: object salesOrdersForOrderHub-lines-amendSubscriptionReferences-item-response

{
    "title":"Amend Subscription References",
    "type":"array",
    "description":"The Amend Subscription References resource manages details about unique references to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_AMEND, this information is used for ending the old subscription lines in Subscription Management that are replaced by the new subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-amendSubscriptionReferences-item-response"
    }
}

Nested Schema : Asset Transaction Details

Type: array

Title: Asset Transaction Details

The Asset Transaction Details resource manages the asset transaction details to support license migration orders. This resource is not currently used.

Show Source

Array of: object salesOrdersForOrderHub-lines-assetTransactionDetails-item-response

{
    "title":"Asset Transaction Details",
    "type":"array",
    "description":"The Asset Transaction Details resource manages the asset transaction details to support license migration orders. This resource is not currently used.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-assetTransactionDetails-item-response"
    }
}

Nested Schema : Associated Product Items

Type: array

Title: Associated Product Items

The Associated Product Items resource manages details about the product item that is associated with the subscription item on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

Array of: object salesOrdersForOrderHub-lines-associatedProductReferences-item-response

{
    "title":"Associated Product Items",
    "type":"array",
    "description":"The Associated Product Items resource manages details about the product item that is associated with the subscription item on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-associatedProductReferences-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages attachments for the order header and order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages attachments for the order header and order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-attachments-item-response"
    }
}

Nested Schema : Billing Plans

Type: array

Title: Billing Plans

The Billing Plans resource manages the billing plan for the sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-billingPlans-item-response

{
    "title":"Billing Plans",
    "type":"array",
    "description":"The Billing Plans resource manages the billing plan for the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-billingPlans-item-response"
    }
}

Nested Schema : Bill-to Customers

Type: array

Title: Bill-to Customers

The Bill-to Customers resource manages the bill-to customer that the sales order header references.

Show Source

Array of: object salesOrdersForOrderHub-lines-billToCustomer-item-response

{
    "title":"Bill-to Customers",
    "type":"array",
    "description":"The Bill-to Customers resource manages the bill-to customer that the sales order header references.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-billToCustomer-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Channel Programs

Type: array

Title: Channel Programs

The Channel Programs resource manages the channel programs of a sales order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-channelPrograms-item-response

{
    "title":"Channel Programs",
    "type":"array",
    "description":"The Channel Programs resource manages the channel programs of a sales order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-channelPrograms-item-response"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The Charges resource manages price details for the sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The Charges resource manages price details for the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-item-response"
    }
}

Nested Schema : Coverage Items

Type: array

Title: Coverage Items

The Coverage Items resource manages details about each coverage item that covers a covered item on an order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-coverageReferences-item-response

{
    "title":"Coverage Items",
    "type":"array",
    "description":"The Coverage Items resource manages details about each coverage item that covers a covered item on an order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-coverageReferences-item-response"
    }
}

Nested Schema : Covered Assets

Type: array

Title: Covered Assets

The Covered Assets resource manages details about Asset that a coverage item covers. This is available for use with the Integrate Order Management with Subscription Management to Process Coverages feature.

Show Source

Array of: object salesOrdersForOrderHub-lines-coveredAssetReference-item-response

{
    "title":"Covered Assets",
    "type":"array",
    "description":"The Covered Assets resource manages details about Asset that a coverage item covers. This is available for use with the Integrate Order Management with Subscription Management to Process Coverages feature.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-coveredAssetReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Covered Items

Type: array

Title: Covered Items

The Covered Items resource manages details about each covered item that a coverage item covers on an order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-coveredProductReferences-item-response

{
    "title":"Covered Items",
    "type":"array",
    "description":"The Covered Items resource manages details about each covered item that a coverage item covers on an order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-coveredProductReferences-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Drop Ships

Type: array

Title: Drop Ships

The Drop Ships resource manages the purchase order when order management uses drop ship to ship the sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-dropShipPurchaseOrderReference-item-response

{
    "title":"Drop Ships",
    "type":"array",
    "description":"The Drop Ships resource manages the purchase order when order management uses drop ship to ship the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-dropShipPurchaseOrderReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Drop Ship Requisitions

Type: array

Title: Drop Ship Requisitions

The Drop Ship Requisitions resource manages the requisition when order management uses drop ship to ship the sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-dropShipRequisitionReference-item-response

{
    "title":"Drop Ship Requisitions",
    "type":"array",
    "description":"The Drop Ship Requisitions resource manages the requisition when order management uses drop ship to ship the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-dropShipRequisitionReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : External Asset References

Type: array

Title: External Asset References

The External Asset References resource manages details about asset keys from an external application that are associated with subscription items on an order line when ActionTypeCode is null or ORA_ADD. The External Asset References resource also manages details about unique references to the subscription product in Oracle Subscription Management Cloud when ActionTypeCode is ORA_END. When ActionTypeCode is ORA_END, this information is used for ending the subscription in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

Array of: object salesOrdersForOrderHub-lines-externalAssetReference-item-response

{
    "title":"External Asset References",
    "type":"array",
    "description":"The External Asset References resource manages details about asset keys from an external application that are associated with subscription items on an order line when ActionTypeCode is null or ORA_ADD. The External Asset References resource also manages details about unique references to the subscription product in Oracle Subscription Management Cloud when ActionTypeCode is ORA_END. When ActionTypeCode is ORA_END, this information is used for ending the subscription in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-externalAssetReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Fulfillment Orders

Type: array

Title: Fulfillment Orders

The Fulfillment Orders resource manages the fulfillment order in the fulfillment system that fulfills the sales order that order management submitted to the fulfillment system.

Show Source

Array of: object salesOrdersForOrderHub-lines-externalFulfillmentSalesOrderReference-item-response

{
    "title":"Fulfillment Orders",
    "type":"array",
    "description":"The Fulfillment Orders resource manages the fulfillment order in the fulfillment system that fulfills the sales order that order management submitted to the fulfillment system.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-externalFulfillmentSalesOrderReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Holds

Type: array

Title: Holds

The Holds resource manages active and released holds on the order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-holds-item-response

{
    "title":"Holds",
    "type":"array",
    "description":"The Holds resource manages active and released holds on the order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-holds-item-response"
    }
}

Nested Schema : Internal Sales Orders

Type: array

Title: Internal Sales Orders

The Internal Sales Orders resource manages sales orders that are internal to order management.

Show Source

Array of: object salesOrdersForOrderHub-lines-internalOrderReference-item-response

{
    "title":"Internal Sales Orders",
    "type":"array",
    "description":"The Internal Sales Orders resource manages sales orders that are internal to order management.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-internalOrderReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Line Details

Type: array

Title: Line Details

The Line Details resource manages shipping and billing details for the order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-lineDetails-item-response

{
    "title":"Line Details",
    "type":"array",
    "description":"The Line Details resource manages shipping and billing details for the order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-lineDetails-item-response"
    }
}

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 : Lot Serials

Type: array

Title: Lot Serials

The Lot Serials resource manages the lot serial details for returns and inventory transaction order lines.

Show Source

Array of: object salesOrdersForOrderHub-lines-lotSerials-item-response

{
    "title":"Lot Serials",
    "type":"array",
    "description":"The Lot Serials resource manages the lot serial details for returns and inventory transaction order lines.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-lotSerials-item-response"
    }
}

Nested Schema : Manual Price Adjustments

Type: array

Title: Manual Price Adjustments

The Manual Price Adjustments resource manages manual price adjustments that the Order Entry Specialist applies for each order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-manualPriceAdjustments-item-response

{
    "title":"Manual Price Adjustments",
    "type":"array",
    "description":"The Manual Price Adjustments resource manages manual price adjustments that the Order Entry Specialist applies for each order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-manualPriceAdjustments-item-response"
    }
}

Nested Schema : Original Orders

Type: array

Title: Original Orders

The Original Orders resource manages the original order for a return sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-originalOrderReference-item-response

{
    "title":"Original Orders",
    "type":"array",
    "description":"The Original Orders resource manages the original order for a return sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-originalOrderReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Payments

Type: array

Title: Payments

The Payments resource manages payment details of the order.

Show Source

Array of: object salesOrdersForOrderHub-lines-payments-item-response

{
    "title":"Payments",
    "type":"array",
    "description":"The Payments resource manages payment details of the order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-payments-item-response"
    }
}

Nested Schema : Price Adjustments

Type: array

Title: Price Adjustments

The Price Adjustments resource manages price adjustments, such as discounts.

Show Source

Array of: object salesOrdersForOrderHub-lines-priceAdjustments-item-response

{
    "title":"Price Adjustments",
    "type":"array",
    "description":"The Price Adjustments resource manages price adjustments, such as discounts.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-priceAdjustments-item-response"
    }
}

Nested Schema : Price Validations

Type: array

Title: Price Validations

The Price Validations resource manages price validations and price violations that occur when pricing prices a sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-priceValidations-item-response

{
    "title":"Price Validations",
    "type":"array",
    "description":"The Price Validations resource manages price validations and price violations that occur when pricing prices a sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-priceValidations-item-response"
    }
}

Nested Schema : Projects

Type: array

Title: Projects

The Projects resource manages the project details of a sales order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-project-item-response

{
    "title":"Projects",
    "type":"array",
    "description":"The Projects resource manages the project details of a sales order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-project-item-response"
    }
}

Nested Schema : Renew Subscription References

Type: array

Title: Renew Subscription References

The Renew Subscription References resource manages details about unique reference to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_RENEW, this information is used for associating the old subscription line in Subscription Management that is replaced by the renewed subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

Array of: object salesOrdersForOrderHub-lines-renewSubscriptionReference-item-response

{
    "title":"Renew Subscription References",
    "type":"array",
    "description":"The Renew Subscription References resource manages details about unique reference to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_RENEW, this information is used for associating the old subscription line in Subscription Management that is replaced by the renewed subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-renewSubscriptionReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The Sales Credits resource manages sales credits for each salesperson on the sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-salesCredits-item-response

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The Sales Credits resource manages sales credits for each salesperson on the sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-salesCredits-item-response"
    }
}

Nested Schema : Ship-to Customers

Type: array

Title: Ship-to Customers

The Ship-to Customers resource manages the ship-to customer that the sales order header references.

Show Source

Array of: object salesOrdersForOrderHub-lines-shipToCustomer-item-response

{
    "title":"Ship-to Customers",
    "type":"array",
    "description":"The Ship-to Customers resource manages the ship-to customer that the sales order header references.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-shipToCustomer-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Subscription Items

Type: array

Title: Subscription Items

The Subscription Items resource manages details about subscription items that are associated with product items on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

Array of: object salesOrdersForOrderHub-lines-subscriptionReferences-item-response

{
    "title":"Subscription Items",
    "type":"array",
    "description":"The Subscription Items resource manages details about subscription items that are associated with product items on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-subscriptionReferences-item-response"
    }
}

Nested Schema : Subscription Terms

Type: array

Title: Subscription Terms

The Subscription Terms resource manages details about pricing term definitions for subscriptions. When the pricing term is enabled, subscription generates the billing schedule for the duration of the pricing term, for both evergreen and termed lines based of the pricing method. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

Array of: object salesOrdersForOrderHub-lines-subscriptionTerm-item-response

{
    "title":"Subscription Terms",
    "type":"array",
    "description":"The Subscription Terms resource manages details about pricing term definitions for subscriptions. When the pricing term is enabled, subscription generates the billing schedule for the duration of the pricing term, for both evergreen and termed lines based of the pricing method. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-subscriptionTerm-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Supply Orders

Type: array

Title: Supply Orders

The Supply Orders resource manages the supply that order management uses to supply the item.

Show Source

Array of: object salesOrdersForOrderHub-lines-supplyOrderReference-item-response

{
    "title":"Supply Orders",
    "type":"array",
    "description":"The Supply Orders resource manages the supply that order management uses to supply the item.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-supplyOrderReference-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Transaction Item Attributes

Type: array

Title: Transaction Item Attributes

The Transaction Item Attributes resource manages transaction item attributes for each item on each order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-transactionItemAttributes-item-response

{
    "title":"Transaction Item Attributes",
    "type":"array",
    "description":"The Transaction Item Attributes resource manages transaction item attributes for each item on each order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-transactionItemAttributes-item-response"
    }
}

Nested Schema : Discriminator: Category

Type: object

Discriminator: Category

Discriminator Values

DOO_FULFILL_LINES_ADD_INFO

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_FULFILL_LINES_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response"
        }
    ]
}

Match One Schema

Show Source

DOO_FULFILL_LINES_ADD_INFO - object oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_FULFILL_LINES_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response

Type: object

Show Source

Category: string

Maximum Length: 240

Default Value: DOO_FULFILL_LINES_ADD_INFO

Category of the flexfield.
FulfillLineId: integer (int64)

Value that uniquely identifies the order line that contains the additional information.
HeaderId: integer (int64)

Value that uniquely identifies the sales order that contains the additional information.
links: array Links

Title: Links

The link relations associated with the resource instance.
SourceTransactionLineIdentifier: string

Maximum Length: 255

Value that uniquely identifies the transaction in the source application.
SourceTransactionScheduleIdentifier: string

Maximum Length: 255

Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.
SourceTransactionSystem: string

Maximum Length: 255

Source application that placed the request.

{
    "type":"object",
    "properties":{
        "FulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line that contains the additional information.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Category":{
            "maxLength":240,
            "type":"string",
            "description":"Category of the flexfield.",
            "nullable":true,
            "default":"DOO_FULFILL_LINES_ADD_INFO"
        },
        "SourceTransactionScheduleIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.",
            "nullable":true
        },
        "SourceTransactionSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Source application that placed the request.",
            "nullable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that contains the additional information.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceTransactionLineIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application.",
            "nullable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-amendSubscriptionReferences-item-response

Type: object

Show Source

ExternalAssetKey: string

Maximum Length: 150

Value that identifies the asset key for the subscription or coverage item in an external application.
ExternalParentAssetKey: string

Maximum Length: 150

Value that identifies the parent asset key for the subscription or coverage item in an external application.
ExternalRootParentAssetKey: string

Maximum Length: 150

Value that identifies the root parent asset key for the subscription or coverage item in an external application.
links: array Links

Title: Links

The link relations associated with the resource instance.
SubscriptionProductPuid: string

Maximum Length: 150

Value that uniquely identifies the subscription product in Oracle Subscription Management Cloud.

{
    "type":"object",
    "properties":{
        "ExternalAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalParentAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the parent asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalRootParentAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the root parent asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":150,
            "type":"string",
            "description":"Value that uniquely identifies the subscription product in Oracle Subscription Management Cloud.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-assetTransactionDetails-item-response

Type: object

Show Source

AssetId: integer (int64)

Value that uniquely identifies the asset.
AssetNumber: string

Maximum Length: 80

Number that identifies the asset.
AssetTransactionAction: string

Maximum Length: 80

Name of the transaction that installed base does on the asset.
AssetTransactionActionCode: string

Maximum Length: 30

Abbreviation that identifies the transaction that installed base does on the asset.
AssetTransactionDetailId: integer (int64)

Value that uniquely identifies the asset transaction detail for an order line.
AssetUOM: string

Maximum Length: 25

Unit of measure for the asset quantity.
AssetUOMCode: string

Maximum Length: 3

Abbreviation that identifies the unit of measure for the asset quantity.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the asset transaction detail.
CreationDate: string (date-time)

Read Only: true

Date and time when the user created the asset transaction detail.
CustomerAssetEndDate: string (date-time)

Date and time when the customer asset ends in installed base.
FulfillLineId: integer (int64)

Value that uniquely identifies the order line that contains the asset transaction details.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the user most recently updated the asset transaction detail.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the asset transaction detail.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Login that user used when updating the asset transaction detail.
links: array Links

Title: Links

The link relations associated with the resource instance.
Quantity: number

Quantity of the asset transacted by installed base assets.
SourceAssetTransactionDetailId: string

Maximum Length: 50

Value that uniquely identifies the asset transaction detail for an order line. The source application assigns this value.
Status: string

Maximum Length: 120

Status of the asset after installed base does the transaction on the asset.
StatusCode: string

Maximum Length: 30

Abbreviation that identifies the status of the asset after installed base does the transaction on the asset.
StatusId: integer (int64)

Value that uniquely identifies the status of the asset after installed base does the transaction on the asset.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the asset transaction detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":120,
            "type":"string",
            "description":"Status of the asset after installed base does the transaction on the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the asset transaction detail.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the asset transaction detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetTransactionAction":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the transaction that installed base does on the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the asset transacted by installed base assets.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the asset quantity.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the asset after installed base does the transaction on the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetTransactionActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the transaction that installed base does on the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line that contains the asset transaction details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetTransactionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction detail for an order line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceAssetTransactionDetailId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the asset transaction detail for an order line. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAssetEndDate":{
            "type":"string",
            "description":"Date and time when the customer asset ends in installed base.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssetUOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the asset quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the asset after installed base does the transaction on the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the asset transaction detail.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that user used when updating the asset transaction detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-associatedProductReferences-item-response

Type: object

Show Source

AssociatedProductFulfillLineId: integer

Value that uniquely identifies the fulfillment line of the product item with which the subscription is associated.
AssociatedProductHeaderId: integer

Read Only: true

Value that uniquely identifies the sales order header that contains the product item with which the subscription is associated.
AssociatedProductItemNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the product item with which the subscription is associated.
DisplayLineNumber: string

Read Only: true

Maximum Length: 255

Number that the order management work area displays to identify the order line that contains the product item with which the subscription is associated.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderNumber: string

Read Only: true

Maximum Length: 150

Number that identifies the sales order that contains the associated product item with which the subscription is associated.
SourceLineId: string

Maximum Length: 255

Value that uniquely identifies the source order line from order capture with which the subscription is associated.
SourceLineNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the order line in the source application that contains the associated product item with which the subscription is associated.
SourceOrderId: string

Maximum Length: 255

Value that uniquely identifies the source order from order capture with which the subscription is associated.
SourceOrderNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the source order in the source application that contains the associated product item with which the subscription is associated.
SourceOrderSystem: string

Maximum Length: 255

Value that references the order capture application that the source order came from with which the subscription is associated.

{
    "type":"object",
    "properties":{
        "SourceOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source order in the source application that contains the associated product item with which the subscription is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that the order management work area displays to identify the order line that contains the product item with which the subscription is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssociatedProductFulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line of the product item with which the subscription is associated.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceOrderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the source order from order capture with which the subscription is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that references the order capture application that the source order came from with which the subscription is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociatedProductItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the product item with which the subscription is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedProductHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order header that contains the product item with which the subscription is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the sales order that contains the associated product item with which the subscription is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the source order line from order capture with which the subscription is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the order line in the source application that contains the associated product item with which the subscription is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-attachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

An identifier used for tracking the uploaded files.
AttachedDocumentId: integer (int64)

Title: Attached Document Id

Value that uniquely identifies the attachment.
CategoryName: string

Title: Category

Maximum Length: 30

Name of the attachment category.
ContentRepositoryFileShared: boolean

Title: Shared

Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

User who created the attachment.
CreatedByUserName: string

Title: Created By User Name

Read Only: true

Login that the user used when creating the attachment.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date and time when the user created the attachment.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

Abbreviation that identifies the data type of the attachment.
Description: string

Title: Description

Maximum Length: 255

Description of the attachment.
DmDocumentId: string

Maximum Length: 255

Value that uniquely identifies the attached document.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

Path to the folder that contains the attachment.
DmVersionNumber: string

Maximum Length: 255

Number that identifies the version of the attached document.
DownloadInfo: string

Title: DownloadInfo

JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

Abbreviation that identifies the status of the attachment upload.
ErrorStatusMessage: string

Title: Error Status Message

Error message encountered while uploading attachment.
ExpirationDate: string (date-time)

Title: Expiration Date

Date when the attachment expires.
FileContents: string (byte)

Title: File Contents

Contents of the attachment file.
FileName: string

Title: File Name

Maximum Length: 2048

File name of the attachment.
FileUrl: string

Title: File Url

URL (Uniform Resource Locator) that locates the attachment file.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date and time when the user most recently updated the attachment.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

User who most recently updated the attachment.
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true

Login that the user used when updating the attachment.
links: array Links

Title: Links

The link relations associated with the resource instance.
Title: string

Title: Title

Title of the attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

Type of the attachment file.
UploadedFileLength: integer

Title: File Size

Length of the attachment file.
UploadedFileName: string

Title: Uploaded File Name

Name of the attachment file.
UploadedText: string

Title: Uploaded Text

Text that the attachment contains.
Uri: string

Title: Uri

Maximum Length: 4000

URI (Uniform Resource Identifier) that identifies the attachment file.
Url: string

Title: Url

Maximum Length: 4000

URL (Uniform Resource Locator) that locates the attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

User who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message encountered while uploading attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the status of the attachment upload.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path to the folder that contains the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text that the attachment contains.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : salesOrdersForOrderHub-lines-billingPlans-item-response

Type: object

Show Source

BillingNumberOfPeriods: integer (int32)

Number of timeframes in a recurring invoice.
BillingPeriodEndDate: string (date)

End date of the billing timeframe. The application sets this date to the contract end date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the end date to the billing end date of the subsequent billing timeframe.
BillingPeriodNumber: integer (int32)

Timeframe number for the billing start date, end date, or transaction date.
BillingPeriodStartDate: string (date)

Start date of the billing timeframe. The application sets this date to the contract start date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the start date to the billing start date of the subsequent billing timeframe.
BillingPlanId: integer (int64)

Value that uniquely identifies the billing plan.
BillingPlanType: string

Maximum Length: 80

Name of the billing plan type.
BillingPlanTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of billing plan, such as periodic or milestone.
BillingTransactionDate: string (date)

Date when the first invoice occurs when the sales order uses a recurring invoice. If the invoice covers only part of an invoice timeframe, then this attribute stores the date of the subsequent invoice.
CancellationEffectiveDate: string (date)

Date when recurring billing stops and no future billing occurs.
links: array Links

Title: Links

The link relations associated with the resource instance.
NetBillingAmountForEachPeriod: number

Net amount that the application bills for each billing timeframe.
OverridePeriod: integer (int32)

Timeframe that includes an override amount. For example, the first invoice is for timeframe 1, the second invoice is for timeframe 2, and so on.
OverridePeriodAmount: number

Override amount to apply on the timeframe.
OverridePeriodQuantity: number

Quantity to use when calculating recurring billing or credit for the override timeframe.
Periodicity: string

Maximum Length: 80

Name of the timeframe of the recurring invoice.
PeriodicityCode: string

Maximum Length: 30

Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year.
SourceBillingPlanId: string

Maximum Length: 50

Value that identifies the billing plan. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "BillingPeriodEndDate":{
            "type":"string",
            "description":"End date of the billing timeframe. The application sets this date to the contract end date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the end date to the billing end date of the subsequent billing timeframe.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceBillingPlanId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the billing plan. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "CancellationEffectiveDate":{
            "type":"string",
            "description":"Date when recurring billing stops and no future billing occurs.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "BillingTransactionDate":{
            "type":"string",
            "description":"Date when the first invoice occurs when the sales order uses a recurring invoice. If the invoice covers only part of an invoice timeframe, then this attribute stores the date of the subsequent invoice.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "NetBillingAmountForEachPeriod":{
            "type":"number",
            "description":"Net amount that the application bills for each billing timeframe.",
            "nullable":true,
            "x-queryable":false
        },
        "Periodicity":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the timeframe of the recurring invoice.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingPeriodNumber":{
            "type":"integer",
            "description":"Timeframe number for the billing start date, end date, or transaction date.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "BillingPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the billing plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OverridePeriodAmount":{
            "type":"number",
            "description":"Override amount to apply on the timeframe.",
            "nullable":true,
            "x-queryable":false
        },
        "OverridePeriod":{
            "type":"integer",
            "description":"Timeframe that includes an override amount. For example, the first invoice is for timeframe 1, the second invoice is for timeframe 2, and so on.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year.",
            "nullable":false,
            "x-queryable":false
        },
        "OverridePeriodQuantity":{
            "type":"number",
            "description":"Quantity to use when calculating recurring billing or credit for the override timeframe.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingPeriodStartDate":{
            "type":"string",
            "description":"Start date of the billing timeframe. The application sets this date to the contract start date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the start date to the billing start date of the subsequent billing timeframe.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillingNumberOfPeriods":{
            "type":"integer",
            "description":"Number of timeframes in a recurring invoice.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "BillingPlanTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of billing plan, such as periodic or milestone.",
            "nullable":false,
            "x-queryable":false
        },
        "BillingPlanType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the billing plan type.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-billToCustomer-item-response

Type: object

Show Source

AccountDescription: string

Maximum Length: 255

Description of the account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
AccountNumber: string

Maximum Length: 255

Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
Address1: string

Maximum Length: 255

First line of the bill-to customer address.
Address2: string

Maximum Length: 255

Second line of the bill-to customer address.
Address3: string

Maximum Length: 255

Third line of the bill-to customer address.
Address4: string

Maximum Length: 255

Fourth line of the bill-to customer address.
AddressId: integer (int64)

Value that uniquely identifies the bill-to customer address.
City: string

Maximum Length: 255

City of the bill-to customer address.
ContactFirstName: string

Maximum Length: 255

First name of the person to contact at the bill-to customer site.
ContactId: integer (int64)

Value that uniquely identifies the contact for the billing account.
ContactLastName: string

Maximum Length: 255

Last name of the person to contact at the bill-to customer site.
ContactMiddleName: string

Maximum Length: 255

Middle name of the person to contact at the bill-to customer site.
ContactName: string

Maximum Length: 255

Person to contact at the bill-to customer site.
ContactNameSuffix: string

Maximum Length: 255

Name suffix of the person to contact at the bill-to customer site.
ContactNumber: string

Maximum Length: 255

Telephone number of the person to contact at the bill-to customer site.
ContactTitle: string

Maximum Length: 255

Title of the person to contact at the bill-to customer site.
Country: string

Maximum Length: 255

Country of the bill-to customer address.
County: string

Maximum Length: 255

County of the bill-to customer address.
CustomerAccountId: integer (int64)

Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyName: string

Maximum Length: 255

Name of the party who is legally responsible for payment.
PersonFirstName: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the first name of the person.
PersonLastName: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the last name of the person.
PersonMiddleName: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the middle name of the person.
PersonNameSuffix: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
PersonTitle: string

Maximum Length: 255

If a person is legally responsible for payment, then this attribute contains the title of the person.
PostalCode: string

Maximum Length: 255

Postal code of the bill-to customer address.
PreferredContactPointId: integer (int64)

Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
Province: string

Maximum Length: 255

Province of the bill-to customer address.
SiteUseId: integer (int64)

Value that uniquely identifies the account site that is legally responsible for payment.
SourceAddressId: string

Maximum Length: 255

Value that uniquely identifies the bill-to customer address. Value is 1.
State: string

Maximum Length: 255

State of the bill-to customer address.

{
    "type":"object",
    "properties":{
        "SiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account site that is legally responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the name suffix of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the party who is legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact for the billing account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":255,
            "type":"string",
            "description":"County of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the title of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Telephone number of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccountDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the last name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":255,
            "type":"string",
            "description":"Second line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the first name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":255,
            "type":"string",
            "description":"First line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"City of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"State of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAddressId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer address. Value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-channelPrograms-item-response

Type: object

Show Source

ApplyType: string

Maximum Length: 255

Value that indicates whether the channel program for an order line is applied by the user or the application. The values for this attribute are based on the value of ManuallyAppliedFlag.
Comments: string

Maximum Length: 2000

Comments for channel program for an order line.
DeclinableFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the channel program for an order line can be declined by a user. If false, then the channel program for an order line can't be declined by a user. The default value is true.
DeclineReason: string

Maximum Length: 255

Reason to decline the channel program for an order line.
DeclineReasonCode: string

Maximum Length: 30

Abbreviation that identifies the reason to decline the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENT_DECLINE_REASON.
DiscountAmount: integer (int64)

Amount of discount for the product rule.
DiscountType: string

Maximum Length: 255

Value that identifies the discount type of the product rule.
DiscountTypeCode: string

Maximum Length: 255

Abbreviation that identifies the discount type of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
EndDate: string (date)

Date when the product rule is no longer effective.
IncentiveEntitySubtypeCode: string

Maximum Length: 30

Abbreviation that identifies the sub type of the channel program.
IncentiveEntityTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of the channel program.
IncentiveId: integer (int64)

Value that uniquely identifies the channel program for an order line.
ItemLevel: string

Maximum Length: 255

Value that indicates the item level of the product rule.
ItemLevelCode: string

Maximum Length: 255

Abbreviation that indicates the item level of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.
links: array Links

Title: Links

The link relations associated with the resource instance.
ManuallyAppliedFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the channel program for an order line is selected by the user. If false, then the channel program for an order line is applied by the application. The default value is false. A list of accepted values is defined in the lookup type ORA_FOM_USER_APPLIED_INCENTIVE.
ProgramCode: string

Maximum Length: 255

Abbreviation that uniquely identifies the channel program.
ProgramDescription: string

Maximum Length: 255

Description of the channel program.
ProgramDetails: string

Maximum Length: 255

Details of the product rule. The value of this attribute is a concatenation of DiscountType and DiscountAmount from the product rule.
ProgramId: string

Maximum Length: 50

Value that uniquely identifies the channel program.
ProgramLine: string

Maximum Length: 255

Value that indicates the item level at which a channel program is applied for an order line. The values for this attribute are based on the value of ItemLevelCode. If the value of ItemLevelCode is ALL_ITEMS, then the value of ItemLevel is used as the value of this attribute. If the value of ItemLevelCode is ITEM, then item number from order line is used as the value of this attribute. Otherwise, the value of item identifier from product rule is used as the value of this attribute.
ProgramLineId: string

Maximum Length: 50

Value that uniquely identifies the product rule.
ProgramName: string

Maximum Length: 255

Name of the channel program.
ProgramTypeName: string

Maximum Length: 255

Name of the channel program type.
SourceIncentiveId: string

Maximum Length: 50

Value that uniquely identifies the channel program for an order line. The source application assigns this value.
StartDate: string (date)

Date when the product rule is effective.
Status: string

Maximum Length: 255

Value that indicates the status of the channel program for an order line.
StatusCode: string

Maximum Length: 30

Abbreviation that indicates the status of the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENTIVE_STATUS.

{
    "type":"object",
    "properties":{
        "DeclineReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason to decline the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENT_DECLINE_REASON.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the status of the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENTIVE_STATUS.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the product rule is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemLevel":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the item level of the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates whether the channel program for an order line is applied by the user or the application. The values for this attribute are based on the value of ManuallyAppliedFlag.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the item level of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "DeclinableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the channel program for an order line can be declined by a user. If false, then the channel program for an order line can't be declined by a user. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "DeclineReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason to decline the channel program for 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"
            }
        },
        "ProgramLine":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the item level at which a channel program is applied for an order line. The values for this attribute are based on the value of ItemLevelCode. If the value of ItemLevelCode is ALL_ITEMS, then the value of ItemLevel is used as the value of this attribute. If the value of ItemLevelCode is ITEM, then item number from order line is used as the value of this attribute. Otherwise, the value of item identifier from product rule is used as the value of this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IncentiveEntityTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the channel program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the channel program type.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the status of the channel program for an order line.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the discount type of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments for channel program for an order line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the channel program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the product rule is no longer effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "type":"integer",
            "description":"Amount of discount for the product rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ProgramCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramLineId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the discount type of the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "IncentiveId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program for an order line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramDetails":{
            "maxLength":255,
            "type":"string",
            "description":"Details of the product rule. The value of this attribute is a concatenation of DiscountType and DiscountAmount from the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ManuallyAppliedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the channel program for an order line is selected by the user. If false, then the channel program for an order line is applied by the application. The default value is false. A list of accepted values is defined in the lookup type ORA_FOM_USER_APPLIED_INCENTIVE.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceIncentiveId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the channel program for an order line. The source application assigns this value.",
            "nullable":false,
            "x-queryable":true
        },
        "IncentiveEntitySubtypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the sub type of the channel program.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-charges-item-response

Type: object

Show Source

ApplyTo: string

Maximum Length: 255

Specifies where pricing applies the charge: for the item, for shipping, or for the return.
ApplyToCode: string

Maximum Length: 30

Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.
AverageUnitSellingPrice: number

Weighted average of the selling price. This average is the total sales revenue divided by total units sold.
BlockAllowance: number

Value that indicates the block allowance for a non-tiered consumption charge. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
BlockSize: number

Number that represents the size of the block for charge calculation for a tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
CanAdjustFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the charge is eligible for adjustment. If false, then the charge is not eligible for adjustment. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
chargeComponents: array Charge Components

Title: Charge Components

The Charge Components resource manages price details for the order line, including price elements and amounts.
ChargeCurrency: string

Maximum Length: 255

Charge currency.
ChargeCurrencyCode: string

Maximum Length: 15

Abbreviation that identifies the charge currency.
ChargeDefinition: string

Maximum Length: 255

Charge definition that defines the price type, charge type, and subtype.
ChargeDefinitionCode: string

Maximum Length: 30

Abbreviation that identifies the charge definition.
ChargePeriod: string

Read Only: true

Maximum Length: 25

Charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.
ChargePeriodCode: string

Read Only: true

Maximum Length: 3

Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.
ChargeSubType: string

Maximum Length: 255

Charge subtype.
ChargeSubtypeCode: string

Maximum Length: 30

Abbreviation that identifies the charge subtype.
chargeTiers: array Charge Tiers

Title: Charge Tiers

The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.
ChargeType: string

Maximum Length: 255

Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on.
ChargeTypeCode: string

Maximum Length: 30

Abbreviation that identifies the charge type.
GSAUnitPrice: number

Price for each unit. Determined from the price list on the pricing strategy.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderChargeId: integer (int64)

Read Only: true

Value that uniquely identifies the transaction.
PricedQuantity: number

Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
PricedQuantityUOM: string

Maximum Length: 255

Unit of measure for priced quantity, such as Ton. Oracle Product Lifecycle Management Cloud or a service in Oracle Order Management Cloud provides this value.
PricedQuantityUOMCode: string

Maximum Length: 3

Abbreviation that identifies the unit of measure for the priced quantity.
PricePeriodicity: string

Maximum Length: 255

Periodicity for recurring price types, such as month, quarter, or year.
PricePeriodicityCode: string

Maximum Length: 30

Abbreviation that identifies the price periodicity.
PriceType: string

Maximum Length: 255

Price type, such as one time, recurring, and so on.
PriceTypeCode: string

Maximum Length: 30

Abbreviation that identifies the price type.
PrimaryFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the value is entered by the user.
RollupFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the charge is a rollup charge. If false, then the charge is not a rollup charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
SequenceNumber: integer (int32)

Sequence number for the charge.
SourceChargeId: string

Maximum Length: 120

Value that uniquely identifies the charge. The source application applies this value.
TierAppliesTo: string

Maximum Length: 80

Value that identifies whether the applicability of the tier is for all tiers or the highest tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
TierAppliesToCode: string

Maximum Length: 30

Abbreviation that identifies the applicability of the tier whether all tiers or the highest tier. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
TieredFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the charge has a tier defined. If false, then the charge does not have a tier defined. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
UsagePriceLockFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the usage pricing is used. If false, then the usage pricing isn't used. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
UsageUOM: string

Read Only: true

Maximum Length: 25

Unit of measure for the usage price of the product.
UsageUOMCode: string

Read Only: true

Maximum Length: 3

Abbreviation that identifies the unit of measure for the usage price of the product.

{
    "type":"object",
    "properties":{
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge is a rollup charge. If false, then the charge is not a rollup charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageUOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the usage price of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the value is entered by the user.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":255,
            "type":"string",
            "description":"Charge definition that defines the price type, charge type, and subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the priced quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "TierAppliesToCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the applicability of the tier whether all tiers or the highest tier. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the charge type.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the charge definition.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceChargeId":{
            "maxLength":120,
            "type":"string",
            "description":"Value that uniquely identifies the charge. The source application applies this value.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the price type.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the charge currency.",
            "nullable":false,
            "x-queryable":true
        },
        "AverageUnitSellingPrice":{
            "type":"number",
            "description":"Weighted average of the selling price. This average is the total sales revenue divided by total units sold.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the usage price of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GSAUnitPrice":{
            "type":"number",
            "description":"Price for each unit. Determined from the price list on the pricing strategy.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ApplyTo":{
            "maxLength":255,
            "type":"string",
            "description":"Specifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargePeriodCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanAdjustFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge is eligible for adjustment. If false, then the charge is not eligible for adjustment. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ChargePeriod":{
            "maxLength":25,
            "type":"string",
            "description":"Charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeComponents":{
            "title":"Charge Components",
            "type":"array",
            "description":"The Charge Components resource manages price details for the order line, including price elements and amounts.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-item-response"
            }
        },
        "ChargeCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Charge currency.",
            "nullable":true,
            "x-queryable":false
        },
        "BlockAllowance":{
            "type":"number",
            "description":"Value that indicates the block allowance for a non-tiered consumption charge. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeSubType":{
            "maxLength":255,
            "type":"string",
            "description":"Charge subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge has a tier defined. If false, then the charge does not have a tier defined. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ChargeSubtypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the charge subtype.",
            "nullable":false,
            "x-queryable":true
        },
        "TierAppliesTo":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies whether the applicability of the tier is for all tiers or the highest tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the usage pricing is used. If false, then the usage pricing isn't used. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyToCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":false,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "maxLength":255,
            "type":"string",
            "description":"Periodicity for recurring price types, such as month, quarter, or year.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeType":{
            "maxLength":255,
            "type":"string",
            "description":"Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for priced quantity, such as Ton. Oracle Product Lifecycle Management Cloud or a service in Oracle Order Management Cloud provides this value.",
            "nullable":true,
            "x-queryable":false
        },
        "OrderChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeTiers-item-response"
            }
        },
        "BlockSize":{
            "type":"number",
            "description":"Number that represents the size of the block for charge calculation for a tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "maxLength":255,
            "type":"string",
            "description":"Price type, such as one time, recurring, and so on.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Charge Components

Type: array

Title: Charge Components

The Charge Components resource manages price details for the order line, including price elements and amounts.

Show Source

Array of: object salesOrdersForOrderHub-lines-charges-chargeComponents-item-response

{
    "title":"Charge Components",
    "type":"array",
    "description":"The Charge Components resource manages price details for the order line, including price elements and amounts.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-item-response"
    }
}

Nested Schema : Charge Tiers

Type: array

Title: Charge Tiers

The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.

Show Source

Array of: object salesOrdersForOrderHub-lines-charges-chargeTiers-item-response

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeTiers-item-response"
    }
}

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 : salesOrdersForOrderHub-lines-charges-chargeComponents-item-response

Type: object

Show Source

ChargeCurrency: string

Maximum Length: 255

Name of the currency that the charge component uses.
ChargeCurrencyCode: string

Maximum Length: 15

Abbreviation that identifies the currency that the charge component uses.
ChargeCurrencyDurationExtendedAmount: number

Extended amount for the duration displayed in the currency that the charge uses.
ChargeCurrencyExtendedAmount: number

Extended amount displayed in the currency that the charge uses. Extended amount equals the unit price multiplied by the quantity on the order line. For a configured item, the extended amount equals the unit price multiplied by the extended quantity on the order line.
ChargeCurrencyUnitPrice: number

Price or adjustment for each unit displayed in the charge currency that the order line uses.
Explanation: string

Maximum Length: 1000

Explanation of the charge component.
ExplanationMessageName: string

Maximum Length: 30

Message name of the explanation that displays in the price break down dialog.
HeaderCurrency: string

Maximum Length: 255

Name of the currency that the order header uses.
HeaderCurrencyCode: string

Maximum Length: 15

Abbreviation that identifies the currency that the order header uses.
HeaderCurrencyDurationExtendedAmount: number

Extended amount for the duration, displayed in the currency that the order header uses.
HeaderCurrencyExtendedAmount: number

Extended amount, displayed in the currency that the order header uses.
HeaderCurrencyUnitPrice: number

Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderChargeComponentId: integer (int64)

Read Only: true

Value that uniquely identifies the transaction.
PercentOfComparisonElement: number

Percent that the unit price constitutes of the basis charge component. The default value for the basis is List Price. This attribute stores the margin percent, the percent that net price constitutes of the list price, and so on.
PriceElement: string

Maximum Length: 255

Name of the price element, such as list price, net price, and so on.
PriceElementCode: string

Maximum Length: 30

Abbreviation that identifies the price element.
PriceElementUsage: string

Maximum Length: 255

Name that describes charge component usage.
PriceElementUsageCode: string

Maximum Length: 30

Abbreviation that identifies the charge component usage.
PricingSourceId: string

Maximum Length: 30

Value that identifies the source of the lowest level pricing. For example, it contains the Id that identifies a line on the price list, a tier rule, a shipping line, and so on.
PricingSourceType: string

Maximum Length: 255

Type of the price source.
PricingSourceTypeCode: string

Maximum Length: 30

Type of the price source, such as the charge of a segment price list. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.
RollupFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the value is a rollup value for the charge component. If false, then the value is not a rollup value. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
SequenceNumber: integer (int32)

Sequence number for the charge component.
SourceChargeComponentId: string

Maximum Length: 50

Value that uniquely identifies the charge component. The source application assigns this value.
SourceMpaId: string

Maximum Length: 50

Value that identifies the source of a manual price adjustment.
TaxIncludedFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the price for the charge component includes tax. If false, then the price for the charge component does not include tax. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
totalComponents: array Total Components

Title: Total Components

The Total Components resource manages the components that determine the total price of a sales order.

{
    "type":"object",
    "properties":{
        "SourceMpaId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the source of a manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the value is a rollup value for the charge component. If false, then the value is not a rollup value. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "Explanation":{
            "maxLength":1000,
            "type":"string",
            "description":"Explanation of the charge component.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingSourceId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the source of the lowest level pricing. For example, it contains the Id that identifies a line on the price list, a tier rule, a shipping line, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxIncludedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the price for the charge component includes tax. If false, then the price for the charge component does not include tax. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "OrderChargeComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PricingSourceType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the price source.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit displayed in the charge currency that the order line uses.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration displayed in the currency that the charge uses.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceElementUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the charge component usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount displayed in the currency that the charge uses. Extended amount equals the unit price multiplied by the quantity on the order line. For a configured item, the extended amount equals the unit price multiplied by the extended quantity on the order line.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge component.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "totalComponents":{
            "title":"Total Components",
            "type":"array",
            "description":"The Total Components resource manages the components that determine the total price of a sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-response"
            }
        },
        "PriceElementUsage":{
            "maxLength":255,
            "type":"string",
            "description":"Name that describes charge component usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ExplanationMessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Message name of the explanation that displays in the price break down dialog.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceChargeComponentId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the charge component. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit of the item, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PercentOfComparisonElement":{
            "type":"number",
            "description":"Percent that the unit price constitutes of the basis charge component. The default value for the basis is List Price. This attribute stores the margin percent, the percent that net price constitutes of the list price, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceElementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the price element.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price element, such as list price, net price, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the price source, such as the charge of a segment price list. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : Total Components

Type: array

Title: Total Components

The Total Components resource manages the components that determine the total price of a sales order.

Show Source

Array of: object salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-response

{
    "title":"Total Components",
    "type":"array",
    "description":"The Total Components resource manages the components that determine the total price of a sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-response"
    }
}

Nested Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-response

Type: object

Show Source

HeaderCurrencyCode: string

Read Only: true

Maximum Length: 15

Abbreviation that identifies the currency that the order header uses.
HeaderCurrencyExtendedAmount: number

Read Only: true

Extended amount, displayed in currency that the order header uses.
HeaderCurrencyName: string

Read Only: true

Maximum Length: 255

Name of the currency that the order header uses.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderChargeComponentId: integer (int64)

Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.
OrderTotalComponentId: integer (int64)

Value that identifies the charge component that stores the sales order total.
OrderTotalId: integer (int64)

Value that identifies the sales order total.
PriceElement: string

Read Only: true

Maximum Length: 255

Name of the price element. For example, list price, net price, and so on.
PriceElementCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the price element.
PriceElementUsage: string

Read Only: true

Maximum Length: 255

Name of the price element usage.
PriceElementUsageCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies price element usage.

{
    "type":"object",
    "properties":{
        "OrderTotalComponentId":{
            "type":"integer",
            "description":"Value that identifies the charge component that stores the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the price element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderTotalId":{
            "type":"integer",
            "description":"Value that identifies the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price element. For example, list price, net price, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriceElementUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies price element usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HeaderCurrencyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderChargeComponentId":{
            "type":"integer",
            "description":"Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElementUsage":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price element usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-charges-chargeTiers-item-response

Type: object

Show Source

AdjustmentAmount: number

Amount to be adjusted or the price for each unit or block for the item. In Oracle Subscription Management Cloud, this attribute is mapped to the list price.
ApplicationMethod: string

Maximum Length: 80

Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat.
ApplicationMethodCode: string

Maximum Length: 30

Abbreviation that identifies the application method to use for tiered pricing. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
BlockSize: number

Number that represents the size of the block for charge calculation for a tier.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderChargeId: integer (int64)

Value that uniquely identifies the charge.
OrderChargeTierId: integer (int64)

Value that uniquely identifies the charge tier.
SourceOrderChargeTierId: string

Maximum Length: 50

Value that uniquely identifies the charge tier in the source application.
TierFrom: number

Number that indicates the starting value of the tier.
TierSequenceNumber: number

Sequence number for the charge tier.
TierTo: number

Number that indicates the ending value of the tier.

{
    "type":"object",
    "properties":{
        "TierSequenceNumber":{
            "type":"number",
            "description":"Sequence number for the charge tier.",
            "nullable":false,
            "x-queryable":true
        },
        "TierTo":{
            "type":"number",
            "description":"Number that indicates the ending value of the tier.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the application method to use for tiered pricing. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderChargeTierId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the charge tier in the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount to be adjusted or the price for each unit or block for the item. In Oracle Subscription Management Cloud, this attribute is mapped to the list price.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicationMethod":{
            "maxLength":80,
            "type":"string",
            "description":"Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat.",
            "nullable":true,
            "x-queryable":true
        },
        "BlockSize":{
            "type":"number",
            "description":"Number that represents the size of the block for charge calculation for a tier.",
            "nullable":true,
            "x-queryable":true
        },
        "TierFrom":{
            "type":"number",
            "description":"Number that indicates the starting value of the tier.",
            "nullable":false,
            "x-queryable":true
        },
        "OrderChargeTierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-coverageReferences-item-response

Type: object

Show Source

CoverageFulfillLineId: integer (int64)

Read Only: true

Value that uniquely identifies the fulfillment line that fulfills the coverage line.
CoverageItemNumber: string

Read Only: true

Maximum Length: 255

Item number of the coverage that the covered item covers.
DisplayLineNumber: string

Read Only: true

Maximum Length: 255

Number that the order management work area displays to identify the order line that contains the coverage.
HeaderId: integer (int64)

Read Only: true

Value that uniquely identifies the sales order header that contains the coverage.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderNumber: string

Read Only: true

Maximum Length: 255

Sales order number that contains the coverage line.
SourceLineNumber: string

Title: Source Order Line

Maximum Length: 100

Value that uniquely identifies the order line in the source application that contains the coverage.
SourceOrderNumber: string

Title: Source Order

Maximum Length: 50

Value that uniquely identifies the source order in the source application that contains the coverage.

{
    "type":"object",
    "properties":{
        "DisplayLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that the order management work area displays to identify the order line that contains the coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderNumber":{
            "title":"Source Order",
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the source order in the source application that contains the coverage.",
            "nullable":false,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order header that contains the coverage.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Sales order number that contains the coverage line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageFulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line that fulfills the coverage line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the coverage that the covered item covers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLineNumber":{
            "title":"Source Order Line",
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the order line in the source application that contains the coverage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-coveredAssetReference-item-response

Type: object

Show Source

CoveredAssetId: integer

Value that uniquely identifies the asset that the coverage item covers.
CoveredAssetNumber: string

Maximum Length: 150

Number that identifies the asset that the coverage item covers.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CoveredAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset that the coverage item covers.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoveredAssetNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the asset that the coverage item covers.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-coveredProductReferences-item-response

Type: object

Show Source

CoveredFulfillLineId: integer

Value that uniquely identifies the fulfillment line that fulfills the covered item.
CoveredItemNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the covered item.
DisplayLineNumber: string

Read Only: true

Maximum Length: 255

Number that the order management work area displays to identify the order line that contains the covered item.
HeaderId: integer

Read Only: true

Value that uniquely identifies the sales order head that contains the covered item.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderNumber: string

Maximum Length: 150

Number that identifies the sales order that contains the covered item.
SourceLineId: string

Maximum Length: 255

Value that uniquely identifies the source order line from order capture.
SourceLineNumber: string

Maximum Length: 255

Value that uniquely identifies the transaction in the source application that contains the order line for the covered item.
SourceOrderId: string

Maximum Length: 255

Value that uniquely identifies the source order from order capture.
SourceOrderNumber: string

Maximum Length: 255

Number that identifies the source application that contains the covered item.
SourceOrderSystem: string

Maximum Length: 255

Value that references to the order capture application that the source order came from.

{
    "type":"object",
    "properties":{
        "DisplayLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that the order management work area displays to identify the order line that contains the covered item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the source order from order capture.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source application that contains the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that references to the order capture application that the source order came from.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order head that contains the covered item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the sales order that contains the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the source order line from order capture.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application that contains the order line for the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the covered item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoveredFulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line that fulfills the covered item.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-dropShipPurchaseOrderReference-item-response

Type: object

Show Source

DocumentSystemReferenceId: integer (int64)

Value that uniquely identifies the document system for the drop ship.
links: array Links

Title: Links

The link relations associated with the resource instance.
POHeaderId: string

Maximum Length: 255

Value that uniquely identifies the purchase order header for the drop ship.
POLineId: string

Maximum Length: 255

Value that uniquely identifies the purchase order line for the drop ship.
POLineLocationId: string

Maximum Length: 255

Value that uniquely identifies the location of the purchase order line for the drop ship.
PONumber: string

Maximum Length: 150

Number that identifies the purchase order for the drop ship.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the purchase order for the drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSystemReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document system for the drop ship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the purchase order line for the drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the location of the purchase order line for the drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the purchase order header for the drop ship.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-dropShipRequisitionReference-item-response

Type: object

Show Source

DocumentSystemReferenceId: integer (int64)

Value that uniquely identifies the document system reference for the drop ship.
links: array Links

Title: Links

The link relations associated with the resource instance.
RequisitionHeaderId: string

Maximum Length: 255

Value that uniquely identifies the purchase requisition for the drop ship.
RequisitionLineId: string

Maximum Length: 255

Value that uniquely identifies the requisition line for the drop ship.
RequisitionLineNumber: string

Maximum Length: 150

Number that identifies the requisition line for the drop ship.
RequisitionNumber: string

Maximum Length: 150

Number that identifies the requisition for the drop ship.

{
    "type":"object",
    "properties":{
        "DocumentSystemReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document system reference for the drop ship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitionLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the requisition line for the drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionHeaderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the purchase requisition for the drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the requisition for the drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionLineNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the requisition line for the drop ship.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-externalAssetReference-item-response

Type: object

Show Source

ExternalAssetKey: string

Maximum Length: 150

Value that identifies the asset key for the subscription or coverage item in an external application.
ExternalParentAssetKey: string

Maximum Length: 150

Value that identifies the parent asset key for the subscription or coverage item in an external application.
ExternalRootParentAssetKey: string

Maximum Length: 150

Value that identifies the root parent asset key for the subscription or coverage item in an external application.
links: array Links

Title: Links

The link relations associated with the resource instance.
SubscriptionProductPuid: string

Maximum Length: 150

Value that uniquely identifies the product within the subscription in Oracle Subscription Management Cloud.

{
    "type":"object",
    "properties":{
        "ExternalAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalParentAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the parent asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalRootParentAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the root parent asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":150,
            "type":"string",
            "description":"Value that uniquely identifies the product within the subscription in Oracle Subscription Management Cloud.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-externalFulfillmentSalesOrderReference-item-response

Type: object

Show Source

DocumentId: string

Maximum Length: 255

Value that uniquely identifies the external order reference that the application sends to the fulfillment system.
DocumentLineNumber: string

Maximum Length: 150

Number that uniquely identifies the order line in the external order reference that the application sends to the fulfillment system.
DocumentNumber: string

Maximum Length: 150

Number that uniquely identifies the external order reference that the application sends to the fulfillment system.
DocumentSystemReferenceId: integer (int64)

Value that uniquely identifies the document system reference for an external order.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the external order reference that the application sends to the fulfillment system.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSystemReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document system reference for an external order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that uniquely identifies the order line in the external order reference that the application sends to the fulfillment system.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that uniquely identifies the external order reference that the application sends to the fulfillment system.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-holds-item-response

Type: object

Show Source

ActiveFlag: boolean

Title: Active

Maximum Length: 1

Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.
ApplyDate: string (date-time)

Title: Hold Date

Read Only: true

Date when the user applied the hold.
ApplySystem: string

Maximum Length: 30

Application that requested to apply the hold.
ApplyUser: string

Read Only: true

Maximum Length: 255

Name of the user who applied the hold.
HoldCode: string

Read Only: true

Maximum Length: 255

Abbreviation that identifies the hold.
HoldComments: string

Title: Comments

Maximum Length: 240

Comments that the user added when placing the hold.
HoldInstanceId: integer (int64)

Value that uniquely identifies the hold.
HoldName: string

Read Only: true

Maximum Length: 255

Name of the hold.
HoldReleaseComments: string

Title: Release Comments

Maximum Length: 240

Comments that the user added when releasing the hold.
HoldReleaseReason: string

Read Only: true

Maximum Length: 255

Reason for releasing the hold.
HoldReleaseReasonCode: string

Title: Release Reason

Maximum Length: 30

Abbreviation that identifies the reason for releasing the hold.
links: array Links

Title: Links

The link relations associated with the resource instance.
ReleaseDate: string (date-time)

Title: Release Date

Date when the user released the hold.
ReleaseUser: string

Read Only: true

Maximum Length: 255

Name of the user who released the hold.
SourceRequestId: string

Maximum Length: 50

Value that identifies the source application that requested the hold.

{
    "type":"object",
    "properties":{
        "HoldInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hold.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplyUser":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who applied the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReleaseReasonCode":{
            "title":"Release Reason",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for releasing the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplySystem":{
            "maxLength":30,
            "type":"string",
            "description":"Application that requested to apply the hold.",
            "nullable":false,
            "x-queryable":false
        },
        "SourceRequestId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the source application that requested the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "ReleaseDate":{
            "title":"Release Date",
            "type":"string",
            "description":"Date when the user released the hold.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyDate":{
            "title":"Hold Date",
            "type":"string",
            "description":"Date when the user applied the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReleaseComments":{
            "title":"Release Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments that the user added when releasing the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "HoldName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseUser":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who released the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HoldComments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments that the user added when placing the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "HoldReleaseReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for releasing the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-internalOrderReference-item-response

Type: object

Show Source

DocumentSystemReferenceId: integer (int64)

Value that uniquely identifies the document system reference for an internal order.
InternalOrderDocumentType: string

Maximum Length: 255

Type of internal order.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DocumentSystemReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document system reference for an internal order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InternalOrderDocumentType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of internal order.",
            "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 : salesOrdersForOrderHub-lines-lineDetails-item-response

Type: object

Show Source

ActualDeliveryDate: string (date-time)

Date when the carrier delivered the item that the fulfillment line contains.
AvailabilityShipDate: string (date-time)

Ship date for each fulfillment line that the carrier sends to order management.
BillingTransactionAmount: number

Title: Charge Amount

Amount of the billing transaction.
BillingTransactionDate: string (date-time)

Title: Invoice Date

Date on the customer invoice. The application uses this date to calculate the invoice due date according to the payment terms for the customer.
BillingTransactionNumber: string

Title: Invoice Number

Maximum Length: 30

Value that uniquely identifies the billing transaction.
BillOfLadingNumber: string

Title: Bill of Lading

Maximum Length: 120

Contract and receipt from the carrier for the item that the carrier agrees to transport to the destination address.
CustomerTransactionLineId: integer (int64)

Value that uniquely identifies the billing line.
DeliveryName: string

Title: Delivery

Maximum Length: 120

Group of items that the carrier carries under the terms of one bill of lading.
ExceptionFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the available-to-ship date for the line on the supply order has past the requested date, or supply is not available for the fulfillment line. If false, then this available-to-ship date has not past the requested date, or supply is available for the fulfillment line.
FulfillLineDetailId: integer (int64)

Value that uniquely identifies details for the fulfillment line.
links: array Links

Title: Links

The link relations associated with the resource instance.
Quantity: number

Title: Shipped Quantity

Quantity of the item that the supplier fulfilled.
RMAReceiptDate: string (date)

Date when the fulfillment application sent the receipt.
RMAReceiptDateTime: string (date-time)

Date and time when the fulfillment application sent the receipt.
RMAReceiptLineNumber: string

Maximum Length: 50

Line number of the receipt sent by the receiving application.
RMAReceiptNumber: string

Maximum Length: 50

Receipt header number sent by the receiving application.
RMAReceiptTransactionId: string

Maximum Length: 18

Value that uniquely identifies receiving.
SecondaryQuantity: number

Read Only: true

Shipped, received, or delivered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.
Status: string

Read Only: true

Maximum Length: 255

Status of the fulfillment line.
StatusAsOfDate: string (date-time)

Title: Transaction Date

Date when the transaction occurred.
StatusCode: string

Title: Status

Maximum Length: 30

Abbreviation that identifies the status of the fulfillment line.
TaskType: string

Title: Task Type

Maximum Length: 50

Task classification that assigns default attributes to tasks and controls task processing.
TrackingNumber: string

Title: Tracking Number

Maximum Length: 120

Unique value that the carriers provides to track shipment during transportation.
TradeComplianceCode: string

Maximum Length: 30

Abbreviation that identifies the trade compliance screening.
TradeComplianceExplanation: string

Maximum Length: 1000

Explanation that describes the result of trade compliance screening.
TradeComplianceResultCode: string

Maximum Length: 30

Abbreviation that identifies the result of trade compliance screening.
TradeComplianceType: string

Read Only: true

Maximum Length: 255

Type of trade compliance screening.
TradeComplianceTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of trade compliance screening.
WaybillNumber: string

Title: Waybill Number

Maximum Length: 30

Waybill or airbill number for the shipment.

{
    "type":"object",
    "properties":{
        "TrackingNumber":{
            "title":"Tracking Number",
            "maxLength":120,
            "type":"string",
            "description":"Unique value that the carriers provides to track shipment during transportation.",
            "nullable":true,
            "x-queryable":false
        },
        "WaybillNumber":{
            "title":"Waybill Number",
            "maxLength":30,
            "type":"string",
            "description":"Waybill or airbill number for the shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "ActualDeliveryDate":{
            "type":"string",
            "description":"Date when the carrier delivered the item that the fulfillment line contains.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StatusAsOfDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Date when the transaction occurred.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "BillOfLadingNumber":{
            "title":"Bill of Lading",
            "maxLength":120,
            "type":"string",
            "description":"Contract and receipt from the carrier for the item that the carrier agrees to transport to the destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the trade compliance screening.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the fulfillment line.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of trade compliance screening.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveryName":{
            "title":"Delivery",
            "maxLength":120,
            "type":"string",
            "description":"Group of items that the carrier carries under the terms of one bill of lading.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of trade compliance screening.",
            "nullable":true,
            "x-queryable":false
        },
        "RMAReceiptLineNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Line number of the receipt sent by the receiving application.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceExplanation":{
            "maxLength":1000,
            "type":"string",
            "description":"Explanation that describes the result of trade compliance screening.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskType":{
            "title":"Task Type",
            "maxLength":50,
            "type":"string",
            "description":"Task classification that assigns default attributes to tasks and controls task processing.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TradeComplianceResultCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the result of trade compliance screening.",
            "nullable":true,
            "x-queryable":false
        },
        "RMAReceiptTransactionId":{
            "maxLength":18,
            "type":"string",
            "description":"Value that uniquely identifies receiving.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AvailabilityShipDate":{
            "type":"string",
            "description":"Ship date for each fulfillment line that the carrier sends to order management.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RMAReceiptDateTime":{
            "type":"string",
            "description":"Date and time when the fulfillment application sent the receipt.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "BillingTransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"Date on the customer invoice. The application uses this date to calculate the invoice due date according to the payment terms for the customer.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RMAReceiptDate":{
            "type":"string",
            "description":"Date when the fulfillment application sent the receipt.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Shipped Quantity",
            "type":"number",
            "description":"Quantity of the item that the supplier fulfilled.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingTransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the billing transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Shipped, received, or delivered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerTransactionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the billing line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FulfillLineDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies details for the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExceptionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the available-to-ship date for the line on the supply order has past the requested date, or supply is not available for the fulfillment line. If false, then this available-to-ship date has not past the requested date, or supply is available for the fulfillment line.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingTransactionAmount":{
            "title":"Charge Amount",
            "type":"number",
            "description":"Amount of the billing transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "RMAReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Receipt header number sent by the receiving application.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-lotSerials-item-response

Type: object

Show Source

DeletedFlag: boolean

Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines are not deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute does not have a default value.
ItemRevisionNumber: string

Title: Revision Number

Maximum Length: 120

Value that identifies the item revision.
ItemSerialNumberFrom: string

Title: From Serial Number

Maximum Length: 120

Starting serial number of a range of serial numbers.
ItemSerialNumberTo: string

Title: To Serial Number

Maximum Length: 120

Ending serial number of a range of serial numbers.
links: array Links

Title: Links

The link relations associated with the resource instance.
Locator: string

Concatenated segments for the locator flexfields from where the item is shipped from or received into.
LocatorId: integer (int64)

Locator where the application ships or receives the item.
LotNumber: string

Title: Lot Number

Maximum Length: 320

Identifies the quantity for the item.
LotSerialId: integer (int64)

Read Only: true

Value that uniquely identifies the lot and serial.
Quantity: number

Quantity of lots and serials.
SecondaryQuantity: number

Read Only: true

Quantity of the lot for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.
SourceLotSerialId: string

Maximum Length: 50

Value that uniquely identifies the lot and serial. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "ItemSerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":120,
            "type":"string",
            "description":"Ending serial number of a range of serial numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "Locator":{
            "type":"string",
            "description":"Concatenated segments for the locator flexfields from where the item is shipped from or received into.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Quantity of the lot for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LotSerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lot and serial.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ItemRevisionNumber":{
            "title":"Revision Number",
            "maxLength":120,
            "type":"string",
            "description":"Value that identifies the item revision.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLotSerialId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the lot and serial. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Locator where the application ships or receives the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines are not deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of lots and serials.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemSerialNumberFrom":{
            "title":"From Serial Number",
            "maxLength":120,
            "type":"string",
            "description":"Starting serial number of a range of serial numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":320,
            "type":"string",
            "description":"Identifies the quantity for the item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-manualPriceAdjustments-item-response

Type: object

Show Source

AdjustmentAmount: number

Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.
AdjustmentElementBasis: string

Maximum Length: 30

Basis that pricing uses to calculate the manual pricing adjustment.
AdjustmentElementBasisName: string

Maximum Length: 255

Name of the basis that pricing uses to calculate the manual pricing adjustment.
AdjustmentType: string

Maximum Length: 255

Method that pricing uses to calculate manual price adjustment for the item.
AdjustmentTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of manual price adjustment.
ChargeDefinition: string

Maximum Length: 255

Definition of the charge that pricing uses to apply a manual price adjustment.
ChargeDefinitionCode: string

Maximum Length: 30

Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.
ChargeRollupFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then pricing rolls up the charge for the manual price adjustment. If false, then pricing does not do this roll up. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, there is no default value.
Comments: string

Maximum Length: 1000

Comments that describe the manual price adjustment.
EffectiveNumberOfPeriods: number

Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EffectivePeriodFrom: number

Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EffectivePeriodUntil: number

Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EffectivityType: string

Maximum Length: 80

Type of effectivity of the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
EffectivityTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of effectivity to use for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
links: array Links

Title: Links

The link relations associated with the resource instance.
ManualPriceAdjustmentId: integer (int64)

Read Only: true

Value that identifies the manual price adjustment.
ParentEntityId: integer (int64)

Read Only: true

Value that identifies the parent entity where pricing applies the manual price adjustment.
PricePeriodicity: string

Maximum Length: 255

Price periodicity of the charge where pricing applies the manual price adjustment.
PricePeriodicityCode: string

Maximum Length: 30

Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.
Reason: string

Maximum Length: 255

Reason for the manual price adjustment.
ReasonCode: string

Maximum Length: 30

Abbreviation that identifies the reason for the manual price adjustment.
SequenceNumber: integer (int32)

Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.
SourceManualPriceAdjustmentId: string

Maximum Length: 50

Value that uniquely identifies the manual price adjustment. The source application assigns this value.
ValidationStatusCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the validation status of the manual price adjustment.

{
    "type":"object",
    "properties":{
        "AdjustmentElementBasis":{
            "maxLength":30,
            "type":"string",
            "description":"Basis that pricing uses to calculate the manual pricing adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that identifies the parent entity where pricing applies the manual price adjustment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentElementBasisName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the basis that pricing uses to calculate the manual pricing adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "ValidationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the validation status of the manual price adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "maxLength":255,
            "type":"string",
            "description":"Definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"Comments that describe the manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectivityTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of effectivity to use for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":false,
            "x-queryable":false
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the manual price adjustment.",
            "nullable":false,
            "x-queryable":false
        },
        "Reason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for the manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Method that pricing uses to calculate manual price adjustment for the item.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of manual price adjustment.",
            "nullable":false,
            "x-queryable":false
        },
        "PricePeriodicity":{
            "maxLength":255,
            "type":"string",
            "description":"Price periodicity of the charge where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then pricing rolls up the charge for the manual price adjustment. If false, then pricing does not do this roll up. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, there is no default value.",
            "nullable":false,
            "x-queryable":false
        },
        "ManualPriceAdjustmentId":{
            "type":"integer",
            "description":"Value that identifies the manual price adjustment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceManualPriceAdjustmentId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the manual price adjustment. The source application assigns this value.",
            "nullable":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EffectivityType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of effectivity of the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivePeriodUntil":{
            "type":"number",
            "description":"Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectivePeriodFrom":{
            "type":"number",
            "description":"Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveNumberOfPeriods":{
            "type":"number",
            "description":"Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-originalOrderReference-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
OriginalFulfillLineId: integer

Value that uniquely identifies the fulfillment line from the original sales order that the return order is returning.
OriginalHeaderId: integer

Read Only: true

Value that uniquely identifies the original sales order header that the return order is returning.
OriginalItemLineNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the original order line that the return order is returning.
OriginalItemNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the original item that the return order is returning.
OriginalOrderNumber: string

Maximum Length: 150

Number that identifies the original sales order that the return order is returning.
OriginalSourceLineId: string

Maximum Length: 255

Value that uniquely identifies the original source line in the return order. This value refers to the original order.
OriginalSourceLineNumber: string

Maximum Length: 255

Number that identifies the original source line in the return order. This value refers to the original order.
OriginalSourceOrderId: string

Maximum Length: 255

Value that uniquely identifies the original source order in the return order. This value refers to the original order.
OriginalSourceOrderNumber: string

Maximum Length: 255

Number that identifies the original source order that the return order is returning. This source order resides in a source application.
OriginalSourceOrderSystem: string

Maximum Length: 255

Value that identifies the original source application in the return order. This value refers to the original order.

{
    "type":"object",
    "properties":{
        "OriginalSourceOrderSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the original source application in the return order. This value refers to the original order.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalItemLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the original order line that the return order is returning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalOrderNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the original sales order that the return order is returning.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original sales order header that the return order is returning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalSourceOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the original source order that the return order is returning. This source order resides in a source application.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalSourceLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the original source line in the return order. This value refers to the original order.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalSourceLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the original source line in the return order. This value refers to the original order.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalFulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line from the original sales order that the return order is returning.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the original item that the return order is returning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OriginalSourceOrderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the original source order in the return order. This value refers to the original order.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-payments-item-response

Type: object

Show Source

Amount: number

Amount authorized for the payment.
AuthorizationRequestId: string

Maximum Length: 30

Value that uniquely identifies the authorization request received from the tokenization service provider to authorize the card number. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.
AuthorizationStatus: string

Maximum Length: 255

Authorization status of the payment transaction. Values include Pass or Fail.
AuthorizationStatusCode: string

Maximum Length: 30

Status of the payment. Values include Pass or Fail.
AuthorizedAmount: number

Authorized amount received from the tokenization service provider to authorize the transaction. The authorized amount must be provided if the authorization request identifier is sent in the payload.
AuthorizedInSourceFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then payment authorization occurs in the source application. If false, then payment authorization does not occur in the source application. The default value is true.
AuthorizedOn: string (date-time)

Date when the application authorized payment.
CardExpirationDate: string

Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.
CardFirstName: string

Maximum Length: 40

First name of the card holder.
CardIssuerCode: string

Maximum Length: 30

Value that identifies the card issuer; for example, Visa or MasterCard.
CardLastName: string

Maximum Length: 40

Last name of the card holder.
CardTokenNumber: string

Maximum Length: 30

Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.
InstrumentAssignmentId: integer (int64)

Read Only: true

Value that identifies the payment method.
links: array Links

Title: Links

The link relations associated with the resource instance.
MaskedCardNumber: string

Maximum Length: 30

Masked format that displays only the last four digits of a card number, and replaces all other digits with X. This attribute is used for security purposes. The length of the masked card number should match the actual length of the number provided by the card issuer. For example, the masked card number for a Visa card number is XXXXXXXXXXXX2345.
OriginalSystemPaymentReference: string

Maximum Length: 50

Value that uniquely identifies the payment details from the source application.
PaymentMethod: string

Maximum Length: 255

Name of the billing payment method.
PaymentMethodCode: integer (int64)

Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.
PaymentServerOrderNumber: string

Maximum Length: 80

Number that identifies the card payment that was authorized by Oracle Payments Cloud.
PaymentSetId: integer (int64)

Value that uniquely identifies the group of payments for one prepaid sales order. If the payment is a prepayment, then this attribute uses a foreign key to reference billing.
PaymentTransactionId: integer (int64)

Read Only: true

Value that uniquely identifies the payment.
PaymentType: string

Maximum Length: 255

Name of the payment method for the transaction.
PaymentTypeCode: string

Maximum Length: 30

Abbreviation that identifies the payment type.
TransactionExtensionId: integer (int64)

Value that identifies the payment transaction extension in the payment system.
UniquePaymentReference: string

Read Only: true

Maximum Length: 30

Unique payment reference that the application sends to the payment system for authorization.
VoiceAuthorizationCode: string

Maximum Length: 100

Abbreviation that identifies the card authorization. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstrumentAssignmentId":{
            "type":"integer",
            "description":"Value that identifies the payment method.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AuthorizedOn":{
            "type":"string",
            "description":"Date when the application authorized payment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "VoiceAuthorizationCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the card authorization. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizationRequestId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the authorization request received from the tokenization service provider to authorize the card number. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalSystemPaymentReference":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the payment details from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Authorization status of the payment transaction. Values include Pass or Fail.",
            "nullable":true,
            "x-queryable":true
        },
        "CardExpirationDate":{
            "type":"string",
            "description":"Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the payment method for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuthorizedInSourceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then payment authorization occurs in the source application. If false, then payment authorization does not occur in the source application. The default value is true.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "UniquePaymentReference":{
            "maxLength":30,
            "type":"string",
            "description":"Unique payment reference that the application sends to the payment system for authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CardTokenNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.",
            "nullable":true,
            "x-queryable":false
        },
        "CardLastName":{
            "maxLength":40,
            "type":"string",
            "description":"Last name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "CardIssuerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the card issuer; for example, Visa or MasterCard.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Amount authorized for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "MaskedCardNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Masked format that displays only the last four digits of a card number, and replaces all other digits with X. This attribute is used for security purposes. The length of the masked card number should match the actual length of the number provided by the card issuer. For example, the masked card number for a Visa card number is XXXXXXXXXXXX2345.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group of payments for one prepaid sales order. If the payment is a prepayment, then this attribute uses a foreign key to reference billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "PaymentServerOrderNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the card payment that was authorized by Oracle Payments Cloud.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the payment. Values include Pass or Fail.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionExtensionId":{
            "type":"integer",
            "description":"Value that identifies the payment transaction extension in the payment system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CardFirstName":{
            "maxLength":40,
            "type":"string",
            "description":"First name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the payment type.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the billing payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"Authorized amount received from the tokenization service provider to authorize the transaction. The authorized amount must be provided if the authorization request identifier is sent in the payload.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-priceAdjustments-item-response

Type: object

Show Source

AdjustmentName: string

Maximum Length: 1000

Name of the price adjustment, such as discount, charge, or cost.
AdjustmentType: string

Read Only: true

Maximum Length: 255

Type of price adjustment.
AdjustmentTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of price adjustment.
Amount: number

Title: Amount

Cost amount or charge amount of the price adjustment.
InvoicedFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the application bills the price adjustment. If false, then the application does not bill the price adjustment.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrigSystemAdjustmentReference: string

Maximum Length: 50

Reference to the price adjustment from the source application.
PriceAdjustmentId: integer (int64)

Value that uniquely identifies the price adjustment.

{
    "type":"object",
    "properties":{
        "AdjustmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application bills the price adjustment. If false, then the application does not bill the price adjustment.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OrigSystemAdjustmentReference":{
            "maxLength":50,
            "type":"string",
            "description":"Reference to the price adjustment from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Cost amount or charge amount of the price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PriceAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of the price adjustment, such as discount, charge, or cost.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of price adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-lines-priceValidations-item-response

Type: object

Show Source

ChargeDefinition: string

Read Only: true

Maximum Length: 255

Value that identifies the pricing charge definition to use during price validation.
ChargeDefinitionCode: string

Maximum Length: 30

Abbreviation that identifies the pricing charge definition to use during price validation.
ChargeId: integer (int64)

Value that identifies the charge of the charge component during price validation.
ConstrainingValue: number

Specifies whether validation applies to discount percent or discount amount.
ConstrainingValueTypeCode: string

Maximum Length: 30

Abbreviation that identifies the type of constraining value, such as percent or amount.
ConstrainingValueTypeName: string

Read Only: true

Maximum Length: 255

Name of the type of constraining value, such as percent or amount.
Explanation: string

Maximum Length: 1000

Explanation that describes the price validation.
ExplanationMessageName: string

Maximum Length: 30

Name of the explanation that describes the price validation.
HeaderCurrencyCode: string

Maximum Length: 15

Abbreviation that identifies the header currency during price validation.
HeaderCurrencyConstrainingAmount: number

Value that constrains the calculation for the header currency during price validation.
HeaderCurrencyName: string

Read Only: true

Maximum Length: 255

Name of the header currency used during price validation.
links: array Links

Title: Links

The link relations associated with the resource instance.
ManualPriceAdjustmentId: integer (int64)

Value that identifies the manual price adjustment during price validation.
PricePeriodicity: string

Read Only: true

Maximum Length: 255

Name of the price periodicity to use recurring prices during price validation.
PricePeriodicityCode: string

Maximum Length: 30

Price periodicity to use recurring prices during price validation.
PriceValidationId: integer (int64)

Value that uniquely identifies the price validation.
RollupFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then apply validation on a rollup charge. If false, then validation do not apply validation on a rollup charge.
ValidationComponent: string

Read Only: true

Maximum Length: 255

Name of the charge component or total that pricing evaluates for the pricing guideline during price validation.
ValidationComponentCode: string

Maximum Length: 30

Abbreviation that identifies the charge component or total that pricing evaluates for the pricing guideline during price validation.
ValidationComponentEntityId: integer (int64)

Value that identifies the charge component or total that pricing evaluates for the pricing guideline during price validation.
ValidationComponentEntityType: string

Maximum Length: 30

Type of component entity against which the guideline is evaluated. Valid values include Charge Component or Total.
ValidationSourceRuleId: integer (int64)

Value that identifies the rule that pricing uses to evaluate the pricing guideline during price validation.
ValidationSourceType: string

Maximum Length: 255

Type of price validation. Values include Charge Guideline, Total Guideline, Floor Price, or GSA Price.
ValidationSourceTypeCode: string

Maximum Length: 30

Abbreviation that identifies the source type of the price validation.
ValidationStatus: string

Maximum Length: 30

Indicates whether price validation failed or passed.
ViolationTypeCode: string

Maximum Length: 30

Abbreviation that identifies the violation type that occurred during price validation. A list of accepted values is defined in the lookup type ORA_QP_GUIDE_VIOLATION_TYPES.
ViolationTypeName: string

Read Only: true

Maximum Length: 255

Name of the violation type that occurred during price validation.

{
    "type":"object",
    "properties":{
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then apply validation on a rollup charge. If false, then validation do not apply validation on a rollup charge.",
            "nullable":false,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the pricing charge definition to use during price validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Explanation":{
            "maxLength":1000,
            "type":"string",
            "description":"Explanation that describes the price validation.",
            "nullable":false,
            "x-queryable":false
        },
        "ValidationComponentEntityType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of component entity against which the guideline is evaluated. Valid values include Charge Component or Total.",
            "nullable":false,
            "x-queryable":false
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the pricing charge definition to use during price validation.",
            "nullable":true,
            "x-queryable":false
        },
        "ValidationSourceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the source type of the price validation.",
            "nullable":false,
            "x-queryable":false
        },
        "ValidationComponent":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the charge component or total that pricing evaluates for the pricing guideline during price validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationSourceRuleId":{
            "type":"integer",
            "description":"Value that identifies the rule that pricing uses to evaluate the pricing guideline during price validation.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HeaderCurrencyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the header currency used during price validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViolationTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the violation type that occurred during price validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConstrainingValueTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of constraining value, such as percent or amount.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyConstrainingAmount":{
            "type":"number",
            "description":"Value that constrains the calculation for the header currency during price validation.",
            "nullable":false,
            "x-queryable":false
        },
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Price periodicity to use recurring prices during price validation.",
            "nullable":true,
            "x-queryable":false
        },
        "ViolationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the violation type that occurred during price validation. A list of accepted values is defined in the lookup type ORA_QP_GUIDE_VIOLATION_TYPES.",
            "nullable":false,
            "x-queryable":false
        },
        "ExplanationMessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the explanation that describes the price validation.",
            "nullable":false,
            "x-queryable":false
        },
        "HeaderCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the header currency during price validation.",
            "nullable":false,
            "x-queryable":false
        },
        "ValidationComponentEntityId":{
            "type":"integer",
            "description":"Value that identifies the charge component or total that pricing evaluates for the pricing guideline during price validation.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ValidationComponentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the charge component or total that pricing evaluates for the pricing guideline during price validation.",
            "nullable":false,
            "x-queryable":false
        },
        "ValidationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether price validation failed or passed.",
            "nullable":false,
            "x-queryable":false
        },
        "PricePeriodicity":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price periodicity to use recurring prices during price validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationSourceType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of price validation. Values include Charge Guideline, Total Guideline, Floor Price, or GSA Price.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualPriceAdjustmentId":{
            "type":"integer",
            "description":"Value that identifies the manual price adjustment during price validation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConstrainingValue":{
            "type":"number",
            "description":"Specifies whether validation applies to discount percent or discount amount.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeId":{
            "type":"integer",
            "description":"Value that identifies the charge of the charge component during price validation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceValidationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price validation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConstrainingValueTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of constraining value, such as percent or amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-project-item-response

Type: object

Show Source

DooOrderPrjId: integer

Value that uniquely identifies the project for an order line.
links: array Links

Title: Links

The link relations associated with the resource instance.
projectDetail: array Project Details

Title: Project Details

The Project Details resource manages the descriptive flexfield data of the project for an order line.

{
    "type":"object",
    "properties":{
        "DooOrderPrjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for an order line.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "projectDetail":{
            "title":"Project Details",
            "type":"array",
            "description":"The Project Details resource manages the descriptive flexfield data of the project for an order line.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-project-projectDetail-item-response"
            },
            "x-cardinality":"1"
        },
        "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 : Project Details

Type: array

Title: Project Details

The Project Details resource manages the descriptive flexfield data of the project for an order line.

Show Source

Array of: object salesOrdersForOrderHub-lines-project-projectDetail-item-response

{
    "title":"Project Details",
    "type":"array",
    "description":"The Project Details resource manages the descriptive flexfield data of the project for an order line.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-project-projectDetail-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : salesOrdersForOrderHub-lines-project-projectDetail-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Value

Maximum Length: 40

Default Value: OM_Sales_Order
__FLEX_Context_DisplayValue: string

Title: Context Value
DooOrderPrjId: integer

Value that uniquely identifies the project details for an order line.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DooOrderPrjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project details for an order line.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "default":"OM_Sales_Order",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-renewSubscriptionReference-item-response

Type: object

Show Source

ExternalAssetKey: string

Maximum Length: 150

Value that identifies the asset key for the subscription or coverage item in an external application.
ExternalParentAssetKey: string

Maximum Length: 150

Value that identifies the parent asset key for the subscription or coverage item in an external application.
ExternalRootParentAssetKey: string

Maximum Length: 150

Value that identifies the root parent asset key for the subscription or coverage item in an external application.
links: array Links

Title: Links

The link relations associated with the resource instance.
SubscriptionProductPuid: string

Maximum Length: 150

Value that uniquely identifies the subscription product in Oracle Subscription Management Cloud.

{
    "type":"object",
    "properties":{
        "ExternalAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalParentAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the parent asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalRootParentAssetKey":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the root parent asset key for the subscription or coverage item in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":150,
            "type":"string",
            "description":"Value that uniquely identifies the subscription product in Oracle Subscription Management Cloud.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-salesCredits-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
Percent: number

Value that specifies the sales credit percent for the salesperson.
SalesCreditId: integer (int64)

Read Only: true

Value that uniquely identifies the sales credit.
SalesCreditType: string

Maximum Length: 255

Name of the sales credit type.
SalesCreditTypeId: integer (int64)

Value that identifies the sales credit type.
Salesperson: string

Maximum Length: 255

Name of person who sold the item.
SalespersonId: integer (int64)

Value that identifies the person who sold the item.
SourceTransactionSalesCreditIdentifier: string

Maximum Length: 50

Value that uniquely identifies the sales credit. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "Percent":{
            "type":"number",
            "description":"Value that specifies the sales credit percent for the salesperson.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"Value that identifies the sales credit type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SalesCreditType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the sales credit type.",
            "nullable":true,
            "x-queryable":true
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that identifies the person who sold the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceTransactionSalesCreditIdentifier":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the sales credit. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "Salesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Name of person who sold the item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-shipToCustomer-item-response

Type: object

Show Source

Address1: string

Maximum Length: 255

First line of the ship-to customer address.
Address2: string

Maximum Length: 255

Second line of the ship-to customer address.
Address3: string

Maximum Length: 255

Third line of the ship-to customer address.
Address4: string

Maximum Length: 255

Fourth line of the ship-to customer address.
AddressId: integer (int64)

Value that uniquely identifies the ship-to customer address.
City: string

Maximum Length: 255

City of the ship-to customer address.
ContactFirstName: string

Maximum Length: 255

First name of the person to contact at the ship-to party site.
ContactId: integer (int64)

Value that uniquely identifies the contact at the ship-to party site.
ContactLastName: string

Maximum Length: 255

Title name of the person to contact at the ship-to party site.
ContactMiddleName: string

Maximum Length: 255

Middle name of the person to contact at the ship-to party site.
ContactName: string

Maximum Length: 255

Name of the person to contact at the ship-to party site.
ContactNameSuffix: string

Maximum Length: 255

Name suffix of the person to contact at the ship-to party site.
ContactNumber: string

Maximum Length: 255

Telephone number of the person to contact at the ship-to party site.
ContactTitle: string

Maximum Length: 255

Title of the person to contact at the ship-to party site.
Country: string

Maximum Length: 255

Country of the ship-to customer address.
County: string

Maximum Length: 255

County of the ship-to customer address.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyId: integer (int64)

Value that uniquely identifies the ship-to party.
PartyName: string

Maximum Length: 255

Name of the ship-to party.
PartyNumber: string

Maximum Length: 255

Telephone number of the ship-to party.
PersonFirstName: string

Maximum Length: 255

First name of the person to contact at the ship-to customer site.
PersonLastName: string

Maximum Length: 255

Last name of the person to contact at the ship-to customer site.
PersonMiddleName: string

Maximum Length: 255

Middle name of the person to contact at the ship-to customer site.
PersonNameSuffix: string

Maximum Length: 255

Name suffix of the person to contact at the ship-to customer site.
PersonTitle: string

Maximum Length: 255

Title of the person to contact at the ship-to customer site.
PostalCode: string

Maximum Length: 255

City of the ship-to customer address.
PreferredContactPointId: integer (int64)

Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
Province: string

Maximum Length: 255

Province of the ship-to customer address.
SiteId: integer (int64)

Value that uniquely identifies the ship-to customer address.
SourceAddressId: string

Maximum Length: 255

Value that uniquely identifies the ship-to customer address. Value is 1.
State: string

Maximum Length: 255

State of the ship-to customer address.

{
    "type":"object",
    "properties":{
        "SiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":255,
            "type":"string",
            "description":"County of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Telephone number of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":255,
            "type":"string",
            "description":"Second line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":255,
            "type":"string",
            "description":"First line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Title name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Telephone number of the ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"State of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAddressId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the ship-to customer address. Value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-subscriptionReferences-item-response

Type: object

Show Source

DisplayLineNumber: string

Read Only: true

Maximum Length: 255

Number that the order management work area displays to identify the order line of the subscription item that is associated with the product.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the sales order that contains the subscription item that is associated with the product.
SourceLineNumber: string

Title: Source Order Line

Maximum Length: 100

Number that identifies the order line in the source application that contains the subscription item which is associated with the product.
SourceOrderNumber: string

Title: Source Order

Maximum Length: 50

Number that identifies the source order in the source application that contains the subscription item which is associated with the product.
SubscriptionFulFillLineId: integer (int64)

Read Only: true

Value that uniquely identifies the fulfillment line of the subscription item that is associated with the product.
SubscriptionHeaderId: integer (int64)

Read Only: true

Value that uniquely identifies the sales order header that contains the subscription item which is associated with the product.
SubscriptionItemNumber: string

Read Only: true

Maximum Length: 255

Number that identifies the subscription item that is associated with the product.

{
    "type":"object",
    "properties":{
        "DisplayLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that the order management work area displays to identify the order line of the subscription item that is associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriptionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order header that contains the subscription item which is associated with the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrderNumber":{
            "title":"Source Order",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the source order in the source application that contains the subscription item which is associated with the product.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the subscription item that is associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriptionFulFillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line of the subscription item that is associated with the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the sales order that contains the subscription item that is associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceLineNumber":{
            "title":"Source Order Line",
            "maxLength":100,
            "type":"string",
            "description":"Number that identifies the order line in the source application that contains the subscription item which is associated with the product.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-subscriptionTerm-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
OrderTermId: integer (int64)

Value that uniquely identifies the term.
SourceOrderTermId: string

Maximum Length: 50

Value that uniquely identifies the order term in the source application. For subscription term, the value is 1.
TermAdjustmentPercent: number

Percent of adjustment for the term.
TermApplicationMethod: string

Maximum Length: 80

Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod.
TermApplicationMethodCode: string

Maximum Length: 30

Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE.
TermDuration: number

Duration for the subscription term.
TermPeriod: string

Maximum Length: 25

Name of the time unit of measure for the subscription term.
TermPeriodCode: string

Maximum Length: 15

Abbreviation that identifies the time unit of measure for the subscription term.
TermStartDate: string (date-time)

Date when the subscription term starts.
TermTypeCode: string

Read Only: true

Maximum Length: 30

Default Value: SUBSCRIPTION

Abbreviation that identifies the type of the term. For subscription term, the TermTypeCode is SUBSCRIPTION.

{
    "type":"object",
    "properties":{
        "SourceOrderTermId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the order term in the source application. For subscription term, the value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "TermApplicationMethod":{
            "maxLength":80,
            "type":"string",
            "description":"Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod.",
            "nullable":true,
            "x-queryable":true
        },
        "TermPeriod":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the time unit of measure for the subscription term.",
            "nullable":true,
            "x-queryable":true
        },
        "TermAdjustmentPercent":{
            "type":"number",
            "description":"Percent of adjustment for the term.",
            "nullable":true,
            "x-queryable":true
        },
        "TermStartDate":{
            "type":"string",
            "description":"Date when the subscription term starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TermApplicationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TermDuration":{
            "type":"number",
            "description":"Duration for the subscription term.",
            "nullable":true,
            "x-queryable":true
        },
        "TermTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the term. For subscription term, the TermTypeCode is SUBSCRIPTION.",
            "nullable":false,
            "readOnly":true,
            "default":"SUBSCRIPTION",
            "x-queryable":true
        },
        "TermPeriodCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the time unit of measure for the subscription term.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderTermId":{
            "type":"integer",
            "description":"Value that uniquely identifies the term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-supplyOrderReference-item-response

Type: object

Show Source

DocumentSystemReferenceId: integer (int64)

Value that uniquely identifies the document system reference for the supply order.
links: array Links

Title: Links

The link relations associated with the resource instance.
SupplyOrderNumber: string

Maximum Length: 150

Number that identifies the supply order during back-to-back fulfillment.

{
    "type":"object",
    "properties":{
        "DocumentSystemReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document system reference for the supply order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplyOrderNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the supply order during back-to-back fulfillment.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-transactionItemAttributes-item-response

Type: object

Show Source

CharacterAttributeValue: string

Maximum Length: 2000

Character value for the transaction item attribute (TIA).
DateAttributeValue: string (date)

Date value for the transaction item attribute (TIA).
links: array Links

Title: Links

The link relations associated with the resource instance.
NumberAttributeValue: number

Number value for the transaction item attribute (TIA).
SourceTransactionLineAttributeId: string

Maximum Length: 50

Value that uniquely identifies the transaction item attribute on the fulfillment line. The source application assigns this value.
TimestampAttributeValue: string (date-time)

Time value for the transaction item attribute (TIA).
TransactionAttributeId: integer (int64)

Read Only: true

Value that uniquely identifies the transaction item attribute on the fulfillment line.
TransactionAttributeMetadataid: integer (int64)

Value that identifies the transaction item attribute (TIA) that stores the metadata.
TransactionAttributeName: string

Maximum Length: 255

Name of the transaction item attribute.
TransactionItemAttributeId: integer (int64)

Value that identifies the transaction item attribute (TIA).

{
    "type":"object",
    "properties":{
        "NumberAttributeValue":{
            "type":"number",
            "description":"Number value for the transaction item attribute (TIA).",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionAttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction item attribute on the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceTransactionLineAttributeId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction item attribute on the fulfillment line. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "TimestampAttributeValue":{
            "type":"string",
            "description":"Time value for the transaction item attribute (TIA).",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionAttributeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the transaction item attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionAttributeMetadataid":{
            "type":"integer",
            "description":"Value that identifies the transaction item attribute (TIA) that stores the metadata.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionItemAttributeId":{
            "type":"integer",
            "description":"Value that identifies the transaction item attribute (TIA).",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CharacterAttributeValue":{
            "maxLength":2000,
            "type":"string",
            "description":"Character value for the transaction item attribute (TIA).",
            "nullable":true,
            "x-queryable":false
        },
        "DateAttributeValue":{
            "type":"string",
            "description":"Date value for the transaction item attribute (TIA).",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-payments-item-response

Type: object

Show Source

Amount: number

Amount authorized for the payment.
AuthorizationRequestId: string

Maximum Length: 30

Value that uniquely identifies the authorization request received from the tokenization service provider to authorize the card number. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.
AuthorizationStatus: string

Maximum Length: 255

Authorization status of the payment transaction. Values include Pass or Fail.
AuthorizationStatusCode: string

Maximum Length: 30

Status of the payment. Values include Pass or Fail.
AuthorizedAmount: number

Authorized amount received from the tokenization service provider to authorize the transaction. The authorized amount must be provided if the authorization request identifier is sent in the payload.
AuthorizedInSourceFlag: boolean

Read Only: true

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then payment authorization occurs in the source application. If false, then payment authorization does not occur in the source application. The default value is true.
AuthorizedOn: string (date-time)

Date when the application authorized payment.
CardExpirationDate: string

Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.
CardFirstName: string

Maximum Length: 40

First name of the card holder.
CardIssuerCode: string

Maximum Length: 30

Value that identifies the card issuer; for example, Visa or MasterCard.
CardLastName: string

Maximum Length: 40

Last name of the card holder.
CardTokenNumber: string

Maximum Length: 30

Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.
InstrumentAssignmentId: integer (int64)

Read Only: true

Value that identifies the payment method.
links: array Links

Title: Links

The link relations associated with the resource instance.
MaskedCardNumber: string

Maximum Length: 30

Masked format that displays only the last four digits of a card number, and replaces all other digits with X. This attribute is used for security purposes. The length of the masked card number should match the actual length of the number provided by the card issuer. For example, the masked card number for a Visa card number is XXXXXXXXXXXX2345.
OriginalSystemPaymentReference: string

Maximum Length: 50

Value that uniquely identifies the payment details from the source application.
PaymentMethod: string

Maximum Length: 255

Name of the billing payment method.
PaymentMethodCode: integer (int64)

Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.
PaymentServerOrderNumber: string

Maximum Length: 80

Number that identifies the card payment that was authorized by Oracle Payments Cloud.
PaymentSetId: integer (int64)

Value that uniquely identifies the group of payments for one prepaid sales order. If the payment is a prepayment, then this attribute uses a foreign key to reference billing.
PaymentTransactionId: integer (int64)

Read Only: true

Value that uniquely identifies the payment.
PaymentType: string

Maximum Length: 255

Name of the payment method for the transaction.
PaymentTypeCode: string

Maximum Length: 30

Abbreviation that identifies the payment type.
TransactionExtensionId: integer (int64)

Value that identifies the payment transaction extension in the payment system.
UniquePaymentReference: string

Read Only: true

Maximum Length: 30

Unique payment reference that the application sends to the payment system for authorization.
VoiceAuthorizationCode: string

Maximum Length: 100

Abbreviation that identifies the card authorization. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstrumentAssignmentId":{
            "type":"integer",
            "description":"Value that identifies the payment method.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AuthorizedOn":{
            "type":"string",
            "description":"Date when the application authorized payment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "VoiceAuthorizationCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the card authorization. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizationRequestId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the authorization request received from the tokenization service provider to authorize the card number. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalSystemPaymentReference":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the payment details from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Authorization status of the payment transaction. Values include Pass or Fail.",
            "nullable":true,
            "x-queryable":true
        },
        "CardExpirationDate":{
            "type":"string",
            "description":"Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the payment method for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuthorizedInSourceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then payment authorization occurs in the source application. If false, then payment authorization does not occur in the source application. The default value is true.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "UniquePaymentReference":{
            "maxLength":30,
            "type":"string",
            "description":"Unique payment reference that the application sends to the payment system for authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CardTokenNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.",
            "nullable":true,
            "x-queryable":false
        },
        "CardLastName":{
            "maxLength":40,
            "type":"string",
            "description":"Last name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "CardIssuerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the card issuer; for example, Visa or MasterCard.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Amount authorized for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "MaskedCardNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Masked format that displays only the last four digits of a card number, and replaces all other digits with X. This attribute is used for security purposes. The length of the masked card number should match the actual length of the number provided by the card issuer. For example, the masked card number for a Visa card number is XXXXXXXXXXXX2345.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group of payments for one prepaid sales order. If the payment is a prepayment, then this attribute uses a foreign key to reference billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "PaymentServerOrderNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the card payment that was authorized by Oracle Payments Cloud.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the payment. Values include Pass or Fail.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionExtensionId":{
            "type":"integer",
            "description":"Value that identifies the payment transaction extension in the payment system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CardFirstName":{
            "maxLength":40,
            "type":"string",
            "description":"First name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the payment type.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the billing payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"Authorized amount received from the tokenization service provider to authorize the transaction. The authorized amount must be provided if the authorization request identifier is sent in the payload.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : salesOrdersForOrderHub-salesCredits-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
Percent: number

Value that specifies the sales credit percent for the salesperson.
SalesCreditId: integer (int64)

Read Only: true

Value that uniquely identifies the sales credit.
SalesCreditType: string

Maximum Length: 255

Name of the sales credit type.
SalesCreditTypeId: integer (int64)

Value that identifies the sales credit type.
Salesperson: string

Maximum Length: 255

Name of person who sold the item.
SalespersonId: integer (int64)

Value that identifies the person who sold the item.
SourceTransactionSalesCreditIdentifier: string

Maximum Length: 50

Value that uniquely identifies the sales credit. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "Percent":{
            "type":"number",
            "description":"Value that specifies the sales credit percent for the salesperson.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"Value that identifies the sales credit type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SalesCreditType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the sales credit type.",
            "nullable":true,
            "x-queryable":true
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that identifies the person who sold the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceTransactionSalesCreditIdentifier":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the sales credit. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "Salesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Name of person who sold the item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-shipToCustomer-item-response

Type: object

Show Source

Address1: string

Maximum Length: 255

First line of the ship-to customer address.
Address2: string

Maximum Length: 255

Second line of the ship-to customer address.
Address3: string

Maximum Length: 255

Third line of the ship-to customer address.
Address4: string

Maximum Length: 255

Fourth line of the ship-to customer address.
AddressId: integer (int64)

Value that uniquely identifies the ship-to customer address.
City: string

Maximum Length: 255

City of the ship-to customer address.
ContactFirstName: string

Maximum Length: 255

First name of the person to contact at the ship-to party site.
ContactId: integer (int64)

Value that uniquely identifies the contact at the ship-to party site.
ContactLastName: string

Maximum Length: 255

Title name of the person to contact at the ship-to party site.
ContactMiddleName: string

Maximum Length: 255

Middle name of the person to contact at the ship-to party site.
ContactName: string

Maximum Length: 255

Name of the person to contact at the ship-to party site.
ContactNameSuffix: string

Maximum Length: 255

Name suffix of the person to contact at the ship-to party site.
ContactNumber: string

Maximum Length: 255

Telephone number of the person to contact at the ship-to party site.
ContactTitle: string

Maximum Length: 255

Title of the person to contact at the ship-to party site.
Country: string

Maximum Length: 255

Country of the ship-to customer address.
County: string

Maximum Length: 255

County of the ship-to customer address.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyId: integer (int64)

Value that uniquely identifies the ship-to party.
PartyName: string

Maximum Length: 255

Name of the ship-to party.
PartyNumber: string

Maximum Length: 255

Telephone number of the ship-to party.
PersonFirstName: string

Maximum Length: 255

First name of the person to contact at the ship-to customer site.
PersonLastName: string

Maximum Length: 255

Last name of the person to contact at the ship-to customer site.
PersonMiddleName: string

Maximum Length: 255

Middle name of the person to contact at the ship-to customer site.
PersonNameSuffix: string

Maximum Length: 255

Name suffix of the person to contact at the ship-to customer site.
PersonTitle: string

Maximum Length: 255

Title of the person to contact at the ship-to customer site.
PostalCode: string

Maximum Length: 255

City of the ship-to customer address.
PreferredContactPointId: integer (int64)

Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
Province: string

Maximum Length: 255

Province of the ship-to customer address.
SiteId: integer (int64)

Value that uniquely identifies the ship-to customer address.
SourceAddressId: string

Maximum Length: 255

Value that uniquely identifies the ship-to customer address. Value is 1.
State: string

Maximum Length: 255

State of the ship-to customer address.

{
    "type":"object",
    "properties":{
        "SiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":255,
            "type":"string",
            "description":"County of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Telephone number of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":255,
            "type":"string",
            "description":"Second line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":255,
            "type":"string",
            "description":"First line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Title name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Telephone number of the ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"State of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAddressId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the ship-to customer address. Value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : salesOrdersForOrderHub-totals-item-response

Type: object

Show Source

CurrencyCode: string

Maximum Length: 15

Currency that the sales order total uses.
CurrencyName: string

Read Only: true

Maximum Length: 255

Name of the currency that the sales order total uses.
DisplayName: string

Maximum Length: 255

Display name of the sales order total, displayed in the language that the sales order uses.
EstimatedFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then Oracle Fusion Pricing estimates the total. For example, pricing might estimate total for a usage price. If false, then Oracle Fusion Pricing does not estimate the total.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderTotalId: integer (int64)

Value that uniquely identifies the total for the sales order.
PrimaryFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the total is the primary total. If false, then the total is not the primary total. Each sales order includes only one primary total.
TotalAmount: number

Amount calculated for the sales order total.
TotalCode: string

Maximum Length: 30

Abbreviation that identifies the definition that defines properties for the sales order total.
totalComponents: array Total Components

Title: Total Components

The Total Components resource manages the components that determine the total price of a sales order.
TotalGroup: string

Maximum Length: 240

Group of related totals. For example, total for a one-time charge, or total for adjustments on a one-time charge.
TotalName: string

Read Only: true

Maximum Length: 255

Name of the definition that defines properties for the sales order total.

{
    "type":"object",
    "properties":{
        "TotalCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the definition that defines properties for the sales order total.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency that the sales order total uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the total is the primary total. If false, then the total is not the primary total. Each sales order includes only one primary total.",
            "nullable":false,
            "x-queryable":false
        },
        "OrderTotalId":{
            "type":"integer",
            "description":"Value that uniquely identifies the total for the sales order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalGroup":{
            "maxLength":240,
            "type":"string",
            "description":"Group of related totals. For example, total for a one-time charge, or total for adjustments on a one-time charge.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the sales order total, displayed in the language that the sales order uses.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the definition that defines properties for the sales order total.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EstimatedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then Oracle Fusion Pricing estimates the total. For example, pricing might estimate total for a usage price. If false, then Oracle Fusion Pricing does not estimate the total.",
            "nullable":false,
            "x-queryable":false
        },
        "TotalAmount":{
            "type":"number",
            "description":"Amount calculated for the sales order total.",
            "nullable":false,
            "x-queryable":true
        },
        "totalComponents":{
            "title":"Total Components",
            "type":"array",
            "description":"The Total Components resource manages the components that determine the total price of a sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-totals-totalComponents-item-response"
            }
        },
        "CurrencyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency that the sales order total uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : Total Components

Type: array

Title: Total Components

The Total Components resource manages the components that determine the total price of a sales order.

Show Source

Array of: object salesOrdersForOrderHub-totals-totalComponents-item-response

{
    "title":"Total Components",
    "type":"array",
    "description":"The Total Components resource manages the components that determine the total price of a sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-totals-totalComponents-item-response"
    }
}

Nested Schema : salesOrdersForOrderHub-totals-totalComponents-item-response

Type: object

Show Source

HeaderCurrencyCode: string

Read Only: true

Maximum Length: 15

Abbreviation that identifies the currency that the order header uses.
HeaderCurrencyExtendedAmount: number

Read Only: true

Extended amount, displayed in currency that the order header uses.
HeaderCurrencyName: string

Read Only: true

Maximum Length: 255

Name of the currency that the order header uses.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderChargeComponentId: integer (int64)

Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.
OrderTotalComponentId: integer (int64)

Value that identifies the charge component that stores the sales order total.
OrderTotalId: integer (int64)

Value that identifies the sales order total.
PriceElement: string

Read Only: true

Maximum Length: 255

Name of the price element. For example, list price, net price, and so on.
PriceElementCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the price element.
PriceElementUsage: string

Read Only: true

Maximum Length: 255

Name of the price element usage.
PriceElementUsageCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies price element usage.

{
    "type":"object",
    "properties":{
        "OrderTotalComponentId":{
            "type":"integer",
            "description":"Value that identifies the charge component that stores the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the price element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderTotalId":{
            "type":"integer",
            "description":"Value that identifies the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price element. For example, list price, net price, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriceElementUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies price element usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HeaderCurrencyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderChargeComponentId":{
            "type":"integer",
            "description":"Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElementUsage":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the price element usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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"
    }
}

Links

applyHold: Operation: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/action/applyHold

This service can be used to apply holds on the sales order resource at the order header and fulfillment line levels.
releaseHold: Operation: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/action/releaseHold

This service can be used to release holds on the sales order resource at the order header and fulfillment line levels.
splitFulfillmentLine: Operation: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/action/splitFulfillmentLine

Splits fulfillment lines across sales orders without having to revise the orders. This service sets the OverrideScheduleDateFlag attribute to true on the original and split lines when you split the fulfillment lines.
updateSchedulingAttribute: Operation: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/action/updateSchedulingAttribute

Updates fulfillment lines across sales orders without having to revise the orders. You can update scheduling attributes, substitute items, or remove fulfillment lines from a shipment set. This service sets the OverrideScheduleDateFlag attribute to true when you update the fulfillment lines.

Examples

This example describes how to get all sales orders.

Example Number	Description
Example 1	Get all sales orders.
Example 2	Get one or more sales orders using the findBySourceOrderNumberAndSystem finder.
Example 3	Get one sales order using the findByHeaderId finder.
Example 4	Get one or more sales orders using the findByOrderKey finder.
Example 5	Get or more sales orders using the findByOrderNumber finder.
Example 6	Get one sales order using the PrimaryKey finder.
Example 7	Get one or more sales orders using the findByOrderedDate finder.
Example 8	Get one or more sales orders using order creation date time range.
Example 9	Get one or more orders using query attributes at the order line level.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub"

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100088545772,
		"OrderNumber" : "404087",
		"SourceTransactionNumber" : "404087",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100088545772",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2017-07-26T14:03:55+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : "ManualSchedulingProcess",
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-15T14:03:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Vision Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 4,
		"PaymentTerms" : "30 Net",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1 because Revenue Potential=Medium Customer Size=Medium Cost To Serve=Medium Customer Value=Medium Customer Rating=Medium",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "OPEN",
		"Status" : "Processing",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : true,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		"PreCreditCheckedFlag" : false,
		"RevisionSourceSystem" : null,
		"SourceTransactionRevisionNumber" : 1,
		"TradeComplianceResultCode" : null,
		"TradeComplianceResult" : null,
		"LastUpdatedBy" : "OPERATIONS",
		"LastUpdateDate" : "2017-07-26T11:49:06.848+00:00",
		"CreatedBy" : "OPERATIONS",
		"CreationDate" : "2015-12-14T14:03:55.335+00:00",
		"OpenFlag" : true,
		"OrigSystemDocumentReference" : null,
		...
		...
		...
	},  {
		"HeaderId" : 300100085362537,
		"OrderNumber" : "341084",
		"SourceTransactionNumber" : "341084",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100085335551",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2015-12-11T09:16:55+00:00",
		"BuyingPartyId" : 34760,
		"BuyingPartyName" : "Tall Manufacturing",
		"BuyingPartyNumber" : "23482",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : null,
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-24T09:16:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Vision Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 1020,
		"PaymentTerms" : "Net 15",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1000 because Revenue Potential=null Customer Size=null Cost To Serve=null Customer Value=null Customer Rating=null",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "DOO_REFERENCE",
		"Status" : "Reference",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : false,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		...
		...
		...
	} ],
	"count" : 25,
	"hasMore" : true,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to get one or more sales orders using the findBySourceOrderNumberAndSystem finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?finder=findBySourceOrderNumberAndSystem;SourceTransactionNumber=404087,SourceTransactionSystem=GPR"

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100088545772,
		"OrderNumber" : "404087",
		"SourceTransactionNumber" : "404087",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100088545772",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2017-07-26T14:03:55+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : "ManualSchedulingProcess",
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-15T14:03:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Tall Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 4,
		"PaymentTerms" : "30 Net",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1 because Revenue Potential=Medium Customer Size=Medium Cost To Serve=Medium Customer Value=Medium Customer Rating=Medium",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "OPEN",
		"Status" : "Processing",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : true,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		"PreCreditCheckedFlag" : false,
		"RevisionSourceSystem" : null,
		"SourceTransactionRevisionNumber" : 1,
		"TradeComplianceResultCode" : null,
		"TradeComplianceResult" : null,
		"LastUpdatedBy" : "SCMOPERATIONS",
		"LastUpdateDate" : "2017-07-26T11:49:06.848+00:00",
		"CreatedBy" : "SCMOPERATIONS",
		"CreationDate" : "2015-12-14T14:03:55.335+00:00",
		"OpenFlag" : true,
		"OrigSystemDocumentReference" : null,
		"OrderKey" : "GPR:300100088545772",
		"AppliedCurrencyName" : "US Dollar",
		"SupplierSiteName" : null,
		"MessageText" : null,
		"AgreementHeaderId" : null,
		"AgreementNumber" : null,
		"AgreementVersionNumber" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/additionalInformation",
			"name" : "additionalInformation",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/attachments",
			"name" : "attachments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/billToCustomer",
			"name" : "billToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/copyOrderReference",
			"name" : "copyOrderReference",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/holds",
			"name" : "holds",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/lines",
			"name" : "lines",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/payments",
			"name" : "payments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/salesCredits",
			"name" : "salesCredits",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/shipToCustomer",
			"name" : "shipToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/totals",
			"name" : "totals",
			"kind" : "collection"
		} ]
	}, {
		"HeaderId" : 300100088546081,
		"OrderNumber" : "404087",
		"SourceTransactionNumber" : "404087",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100088545772",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2015-12-14T14:03:55+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : "ManualSchedulingProcess",
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-15T14:03:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Tall Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 4,
		"PaymentTerms" : "30 Net",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1000 because Revenue Potential=null Customer Size=null Cost To Serve=null Customer Value=null Customer Rating=null",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "DOO_REFERENCE",
		"Status" : "Reference",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : false,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		"PreCreditCheckedFlag" : false,
		"RevisionSourceSystem" : null,
		"SourceTransactionRevisionNumber" : 1,
		"TradeComplianceResultCode" : null,
		"TradeComplianceResult" : null,
		"LastUpdatedBy" : "SCMOPERATIONS",
		"LastUpdateDate" : "2015-12-14T14:07:52.741+00:00",
		"CreatedBy" : "SCMOPERATIONS",
		"CreationDate" : "2015-12-14T14:07:52.740+00:00",
		"OpenFlag" : false,
		"OrigSystemDocumentReference" : null,
		"OrderKey" : "GPR:300100088545772",
		"AppliedCurrencyName" : "US Dollar",
		"SupplierSiteName" : null,
		"MessageText" : null,
		"AgreementHeaderId" : null,
		"AgreementNumber" : null,
		"AgreementVersionNumber" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/additionalInformation",
			"name" : "additionalInformation",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/attachments",
			"name" : "attachments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/billToCustomer",
			"name" : "billToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/copyOrderReference",
			"name" : "copyOrderReference",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/holds",
			"name" : "holds",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/lines",
			"name" : "lines",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/payments",
			"name" : "payments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/salesCredits",
			"name" : "salesCredits",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/shipToCustomer",
			"name" : "shipToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/totals",
			"name" : "totals",
			"kind" : "collection"
		} ]
	} ],
	"count" : 2,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}

Example 3 cURL Command

Use the following cURL command to submit a request on the REST resource to Get one sales order using the findByHeaderId finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?finder=findByHeaderId;HeaderId= 300100088545772"

Example 3 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100088545772,
		"OrderNumber" : "404087",
		"SourceTransactionNumber" : "404087",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100088545772",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2017-07-26T14:03:55+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : "ManualSchedulingProcess",
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-15T14:03:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Tall Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 4,
		"PaymentTerms" : "30 Net",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1 because Revenue Potential=Medium Customer Size=Medium Cost To Serve=Medium Customer Value=Medium Customer Rating=Medium",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "OPEN",
		"Status" : "Processing",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : true,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		"PreCreditCheckedFlag" : false,
		"RevisionSourceSystem" : null,
		"SourceTransactionRevisionNumber" : 1,
		"TradeComplianceResultCode" : null,
		"TradeComplianceResult" : null,
		"LastUpdatedBy" : "SCMOPERATIONS",
		"LastUpdateDate" : "2017-07-26T11:49:06.848+00:00",
		"CreatedBy" : "SCMOPERATIONS",
		"CreationDate" : "2015-12-14T14:03:55.335+00:00",
		"OpenFlag" : true,
		"OrigSystemDocumentReference" : null,
		"OrderKey" : "GPR:300100088545772",
		"AppliedCurrencyName" : "US Dollar",
		"SupplierSiteName" : null,
		"MessageText" : null,
		"AgreementHeaderId" : null,
		"AgreementNumber" : null,
		"AgreementVersionNumber" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/additionalInformation",
			"name" : "additionalInformation",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/attachments",
			"name" : "attachments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/billToCustomer",
			"name" : "billToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/copyOrderReference",
			"name" : "copyOrderReference",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/holds",
			"name" : "holds",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/lines",
			"name" : "lines",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/payments",
			"name" : "payments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/salesCredits",
			"name" : "salesCredits",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/shipToCustomer",
			"name" : "shipToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/totals",
			"name" : "totals",
			"kind" : "collection"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}

Example 4 cURL Command

Use the following cURL command to submit a request on the REST resource to get one or more sales orders using the findByOrderKey finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?finder=findByOrderKey;OrderKey='GPR:300100088545772'"

Example 4 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100088545772,
		"OrderNumber" : "404087",
		"SourceTransactionNumber" : "404087",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100088545772",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2017-07-26T14:03:55+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : "ManualSchedulingProcess",
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-15T14:03:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Tall Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 4,
		"PaymentTerms" : "30 Net",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1 because Revenue Potential=Medium Customer Size=Medium Cost To Serve=Medium Customer Value=Medium Customer Rating=Medium",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "OPEN",
		"Status" : "Processing",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : true,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		"PreCreditCheckedFlag" : false,
		"RevisionSourceSystem" : null,
		"SourceTransactionRevisionNumber" : 1,
		"TradeComplianceResultCode" : null,
		"TradeComplianceResult" : null,
		"LastUpdatedBy" : "SCMOPERATIONS",
		"LastUpdateDate" : "2017-07-26T11:49:06.848+00:00",
		"CreatedBy" : "SCMOPERATIONS",
		"CreationDate" : "2015-12-14T14:03:55.335+00:00",
		"OpenFlag" : true,
		"OrigSystemDocumentReference" : null,
		"OrderKey" : "GPR:300100088545772",
		"AppliedCurrencyName" : "US Dollar",
		"SupplierSiteName" : null,
		"MessageText" : null,
		"AgreementHeaderId" : null,
		"AgreementNumber" : null,
		"AgreementVersionNumber" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/additionalInformation",
			"name" : "additionalInformation",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/attachments",
			"name" : "attachments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/billToCustomer",
			"name" : "billToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/copyOrderReference",
			"name" : "copyOrderReference",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/holds",
			"name" : "holds",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/lines",
			"name" : "lines",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/payments",
			"name" : "payments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/salesCredits",
			"name" : "salesCredits",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/shipToCustomer",
			"name" : "shipToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/totals",
			"name" : "totals",
			"kind" : "collection"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}

Example 5 cURL Command

Use the following cURL command to submit a request on the REST resource to Get or more sales orders using the findByOrderNumber finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?finder=findByOrderNumber;OrderNumber='404087'"

Example 5 Response Body

The following example includes the contents of the response body in JSON format. There are two versions of order 404087. The OrderKey value is GPR:300100088545772 for the latest version of the order. The reference order has the OrderKey value 300100088546081, which is the headerId of the reference order. Using corresponding links you can get either the latest version of the order or the reference order data.

{
    "items": [
        {
            "HeaderId": 300100088546081,
            "OrderNumber": "404087",
            "SourceTransactionNumber": "404087",
            "SourceTransactionSystem": "GPR",
            "SourceTransactionId": "300100088545772",
            "BusinessUnitId": 204,
            "BusinessUnitName": "Vision Operations",
            . . . 
            . . .
            "OpenFlag": false,
            "OrigSystemDocumentReference": null,
            "OrderKey": "300100088546081",
            "AppliedCurrencyName": "US Dollar",
            "SupplierSiteName": null,
            "MessageText": null,
            "AgreementHeaderId": null,
            "AgreementNumber": null,
            "AgreementVersionNumber": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/300100088546081",
                    "name": "salesOrdersForOrderHub",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                . . .
            ]
        },
        {
            "HeaderId": 300100088545772,
            "OrderNumber": "404087",
            "SourceTransactionNumber": "404087",
            "SourceTransactionSystem": "GPR",
            "SourceTransactionId": "300100088545772",
            "BusinessUnitId": 204,
            "BusinessUnitName": "Vision Operations",
            . . .
            . . .
            "OpenFlag": true,
            "OrigSystemDocumentReference": null,
            "OrderKey": "GPR:300100088545772",
            "AppliedCurrencyName": "US Dollar",
            "SupplierSiteName": null,
            "MessageText": null,
            "AgreementHeaderId": null,
            "AgreementNumber": null,
            "AgreementVersionNumber": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
                    "name": "salesOrdersForOrderHub",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
                    }
                },
                . . .
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
            "name": "salesOrdersForOrderHub",
            "kind": "collection"
        }
    ]
}

Example 6 cURL Command

Use the following cURL command to submit a request on the REST resource to get one sales order using the PrimaryKey finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?finder=PrimaryKey;HeaderId=300100088545772"

Example 6 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100088545772,
		"OrderNumber" : "404087",
		"SourceTransactionNumber" : "404087",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100088545772",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2017-07-26T14:03:55+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		"BuyingPartyPersonFirstName" : null,
		"BuyingPartyPersonLastName" : null,
		"BuyingPartyPersonMiddleName" : null,
		"BuyingPartyPersonNameSuffix" : null,
		"BuyingPartyPersonTitle" : null,
		"BuyingPartyContactId" : null,
		"BuyingPartyContactName" : null,
		"BuyingPartyContactNumber" : null,
		"BuyingPartyContactFirstName" : null,
		"BuyingPartyContactLastName" : null,
		"BuyingPartyContactMiddleName" : null,
		"BuyingPartyContactNameSuffix" : null,
		"BuyingPartyContactTitle" : null,
		"PreferredSoldToContactPointId" : null,
		"CustomerPONumber" : null,
		"TransactionTypeCode" : null,
		"TransactionType" : null,
		"SubstituteAllowedFlag" : false,
		"PackingInstructions" : "ManualSchedulingProcess",
		"ShippingInstructions" : null,
		"ShipsetFlag" : false,
		"PartialShipAllowedFlag" : true,
		"RequestedShipDate" : "2019-01-15T14:03:55+00:00",
		"RequestedArrivalDate" : null,
		"LatestAcceptableShipDate" : null,
		"LatestAcceptableArrivalDate" : null,
		"EarliestAcceptableShipDate" : null,
		"ShipmentPriorityCode" : null,
		"ShipmentPriority" : null,
		"ShippingCarrierId" : null,
		"ShippingCarrier" : null,
		"ShippingServiceLevelCode" : null,
		"ShippingServiceLevel" : null,
		"ShippingModeCode" : null,
		"ShippingMode" : null,
		"FOBPointCode" : null,
		"FOBPoint" : null,
		"DemandClassCode" : null,
		"DemandClass" : null,
		"FreightTermsCode" : null,
		"FreightTerms" : null,
		"RequestedFulfillmentOrganizationId" : 207,
		"RequestedFulfillmentOrganizationCode" : "M1",
		"RequestedFulfillmentOrganizationName" : "Tall Manufacturing",
		"SupplierId" : null,
		"SupplierName" : null,
		"SupplierSiteId" : null,
		"PaymentTermsCode" : 4,
		"PaymentTerms" : "30 Net",
		"SalespersonId" : null,
		"Salesperson" : null,
		"PricedOn" : null,
		"TransactionalCurrencyCode" : "USD",
		"TransactionalCurrencyName" : "US Dollar",
		"AppliedCurrencyCode" : "USD",
		"CurrencyConversionDate" : null,
		"CurrencyConversionRate" : null,
		"CurrencyConversionType" : null,
		"PricingSegmentCode" : "CORPORATE_SEGMENT",
		"PricingSegment" : "Corporate Segment",
		"PricingStrategyId" : 300100071623888,
		"PricingStrategyName" : "Corporate Pricing Strategy",
		"AllowCurrencyOverrideFlag" : true,
		"SegmentExplanationMessageName" : null,
		"PricingSegmentExplanation" : "The applicable pricing segment for this transaction is Pricing Segment=Corporate Segment Precedence=1 because Revenue Potential=Medium Customer Size=Medium Cost To Serve=Medium Customer Value=Medium Customer Rating=Medium",
		"StrategyExplanationMessageName" : null,
		"PricingStrategyExplanation" : "The applicable pricing strategy for this transaction is Pricing Strategy=Corporate Pricing Strategy because Channel Method=null Transaction Type=null Pricing Segment=Corporate Segment",
		"SalesChannelCode" : null,
		"SalesChannel" : null,
		"Comments" : null,
		"StatusCode" : "OPEN",
		"Status" : "Processing",
		"OnHoldFlag" : false,
		"CanceledFlag" : false,
		"CancelReasonCode" : null,
		"CancelReason" : null,
		"RequestedCancelDate" : null,
		"RequestingBusinessUnitId" : 204,
		"RequestingBusinessUnitName" : "Vision Operations",
		"RequestingLegalEntityId" : 204,
		"RequestingLegalEntity" : "Vision Operations",
		"FreezePriceFlag" : false,
		"FreezeShippingChargeFlag" : false,
		"FreezeTaxFlag" : false,
		"SubmittedFlag" : true,
		"SubmittedBy" : null,
		"SubmittedDate" : null,
		"TransactionDocumentTypeCode" : null,
		"PreCreditCheckedFlag" : false,
		"RevisionSourceSystem" : null,
		"SourceTransactionRevisionNumber" : 1,
		"TradeComplianceResultCode" : null,
		"TradeComplianceResult" : null,
		"LastUpdatedBy" : "SCMOPERATIONS",
		"LastUpdateDate" : "2017-07-26T11:49:06.848+00:00",
		"CreatedBy" : "SCMOPERATIONS",
		"CreationDate" : "2015-12-14T14:03:55.335+00:00",
		"OpenFlag" : true,
		"OrigSystemDocumentReference" : null,
		"OrderKey" : "GPR:300100088545772",
		"AppliedCurrencyName" : "US Dollar",
		"SupplierSiteName" : null,
		"MessageText" : null,
		"AgreementHeaderId" : null,
		"AgreementNumber" : null,
		"AgreementVersionNumber" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772",
			"name" : "salesOrdersForOrderHub",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/additionalInformation",
			"name" : "additionalInformation",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/attachments",
			"name" : "attachments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/billToCustomer",
			"name" : "billToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/copyOrderReference",
			"name" : "copyOrderReference",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/holds",
			"name" : "holds",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/lines",
			"name" : "lines",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/payments",
			"name" : "payments",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/salesCredits",
			"name" : "salesCredits",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/shipToCustomer",
			"name" : "shipToCustomer",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088545772/child/totals",
			"name" : "totals",
			"kind" : "collection"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}

Example 7 cURL Command

Use the following cURL command to submit a request on the REST resource to get one or more sales orders using the findByOrderedDate finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?finder=findByOrderedDate;FromDate='2019-12-25',ToDate='2019-12-26'"

Example 7 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100196363200,
		"OrderNumber" : "530116",
		"SourceTransactionNumber" : "APSMod-1576656685343",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "APSMod-1576656685343",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T10:00:00+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		...
	}, {
		"HeaderId" : 300100197949646,
		"OrderNumber" : "530732",
		"SourceTransactionNumber" : "P1_JMVY-1576979497929",
		"SourceTransactionSystem" : "LEG",
		"SourceTransactionId" : "P1_JMVY-1576979497929",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T10:00:00+00:00",
		"BuyingPartyId" : 1005,
		"BuyingPartyName" : "AT&T Universal Card",
		"BuyingPartyNumber" : "1005",
		...
	}, {
		"HeaderId" : 300100197948493,
		"OrderNumber" : "530728",
		"SourceTransactionNumber" : "P1_JMVY-1576979484269",
		"SourceTransactionSystem" : "LEG",
		"SourceTransactionId" : "P1_JMVY-1576979484269",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T10:00:00+00:00",
		"BuyingPartyId" : 1005,
		...
	}, {
		"HeaderId" : 300100198744542,
		"OrderNumber" : "531563",
		"SourceTransactionNumber" : "24162941",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "24162941",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T00:29:43+00:00",
		"BuyingPartyId" : 1006,
		...
	}, {
		"HeaderId" : 300100198742225,
		"OrderNumber" : "531565",
		"SourceTransactionNumber" : "531565",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100198742225",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T00:36:31+00:00",
		"BuyingPartyId" : 300100053897095,
		"BuyingPartyName" : "Pricing Customer 1",
		"BuyingPartyNumber" : "CDRM_96894",
		...
	}, {
		"HeaderId" : 300100198744543,
		"OrderNumber" : "531562",
		"SourceTransactionNumber" : "24162939",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "24162939",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T00:29:43+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		...
	} ],
	...
	"count" : 25,
	"hasMore" : true,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}

Example 8 cURL Command

Use the following cURL command to submit a request on the REST resource get one or more sales orders using order creation date time range.

Note:

For this command use Rest-Framework-Version 4 or later in the header parameter.

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?q=TransactionOn >'2019-12-25T00:00:00' AND TransactionOn < '2019-12-25T01:00:00'"

Example 8 Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HeaderId" : 300100196363200,
		"OrderNumber" : "530116",
		"SourceTransactionNumber" : "APSMod-1576656685343",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "APSMod-1576656685343",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T10:00:00+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		...
	}, {
		"HeaderId" : 300100197949646,
		"OrderNumber" : "530732",
		"SourceTransactionNumber" : "P1_JMVY-1576979497929",
		"SourceTransactionSystem" : "LEG",
		"SourceTransactionId" : "P1_JMVY-1576979497929",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T10:00:00+00:00",
		"BuyingPartyId" : 1005,
		"BuyingPartyName" : "AT & T Universal Card",
		"BuyingPartyNumber" : "1005",
		...
	}, {
		"HeaderId" : 300100197948493,
		"OrderNumber" : "530728",
		"SourceTransactionNumber" : "P1_JMVY-1576979484269",
		"SourceTransactionSystem" : "LEG",
		"SourceTransactionId" : "P1_JMVY-1576979484269",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T10:00:00+00:00",
		"BuyingPartyId" : 1005,
		...
	}, {
		"HeaderId" : 300100198744542,
		"OrderNumber" : "531563",
		"SourceTransactionNumber" : "24162941",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "24162941",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T00:29:43+00:00",
		"BuyingPartyId" : 1006,
		...
	}, {
		"HeaderId" : 300100198742225,
		"OrderNumber" : "531565",
		"SourceTransactionNumber" : "531565",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "300100198742225",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T00:36:31+00:00",
		"BuyingPartyId" : 300100053897095,
		"BuyingPartyName" : "Pricing Customer 1",
		"BuyingPartyNumber" : "CDRM_96894",
		...
	}, {
		"HeaderId" : 300100198744543,
		"OrderNumber" : "531562",
		"SourceTransactionNumber" : "24162939",
		"SourceTransactionSystem" : "GPR",
		"SourceTransactionId" : "24162939",
		"BusinessUnitId" : 204,
		"BusinessUnitName" : "Vision Operations",
		"TransactionOn" : "2019-12-25T00:29:43+00:00",
		"BuyingPartyId" : 1006,
		"BuyingPartyName" : "Computer Service and Rentals",
		"BuyingPartyNumber" : "1006",
		...
	} ],
	...
	...
	...
	...
	"count" : 25,
	"hasMore" : true,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
		"name" : "salesOrdersForOrderHub",
		"kind" : "collection"
	} ]
}"

Example 9 cURL Command

Use the following cURL command to submit a request on the REST resource to get one or more sales orders using query attributes at the order line level.

In this example, query parameter is used on the salesOrdersForOrderHub resource to get all sales orders matching the query result. The attributes ProductNumber and StatusCode in the lines resource, and the SubmittedFlag attribute in the salesOrdersForOrderHub resource are used to find all orders matching the given criteria.

Note:

Query attributes at the lines resource are used only for finding sales orders. The result contains all the order lines belonging to each of the matching sales orders and is not restricted to just the order lines that match the order line criteria.

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub?q=lines.ProductNumber%3D'AS92888'%20and%20lines.StatusCode%3D'AWAIT_SHIP'%20and%20SubmittedFlag%3Dtrue&expand=lines&fields=lines%3AFulfillLineId%2CProductNumber%2CStatusCode&onlyData=true'"

Example 9 Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 100000016287340,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED0005770800005AF31172C66C0000000EACED0005770800005AF31172C61B",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000047371007E00020000000B78"
                            }
                        }
                    }
                ],
                "count": 1,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/SIEBEL%3ABR_18Feb_2/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "SIEBEL:BR_18Feb_2",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                }
            }
        },
...
...
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 300100088947516,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F07F32E33C0000000EACED00057708000110F07F32E348",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B7371007E00020000000678"
                            }
                        }
                    },
                    {
                        "FulfillLineId": 300100089049789,
                        "ProductNumber": "CM15140",
                        "StatusCode": "NOT_STARTED",
                        "@context": {
                            "key": "00020000000EACED00057708000110F07F3472BD0000000EACED00057708000110F07F347312",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000047371007E00020000000378"
                            }
                        }
                    }
                ],
                "count": 2,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100088947507/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "GPR:300100088947507",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                }
            }
        },
  ...
  ...
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 300100149601569,
                        "ProductNumber": "AS92888",
                        "StatusCode": "PICKED",
                        "@context": {
                            "key": "00020000000EACED00057708000110F082D065210000000EACED00057708000110F082D06520",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000107371007E00020000000678"
                            }
                        }
                    },
                    {
                        "FulfillLineId": 300100149601571,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F082D065230000000EACED00057708000110F082D06522",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000F7371007E00020000000678"
                            }
                        }
                    },
                    {
                        "FulfillLineId": 300100149601573,
                        "ProductNumber": "AS54888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F082D065250000000EACED00057708000110F082D06524",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E7371007E00020000000678"
                            }
                        }
                    }
                ],
                "count": 3,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100149601567/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "GPR:300100149601567",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B78"
                }
            }
        },
...
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 300100187554440,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F0851382880000000EACED00057708000110F08513829D",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E7371007E00020000000378"
                            }
                        }
                    }
                ],
                "count": 1,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100187554415/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "GPR:300100187554415",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
                }
            }
        },
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 300100200892523,
                        "ProductNumber": "AS54888",
                        "StatusCode": "PICKED",
                        "@context": {
                            "key": "00020000000EACED00057708000110F085DF086B0000000EACED00057708000110F085DF087C",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E7371007E00020000000378"
                            }
                        }
                    },
                    {
                        "FulfillLineId": 300100200892557,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F085DF088D0000000EACED00057708000110F085DF089D",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B7371007E00020000000378"
                            }
                        }
                    },
                    {
                        "FulfillLineId": 300100200892595,
                        "ProductNumber": "MFG-OSP-SERV1",
                        "StatusCode": "NOT_STARTED",
                        "@context": {
                            "key": "00020000000EACED00057708000110F085DF08B30000000EACED00057708000110F085DF08C4",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000077371007E00020000000378"
                            }
                        }
                    }
                ],
                "count": 3,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100200892497/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "GPR:300100200892497",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
                }
            }
        },
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 300100200906451,
                        "ProductNumber": "Kit_Item1",
                        "StatusCode": "NOT_STARTED",
                        "@context": {
                            "key": "00020000000EACED00057708000110F085DF3ED30000000EACED00057708000110F085DF3EDF",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000067371007E00020000000478"
                            }
                        }
                    },
                    {
                        "FulfillLineId": 300100200891975,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F085DF06470000000EACED00057708000110F085DF0646",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000D7371007E00020000000578"
                            }
                        }
                    }
                ],
                "count": 2,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100200906426/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "GPR:300100200906426",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000A78"
                }
            }
        },
  ...
  ...
        {
            "lines": {
                "items": [
                    {
                        "FulfillLineId": 300100202384122,
                        "ProductNumber": "AS92888",
                        "StatusCode": "AWAIT_SHIP",
                        "@context": {
                            "key": "00020000000EACED00057708000110F085F5CAFA0000000EACED00057708000110F085F5CB0E",
                            "headers": {
                                "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B7371007E00020000000378"
                            }
                        }
                    }
                ],
                "count": 1,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100202384097/child/lines",
                        "name": "lines",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "GPR:300100202384097",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
                }
            }
        }
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub",
            "name": "salesOrdersForOrderHub",
            "kind": "collection"
        }
    ]
}