Jump to

• Request
• Response

Get all revenue contracts

get

/fscmRestApi/resources/11.13.18.05/revenueContracts

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 the revenue contracts that match the primary key criteria specified.
    Finder Variables:
    • CustomerContractHeaderId; integer; The unique identifier of the revenue contract header.
  • RevenueContractFinder: Finds the revenue contract that matches the specified search parameters.
    Finder Variables:
    • Number; string; The number associated with the revenue contract.
  • RevenueContractsFinder: Finds the revenue contracts that match the specified search parameters.
    Finder Variables:
    • AllocationPendingReason; string; The reason that allocation is pending on a revenue contract.
    • AllocationStatus; string; The allocation status of the revenue contract.
    • BilledAmount; string; The total amount that was billed to a contract.
    • Classification; string; The codes used to classify revenue contracts.
    • ContractGroupNumber; string; The unique identifier of a contract group.
    • Currency; string; The currency of the revenue contract.
    • Date; string; The date the revenue contract was created.
    • EffectivePeriod; string; The date range used to establish the standalone selling price.
    • ExcludeFromAutomaticWriteOff; string; The option that indicates whether the contract's residual balances are excluded from automatic write-off by the Residual Account Balance Write-Off process.
    • FreezeDate; string; The date when the revenue contract was frozen.
    • IdentificationRule; string; The unique identifier of the revenue contract identification rule.
    • NonexemptTransactionPrice; string; The amount of the contract after excluding the exempt performance obligations.
    • Reference; string; The reference information for the contract entered by the user.
    • RequestId; string; The unique identifier of the request.
    • ResidualBalanceAdjustmentStatus; string; The residual balance adjustment status of the revenue contract.
    • RevenueRecognisedAmount; string; The total amount of revenue that was recognized for a revenue contract.
    • ReviewStatus; string; The status of the revenue contract.
    • TransactionPrice; string; The total amount of the contract in the ledger currency.
• 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:
  

  • AllocationPendingReason; string; The reason that allocation is pending on a revenue contract. A list of accepted values is defined in the lookup type ORA_ALLOCATION_PENDING_REASON.
  • AllocationStatus; string; The allocation status of the revenue contract. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_ALLOCN_STATUS.
  • BilledAmount; number; The total amount that was billed to a contract.
  • Classification; string; The codes used to classify revenue contracts. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_CLASSIF_CODE.
  • ContractGroupNumber; string; The unique identifier of a contract group.
  • Currency; string; The currency of the revenue contract.
  • Date; string; The date the revenue contract was created.
  • EffectivePeriod; string; The date range used to establish the standalone selling price.
  • ExcludeFromAutomaticWriteOff; string; The option that indicates whether the contract's residual balances are excluded from automatic write-off by the Residual Account Balance Write-Off process.
  • FreezeDate; string; The date when the revenue contract was frozen.
  • IdentificationRule; string; The unique identifier of the revenue contract identification rule.
  • NonexemptTransactionPrice; number; The amount of the contract after excluding the exempt performance obligations.
  • Number; integer; The number associated with the revenue contract.
  • Reference; string; The reference information for the contract entered by the user.
  • RequestId; integer; The unique identifier of the request.
  • ResidualBalanceAdjustmentStatus; string; The residual balance adjustment status of the revenue contract. A list of accepted values is defined in the lookup type ORA_ADJUSTMENT_STATUS.
  • RevenueRecognisedAmount; number; The total amount of revenue that was recognized for a revenue contract.
  • ReviewStatus; string; The status of the revenue contract. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_REVIEW_STATUS.
  • TransactionPrice; number; The total amount of the contract in the ledger currency.
• 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.

Back to Top

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.

Body ()

Root Schema : revenueContracts

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/revenueContracts-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object revenueContracts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-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 : revenueContracts-item-response

Type: object

Show Source

• AllocationPendingReason: string
  Read Only: true

  Maximum Length: 80

  The reason that allocation is pending on a revenue contract. A list of accepted values is defined in the lookup type ORA_ALLOCATION_PENDING_REASON.
• AllocationStatus: string
  Read Only: true

  Maximum Length: 80

  The allocation status of the revenue contract. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_ALLOCN_STATUS.
• BilledAmount: number
  The total amount that was billed to a contract.
• Classification: string
  Read Only: true

  Maximum Length: 80

  The codes used to classify revenue contracts. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_CLASSIF_CODE.
• Comments: string
  Maximum Length: 1000

  The user-entered comments that are associated with the revenue contract.
• ContractGroupNumber: string
  Maximum Length: 320

  The unique identifier of a contract group.
• ConversionDate: string (date)
  The date when a conversion rate is used to convert an amount into another currency for a revenue contract. This attribute is required for nonfunctional currency revenue contracts. The value is imported from the source system along with the revenue basis data or populated by default from the contract date of the revenue contract.
• ConversionRateType: string
  Maximum Length: 30

  The type of currency conversion rate that is used to automatically populate a specific rate when converting a revenue contract into the ledger currency. Examples include corporate, user-defined, and spot.
• Currency: string
  Maximum Length: 15

  The currency of the revenue contract.
• CustomerContractHeaderId: integer (int64)
  The unique identifier of the customer contract header.
• Date: string (date)
  The date the revenue contract was created.
• EffectivePeriod: string
  Read Only: true

  Maximum Length: 60

  The date range used to establish the standalone selling price.
• ExcludeFromAutomaticWriteOff: string
  Read Only: true

  Maximum Length: 80

  The option that indicates whether the contract's residual balances are excluded from automatic write-off by the Residual Account Balance Write-Off process.
• FreezeDate: string (date)
  The date when the revenue contract was frozen.
• IdentificationRule: string
  Read Only: true

  Maximum Length: 100

  The unique identifier of the revenue contract identification rule.
• Ledger: string
  Title: Name

  Read Only: true

  Maximum Length: 30

  The ledger that is associated with the revenue contract.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NonexemptTransactionPrice: number
  The amount of the contract after excluding the exempt performance obligations.
• Number: integer (int64)
  The number associated with the revenue contract.
• performanceObligations: array Performance Obligations
  Title: Performance Obligations

  The performance obligations resource is used to retrieve the performance obligations of a revenue contract.
• Reference: string
  Maximum Length: 1000

  The reference information for the contract entered by the user.
• RequestId: integer (int64)
  The unique identifier of the request.
• ResidualBalanceAdjustmentStatus: string
  Read Only: true

  Maximum Length: 80

  The residual balance adjustment status of the revenue contract. A list of accepted values is defined in the lookup type ORA_ADJUSTMENT_STATUS.
• RevenueRecognisedAmount: number
  The total amount of revenue that was recognized for a revenue contract.
• ReviewStatus: string
  Read Only: true

  Maximum Length: 80

  The status of the revenue contract. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_REVIEW_STATUS.
• TransactionPrice: number
  The total amount of the contract in the ledger currency.

{
    "type":"object",
    "properties":{
        "ExcludeFromAutomaticWriteOff":{
            "maxLength":80,
            "type":"string",
            "description":"The option that indicates whether the contract's residual balances are excluded from automatic write-off by the Residual Account Balance Write-Off process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "performanceObligations":{
            "title":"Performance Obligations",
            "type":"array",
            "description":"The performance obligations resource is used to retrieve the performance obligations of a revenue contract.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-item-response"
            }
        },
        "ConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of currency conversion rate that is used to automatically populate a specific rate when converting a revenue contract into the ledger currency. Examples include corporate, user-defined, and spot.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractGroupNumber":{
            "maxLength":320,
            "type":"string",
            "description":"The unique identifier of a contract group.",
            "nullable":true,
            "x-queryable":true
        },
        "Number":{
            "type":"integer",
            "description":"The number associated with the revenue contract.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReviewStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the revenue contract. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_REVIEW_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NonexemptTransactionPrice":{
            "type":"number",
            "description":"The amount of the contract after excluding the exempt performance obligations.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":80,
            "type":"string",
            "description":"The codes used to classify revenue contracts. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_CLASSIF_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectivePeriod":{
            "maxLength":60,
            "type":"string",
            "description":"The date range used to establish the standalone selling price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the revenue contract.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FreezeDate":{
            "type":"string",
            "description":"The date when the revenue contract was frozen.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AllocationPendingReason":{
            "maxLength":80,
            "type":"string",
            "description":"The reason that allocation is pending on a revenue contract. A list of accepted values is defined in the lookup type ORA_ALLOCATION_PENDING_REASON.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The allocation status of the revenue contract. A list of accepted values is defined in the lookup type ORA_VRM_CONTRACT_ALLOCN_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueRecognisedAmount":{
            "type":"number",
            "description":"The total amount of revenue that was recognized for a revenue contract.",
            "nullable":true,
            "x-queryable":true
        },
        "Reference":{
            "maxLength":1000,
            "type":"string",
            "description":"The reference information for the contract entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The user-entered comments that are associated with the revenue contract.",
            "nullable":true,
            "x-queryable":false
        },
        "Ledger":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The ledger that is associated with the revenue contract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BilledAmount":{
            "type":"number",
            "description":"The total amount that was billed to a contract.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionPrice":{
            "type":"number",
            "description":"The total amount of the contract in the ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "Date":{
            "type":"string",
            "description":"The date the revenue contract was created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "IdentificationRule":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the revenue contract identification rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResidualBalanceAdjustmentStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The residual balance adjustment status of the revenue contract. A list of accepted values is defined in the lookup type ORA_ADJUSTMENT_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerContractHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the customer contract header.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConversionDate":{
            "type":"string",
            "description":"The date when a conversion rate is used to convert an amount into another currency for a revenue contract. This attribute is required for nonfunctional currency revenue contracts. The value is imported from the source system along with the revenue basis data or populated by default from the contract date of the revenue contract.",
            "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 : Performance Obligations

Type: array

Title: Performance Obligations

The performance obligations resource is used to retrieve the performance obligations of a revenue contract.

Show Source

• Array of: object revenueContracts-performanceObligations-item-response

{
    "title":"Performance Obligations",
    "type":"array",
    "description":"The performance obligations resource is used to retrieve the performance obligations of a revenue contract.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-item-response"
    }
}

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 : revenueContracts-performanceObligations-item-response

Type: object

Show Source

• DevolvePerformanceObligation: string
  Maximum Length: 1

  Status indicating that the performance obligation is devolved. A performance obligation is devolved when the Devolve performance obligation option is set to Yes in either the performance obligation identification rule or the implied obligation template that was used during the identification of the performance obligation.
• ImpliedObligationTemplateName: string
  Read Only: true

  Maximum Length: 60

  The name of the template used to create the implied performance obligation.
• ImpliedPerformanceObligation: string
  Read Only: true

  Maximum Length: 80

  The status specifying the performance obligation is added using an implied obligation template or using a source document line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObligationAmount: number
  The transaction price allocated to the performance obligation in the currency of the performance obligation.
• ObligationBasePricePercentage: number
  The base price percentage of the performance obligation.
• ObligationBilledAmount: number
  The total amount that was billed to a performance obligation.
• ObligationClassification: string
  Read Only: true

  Maximum Length: 80

  The codes used to classify performance obligations. A list of accepted values is defined in the lookup type ORA_VRM_OBLIG_CLASSIF_CODE.
• ObligationComputedResidualSSP: number
  The calculated residual estimated extended standalone selling price of the performance obligation in the contract currency.
• ObligationConversionRate: number
  The rate used to convert the performance obligation amount in the entered currency to the ledger currency.
• ObligationConversionRateDate: string (date)
  The date when a conversion rate is used to convert an amount into another currency for a performance obligation. This attribute is required for nonfunctional currency performance obligations. The value is imported from the source system along with the revenue basis data or populated by default from the contract date of the revenue contract.
• ObligationConversionRateType: string
  Maximum Length: 30

  The type of currency conversion rate that is used to automatically populate a specific rate when converting a revenue contract into the ledger currency. Examples include corporate, user-defined, and spot.
• ObligationCreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the performance obligation.
• ObligationCreationDate: string (date-time)
  Read Only: true

  The date on which the performance obligation is created.
• ObligationDiscountAmount: number
  The total discount amount of all the underlying promised details of the performance obligation in the contract currency.
• ObligationDiscountPercentage: number
  The discount percentage of the performance obligation.
• ObligationEnteredCurrency: string
  Maximum Length: 15

  The currency of the performance obligation.
• ObligationEnteredCurrencyBaseprice: number
  The base price of the performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencyBilledAmount: number
  The amount billed to a performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencyComputedResidualSSP: number
  The calculated residual estimated extended standalone selling price of the performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencyCostAmount: number
  The cost amount of the performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencyDiscountAmount: number
  The total discount amount of all the underlying promised details of the performance obligation in the performance obligation currency.
• ObligationEnteredCurrencyExtendedSSP: number
  The total standalone selling price amount of a performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencyListPriceAmount: number
  The list price of a performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencySellingAmount: number
  The selling amount of the performance obligation in the entered currency of the performance obligation.
• ObligationEnteredCurrencyUnitSellingPrice: number
  The unit selling price of the performance obligation in the entered currency of the performance obligation.
• ObligationESSRequestId: integer (int64)
  The request ID of the job that created or last updated the performance obligation.
• ObligationExemptionStatus: string
  Read Only: true

  Maximum Length: 80

  Status indicating that the performance obligation is exempted from allocation.
• ObligationExtendedSSP: number
  The total standalone selling price amount of a performance obligation. The value is calculated by multiplying the unit standalone selling price with the quantity of the performance obligation.
• ObligationFreezeStatus: string
  Read Only: true

  Maximum Length: 80

  The status indicating whether the performance obligation is frozen for the automatic addition of new interfaced lines.
• ObligationFullSatisfactionDate: string (date)
  The date the performance obligation is fully satisfied.
• ObligationGrossMarginPercentage: number
  The gross margin percentage of the performance obligation.
• ObligationIdentificationRule: string
  Read Only: true

  Maximum Length: 100

  The unique identifier of the performance obligation identification rule.
• ObligationLastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the performance obligation.
• ObligationLastUpdatedDate: string (date-time)
  Read Only: true

  The date on which the performance obligation was last updated.
• ObligationLatestRevisionIntent: string
  Read Only: true

  Maximum Length: 80

  The revision intent of the last promised detail revision of the performance obligation. A list of accepted values is defined in the lookup type ORA_VRM_REVISION_INTENT_TYPE.
• ObligationLatestVersionDate: string (date)
  The date of the most recent version of the performance obligation's underlying promised detail.
• ObligationPricingDimension: integer (int64)
  The key flexfield structure that identifies the pricing category of the performance obligation.
• ObligationReference: string
  Maximum Length: 1000

  User entered performance obligation reference.
• ObligationResidualApproach: string
  Read Only: true

  Maximum Length: 80

  The price of goods or services for the line is variable or missing and the standalone selling price for the performance obligation is estimated using the residual approach. Valid values are Y, N, or blank.
• ObligationRevenueRecognized: number
  The total amount of revenue that was recognized for a performance obligation.
• ObligationSellingAmount: number
  Total selling amount of all the promised details of the performance obligation in the currency of the performance obligation.
• ObligationSSPProfile: string
  Read Only: true

  Maximum Length: 60

  The name of the standalone selling price profile for the performance obligation.
• ObligationSSPRepresentationType: string
  Read Only: true

  Maximum Length: 80

  The standalone selling price representation type of the performance obligation. A list of accepted values is defined in the lookup type VRM_FMV_REPRESENTATIONS.
• ObligationTemplateName: string
  Read Only: true

  Maximum Length: 60

  The name of the template used to create the performance obligation template.
• ObligationUnitSSP: number
  Read Only: true

  The unit standalone selling price of the performance obligation.
• PerformanceObligationId: integer (int64)
  The unique identifier of the performance obligation.
• PerformanceObligationNumber: integer (int64)
  The number associated with the performance obligation.
• performanceObligationSeries: array Performance Obligation Series
  Title: Performance Obligation Series

  The performance obligation series resource is used to retrieve the series of a devolved performance obligation.
• promisedDetails: array Promised Details
  Title: Promised Details

  The promised detail resource is used to retrieve the promised detail lines of a performance obligation.
• SatisfactionMethod: string
  Read Only: true

  Maximum Length: 80

  The method indicating whether the performance obligation is satisfied at a point in time or over time. A list of accepted values is defined in the lookup type ORA_VRM_SATISFACTION_METHOD.
• SatisfactionStatus: string
  Read Only: true

  Maximum Length: 80

  The codes used to indicate satisfaction status of the performance obligation. A list of accepted values is defined in the lookup type ORA_VRM_LINE_SATISFACTN_STATUS.

{
    "type":"object",
    "properties":{
        "ObligationExemptionStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status indicating that the performance obligation is exempted from allocation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationRevenueRecognized":{
            "type":"number",
            "description":"The total amount of revenue that was recognized for a performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationLastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the performance obligation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationClassification":{
            "maxLength":80,
            "type":"string",
            "description":"The codes used to classify performance obligations. A list of accepted values is defined in the lookup type ORA_VRM_OBLIG_CLASSIF_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationCreationDate":{
            "type":"string",
            "description":"The date on which the performance obligation is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationConversionRate":{
            "type":"number",
            "description":"The rate used to convert the performance obligation amount in the entered currency to the ledger currency.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationBasePricePercentage":{
            "type":"number",
            "description":"The base price percentage of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImpliedObligationTemplateName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the template used to create the implied performance obligation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationConversionRateDate":{
            "type":"string",
            "description":"The date when a conversion rate is used to convert an amount into another currency for a performance obligation. This attribute is required for nonfunctional currency performance obligations. The value is imported from the source system along with the revenue basis data or populated by default from the contract date of the revenue contract.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObligationDiscountPercentage":{
            "type":"number",
            "description":"The discount percentage of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of currency conversion rate that is used to automatically populate a specific rate when converting a revenue contract into the ledger currency. Examples include corporate, user-defined, and spot.",
            "nullable":true,
            "x-queryable":true
        },
        "ObligationEnteredCurrencyUnitSellingPrice":{
            "type":"number",
            "description":"The unit selling price of the performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationLatestRevisionIntent":{
            "maxLength":80,
            "type":"string",
            "description":"The revision intent of the last promised detail revision of the performance obligation. A list of accepted values is defined in the lookup type ORA_VRM_REVISION_INTENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationExtendedSSP":{
            "type":"number",
            "description":"The total standalone selling price amount of a performance obligation. The value is calculated by multiplying the unit standalone selling price with the quantity of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationEnteredCurrencyCostAmount":{
            "type":"number",
            "description":"The cost amount of the performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationLatestVersionDate":{
            "type":"string",
            "description":"The date of the most recent version of the performance obligation's underlying promised detail.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationCreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the performance obligation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationEnteredCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the performance obligation.",
            "nullable":false,
            "x-queryable":false
        },
        "ObligationReference":{
            "maxLength":1000,
            "type":"string",
            "description":"User entered performance obligation reference.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationSSPRepresentationType":{
            "maxLength":80,
            "type":"string",
            "description":"The standalone selling price representation type of the performance obligation. A list of accepted values is defined in the lookup type VRM_FMV_REPRESENTATIONS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ImpliedPerformanceObligation":{
            "maxLength":80,
            "type":"string",
            "description":"The status specifying the performance obligation is added using an implied obligation template or using a source document line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationEnteredCurrencyListPriceAmount":{
            "type":"number",
            "description":"The list price of a performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationComputedResidualSSP":{
            "type":"number",
            "description":"The calculated residual estimated extended standalone selling price of the performance obligation in the contract currency.",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfactionMethod":{
            "maxLength":80,
            "type":"string",
            "description":"The method indicating whether the performance obligation is satisfied at a point in time or over time. A list of accepted values is defined in the lookup type ORA_VRM_SATISFACTION_METHOD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationResidualApproach":{
            "maxLength":80,
            "type":"string",
            "description":"The price of goods or services for the line is variable or missing and the standalone selling price for the performance obligation is estimated using the residual approach. Valid values are Y, N, or blank.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationGrossMarginPercentage":{
            "type":"number",
            "description":"The gross margin percentage of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationUnitSSP":{
            "type":"number",
            "description":"The unit standalone selling price of the performance obligation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationEnteredCurrencyExtendedSSP":{
            "type":"number",
            "description":"The total standalone selling price amount of a performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfactionStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The codes used to indicate satisfaction status of the performance obligation. A list of accepted values is defined in the lookup type ORA_VRM_LINE_SATISFACTN_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationEnteredCurrencyBaseprice":{
            "type":"number",
            "description":"The base price of the performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "PerformanceObligationId":{
            "type":"integer",
            "description":"The unique identifier of the performance obligation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObligationSSPProfile":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the standalone selling price profile for the performance obligation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationFullSatisfactionDate":{
            "type":"string",
            "description":"The date the performance obligation is fully satisfied.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationTemplateName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the template used to create the performance obligation template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationEnteredCurrencySellingAmount":{
            "type":"number",
            "description":"The selling amount of the performance obligation in the entered currency of the performance obligation.",
            "nullable":false,
            "x-queryable":false
        },
        "performanceObligationSeries":{
            "title":"Performance Obligation Series",
            "type":"array",
            "description":"The performance obligation series resource is used to retrieve the series of a devolved performance obligation.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-performanceObligationSeries-item-response"
            }
        },
        "ObligationEnteredCurrencyDiscountAmount":{
            "type":"number",
            "description":"The total discount amount of all the underlying promised details of the performance obligation in the performance obligation currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ObligationSellingAmount":{
            "type":"number",
            "description":"Total selling amount of all the promised details of the performance obligation in the currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "promisedDetails":{
            "title":"Promised Details",
            "type":"array",
            "description":"The promised detail resource is used to retrieve the promised detail lines of a performance obligation.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-item-response"
            }
        },
        "ObligationLastUpdatedDate":{
            "type":"string",
            "description":"The date on which the performance obligation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformanceObligationNumber":{
            "type":"integer",
            "description":"The number associated with the performance obligation.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObligationDiscountAmount":{
            "type":"number",
            "description":"The total discount amount of all the underlying promised details of the performance obligation in the contract currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ObligationEnteredCurrencyComputedResidualSSP":{
            "type":"number",
            "description":"The calculated residual estimated extended standalone selling price of the performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationAmount":{
            "type":"number",
            "description":"The transaction price allocated to the performance obligation in the currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationBilledAmount":{
            "type":"number",
            "description":"The total amount that was billed to a performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObligationPricingDimension":{
            "type":"integer",
            "description":"The key flexfield structure that identifies the pricing category of the performance obligation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObligationFreezeStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The status indicating whether the performance obligation is frozen for the automatic addition of new interfaced lines.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationIdentificationRule":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the performance obligation identification rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObligationESSRequestId":{
            "type":"integer",
            "description":"The request ID of the job that created or last updated the performance obligation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObligationEnteredCurrencyBilledAmount":{
            "type":"number",
            "description":"The amount billed to a performance obligation in the entered currency of the performance obligation.",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvePerformanceObligation":{
            "maxLength":1,
            "type":"string",
            "description":"Status indicating that the performance obligation is devolved. A performance obligation is devolved when the Devolve performance obligation option is set to Yes in either the performance obligation identification rule or the implied obligation template that was used during the identification of the performance obligation.",
            "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 : Performance Obligation Series

Type: array

Title: Performance Obligation Series

The performance obligation series resource is used to retrieve the series of a devolved performance obligation.

Show Source

• Array of: object revenueContracts-performanceObligations-performanceObligationSeries-item-response

{
    "title":"Performance Obligation Series",
    "type":"array",
    "description":"The performance obligation series resource is used to retrieve the series of a devolved performance obligation.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-performanceObligationSeries-item-response"
    }
}

Nested Schema : Promised Details

Type: array

Title: Promised Details

The promised detail resource is used to retrieve the promised detail lines of a performance obligation.

Show Source

• Array of: object revenueContracts-performanceObligations-promisedDetails-item-response

{
    "title":"Promised Details",
    "type":"array",
    "description":"The promised detail resource is used to retrieve the promised detail lines of a performance obligation.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-item-response"
    }
}

Nested Schema : revenueContracts-performanceObligations-performanceObligationSeries-item-response

Type: object

Show Source

• DevolvedObligationAllocatedAmount: number
  The transaction price allocated to the devolved performance obligation record.
• DevolvedObligationAmount: number
  The selling amount of the devolved performance obligation record. The value is calculated as a proportion of the net consideration amount of the devolved performance obligation for each period of the performance satisfaction plan.
• DevolvedObligationCreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the devolved performance obligation record.
• DevolvedObligationCreatedDate: string (date-time)
  Read Only: true

  The date the devolved performance obligation record is created.
• DevolvedObligationCreatedFrom: string
  Maximum Length: 30

  The process that created the devolved performance obligation record.
• DevolvedObligationESSRequestId: integer (int64)
  The request ID of the job that created or last updated the devolved performance obligation record.
• DevolvedObligationInitialPerformanceAmount: number
  The initial performance event amount of the devolved performance obligation record.
• DevolvedObligationInitialPerformanceDate: string (date)
  The date the initial performance event is recorded.
• DevolvedObligationLastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the devolved performance obligation record.
• DevolvedObligationLastUpdatedDate: string (date-time)
  Read Only: true

  The date the devolved performance obligation record was last updated.
• DevolvedObligationLastUpdatedLogin: string
  Read Only: true

  Maximum Length: 32

  The login name associated to the user who last updated the devolved performance obligation record.
• DevolvedObligationRevenueRecognized: number
  The total amount of revenue that was recognized for a devolved performance obligation record.
• DevolvedObligationReversedStatus: string
  Maximum Length: 1

  The option that indicates whether the devolved performance obligation record is reversed. N indicates not reversed. Y indicates reversed. Not reversed records are the latest records.
• DevolvedObligationSatisfactionDate: string (date)
  The date the devolved performance obligation is satisfied.
• DevolvedPerfObligDtlId: integer (int64)
  The unique identifier of the detailed devolved performance obligation record.
• FirstDevolvedObligationRecord: string
  Maximum Length: 1

  The indicator that specifies whether the record is the first devolved performance obligation record in the ascending order of the satisfaction date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DevolvedPerfObligDtlId":{
            "type":"integer",
            "description":"The unique identifier of the detailed devolved performance obligation record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstDevolvedObligationRecord":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator that specifies whether the record is the first devolved performance obligation record in the ascending order of the satisfaction date.",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvedObligationLastUpdatedLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login name associated to the user who last updated the devolved performance obligation record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DevolvedObligationAllocatedAmount":{
            "type":"number",
            "description":"The transaction price allocated to the devolved performance obligation record.",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvedObligationLastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the devolved performance obligation record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DevolvedObligationCreatedFrom":{
            "maxLength":30,
            "type":"string",
            "description":"The process that created the devolved performance obligation record.",
            "nullable":false,
            "x-queryable":false
        },
        "DevolvedObligationCreatedDate":{
            "type":"string",
            "description":"The date the devolved performance obligation record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DevolvedObligationESSRequestId":{
            "type":"integer",
            "description":"The request ID of the job that created or last updated the devolved performance obligation record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DevolvedObligationLastUpdatedDate":{
            "type":"string",
            "description":"The date the devolved performance obligation record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DevolvedObligationInitialPerformanceAmount":{
            "type":"number",
            "description":"The initial performance event amount of the devolved performance obligation record.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DevolvedObligationRevenueRecognized":{
            "type":"number",
            "description":"The total amount of revenue that was recognized for a devolved performance obligation record.",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvedObligationSatisfactionDate":{
            "type":"string",
            "description":"The date the devolved performance obligation is satisfied.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvedObligationCreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the devolved performance obligation record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DevolvedObligationAmount":{
            "type":"number",
            "description":"The selling amount of the devolved performance obligation record. The value is calculated as a proportion of the net consideration amount of the devolved performance obligation for each period of the performance satisfaction plan.",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvedObligationReversedStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The option that indicates whether the devolved performance obligation record is reversed. N indicates not reversed. Y indicates reversed. Not reversed records are the latest records.",
            "nullable":true,
            "x-queryable":false
        },
        "DevolvedObligationInitialPerformanceDate":{
            "type":"string",
            "description":"The date the initial performance event is recorded.",
            "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 : revenueContracts-performanceObligations-promisedDetails-item-response

Type: object

Show Source

• ExtensibleLineAttribute1: string
  Read Only: true

  Maximum Length: 150

  Generic attribute column used in Oracle Subscription Management integration with Revenue Management to associate the charge description to the source document line.
• Item: string
  Read Only: true

  Maximum Length: 300

  The inventory item name.
• ItemGroup: string
  Read Only: true

  Maximum Length: 60

  The name of the item group that consists of items that share common pricing policies.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLine: string
  Title: Memo Line Name

  Read Only: true

  Maximum Length: 50

  The name of the memo line when the item is not an inventory item.
• PerformanceSatisfactionPlan: string
  Read Only: true

  Maximum Length: 30

  The name of the performance satisfaction plan of the promised detail line.
• PlanDurationinPeriods: number
  Number of periods in the satisfaction plan for the source document line.
• PlanEndDate: string (date)
  The end date of a performance satisfaction plan.
• PlanStartDate: string (date)
  The start date of a performance satisfaction plan.
• PromisedDetailAmount: number
  The transaction price allocated to the promised detail in the currency of the promised detail line.
• PromisedDetailBasePricePercentage: number
  Read Only: true

  The base price percentage of the promised detail line.
• PromisedDetailBilledAmount: number
  The total amount that was billed to a promised detail line.
• PromisedDetailClassification: string
  Read Only: true

  Maximum Length: 80

  The codes used to classify promised details. A list of accepted values is defined in the lookup type ORA_VRM_OBLIG_CLASSIF_CODE.
• PromisedDetailCreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the promised detail line.
• PromisedDetailCreationDate: string (date-time)
  Read Only: true

  The date the promised detail line is created.
• PromisedDetailDiscountPercentage: number
  Read Only: true

  The discount percentage of the promised detail line.
• PromisedDetailEnteredCurrency: string
  Maximum Length: 15

  The currency of the promised detail line.
• PromisedDetailEnteredCurrencyBasePrice: number
  Read Only: true

  The base price of the promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencyBilledAmount: number
  The amount billed to a promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencyCostAmount: number
  Read Only: true

  The cost amount of the promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencyExtendedSSP: number
  The total standalone selling price amount of a promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencyListPriceAmount: number
  Read Only: true

  The list price amount of the promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencySellingAmount: number
  The selling amount of the promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencyUnitListPrice: number
  Read Only: true

  The unit list price of the promised detail line in the entered currency of the promised detail line.
• PromisedDetailEnteredCurrencyUnitSellingPrice: number
  Read Only: true

  The unit selling price of the promised detail line in the entered currency of the promised detail line.
• PromisedDetailExtendedSSPAmount: number
  The total standalone selling price amount of the item or memo line of the promised detail line. The value is calculated by multiplying the unit standalone selling price with the quantity of the promised detail line.
• PromisedDetailGrossMarginPercentage: number
  Read Only: true

  The gross margin percentage of the promised detail line.
• PromisedDetailLastUpdateDate: string (date-time)
  Read Only: true

  The date the promised detail line was last updated.
• PromisedDetailLastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the promised detail line.
• PromisedDetailLatestVersionDate: string (date)
  The date of the most recent version of the promised detail line.
• PromisedDetailLineId: integer (int64)
  The unique identifier of the promised detail.
• PromisedDetailNumber: integer (int64)
  The number associated with the promised detail.
• PromisedDetailPricingDimension: integer (int64)
  The key flexfield structure identifying the pricing category of the promised detail line.
• PromisedDetailResidualApproach: string
  Read Only: true

  Maximum Length: 80

  The status that indicates the price of the goods or services for the line is variable or missing, and the standalone selling price for the promised detail is estimated using the residual approach. Valid values are Y, N, or blank.
• PromisedDetailRevenueRecognizedAmount: number
  The total amount of revenue that was recognized for a promised detail line.
• PromisedDetailRevisionIntent: string
  Read Only: true

  Maximum Length: 80

  The revision intent of the promised detail revision. A list of accepted values is defined in the lookup type ORA_VRM_REVISION_INTENT_TYPE.
• PromisedDetailSellingAmount: number
  The total selling amount of the promised detail in the currency of the promised detail line.
• PromisedDetailSSPProfile: string
  Read Only: true

  Maximum Length: 60

  The name of the standalone selling price profile for the promised detail line.
• PromisedDetailSSPType: string
  Read Only: true

  Maximum Length: 80

  The type of standalone selling price of the promised detail. A list of accepted values is defined in the lookup type VRM_FMV_TYPES.
• PromisedDetailUnitSSP: number
  Read Only: true

  The unit standalone selling price of the promised detail line.
• PromiseDetailSSPRepresentation: string
  Read Only: true

  Maximum Length: 80

  The standalone selling price representation type of the promised detail line. A list of accepted values is defined in the lookup type VRM_FMV_REPRESENTATIONS.
• Quantity: number
  Read Only: true

  The quantity of the item or memo line.
• RecurringAmount: number
  Read Only: true

  The selling amount of the line per recurring frequency.
• RecurringFrequency: number
  Read Only: true

  The recurring frequency of the promised detail.
• RecurringIndicator: string
  Read Only: true

  Maximum Length: 80

  The recurring status of the promised detail that indicates if the line recurs after the plan satisfaction end date.
• RecurringPattern: string
  Read Only: true

  Maximum Length: 80

  The recurring pattern of the promised detail. A list of accepted values is defined in the lookup type ORA_VRM_RECUR_PATTERN_CODE.
• satisfactionEvents: array Satisfaction Events
  Title: Satisfaction Events

  The satisfaction events resource is used to retrieve the satisfaction events for a promised detail.
• SatisfactionMeasurementModel: string
  Read Only: true

  Maximum Length: 80

  The satisfaction measurement model of the promised detail line. A list of accepted values is defined in the lookup type ORA_VRM_SATIS_MEAS_MODEL.
• sourceDocuments: array Source Documents
  Title: Source Documents

  The source documents resource is used to retrieve source document details associated with a promised detail line.
• TerminationDate: string (date)
  Read Only: true

  The date the service was terminated. The termination date is required to terminate a recurring service or when the contract update is immaterial.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 200

  The unit of measure used for the quantity of the item or memo line.

{
    "type":"object",
    "properties":{
        "PromisedDetailRevenueRecognizedAmount":{
            "type":"number",
            "description":"The total amount of revenue that was recognized for a promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailSellingAmount":{
            "type":"number",
            "description":"The total selling amount of the promised detail in the currency of the promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurringPattern":{
            "maxLength":80,
            "type":"string",
            "description":"The recurring pattern of the promised detail. A list of accepted values is defined in the lookup type ORA_VRM_RECUR_PATTERN_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailDiscountPercentage":{
            "type":"number",
            "description":"The discount percentage of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailCreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the promised detail line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "sourceDocuments":{
            "title":"Source Documents",
            "type":"array",
            "description":"The source documents resource is used to retrieve source document details associated with a promised detail line.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-sourceDocuments-item-response"
            }
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"The inventory item name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailSSPType":{
            "maxLength":80,
            "type":"string",
            "description":"The type of standalone selling price of the promised detail.  A list of accepted values is defined in the lookup type VRM_FMV_TYPES.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailGrossMarginPercentage":{
            "type":"number",
            "description":"The gross margin percentage of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailNumber":{
            "type":"integer",
            "description":"The number associated with the promised detail.",
            "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"
            }
        },
        "PromisedDetailEnteredCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the promised detail line.",
            "nullable":false,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "maxLength":200,
            "type":"string",
            "description":"The unit of measure used for the quantity of the item or memo line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailAmount":{
            "type":"number",
            "description":"The transaction price allocated to the promised detail in the currency of the promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailEnteredCurrencyUnitListPrice":{
            "type":"number",
            "description":"The unit list price of the promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanEndDate":{
            "type":"string",
            "description":"The end date of a performance satisfaction plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailLineId":{
            "type":"integer",
            "description":"The unique identifier of the promised detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromisedDetailEnteredCurrencyBilledAmount":{
            "type":"number",
            "description":"The amount billed to a promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "satisfactionEvents":{
            "title":"Satisfaction Events",
            "type":"array",
            "description":"The satisfaction events resource is used to retrieve the satisfaction events for a promised detail.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-satisfactionEvents-item-response"
            }
        },
        "PromisedDetailResidualApproach":{
            "maxLength":80,
            "type":"string",
            "description":"The status that indicates the price of the goods or services for the line is variable or missing, and the standalone selling price for the promised detail is estimated using the residual approach. Valid values are Y, N, or blank.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailEnteredCurrencyListPriceAmount":{
            "type":"number",
            "description":"The list price amount of the promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailLastUpdateDate":{
            "type":"string",
            "description":"The date the promised detail line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RecurringAmount":{
            "type":"number",
            "description":"The selling amount of the line per recurring frequency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailExtendedSSPAmount":{
            "type":"number",
            "description":"The total standalone selling price amount of the item or memo line of the promised detail line. The value is calculated by multiplying the unit standalone selling price with the quantity of the promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailBasePricePercentage":{
            "type":"number",
            "description":"The base price percentage of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemoLine":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line when the item is not an inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SatisfactionMeasurementModel":{
            "maxLength":80,
            "type":"string",
            "description":"The satisfaction measurement model of the promised detail line. A list of accepted values is defined in the lookup type ORA_VRM_SATIS_MEAS_MODEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailBilledAmount":{
            "type":"number",
            "description":"The total amount that was billed to a promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailEnteredCurrencyCostAmount":{
            "type":"number",
            "description":"The cost amount of the promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailClassification":{
            "maxLength":80,
            "type":"string",
            "description":"The codes used to classify promised details. A list of accepted values is defined in the lookup type ORA_VRM_OBLIG_CLASSIF_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformanceSatisfactionPlan":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the performance satisfaction plan of the promised detail line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailPricingDimension":{
            "type":"integer",
            "description":"The key flexfield structure identifying the pricing category of the promised detail line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PromisedDetailEnteredCurrencyBasePrice":{
            "type":"number",
            "description":"The base price of the promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailUnitSSP":{
            "type":"number",
            "description":"The unit standalone selling price of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RecurringFrequency":{
            "type":"number",
            "description":"The recurring frequency of the promised detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerminationDate":{
            "type":"string",
            "description":"The date the service was terminated. The termination date is required to terminate a recurring service or when the contract update is immaterial.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromiseDetailSSPRepresentation":{
            "maxLength":80,
            "type":"string",
            "description":"The standalone selling price representation type of the promised detail line. A list of accepted values is defined in the lookup type VRM_FMV_REPRESENTATIONS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailSSPProfile":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the standalone selling price profile for the promised detail line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExtensibleLineAttribute1":{
            "maxLength":150,
            "type":"string",
            "description":"Generic attribute column used in Oracle Subscription Management integration with Revenue Management to associate the charge description to the source document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailRevisionIntent":{
            "maxLength":80,
            "type":"string",
            "description":"The revision intent of the promised detail revision. A list of accepted values is defined in the lookup type ORA_VRM_REVISION_INTENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the item or memo line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RecurringIndicator":{
            "maxLength":80,
            "type":"string",
            "description":"The recurring status of the promised detail that indicates if the line recurs after the plan satisfaction end date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailLastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the promised detail line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemGroup":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the item group that consists of items that share common pricing policies.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDetailEnteredCurrencyUnitSellingPrice":{
            "type":"number",
            "description":"The unit selling price of the promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanDurationinPeriods":{
            "type":"number",
            "description":"Number of periods in the satisfaction plan for the source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailLatestVersionDate":{
            "type":"string",
            "description":"The date of the most recent version of the promised detail line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailEnteredCurrencySellingAmount":{
            "type":"number",
            "description":"The selling amount of the promised detail line in the entered currency of the promised detail line.",
            "nullable":false,
            "x-queryable":false
        },
        "PromisedDetailEnteredCurrencyExtendedSSP":{
            "type":"number",
            "description":"The total standalone selling price amount of a promised detail line in the entered currency of the promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "PromisedDetailCreationDate":{
            "type":"string",
            "description":"The date the promised detail line is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanStartDate":{
            "type":"string",
            "description":"The start date of a performance satisfaction plan.",
            "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 : Satisfaction Events

Type: array

Title: Satisfaction Events

The satisfaction events resource is used to retrieve the satisfaction events for a promised detail.

Show Source

• Array of: object revenueContracts-performanceObligations-promisedDetails-satisfactionEvents-item-response

{
    "title":"Satisfaction Events",
    "type":"array",
    "description":"The satisfaction events resource is used to retrieve the satisfaction events for a promised detail.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-satisfactionEvents-item-response"
    }
}

Nested Schema : Source Documents

Type: array

Title: Source Documents

The source documents resource is used to retrieve source document details associated with a promised detail line.

Show Source

• Array of: object revenueContracts-performanceObligations-promisedDetails-sourceDocuments-item-response

{
    "title":"Source Documents",
    "type":"array",
    "description":"The source documents resource is used to retrieve source document details associated with a promised detail line.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-sourceDocuments-item-response"
    }
}

Nested Schema : revenueContracts-performanceObligations-promisedDetails-satisfactionEvents-item-response

Type: object

Show Source

• DiscardedBy: string
  Read Only: true

  Maximum Length: 64

  The user who discarded the satisfaction event.
• DiscardedDate: string (date)
  The date the satisfaction measurement event was discarded.
• DiscardedStatus: string
  Read Only: true

  Maximum Length: 80

  The status indicating that the satisfaction event was discarded.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodRatio: number
  The ratio used to distribute the allocated amount to each period of the promised detail line. Used only when the satisfaction measurement model is Period.
• PeriodStartDate: string (date)
  The start date of the period satisfied. This date is used only when the satisfaction measurement model is Period.
• PlanEndDate: string (date)
  The end date of a performance satisfaction plan.
• SatisfactionEventId: integer (int64)
  The unique identifier of the satisfaction event.
• SatisfactionEventNumber: integer (int64)
  The sequential number of the satisfaction event of the promised detail line.
• SatisfactionMeasurementDate: string (date)
  The date the satisfaction is measured. This date is used as the accounting date for the revenue accounting entry.
• SatisfiedPercent: number
  The percentage satisfied on the satisfaction measurement date. If the satisfaction measurement model is Percent then the value for this field is entered manually by the user or is provided by the source system. If the satisfaction measurement model is Period then the value for this field is derived from the performance satisfaction plan of the promised detail.
• SatisfiedQuantity: number
  The quantity satisfied on the measurement date. This attribute is used only when the satisfaction measurement model is Quantity.

{
    "type":"object",
    "properties":{
        "DiscardedDate":{
            "type":"string",
            "description":"The date the satisfaction measurement event was discarded.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DiscardedStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The status indicating that the satisfaction event was discarded.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscardedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who discarded the satisfaction event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SatisfactionMeasurementDate":{
            "type":"string",
            "description":"The date the satisfaction is measured. This date is used as the accounting date for the revenue accounting entry.",
            "format":"date",
            "nullable":false,
            "x-queryable":false
        },
        "PlanEndDate":{
            "type":"string",
            "description":"The end date of a performance satisfaction plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfiedQuantity":{
            "type":"number",
            "description":"The quantity satisfied on the measurement date. This attribute is used only when the satisfaction measurement model is Quantity.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SatisfactionEventId":{
            "type":"integer",
            "description":"The unique identifier of the satisfaction event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodRatio":{
            "type":"number",
            "description":"The ratio used to distribute the allocated amount to each period of the promised detail line. Used only when the satisfaction measurement model is Period.",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfactionEventNumber":{
            "type":"integer",
            "description":"The sequential number of the satisfaction event of the promised detail line.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SatisfiedPercent":{
            "type":"number",
            "description":"The percentage satisfied on the satisfaction measurement date. If the satisfaction measurement model is Percent then the value for this field is entered manually by the user or is provided by the source system. If the satisfaction measurement model is Period then the value for this field is derived from the performance satisfaction plan of the promised detail.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodStartDate":{
            "type":"string",
            "description":"The start date of the period satisfied. This date is used only when the satisfaction measurement model is Period.",
            "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 : revenueContracts-performanceObligations-promisedDetails-sourceDocuments-item-response

Type: object

Show Source

• BillToCustomerNumber: string
  Maximum Length: 30

  The account number of the bill-to customer of the source document.
• BillToCustomerReferenceInSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the bill-to customer from the originating source system.
• BillToCustomerSiteNumber: string
  Maximum Length: 240

  The site number of the bill-to customer of the source document.
• BillToCustomerSiteReferenceInSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the customer's bill-to-site from the originating source system.
• BusinessUnitName: string
  Maximum Length: 240

  The business unit that owns the source document.
• ConversionDate: string (date)
  The date when a conversion rate is used to convert an amount into another currency for a source document.
• ConversionRate: number
  The rate used to convert the source document in the entered currency to the ledger currency.
• ConversionRateType: string
  Maximum Length: 30

  The type of currency conversion rate that is used to automatically populate a specific rate when converting the source document into the ledger currency. Examples include corporate, user-defined, and spot.
• CurrencyCodeOfSourceDocument: string
  Maximum Length: 15

  The currency code of the source document.
• CustomerPurchaseOrderNumber: string
  Maximum Length: 50

  The customer purchase order number on the source document.
• DateOfSourceDocument: string (date)
  The date of the source document, such as the booking date for a sales order or the invoice date for an invoice.
• DocumentId: integer (int64)
  The source document identifier of the document.
• DocumentNumberOfSourceDocument: string
  Maximum Length: 300

  The number of the source document. For example, a sales order number or a Receivables invoice number.
• LegalEntityName: string
  Maximum Length: 240

  The legal entity of the source document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ShipToCustomerNumber: string
  Maximum Length: 30

  The account number of the ship-to customer of the source document.
• ShipToCustomerReferenceInSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the ship-to customer from the originating source system.
• ShipToCustomerSiteReferenceInSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the customer's ship-to-site from the originating source system.
• sourceDocumentLines: array Source Document Lines
  Title: Source Document Lines

  The source document lines resource is used to retrieve details of source document lines associated with a promised detail line.
• SourceDocumentTypeCode: string
  Maximum Length: 30

  The source document type code the source data is imported from.
• SourceDocumentUniqueIdentifierCharacter1: string
  Maximum Length: 30

  The first character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter2: string
  Maximum Length: 30

  The second character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter3: string
  Maximum Length: 30

  The third character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter4: string
  Maximum Length: 30

  The fourth character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter5: string
  Maximum Length: 30

  The fifth character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber1: number
  The first numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber2: number
  The second numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber3: number
  The third numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber4: number
  The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber5: number
  The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceSystemCode: string
  Maximum Length: 120

  The source system code the source data is imported from. The source systems are defined in the Manage Trading Community source systems.

{
    "type":"object",
    "properties":{
        "BillToCustomerReferenceInSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the bill-to customer from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DateOfSourceDocument":{
            "type":"string",
            "description":"The date of the source document, such as the booking date for a sales order or the invoice date for an invoice.",
            "format":"date",
            "nullable":false,
            "x-queryable":false
        },
        "sourceDocumentLines":{
            "title":"Source Document Lines",
            "type":"array",
            "description":"The source document lines resource is used to retrieve details of source document lines associated with a promised detail line.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-item-response"
            }
        },
        "DocumentId":{
            "type":"integer",
            "description":"The source document identifier of the document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of currency conversion rate that is used to automatically populate a specific rate when converting the source document into the ledger currency. Examples include corporate, user-defined, and spot.",
            "nullable":true,
            "x-queryable":false
        },
        "LegalEntityName":{
            "maxLength":240,
            "type":"string",
            "description":"The legal entity of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The account number of the ship-to customer of the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentUniqueIdentifierNumber4":{
            "type":"number",
            "description":"The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceDocumentUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerPurchaseOrderNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The customer purchase order number on the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerSiteReferenceInSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the customer's bill-to-site from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitName":{
            "maxLength":240,
            "type":"string",
            "description":"The business unit that owns the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerSiteNumber":{
            "maxLength":240,
            "type":"string",
            "description":"The site number of the bill-to customer of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerSiteReferenceInSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the customer's ship-to-site from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The account number of the bill-to customer of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCodeOfSourceDocument":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The source document type code the source data is imported from.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionRate":{
            "type":"number",
            "description":"The rate used to convert the source document in the entered currency to the ledger currency.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerReferenceInSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the ship-to customer from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentNumberOfSourceDocument":{
            "maxLength":300,
            "type":"string",
            "description":"The number of the source document. For example, a sales order number or a Receivables invoice number.",
            "nullable":false,
            "x-queryable":false
        },
        "SourceSystemCode":{
            "maxLength":120,
            "type":"string",
            "description":"The source system code the source data is imported from. The source systems are defined in the Manage Trading Community source systems.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionDate":{
            "type":"string",
            "description":"The date when a conversion rate is used to convert an amount into another currency for a source document.",
            "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 : Source Document Lines

Type: array

Title: Source Document Lines

The source document lines resource is used to retrieve details of source document lines associated with a promised detail line.

Show Source

• Array of: object revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-item-response

{
    "title":"Source Document Lines",
    "type":"array",
    "description":"The source document lines resource is used to retrieve details of source document lines associated with a promised detail line.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-item-response"
    }
}

Nested Schema : revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-item-response

Type: object

Show Source

• ActionCodeForAddingNewLineToExistingContract: string
  Maximum Length: 30

  The code that indicates how a line is added to an existing contract. A list of accepted values is defined in the lookup type ORA_ADD_TO_CONTRACT_ACTION.
• AddToExistingContract: string
  Maximum Length: 1

  The option that indicates that the source document line must be added to an existing contract. If this attribute is set to Y, then this line is added to an existing contract.
• BasePrice: number
  The base price of the item or memo line on the source document line. The base price is the selling price of the related product or service.
• BillToCustomerNumber: string
  Maximum Length: 30

  The account number of the bill-to customer of the source document.
• BillToCustomerReferenceInTheSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the bill-to customer from the originating source system.
• BillToCustomerSiteNumber: string
  Maximum Length: 240

  The site number of the bill-to customer of the source document.
• BillToCustomerSiteReferenceInTheSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the customer's bill-to-site from the originating source system.
• ContractRevisionDate: string (date)
  The date the revised terms of the contract become effective.
• CostAmount: number
  The cost amount of the item or memo line on the source document line.
• CustomerClassificationOfABillToCustomer: string
  Maximum Length: 60

  The customer classification of a bill-to customer on the source document line. A list of accepted values is defined in the lookup type CUSTOMER_CLASS.
• CustomerPurchaseOrderNumber: string
  Maximum Length: 50

  The customer purchase order number on the source document.
• DocumentLineId: integer (int64)
  The unique identifier of a source document line.
• DocumentTypeCodeOfTheParentLine: string
  Maximum Length: 30

  The source document type code of the parent source document line of the imported source data.
• DocumentTypeCodeOfTheReferenceDocument: string
  Maximum Length: 30

  The source document type code of the reference document of the imported source data.
• EndDateOfPerformanceSatisfactionPlan: string (date)
  The end date of a performance satisfaction plan.
• ImmaterialChangeType: string
  Maximum Length: 30

  The option that indicates that the contract revision on the source document line is of an immaterial nature. A list of accepted values is defined in the lookup type ORA_IMMATERIAL_CHANGE_TYPE.
• IndicatesTheCurrentSourceProductLineIsAVersionLine: string
  Maximum Length: 1

  The option that indicates whether the current source document line is a version line. Possible values are Y and N.
• ItemInventoryOrganizationCode: string
  Maximum Length: 18

  The inventory organization code the item belongs to.
• ItemNumber: string
  Maximum Length: 300

  The number of the inventory item in the source application.
• LineAmount: number
  The total selling amount of the item or memo line on the source document line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualReviewRequired: string
  Maximum Length: 1

  The option that indicates that the contract requires manual review. The contract is marked Pending Review if this attribute is set to Y.
• MemoLineName: string
  Maximum Length: 50

  The name of the memo line of the source document line when the item is not an inventory item.
• ParentLineSourceSystem: string
  Maximum Length: 120

  The source system code of the parent or related source document line from which source data is imported. The source systems are defined in Manage Trading Community.
• ParentSourceDocumentLineUniqueIdentifierCharacter1: string
  Maximum Length: 30

  The first character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierCharacter2: string
  Maximum Length: 30

  The second character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierCharacter3: string
  Maximum Length: 30

  The third character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierCharacter4: string
  Maximum Length: 30

  The fourth character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierCharacter5: string
  Maximum Length: 30

  The fifth character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierNumber1: number
  The first numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierNumber2: number
  The second numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierNumber3: number
  The third numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierNumber4: number
  The fourth numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• ParentSourceDocumentLineUniqueIdentifierNumber5: number
  The fifth numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.
• PerformanceSatisfactionPlanName: string
  Maximum Length: 30

  The name of the performance satisfaction plan associated with the source document line.
• PlanDuration: number
  The number of periods in which the source document line's revenue is recognized.
• Quantity: number
  The quantity of the item or memo line.
• RecurringAmount: number
  The selling amount of the line per recurring frequency.
• RecurringFrequency: number
  The recurring frequency of the promised detail line.
• RecurringIndicator: string
  Maximum Length: 1

  The recurring status of the promised detail line that indicates if the line recurs after the plan satisfaction end date.
• RecurringPattern: string
  Maximum Length: 30

  The recurring pattern of the promised detail line. A list of accepted values is defined in the lookup type ORA_VRM_RECUR_PATTERN_CODE.
• ReferenceSourceDocumentLineUniqueIdentifierCharacter1: string
  Maximum Length: 30

  The first character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierCharacter2: string
  Maximum Length: 30

  The second character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierCharacter3: string
  Maximum Length: 30

  The third character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierCharacter4: string
  Maximum Length: 30

  The fourth character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierCharacter5: string
  Maximum Length: 30

  The fifth character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierNumber1: number
  The first numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierNumber2: number
  The second numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierNumber3: number
  The third numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierNumber4: number
  The fourth numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceDocumentLineUniqueIdentifierNumber5: number
  The fifth numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.
• ReferenceSourceSystem: string
  Maximum Length: 120

  The source system code of the referred source document line from imported source data. The source systems are defined in the Manage Trading Community source systems.
• RevenueReversalMethodUsedToReverseTheRevenue: string
  Maximum Length: 30

  The revenue reversal method used to reverse the revenue for the return lines. Possible values are LIFO and PRORATE.
• SatisfactionMeasurementModel: string
  Maximum Length: 30

  The satisfaction measurement model of the promised detail. A list of accepted values is defined in the lookup type ORA_VRM_SATIS_MEAS_MODEL.
• ShipToCustomerNumber: string
  Maximum Length: 30

  The account number of the ship-to customer of the source document.
• ShipToCustomerReferenceInTheSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the ship-to customer from the originating source system.
• ShipToCustomerSiteReferenceInTheSourceSystem: string
  Maximum Length: 255

  The reference value used to identify the customer's ship-to-site from the originating source system.
• SourceDocumentLineNumber: string
  Maximum Length: 30

  The line number of the source document.
• SourceDocumentLineUniqueIdentifierCharacter1: string
  Maximum Length: 30

  The first character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharacter2: string
  Maximum Length: 30

  The second character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharacter3: string
  Maximum Length: 30

  The third character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharacter4: string
  Maximum Length: 30

  The fourth character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharacter5: string
  Maximum Length: 30

  The fifth character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber1: number
  The first numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber2: number
  The second numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber3: number
  The third numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber4: number
  The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber5: number
  The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• sourceDocumentSubLines: array Source Document Sublines
  Title: Source Document Sublines

  The source document sublines resource is used to retrieve details of source document sublines associated with a promised detail line.
• SourceDocumentTypeCode: string
  Maximum Length: 30

  The source document type code the source data is imported from.
• SourceDocumentUniqueIdentifieCharacter2: string
  Maximum Length: 30

  The second character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter1: string
  Maximum Length: 30

  The first character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter3: string
  Maximum Length: 30

  The third character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter4: string
  Maximum Length: 30

  The fourth character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierCharacter5: string
  Maximum Length: 30

  The fifth character column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber1: number
  The first numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber2: number
  The second numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber3: number
  The third numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber4: number
  The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceDocumentUniqueIdentifierNumber5: number
  The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document.
• SourceSystem: string
  Maximum Length: 120

  The source system code the source data is imported from. The source systems are defined in the Manage Trading Community source systems.
• SpecifiesTheVersionOfTheSourceProductLine: integer (int32)
  The version number of the source document line. For example, the value for the original source document line is 1 and for revisions the version number is 2 or more. Populate the version indicator if the version number is greater than 1.
• StartDateOfPerformanceSatisfactionPlan: string (date)
  The start date of a performance satisfaction plan.
• TerminationDate: string (date)
  The date the service was terminated. The termination date is required to terminate a recurring service or when the contract update is immaterial.
• UnitListPrice: number
  The unit list price of the item or memo line on the source document line.
• UnitOfMeasureCode: string
  Maximum Length: 200

  The unit of measure code for the inventory item, service item, or memo line on the source document line.
• UnitSellingPrice: number
  The unit selling price of the item or memo line.
• UnitSSP: number
  The unit standalone selling price of the item or memo line on the source document line.
• UseResidualApproach: string
  Maximum Length: 1

  The option that indicates that the extended standalone selling price for the performance obligation associated with the line is estimated using the residual approach. Valid values are Y, N and blank. Blank is treated as N.

{
    "type":"object",
    "properties":{
        "SourceDocumentLineUniqueIdentifierCharacter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharacter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "BasePrice":{
            "type":"number",
            "description":"The base price of the item or memo line on the source document line. The base price is the selling price of the related product or service.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharacter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharacter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceSystem":{
            "maxLength":120,
            "type":"string",
            "description":"The source system code of the referred source document line from imported source data. The source systems are defined in the Manage Trading Community source systems.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurringPattern":{
            "maxLength":30,
            "type":"string",
            "description":"The recurring pattern of the promised detail line. A list of accepted values is defined in the lookup type ORA_VRM_RECUR_PATTERN_CODE.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerReferenceInTheSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the bill-to customer from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitListPrice":{
            "type":"number",
            "description":"The unit list price of the item or memo line on the source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierNumber4":{
            "type":"number",
            "description":"The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "LineAmount":{
            "type":"number",
            "description":"The total selling amount of the item or memo line on the source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualReviewRequired":{
            "maxLength":1,
            "type":"string",
            "description":"The option that indicates that the contract requires manual review. The contract is marked Pending Review if this attribute is set to Y.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceDocumentUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerPurchaseOrderNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The customer purchase order number on the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentLineSourceSystem":{
            "maxLength":120,
            "type":"string",
            "description":"The source system code of the parent or related source document line from which source data is imported. The source systems are defined in Manage Trading Community.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharacter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The line number of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractRevisionDate":{
            "type":"string",
            "description":"The date the revised terms of the contract become effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierNumber4":{
            "type":"number",
            "description":"The fourth numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerReferenceInTheSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the ship-to customer from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PlanDuration":{
            "type":"number",
            "description":"The number of periods in which the source document line's revenue is recognized.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifieCharacter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "AddToExistingContract":{
            "maxLength":1,
            "type":"string",
            "description":"The option that indicates that the source document line must be added to an existing contract. If this attribute is set to Y, then this line is added to an existing contract.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The account number of the bill-to customer of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionCodeForAddingNewLineToExistingContract":{
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates how a line is added to an existing contract. A list of accepted values is defined in the lookup type ORA_ADD_TO_CONTRACT_ACTION.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierCharacter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurringAmount":{
            "type":"number",
            "description":"The selling amount of the line per recurring frequency.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierCharacter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierCharacter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The source document type code the source data is imported from.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceSourceDocumentLineUniqueIdentifierCharacter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "IndicatesTheCurrentSourceProductLineIsAVersionLine":{
            "maxLength":1,
            "type":"string",
            "description":"The option that indicates whether the current source document line is a version line. Possible values are Y and N.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemInventoryOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"The inventory organization code the item belongs to.",
            "nullable":true,
            "x-queryable":false
        },
        "ImmaterialChangeType":{
            "maxLength":30,
            "type":"string",
            "description":"The option that indicates that the contract revision on the source document line is of an immaterial nature. A list of accepted values is defined in the lookup type ORA_IMMATERIAL_CHANGE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentUniqueIdentifierCharacter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the composite key of 10 attributes to uniquely identify a source document.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDateOfPerformanceSatisfactionPlan":{
            "type":"string",
            "description":"The start date of a performance satisfaction plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentLineId":{
            "type":"integer",
            "description":"The unique identifier of a source document line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReferenceSourceDocumentLineUniqueIdentifierCharacter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the reference composite key of 10 attributes to identify the original source document line in the source application for a return or credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfactionMeasurementModel":{
            "maxLength":30,
            "type":"string",
            "description":"The satisfaction measurement model of the promised detail. A list of accepted values is defined in the lookup type ORA_VRM_SATIS_MEAS_MODEL.",
            "nullable":true,
            "x-queryable":false
        },
        "RevenueReversalMethodUsedToReverseTheRevenue":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue reversal method used to reverse the revenue for the return lines. Possible values are LIFO and PRORATE.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitOfMeasureCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unit of measure code for the inventory item, service item, or memo line on the source document line.",
            "nullable":false,
            "x-queryable":false
        },
        "EndDateOfPerformanceSatisfactionPlan":{
            "type":"string",
            "description":"The end date of a performance satisfaction plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerSiteReferenceInTheSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the customer's bill-to-site from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber4":{
            "type":"number",
            "description":"The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line of the source document line when the item is not an inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The number of the inventory item in the source application.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The account number of the ship-to customer of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "CostAmount":{
            "type":"number",
            "description":"The cost amount of the item or memo line on the source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierNumber4":{
            "type":"number",
            "description":"The fourth numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PerformanceSatisfactionPlanName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the performance satisfaction plan associated with the source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerClassificationOfABillToCustomer":{
            "maxLength":60,
            "type":"string",
            "description":"The customer classification of a bill-to customer on the source document line. A list of accepted values is defined in the lookup type CUSTOMER_CLASS.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerSiteNumber":{
            "maxLength":240,
            "type":"string",
            "description":"The site number of the bill-to customer of the source document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceDocumentLineUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the composite key of 10 attributes to identify the parent or related line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurringFrequency":{
            "type":"number",
            "description":"The recurring frequency of the promised detail line.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerSiteReferenceInTheSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"The reference value used to identify the customer's ship-to-site from the originating source system.",
            "nullable":true,
            "x-queryable":false
        },
        "TerminationDate":{
            "type":"string",
            "description":"The date the service was terminated. The termination date is required to terminate a recurring service or when the contract update is immaterial.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UnitSSP":{
            "type":"number",
            "description":"The unit standalone selling price of the item or memo line on the source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the item or memo line.",
            "nullable":false,
            "x-queryable":false
        },
        "sourceDocumentSubLines":{
            "title":"Source Document Sublines",
            "type":"array",
            "description":"The source document sublines resource is used to retrieve details of source document sublines associated with a promised detail line.",
            "items":{
                "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-sourceDocumentSubLines-item-response"
            }
        },
        "RecurringIndicator":{
            "maxLength":1,
            "type":"string",
            "description":"The recurring status of the promised detail line that indicates if the line recurs after the plan satisfaction end date.",
            "nullable":true,
            "x-queryable":false
        },
        "UseResidualApproach":{
            "maxLength":1,
            "type":"string",
            "description":"The option that indicates that the extended standalone selling price for the performance obligation associated with the line is estimated using the residual approach. Valid values are Y, N and blank. Blank is treated as N.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentTypeCodeOfTheReferenceDocument":{
            "maxLength":30,
            "type":"string",
            "description":"The source document type code of the reference document of the imported source data.",
            "nullable":true,
            "x-queryable":false
        },
        "SpecifiesTheVersionOfTheSourceProductLine":{
            "type":"integer",
            "description":"The version number of the source document line. For example, the value for the original source document line is 1 and for revisions the version number is 2 or more. Populate the version indicator if the version number is greater than 1.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "DocumentTypeCodeOfTheParentLine":{
            "maxLength":30,
            "type":"string",
            "description":"The source document type code of the parent source document line of the imported source data.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "maxLength":120,
            "type":"string",
            "description":"The source system code the source data is imported from. The source systems are defined in the Manage Trading Community source systems.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitSellingPrice":{
            "type":"number",
            "description":"The unit selling price of the item or memo line.",
            "nullable":false,
            "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 : Source Document Sublines

Type: array

Title: Source Document Sublines

The source document sublines resource is used to retrieve details of source document sublines associated with a promised detail line.

Show Source

• Array of: object revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-sourceDocumentSubLines-item-response

{
    "title":"Source Document Sublines",
    "type":"array",
    "description":"The source document sublines resource is used to retrieve details of source document sublines associated with a promised detail line.",
    "items":{
        "$ref":"#/components/schemas/revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-sourceDocumentSubLines-item-response"
    }
}

Nested Schema : revenueContracts-performanceObligations-promisedDetails-sourceDocuments-sourceDocumentLines-sourceDocumentSubLines-item-response

Type: object

Show Source

• DocumentSubLineId: integer (int64)
  The unique identifier of the source document subline.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodSatisfactionEeventActionType: string
  Maximum Length: 30

  The action type that indicates that positive or negative satisfaction events are created from the period satisfaction events effective date. This attribute is required when the subline type code is Period. A list of accepted values is defined in the lookup type ORA_VRM_PERIOD_SUBLINE_ACTION.
• PeriodSatisfactionEventEffectiveDate: string (date)
  The date when the period satisfaction event action is effective. The Create Satisfaction Events process creates satisfaction events from this date if the action is Reinstate. The process reverses satisfaction events from this date if the action is Reverse.
• SatisfactionMeasurementDate: string (date)
  The date the satisfaction is measured. This date is used as the accounting date for the revenue accounting entry.
• SatisfiedPercent: number
  The percentage satisfied on the satisfaction measurement date. If the satisfaction measurement model is Percent then the value for this field is entered manually by the user or is provided by the source system. If the satisfaction measurement model is Period then the value for this field is derived from the performance satisfaction plan of the promised detail.
• SatisfiedQuantity: number
  The quantity satisfied on the measurement date. This attribute is used only when the satisfaction measurement model is Quantity.
• SourceDocumentLineUniqueIdentifierCharcter1: string
  Maximum Length: 30

  The first character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharcter2: string
  Maximum Length: 30

  The second character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharcter3: string
  Maximum Length: 30

  The third character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharcter4: string
  Maximum Length: 30

  The fourth character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierCharcter5: string
  Maximum Length: 30

  The fifth character column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber1: number
  The first numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber2: number
  The second numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber3: number
  The third numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber4: integer (int64)
  The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentLineUniqueIdentifierNumber5: number
  The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document line.
• SourceDocumentSubLineUniqueIdentifierCharacter1: string
  Maximum Length: 30

  The first character column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierCharacter2: string
  Maximum Length: 30

  The second character column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierCharacter3: string
  Maximum Length: 30

  The third character column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierCharacter4: string
  Maximum Length: 30

  The fourth character column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierCharacter5: string
  Maximum Length: 30

  The fifth character column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierNumber1: number
  The first numeric column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierNumber2: number
  The second numeric column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierNumber3: number
  The third numeric column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierNumber4: number
  The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentSubLineUniqueIdentifierNumber5: number
  The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document subline.
• SourceDocumentTypeCode: string
  Maximum Length: 30

  The source document type code of the imported source data.
• SourceSystem: string
  Maximum Length: 120

  The source system code that source data is imported from. The source systems are defined in the Manage Trading Community source systems.
• SubLineTypeCode: string
  Maximum Length: 30

  The type of document subline. Possible values are DISTRIBUTIONS, ORA_SATIS_EVENT_SMM_PERCENTAGE and ORA_SATIS_EVENT_SMM_QUANTITY.

{
    "type":"object",
    "properties":{
        "SatisfactionMeasurementDate":{
            "type":"string",
            "description":"The date the satisfaction is measured. This date is used as the accounting date for the revenue accounting entry.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierCharacter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierCharacter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierCharacter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierCharacter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierCharacter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber4":{
            "type":"integer",
            "description":"The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":38
            }
        },
        "SourceDocumentLineUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfiedQuantity":{
            "type":"number",
            "description":"The quantity satisfied on the measurement date. This attribute is used only when the satisfaction measurement model is Quantity.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodSatisfactionEventEffectiveDate":{
            "type":"string",
            "description":"The date when the period satisfaction event action is effective. The Create Satisfaction Events process creates satisfaction events from this date if the action is Reinstate. The process reverses satisfaction events from this date if the action is Reverse.",
            "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"
            }
        },
        "SourceDocumentLineUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SubLineTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type of document subline. Possible values are DISTRIBUTIONS, ORA_SATIS_EVENT_SMM_PERCENTAGE and ORA_SATIS_EVENT_SMM_QUANTITY.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodSatisfactionEeventActionType":{
            "maxLength":30,
            "type":"string",
            "description":"The action type that indicates that positive or negative satisfaction events are created from the period satisfaction events effective date. This attribute is required when the subline type code is Period. A list of accepted values is defined in the lookup type ORA_VRM_PERIOD_SUBLINE_ACTION.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierNumber4":{
            "type":"number",
            "description":"The fourth numeric column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharcter4":{
            "maxLength":30,
            "type":"string",
            "description":"The fourth character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierNumber3":{
            "type":"number",
            "description":"The third numeric column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharcter5":{
            "maxLength":30,
            "type":"string",
            "description":"The fifth character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierNumber2":{
            "type":"number",
            "description":"The second numeric column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The source document type code of the imported source data.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierNumber1":{
            "type":"number",
            "description":"The first numeric column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharcter1":{
            "maxLength":30,
            "type":"string",
            "description":"The first character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharcter2":{
            "maxLength":30,
            "type":"string",
            "description":"The second character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentSubLineUniqueIdentifierNumber5":{
            "type":"number",
            "description":"The fifth numeric column of the composite key of 10 attributes to uniquely identify a source document subline.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentLineUniqueIdentifierCharcter3":{
            "maxLength":30,
            "type":"string",
            "description":"The third character column of the composite key of 10 attributes to uniquely identify a source document line.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentSubLineId":{
            "type":"integer",
            "description":"The unique identifier of the source document subline.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":120,
            "type":"string",
            "description":"The source system code that source data is imported from. The source systems are defined in the Manage Trading Community source systems.",
            "nullable":true,
            "x-queryable":false
        },
        "SatisfiedPercent":{
            "type":"number",
            "description":"The percentage satisfied on the satisfaction measurement date. If the satisfaction measurement model is Percent then the value for this field is entered manually by the user or is provided by the source system. If the satisfaction measurement model is Period then the value for this field is derived from the performance satisfaction plan of the promised detail.",
            "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"
    }
}

Back to Top