Jump to

• Request
• Response
• Examples

Get all contract lines

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine

Request

Path Parameters

• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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:
  
  

  • ContractAllLineAltKey: Finds the contract lines with alternate keys - ID and major version.
    Finder Variables:
    • Id; integer; The unique identifier of the contract line.
    • MajorVersion; integer; The contract line major version.
  • ContractAllLineVOALTKey: Finds the contract lines with alternate key.
    Finder Variables:
    • ExternalKey; string.
    • ExternalSource; string.
  • ContractLinePuidAltKey: Finds the contract lines with alternate key Line PUID
    Finder Variables:
    • LinePuid; string; The public unique identifier of the contract line.
  • PrimaryKey: Finds the contract line with the specified contract line identifier.
    Finder Variables:
    • LineId; integer; The unique identifier of the contract line.
• 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:
  

  • AdjustmentAmount; number; The adjustment amount of the contract line.
  • AdjustmentBasisCode; string; The code that indicates the adjustment basis.
  • AdjustmentBasisId; integer; The unique identifier of the adjustment basis.
  • AdjustmentType; string; The type of adjustment of the contract line.
  • AdjustmentTypeCode; string; The code that indicates the type of adjustment.
  • AgreedAmount; number; The agreed amount of the contract line.
  • AgreedQuantity; number; The agreed quantity to be shipped of the contract line.
  • AgreementAmountLimit; number; The limit on the agreed amount.
  • AgreementPriceLimit; number; The price limit of the agreement line.
  • AgreementPriceOverAllwdYn; string; Indicates if the agreement price can be overridden.
  • AgreementQuantityLimit; number; The limit on the agreed quantity to be shipped.
  • AgreementUnitPrice; number; The unit price of the agreement line.
  • AllowCustomAdjustmentsFlag; boolean; Indicates whether a custom adjustment can be made.
  • AllowPricelistOverrideYn; string; Indicates whether price list override is allowed.
  • AllowPromotionsYn; string; Indicates whether promotions are allowed.
  • AtRiskYn; string; Indicating whether the contract line is at risk.
  • AutoApplyStrategyPriceAdjustmentFlag; boolean; Auto Apply Strategy Price Adjustment Flag
  • BillPlanId; integer; The unique identifier of the bill plan.
  • CarrierId; integer; The unique identifier of the carrier.
  • Cognomen; string; The name of the contract line.
  • Comments; string; The comments on the contract line.
  • CommitLevel; string; Commit Level
  • CommitLevelCode; string; Commit Level Code
  • CustomerPONumber; string; The PO number of the customer.
  • DateCancelled; string; The date cancelled.
  • DateTerminated; string; The date when the contract line is terminated.
  • DeliveryDate; string; The date when the items are expected to be delivered.
  • EndDate; string; The date when the contract line ends.
  • EstimatedVariableConsiderationAmount; number; Estimated Variable Consideration Amount
  • ExemptCertificateNumber; string; Exempt Certificate Number
  • ExemptReasonCode; string; Exempt Reason Code
  • ExternalKey; string; The key identifier of the contract line in the external source system.
  • ExternalSource; string; The name of external source system where the contract line is imported from.
  • FOB; string; The FOB of the contract line.
  • FOBCode; string; The code that indicates the FOB of the contract line.
  • FixedPriceServiceYn; string; Indicates that the service has a fixed price.
  • FloorPrice; number; The floor price of the contract line.
  • FreightTerms; string; The display name of the freight terms of the contract line.
  • FreightTermsCode; string; The code that indicates the freight terms of the contract line.
  • HoldReasonCode; string; The code that indicates the reason for holding a contract line.
  • HoldReasonCodeSetId; integer; The unique identifier of the set used for the hold reason code of the contract line.
  • HoldUntilDate; string; The date until when the contract line is put of hold.
  • Id; integer; Contract Line ID
  • ItemDescription; string; The description of the contract line item.
  • ItemName; string; The name of the contract line item.
  • ItemNameTxt; string; The column that stores the actual name of the contract line item.
  • ItemQuantity; number; The quantity of the contract line.
  • LastRevenueRecogDate; string; The date when the last revenue is recognized.
  • LineAmount; number; The total amount of the contract line.
  • LineId; integer; The unique identifier of the contract line.
  • LineNumber; string; The line number of the contract.
  • LinePuid; string; Line PUID
  • LineTypeId; integer; The unique identifier of the contract line type.
  • LineValueAmount; number; The value of the contract line.
  • ListPrice; number; The list price of the contract line.
  • MajorVersion; integer; The version of the contract line.
  • MinimumReleaseAmount; number; The minimum release amount per order of the contract line.
  • MinimumReleaseQuantity; number; The minimum release quantity to be shipped per order.
  • Object1Id1; integer; The unique identifier of the object.
  • Object1Id2; integer; The alternate key identifier of the object.
  • OrigSystemReference; string; The originating system reference of the contract line.
  • OrigSystemSourceCode; string; The source code of the originating system.
  • OutputTaxClassificationCode; string; The code that indicates the classification of the output tax.
  • PaymentTerms; string; The display name of the payment terms.
  • PaymentTermsId; integer; The unique identifier of the payment terms.
  • PercentComplete; number; The completeness of the contract line in percentage.
  • PriceApplicationRule; string; Price Application Rule
  • PriceAsOf; string; The date as of which a contract line or asset line is priced.
  • PriceBookId; integer; The unique identifier of the price book.
  • PriceListId; integer; The unique identifier of the price list.
  • PurchasingCategoryId; integer; The unique identifier of the purchasing category.
  • RecvInvOrgId; integer; The unique identifier of the receiving inventory organization.
  • RecvLocationId; integer; The unique identifier of the receiving location.
  • RevenuePlanId; integer; The unique identifier of the revenue plan.
  • ShipInvOrgId; integer; The unique identifier of the ship inventory organization.
  • ShipToAccountId; integer; The unique identifier of the ship-to account.
  • ShipToSiteUseId; integer; The unique identifier of the Ship-to site.
  • SourceDocumentId; integer; Source Document Id
  • SourceDocumentLineId; integer; Source Document Line Id
  • SourceDocumentSystemCode; string; Source Application Code
  • StandaloneSellingPrice; number; Standalone Selling Price
  • StartDate; string; The date when the contract line was created.
  • StsCode; string; The code that indicates the status of the contract line.
  • SupplierId; integer; The unique identifier of the supplier.
  • SupplierSiteId; integer; The unique identifier of the supplier's address.
  • TaxAmount; number; The tax amount of the contract line.
  • TaxExemptionControl; string; The code that indicates the reason for tax exemption.
  • TaxExemptionControlMeaning; string; The reason of the tax exemption.
  • TrnCode; string; The unique identifier of the set used for the hold reason code of the contract line.
  • TrnCodeSetId; integer; The unique identifier of the set used for cancel or close reason code of the contract line.
  • UOMCode; string; The code that indicates the Unit Of Measure of a contract line.
  • UnitPrice; number; The unit price of the contract line.
• 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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : contracts-ContractLine

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/contracts-ContractLine-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object contracts-ContractLine-item-response

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

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment

  The adjustment amount of the contract line.
• AdjustmentBasisCode: string
  Title: Adjustment Basis

  The code that indicates the adjustment basis.
• AdjustmentBasisId: integer
  Title: Adjustment Basis

  The unique identifier of the adjustment basis.
• AdjustmentType: string
  The type of adjustment of the contract line.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  The code that indicates the type of adjustment.
• AgreedAmount: number
  Title: AgreedAmount

  The agreed amount of the contract line.
• AgreedQuantity: number
  Title: Committed Quantity

  The agreed quantity to be shipped of the contract line.
• AgreementAmountLimit: number
  Title: Amount Limit

  The limit on the agreed amount.
• AgreementPriceLimit: number
  Title: Price Limit

  The price limit of the agreement line.
• AgreementPriceOverAllwdYn: string
  Title: Allow Price Override

  Maximum Length: 1

  Default Value: N

  Indicates if the agreement price can be overridden.
• AgreementQuantityLimit: number
  Title: Quantity Limit

  The limit on the agreed quantity to be shipped.
• AgreementUnitPrice: number
  Title: Unit Price

  The unit price of the agreement line.
• AllowCustomAdjustmentsFlag: boolean
  Title: Allow Price Override on Order

  Indicates whether a custom adjustment can be made.
• AllowPricelistOverrideYn: string
  Title: Allow Price Book Override on Order

  Maximum Length: 1

  Indicates whether price list override is allowed.
• AllowPromotionsYn: string
  Title: Allow Promotions

  Maximum Length: 1

  Default Value: N

  Indicates whether promotions are allowed.
• AssociatedProject: array Associated Projects
  Title: Associated Projects

  The resource is used to view, create, update, delete associated project information. This includes the project number, task number, percent complete, funded amount etc.
• AtRiskYn: string
  Title: At risk

  Maximum Length: 1

  Default Value: N

  Indicating whether the contract line is at risk.
• AutoApplyStrategyPriceAdjustmentFlag: boolean
  Title: Apply Pricing Strategy Adjustments

  Maximum Length: 1

  Auto Apply Strategy Price Adjustment Flag
• BillingControl: array Billing Controls
  Title: Billing Controls

  The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.
• BillPlan: string
  Title: Bill Plan

  Bill Plan Name
• BillPlanExternalKey: string
  The bill plan external key.
• BillPlanExternalSource: string
  The bill plan external source.
• BillPlanId: integer (int64)
  Title: Bill Plan

  The unique identifier of the bill plan.
• CancelReason: string
  Title: Cancellation Reason

  The cancel reason.
• CarrierId: integer (int64)
  Title: Carrier

  The unique identifier of the carrier.
• CarrierName: string
  Title: Carrier

  The name of the carrier.
• CloseReason: string
  Title: Close Reason

  The reason for closing a contract line.
• Cognomen: string
  Maximum Length: 300

  The name of the contract line.
• Comments: string
  Title: Comments

  Maximum Length: 1995

  The comments on the contract line.
• CommitLevel: string
  Commit Level
• CommitLevelCode: string
  Title: Commitment Level

  Maximum Length: 30

  Default Value: ESTIMATED

  Commit Level Code
• ContractAllLineDesFlexVA: array Contract Line Flexfields
  Title: Contract Line Flexfields

  The resource is used to view, create, update contract line flex field information.
• ContractLineTranslation: array Contract Line Translations
  Title: Contract Line Translations

  The resource is used to view, update contract line translation information.
• ContractPuid: string
  The contract PUID.
• CustomerPONumber: string
  Title: PO Number

  Maximum Length: 50

  The PO number of the customer.
• DateCancelled: string (date)
  The date cancelled.
• DateTerminated: string (date)
  Title: Closed Date

  The date when the contract line is terminated.
• DeliveryDate: string (date)
  Title: Need-by Date

  The date when the items are expected to be delivered.
• EndDate: string (date)
  Title: End Date

  The date when the contract line ends.
• EstimatedVariableConsiderationAmount: number
  Title: Estimated Variable Consideration Amount

  Estimated Variable Consideration Amount
• ExemptCertificateNumber: string
  Title: Exemption Certificate Number

  Maximum Length: 80

  Exempt Certificate Number
• ExemptReason: string
  Title: Exemption Reason

  Exempt Reason Name
• ExemptReasonCode: string
  Title: Exemption Reason

  Maximum Length: 30

  Exempt Reason Code
• ExternalKey: string
  Maximum Length: 150

  The key identifier of the contract line in the external source system.
• ExternalSource: string
  Maximum Length: 150

  The name of external source system where the contract line is imported from.
• FixedPriceServiceYn: string
  Title: Fixed price

  Maximum Length: 1

  Default Value: N

  Indicates that the service has a fixed price.
• FloorPrice: number
  Title: Floor Price

  Read Only: true

  The floor price of the contract line.
• FOB: string
  The FOB of the contract line.
• FOBCode: string
  Title: FOB

  Maximum Length: 30

  The code that indicates the FOB of the contract line.
• FreightTerms: string
  The display name of the freight terms of the contract line.
• FreightTermsCode: string
  Title: Freight Terms

  Maximum Length: 30

  The code that indicates the freight terms of the contract line.
• HoldReason: string
  Title: Hold Reason

  The reason for holding a contract line.
• HoldReasonCode: string
  Title: Hold Reason

  Maximum Length: 30

  The code that indicates the reason for holding a contract line.
• HoldReasonCodeSetId: integer (int64)
  The unique identifier of the set used for the hold reason code of the contract line.
• HoldReasonSetCode: string
  The hold reason set code
• HoldUntilDate: string (date)
  Title: Hold Until Date

  The date until when the contract line is put of hold.
• Id: integer (int64)
  Contract Line ID
• ItemDescription: string
  Title: Description

  Maximum Length: 1995

  The description of the contract line item.
• ItemName: string
  Title: Name

  Maximum Length: 1995

  The name of the contract line item.
• ItemNameTxt: string
  Title: Name

  Maximum Length: 1995

  The column that stores the actual name of the contract line item.
• ItemQuantity: number
  Title: Line Quantity

  The quantity of the contract line.
• LastRevenueRecogDate: string (date)
  Title: Last Revenue Recognized Date

  The date when the last revenue is recognized.
• LineAmount: number
  Title: Line Total

  The total amount of the contract line.
• LineId: integer (int64)
  The unique identifier of the contract line.
• LineNumber: string
  Title: Number

  Maximum Length: 150

  The line number of the contract.
• LinePuid: string
  Title: Line PUID

  Maximum Length: 120

  Line PUID
• LineStatus: string
  Title: Status

  The status of the contract line.
• LineTypeId: integer (int64)
  Title: Type

  The unique identifier of the contract line type.
• LineTypeName: string
  Title: Type

  The name of the contract line type.
• LineValueAmount: number
  Title: Line Amount

  The value of the contract line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Title: List Price

  The list price of the contract line.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  The version of the contract line.
• MinimumReleaseAmount: number
  Title: Minimum Release Amount

  The minimum release amount per order of the contract line.
• MinimumReleaseQuantity: number
  Title: Minimum Quantity per Order

  The minimum release quantity to be shipped per order.
• Object1Id1: integer (int64)
  The unique identifier of the object.
• Object1Id2: integer (int64)
  The alternate key identifier of the object.
• OrigSystemReference: string
  Maximum Length: 30

  The originating system reference of the contract line.
• OrigSystemSourceCode: string
  Maximum Length: 30

  The source code of the originating system.
• OutputTaxClassificationCode: string
  Title: Classification Code

  Maximum Length: 50

  The code that indicates the classification of the output tax.
• OutputTaxClassMeaning: string
  Title: Classification Code

  The classification of the output tax.
• PaymentTerms: string
  Title: Payment Terms

  The display name of the payment terms.
• PaymentTermsId: integer (int64)
  Title: Payment Terms

  The unique identifier of the payment terms.
• PercentComplete: number
  Title: Percent Complete

  The completeness of the contract line in percentage.
• PriceApplicationRule: string
  Title: Price Application Rule

  Maximum Length: 30

  Price Application Rule
• PriceAsOf: string (date)
  Title: Price as of Date

  The date as of which a contract line or asset line is priced.
• PriceBook: string
  Title: Price Book

  Price Book
• PriceBookId: integer (int64)
  The unique identifier of the price book.
• PriceList: string
  Title: Price List

  Price List
• PriceListId: integer (int64)
  The unique identifier of the price list.
• PricingEffectivityDate: string (date-time)
  Read Only: true

  The price effectivity date.
• ProjectContractLineInternalAttributes: array Contract Line Internal Attributes
  Title: Contract Line Internal Attributes

  The contract line internal attributes resource is used to view, create, update, and delete internal contract line attributes.
• PurchasingCategory: string
  Title: Purchasing Category

  Purchasing Category
• PurchasingCategoryId: integer (int64)
  Title: Item Class

  The unique identifier of the purchasing category.
• RecInvOrgName: string
  Title: Ship-to Organization

  Receiving Inventory Organization Name
• RecvInvOrgId: integer (int64)
  Title: Ship-to Organization

  The unique identifier of the receiving inventory organization.
• RecvLocationId: integer (int64)
  Title: Ship-to Location

  The unique identifier of the receiving location.
• RevenueAmount: string
  Title: Revenue Amount

  Read Only: true

  The revenue amount of the contract line.
• RevenuePlan: string
  Title: Revenue Plan

  The revenue amount of the contract line.
• RevenuePlanExternalKey: string
  The revenue plan external key.
• RevenuePlanExternalSource: string
  The revenue plan external source.
• RevenuePlanId: integer (int64)
  Title: Revenue Plan

  The unique identifier of the revenue plan.
• SalesCredit: array Sales Credits
  Title: Sales Credits

  The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date.
• ShipInvOrgId: integer (int64)
  Title: Warehouse

  The unique identifier of the ship inventory organization.
• ShipToAccount: string
  Title: Ship-to Party

  The name of the ship-to account.
• ShipToAccountId: integer (int64)
  Title: Ship-to Account

  The unique identifier of the ship-to account.
• ShipToAccountNumber: string
  Title: Ship-to Account Number

  The alternate unique identifier of the Ship-to site.
• ShipToOrgLocation: string
  Title: Ship-to Location

  The location of the Ship-to organization.
• ShipToSite: string
  Title: Ship-to Site

  The display name of the Ship-to site.
• ShipToSiteUseId: integer (int64)
  Title: Ship-to Site

  The unique identifier of the Ship-to site.
• SourceDocumentId: integer (int64)
  Title: Source Document Number

  Source Document Id
• SourceDocumentLineId: integer (int64)
  Title: Source Document Line Number

  Source Document Line Id
• SourceDocumentSystemCode: string
  Title: Source Application

  Maximum Length: 30

  Source Application Code
• SourceSystemAttributes: string (byte)
  Source System Attributes
• StandaloneSellingPrice: number
  Title: Standalone Selling Price

  Standalone Selling Price
• StartDate: string (date)
  Title: Start Date

  The date when the contract line was created.
• StsCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The code that indicates the status of the contract line.
• Supplier: string
  Title: Supplier

  The name of the supplier.
• SupplierId: integer (int64)
  Title: Supplier

  The unique identifier of the supplier.
• SupplierSiteId: integer (int64)
  Title: Supplier Site

  The unique identifier of the supplier's address.
• SupplierSiteName: string
  Title: Supplier Address

  The address of the supplier.
• TaxAmount: number
  The tax amount of the contract line.
• TaxExemptionControl: string
  Title: Exemption Handling

  Maximum Length: 30

  The code that indicates the reason for tax exemption.
• TaxExemptionControlMeaning: string
  The reason of the tax exemption.
• TrnCode: string
  Title: Close Reason

  Maximum Length: 30

  The unique identifier of the set used for the hold reason code of the contract line.
• TrnCodeSetId: integer (int64)
  The unique identifier of the set used for cancel or close reason code of the contract line.
• TrnSetCode: string
  The transaction set code.
• UnitOfMeasure: string
  Title: UOM

  Unit Of Measure
• UnitPrice: number
  Title: Unit Price

  The unit price of the contract line.
• UOMCode: string
  Title: UOM

  Maximum Length: 15

  The code that indicates the Unit Of Measure of a contract line.
• VendorSiteId: integer
  Read Only: true

  The unique identifier of the vendor site.
• WareHouse: string
  Title: Warehouse

  The warehouse of the contract line.

{
    "type":"object",
    "properties":{
        "ContractPuid":{
            "type":"string",
            "description":"The contract PUID.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceBook":{
            "title":"Price Book",
            "type":"string",
            "description":"Price Book",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PriceListId"
                ]
            }
        },
        "ItemNameTxt":{
            "title":"Name",
            "maxLength":"1995",
            "type":"string",
            "description":"The column that stores the actual name of the contract line item.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "AgreementPriceOverAllwdYn":{
            "title":"Allow Price Override",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the agreement price can be overridden.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "TaxAmount":{
            "type":"number",
            "description":"The tax amount of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "StsCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the status of the contract line.",
            "nullable":true,
            "default":"DRAFT",
            "x-queryable":true
        },
        "HoldUntilDate":{
            "title":"Hold Until Date",
            "type":"string",
            "description":"The date until when the contract line is put of hold.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CloseReason":{
            "title":"Close Reason",
            "type":"string",
            "description":"The reason for closing a contract line.",
            "nullable":true,
            "x-queryable":false
        },
        "AgreementUnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the agreement line.",
            "nullable":true,
            "x-queryable":true
        },
        "CommitLevel":{
            "type":"string",
            "description":"Commit Level",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShipToOrgLocation":{
            "title":"Ship-to Location",
            "type":"string",
            "description":"The location of the Ship-to organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "RecvInvOrgId"
                ]
            }
        },
        "LineAmount":{
            "title":"Line Total",
            "type":"number",
            "description":"The total amount of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "title":"Adjustment",
            "type":"number",
            "description":"The adjustment amount of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptReasonCode":{
            "title":"Exemption Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Exempt Reason Code",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"15",
            "type":"string",
            "description":"The code that indicates the Unit Of Measure of a contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AtRiskYn":{
            "title":"At risk",
            "maxLength":"1",
            "type":"string",
            "description":"Indicating whether the contract line is at risk.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "WareHouse":{
            "title":"Warehouse",
            "type":"string",
            "description":"The warehouse of the contract line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CarrierName":{
            "title":"Carrier",
            "type":"string",
            "description":"The name of the carrier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AgreementPriceLimit":{
            "title":"Price Limit",
            "type":"number",
            "description":"The price limit of the agreement line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AgreementPriceOverAllwdYn"
                ]
            },
            "x-queryable":true
        },
        "PaymentTermsId":{
            "title":"Payment Terms",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystemAttributes":{
            "type":"string",
            "description":"Source System Attributes",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AllowPricelistOverrideYn":{
            "title":"Allow Price Book Override on Order",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether price list override is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxExemptionControlMeaning":{
            "type":"string",
            "description":"The reason of the tax exemption.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillPlan":{
            "title":"Bill Plan",
            "type":"string",
            "description":"Bill Plan Name",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CommitLevelCode":{
            "title":"Commitment Level",
            "maxLength":"30",
            "type":"string",
            "description":"Commit Level Code",
            "nullable":true,
            "default":"ESTIMATED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FloorPrice":{
            "title":"Floor Price",
            "type":"number",
            "description":"The floor price of the contract line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReasonCodeSetId":{
            "type":"integer",
            "description":"The unique identifier of the set used for the hold reason code of the contract line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"30"
            },
            "x-queryable":true
        },
        "HoldReasonSetCode":{
            "type":"string",
            "description":"The hold reason set code",
            "nullable":true,
            "x-queryable":false
        },
        "AllowPromotionsYn":{
            "title":"Allow Promotions",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether promotions are allowed.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Contract Line ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Object1Id1":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Object1Id2":{
            "type":"integer",
            "description":"The alternate key identifier of the object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrigSystemReference":{
            "maxLength":"30",
            "type":"string",
            "description":"The originating system reference of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "Cognomen":{
            "maxLength":"300",
            "type":"string",
            "description":"The name of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementQuantityLimit":{
            "title":"Quantity Limit",
            "type":"number",
            "description":"The limit on the agreed quantity to be shipped.",
            "nullable":true,
            "x-queryable":true
        },
        "BillPlanExternalKey":{
            "type":"string",
            "description":"The bill plan external key.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSiteName":{
            "title":"Supplier Address",
            "type":"string",
            "description":"The address of the supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SupplierId"
                ]
            }
        },
        "BillPlanExternalSource":{
            "type":"string",
            "description":"The bill plan external source.",
            "nullable":true,
            "x-queryable":false
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":"150",
            "type":"string",
            "description":"The line number of the contract.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerPONumber":{
            "title":"PO Number",
            "maxLength":"50",
            "type":"string",
            "description":"The PO number of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "CarrierId":{
            "title":"Carrier",
            "type":"integer",
            "description":"The unique identifier of the carrier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StandaloneSellingPrice":{
            "title":"Standalone Selling Price",
            "type":"number",
            "description":"Standalone Selling Price",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site",
            "type":"integer",
            "description":"The unique identifier of the supplier's address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "SupplierId"
                ]
            },
            "x-queryable":true
        },
        "AgreedQuantity":{
            "title":"Committed Quantity",
            "type":"number",
            "description":"The agreed quantity to be shipped of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractAllLineDesFlexVA":{
            "title":"Contract Line Flexfields",
            "type":"array",
            "description":"The resource is used to view, create, update contract line flex field information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-ContractAllLineDesFlexVA-item-response"
            },
            "x-cardinality":"1"
        },
        "ItemName":{
            "title":"Name",
            "maxLength":"1995",
            "type":"string",
            "description":"The name of the contract line item.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "type":"string",
            "description":"The name of the supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"The version of the contract line.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document Number",
            "type":"integer",
            "description":"Source Document Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgreedAmount":{
            "title":"AgreedAmount",
            "type":"number",
            "description":"The agreed amount of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "TrnSetCode":{
            "type":"string",
            "description":"The transaction set code.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the contract line ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"The unique identifier of the adjustment basis.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShipToSiteUseId":{
            "title":"Ship-to Site",
            "type":"integer",
            "description":"The unique identifier of the Ship-to site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemQuantity":{
            "title":"Line Quantity",
            "type":"number",
            "description":"The quantity of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"The completeness of the contract line in percentage.",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "LastRevenueRecogDate":{
            "title":"Last Revenue Recognized Date",
            "type":"string",
            "description":"The date when the last revenue is recognized.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedVariableConsiderationAmount":{
            "title":"Estimated Variable Consideration Amount",
            "type":"number",
            "description":"Estimated Variable Consideration Amount",
            "nullable":true,
            "x-queryable":true
        },
        "OutputTaxClassMeaning":{
            "title":"Classification Code",
            "type":"string",
            "description":"The classification of the output tax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PriceBookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"30"
            },
            "x-queryable":true
        },
        "RevenuePlanId":{
            "title":"Revenue Plan",
            "type":"integer",
            "description":"The unique identifier of the revenue plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FreightTerms":{
            "type":"string",
            "description":"The display name of the freight terms of the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingEffectivityDate":{
            "type":"string",
            "description":"The price effectivity date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineTypeId":{
            "title":"Type",
            "type":"integer",
            "description":"The unique identifier of the contract line type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceDocumentSystemCode":{
            "title":"Source Application",
            "maxLength":"30",
            "type":"string",
            "description":"Source Application Code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateTerminated":{
            "title":"Closed Date",
            "type":"string",
            "description":"The date when the contract line is terminated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"The date when the items are expected to be delivered.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssociatedProject":{
            "title":"Associated Projects",
            "type":"array",
            "description":"The resource is used to view, create, update, delete associated project information. This includes the project number, task number, percent complete, funded amount etc.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-AssociatedProject-item-response"
            }
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the contract line.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccount":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The name of the ship-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the contract line was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptReason":{
            "title":"Exemption Reason",
            "type":"string",
            "description":"Exempt Reason Name",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TaxExemptionControl"
                ]
            }
        },
        "ShipToSite":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The display name of the Ship-to site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LineValueAmount":{
            "title":"Line Amount",
            "type":"number",
            "description":"The value of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSource":{
            "maxLength":"150",
            "type":"string",
            "description":"The name of external source system where the contract line is imported from.",
            "nullable":true,
            "x-queryable":true
        },
        "FOB":{
            "type":"string",
            "description":"The FOB of the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the Ship-to site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RevenuePlan":{
            "title":"Revenue Plan",
            "type":"string",
            "description":"The revenue amount of the contract line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "FOBCode":{
            "title":"FOB",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the FOB of the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "type":"string",
            "description":"Unit Of Measure",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "UOMCode"
                ]
            }
        },
        "LinePuid":{
            "title":"Line PUID",
            "maxLength":"120",
            "type":"string",
            "description":"Line PUID",
            "nullable":true,
            "x-queryable":true
        },
        "RevenuePlanExternalKey":{
            "type":"string",
            "description":"The revenue plan external key.",
            "nullable":true,
            "x-queryable":false
        },
        "PurchasingCategoryId":{
            "title":"Item Class",
            "type":"integer",
            "description":"The unique identifier of the purchasing category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractLineTranslation":{
            "title":"Contract Line Translations",
            "type":"array",
            "description":"The resource is used to view, update contract line translation information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-ContractLineTranslation-item-response"
            }
        },
        "MinimumReleaseQuantity":{
            "title":"Minimum Quantity per Order",
            "type":"number",
            "description":"The minimum release quantity to be shipped per order.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenuePlanExternalSource":{
            "type":"string",
            "description":"The revenue plan external source.",
            "nullable":true,
            "x-queryable":false
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"The unique identifier of the vendor site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierId":{
            "title":"Supplier",
            "type":"integer",
            "description":"The unique identifier of the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DateCancelled":{
            "type":"string",
            "description":"The date cancelled.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "type":"string",
            "description":"The cancel reason.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipInvOrgId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The unique identifier of the ship inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MinimumReleaseAmount":{
            "title":"Minimum Release Amount",
            "type":"number",
            "description":"The minimum release amount per order of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "OrigSystemSourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The source code of the originating system.",
            "nullable":true,
            "x-queryable":true
        },
        "LineTypeName":{
            "title":"Type",
            "type":"string",
            "description":"The name of the contract line type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LineTypeId"
                ]
            }
        },
        "AllowCustomAdjustmentsFlag":{
            "title":"Allow Price Override on Order",
            "type":"boolean",
            "description":"Indicates whether a custom adjustment can be made.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceApplicationRule":{
            "title":"Price Application Rule",
            "maxLength":"30",
            "type":"string",
            "description":"Price Application Rule",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HoldReasonCode":{
            "title":"Hold Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the reason for holding a contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "TrnCodeSetId":{
            "type":"integer",
            "description":"The unique identifier of the set used for cancel or close reason code of the contract line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecvLocationId":{
            "title":"Ship-to Location",
            "type":"integer",
            "description":"The unique identifier of the receiving location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "RecvInvOrgId"
                ]
            },
            "x-queryable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The date as of which a contract line or asset line is priced.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectContractLineInternalAttributes":{
            "title":"Contract Line Internal Attributes",
            "type":"array",
            "description":"The contract line internal attributes resource is used to view, create, update, and delete internal contract line attributes.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-ProjectContractLineInternalAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "FixedPriceServiceYn":{
            "title":"Fixed price",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the service has a fixed price.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PaymentTerms":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The display name of the payment terms.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueAmount":{
            "title":"Revenue Amount",
            "type":"string",
            "description":"The revenue amount of the contract line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":"1995",
            "type":"string",
            "description":"The description of the contract line item.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "OutputTaxClassificationCode":{
            "title":"Classification Code",
            "maxLength":"50",
            "type":"string",
            "description":"The code that indicates the classification of the output tax.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAccountId":{
            "title":"Ship-to Account",
            "type":"integer",
            "description":"The unique identifier of the ship-to account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The key identifier of the contract line in the external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceList":{
            "title":"Price List",
            "type":"string",
            "description":"Price List",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PriceListId"
                ]
            }
        },
        "TrnCode":{
            "title":"Close Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the set used for the  hold reason code of the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineId":{
            "title":"Source Document Line Number",
            "type":"integer",
            "description":"Source Document Line Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesCredit":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-SalesCredit-item-response"
            }
        },
        "LineId":{
            "type":"integer",
            "description":"The unique identifier of the contract line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1995",
            "type":"string",
            "description":"The comments on the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxExemptionControl":{
            "title":"Exemption Handling",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the reason for tax exemption.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecInvOrgName":{
            "title":"Ship-to Organization",
            "type":"string",
            "description":"Receiving Inventory Organization Name",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AgreementAmountLimit":{
            "title":"Amount Limit",
            "type":"number",
            "description":"The limit on the agreed amount.",
            "nullable":true,
            "x-queryable":true
        },
        "BillPlanId":{
            "title":"Bill Plan",
            "type":"integer",
            "description":"The unique identifier of the bill plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurchasingCategory":{
            "title":"Purchasing Category",
            "type":"string",
            "description":"Purchasing Category",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingControl":{
            "title":"Billing Controls",
            "type":"array",
            "description":"The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-BillingControl-item-response"
            }
        },
        "ExemptCertificateNumber":{
            "title":"Exemption Certificate Number",
            "maxLength":"80",
            "type":"string",
            "description":"Exempt Certificate Number",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "type":"string",
            "description":"The type of adjustment of the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HoldReason":{
            "title":"Hold Reason",
            "type":"string",
            "description":"The reason for holding a contract line.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "type":"string",
            "description":"The code that indicates the type of adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecvInvOrgId":{
            "title":"Ship-to Organization",
            "type":"integer",
            "description":"The unique identifier of the receiving inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FreightTermsCode":{
            "title":"Freight Terms",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the freight terms of the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AutoApplyStrategyPriceAdjustmentFlag":{
            "title":"Apply Pricing Strategy Adjustments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Auto Apply Strategy Price Adjustment Flag",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasisCode":{
            "title":"Adjustment Basis",
            "type":"string",
            "description":"The code that indicates the adjustment basis.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Associated Projects

Type: array

Title: Associated Projects

The resource is used to view, create, update, delete associated project information. This includes the project number, task number, percent complete, funded amount etc.

Show Source

• Array of: object contracts-ContractLine-AssociatedProject-item-response

{
    "title":"Associated Projects",
    "type":"array",
    "description":"The resource is used to view, create, update, delete associated project information. This includes the project number, task number, percent complete, funded amount etc.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-AssociatedProject-item-response"
    }
}

Nested Schema : Billing Controls

Type: array

Title: Billing Controls

The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.

Show Source

• Array of: object contracts-ContractLine-BillingControl-item-response

{
    "title":"Billing Controls",
    "type":"array",
    "description":"The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-BillingControl-item-response"
    }
}

Nested Schema : Contract Line Flexfields

Type: array

Title: Contract Line Flexfields

The resource is used to view, create, update contract line flex field information.

Show Source

• Array of: object contracts-ContractLine-ContractAllLineDesFlexVA-item-response

{
    "title":"Contract Line Flexfields",
    "type":"array",
    "description":"The resource is used to view, create, update contract line flex field information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-ContractAllLineDesFlexVA-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Contract Line Translations

Type: array

Title: Contract Line Translations

The resource is used to view, update contract line translation information.

Show Source

• Array of: object contracts-ContractLine-ContractLineTranslation-item-response

{
    "title":"Contract Line Translations",
    "type":"array",
    "description":"The resource is used to view, update contract line translation information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-ContractLineTranslation-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 : Contract Line Internal Attributes

Type: array

Title: Contract Line Internal Attributes

The contract line internal attributes resource is used to view, create, update, and delete internal contract line attributes.

Show Source

• Array of: object contracts-ContractLine-ProjectContractLineInternalAttributes-item-response

{
    "title":"Contract Line Internal Attributes",
    "type":"array",
    "description":"The contract line internal attributes resource is used to view, create, update, and delete internal contract line attributes.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-ProjectContractLineInternalAttributes-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date.

Show Source

• Array of: object contracts-ContractLine-SalesCredit-item-response

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-SalesCredit-item-response"
    }
}

Nested Schema : contracts-ContractLine-AssociatedProject-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Flag to check if linkage is still valid
• CurrencyCode: string
  Title: Contract Currency

  The currency code.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Reference key in External source
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  External Source Key
• FundingAmount: number
  Title: Contract Funding

  Linkage funding amount
• LastRevRecogDate: string (date)
  Title: Last Revenue Recognized Date

  Read Only: true

  The date revenue was last recognized for this associated project within this contract line.
• LinkId: integer (int64)
  Title: Contract Project Association ID

  The unique identifier of the Contract project linkage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Contract Version on which linkage is defined
• PercentComplete: number
  Title: Percent Complete

  Percentage Complete
• ProjectId: integer (int64)
  Title: Project ID

  Project Identifier for the project on Linkage
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Project Number of the project on Linkage
• ProjElementId: integer (int64)
  Title: Project Task ID

  Task Identifier for the the task on linkage
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Task Number of the Task on the linkage

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Contract Version on which linkage is defined",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":"150",
            "type":"string",
            "description":"Reference key in External source",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":"150",
            "type":"string",
            "description":"External Source Key",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Project Number of the project on Linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "LastRevRecogDate":{
            "title":"Last Revenue Recognized Date",
            "type":"string",
            "description":"The date revenue was last recognized for this associated project within this contract line.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Project Identifier for the project on Linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Task Number of the Task on the linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag to check if linkage is still valid",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Contract Currency",
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ProjElementId":{
            "title":"Project Task ID",
            "type":"integer",
            "description":"Task Identifier for the the task on linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            },
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"Percentage Complete",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "FundingAmount":{
            "title":"Contract Funding",
            "type":"number",
            "description":"Linkage funding amount",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkId":{
            "title":"Contract Project Association ID",
            "type":"integer",
            "description":"The unique identifier of the Contract project linkage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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 : contracts-ContractLine-BillingControl-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the billing control is active.
• BillingControlId: integer (int64)
  The unique identifier of the billing control.
• BillingResource: string
  Title: Billing Resource

  The Resource Breakdown structure Element for which Billing control is defined.
• EndDate: string (date)
  Title: End Date

  The date when the billing control ends.
• ExternalReferenceKey: string
  Maximum Length: 150

  The reference key in the external source.
• ExternalSourceKey: string
  Maximum Length: 150

  The external source key of the billing control.
• HardLimitAmount: number
  Title: Hard Limit

  The hard limit for the billing control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  The contract version of the billing control.
• RbsElementId: integer (int64)
  Title: Billing Resource ID

  The identifier of the Resource Breakdown structure Element for which Billing control is defined.
• SoftLimitAmount: number
  Title: Soft Limit

  The soft limit for the billing control.
• StartDate: string (date)
  Title: Start Date

  The date when the billing control starts.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"The contract version of the billing control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the billing control starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The reference key in the external source.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The external source key of the billing control.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingResource":{
            "title":"Billing Resource",
            "type":"string",
            "description":"The Resource Breakdown structure Element for which Billing control is defined.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingControlId":{
            "type":"integer",
            "description":"The unique identifier of the billing control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HardLimitAmount":{
            "title":"Hard Limit",
            "type":"number",
            "description":"The hard limit for the billing control.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the billing control ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the billing control is active.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RbsElementId":{
            "title":"Billing Resource ID",
            "type":"integer",
            "description":"The identifier of the Resource Breakdown structure Element for which Billing control is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SoftLimitAmount":{
            "title":"Soft Limit",
            "type":"number",
            "description":"The soft limit for the billing control.",
            "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 : contracts-ContractLine-ContractAllLineDesFlexVA-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive Flexfield: structure definition of the user descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• LineId: integer (int64)
  Line Id
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineId":{
            "type":"integer",
            "description":"Line Id",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : contracts-ContractLine-ContractLineTranslation-item-response

Type: object

Show Source

• Comments: string
  Maximum Length: 1995

  Contract Line Comments
• Id: integer
  Contract Line ID
• ItemDescription: string
  Maximum Length: 1995

  Item Description
• ItemName: string
  Maximum Length: 1995

  Item Name
• Language: string
  Maximum Length: 12

  Indicates the code of the language into which the contents of the translatable columns are translated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Major Version
• SourceLanguage: string
  Maximum Length: 12

  Source Language

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":"12",
            "type":"string",
            "description":"Source Language",
            "nullable":false,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"12",
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"1995",
            "type":"string",
            "description":"Contract Line Comments",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"1995",
            "type":"string",
            "description":"Item Name",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"Contract Line ID",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"1995",
            "type":"string",
            "description":"Item Description",
            "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 : contracts-ContractLine-ProjectContractLineInternalAttributes-item-response

Type: object

Show Source

• ContractId: integer
  Unique identifier of the contract.
• ContractLineId: integer
  Unique identifier of the contract line.
• ControlMilestoneDatesFlag: boolean
  Maximum Length: 1

  Indicates whether project managers can change the planned finish date of a milestone once created in the project plan. The default value is Y, which allows project managers to manage planned finish dates for milestones in the project plan.
• ExpenditureTypeId: integer
  Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ExpenditureTypeName: string
  Title: Expenditure Type Name

  Maximum Length: 240

  Name of the expenditure type that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ExpOrgSourceFlag: boolean
  Title: Use original task owning organization

  Maximum Length: 20

  Indicates whether the expenditure organization populated on the intercompany invoice line sent to payables comes from the task owning organization on the original expenditure item or the expenditure organization on the intercompany contract line.
• ExpTypeOrigEiFlag: boolean
  Title: Use original expenditure type

  Maximum Length: 1

  Indicates whether the expenditure type populated on the internal invoice line sent to payables comes from the expenditure type on the original expenditure item or the expenditure type on the internal contract line..
• ExternalReferenceKey: string
  Maximum Length: 150

  The external reference key.
• ExternalSourceKey: string
  Maximum Length: 150

  The external source key.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer
  Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.
• OrganizationId: integer
  Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• OrganizationName: string
  Title: Expenditure Organization Name

  Maximum Length: 240

  Name of the organization that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ProviderBusinessUnitId: integer
  Title: Provider Business Unit ID

  Unique identifier for the business unit that provides goods or services which are charged using the internal contract line.
• ProviderBusinessUnitName: string
  Title: Provider Business Unit Name

  Maximum Length: 240

  Name of the business unit that provides goods or services which are charged using the internal contract line.
• RcvrBusinessUnitId: integer (int64)
  The unique identifier of the receiver business unit.
• RcvrBusinessUnitName: string
  Title: Receiver Business Unit

  Maximum Length: 240

  The receiver business unit name.
• ReceiverProjectId: integer
  Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ReceiverProjectName: string
  Title: Receiver Project Name

  Maximum Length: 240

  Name of the project that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ReceiverTaskId: integer
  Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ReceiverTaskName: string
  Title: Receiver Task Name

  Maximum Length: 255

  Name of the task that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Expenditure Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ReceiverProjectName",
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The external reference key.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpOrgSourceFlag":{
            "title":"Use original task owning organization",
            "maxLength":"20",
            "type":"boolean",
            "description":"Indicates whether the expenditure organization populated on the intercompany invoice line sent to payables comes from the task owning organization on the original expenditure item or the expenditure organization on the intercompany contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The external source key.",
            "nullable":true,
            "x-queryable":true
        },
        "ProviderBusinessUnitName":{
            "title":"Provider Business Unit Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit that provides goods or services which are charged using the internal contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ContractLineId":{
            "type":"integer",
            "description":"Unique identifier of the contract line.",
            "nullable":false,
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Unique identifier of the contract.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "RcvrBusinessUnitName":{
            "title":"Receiver Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The receiver business unit name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ControlMilestoneDatesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether project managers can change the planned finish date of a milestone once created in the project plan. The default value is Y, which allows project managers to manage planned finish dates for milestones in the project plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "type":"integer",
            "description":"Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure type that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ReceiverProjectName",
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ReceiverProjectName":{
            "title":"Receiver Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProviderBusinessUnitId":{
            "title":"Provider Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the business unit that provides goods or services which are charged using the internal contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "RcvrBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the receiver business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReceiverTaskId":{
            "type":"integer",
            "description":"Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ReceiverProjectId":{
            "type":"integer",
            "description":"Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpTypeOrigEiFlag":{
            "title":"Use original expenditure type",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the expenditure type populated on the internal invoice line sent to payables comes from the expenditure type on the original expenditure item or the expenditure type on the internal contract line..",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverTaskName":{
            "title":"Receiver Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ReceiverProjectName",
                    "ReceiverProjectId"
                ]
            },
            "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 : contracts-ContractLine-SalesCredit-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: false

  Active Flag
• EndDate: string (date)
  Title: End Date

  sales Credit End Date
• ExternalReferenceKey: string
  Maximum Length: 120

  External Reference Key
• ExternalSourceKey: string
  Maximum Length: 120

  External Source Key
• Id: integer (int64)
  Sales Credit Id
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Major Version
• Percent: number
  Title: Percent

  Sales Credit Percent
• SalesCreditPuid: string
  Title: Sales Credit PUID

  Maximum Length: 120

  sales Credit PUID
• SalesCreditType: string
  Maximum Length: 240

  Sales Credit Type
• SalesCreditTypeId: integer
  Title: Credit Type

  Sales Credit Type Id
• SalesrepId: integer (int64)
  Salesrep Id
• SalesrepName: string
  Title: Salesperson

  Maximum Length: 360

  Sales Representative Name
• StartDate: string (date)
  Title: Start Date

  sales Credit Start Date

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "maxLength":"120",
            "type":"string",
            "description":"External Reference Key",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "maxLength":"120",
            "type":"string",
            "description":"External Source Key",
            "nullable":true,
            "x-queryable":true
        },
        "Percent":{
            "title":"Percent",
            "type":"number",
            "description":"Sales Credit Percent",
            "nullable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "SalesrepId":{
            "type":"integer",
            "description":"Salesrep Id",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"Sales Credit Type Id",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesCreditType":{
            "maxLength":"240",
            "type":"string",
            "description":"Sales Credit Type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Active Flag",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"sales Credit End Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SalesrepName":{
            "title":"Salesperson",
            "maxLength":"360",
            "type":"string",
            "description":"Sales Representative Name",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"sales Credit Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SalesCreditPuid":{
            "title":"Sales Credit PUID",
            "maxLength":"120",
            "type":"string",
            "description":"sales Credit PUID",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"Sales Credit Id",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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"
    }
}

Back to Top

Examples

The following example shows how to get all contract lines by submitting a GET request on the REST resource using cURL.

cURL command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/00020000000EACED0005770800005AF3113B1FE60000000EACED000577080000000000000001/child/ContractLine

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items": [
  {
"LineNumber": "1",
"Id": 100000012640235,
"MajorVersion": 1,
"LineTypeId": 104,
"LineTypeName": "Item",
"StsCode": "DRAFT",
"LineStatus": "Draft",
"Object1Id1": 33374,
"Object1Id2": 204,
"ItemName": "AS34300",
"ItemNameTxt": "AS34300",
"ItemDescription": "HP ProLiant DL740 - Xeon MP 3 GHz",
"StartDate": "2009-10-15",
"EndDate": null,
"PriceListId": null,
"UOMCode": "Ea",
"FixedPriceServiceYn": "N",
"ItemQuantity": 1,
"UnitPrice": 4444444444444,
"LineValueAmount": 4444444444444,
"LineAmount": 4444444444444,
"Comments": null,
"AgreedQuantity": null,
"AgreedAmount": null,
"AgreementQuantityLimit": null,
"AgreementAmountLimit": null,
"MinimumReleaseQuantity": null,
"MinimumReleaseAmount": null,
"PriceBookId": null,
"AllowPricelistOverrideYn": null,
"ListPrice": null,
"FloorPrice": null,
"AgreementPriceLimit": null,
"AgreementUnitPrice": null,
"AdjustmentTypeCode": null,
"AdjustmentType": null,
"AdjustmentBasisId": null,
"AdjustmentBasisCode": null,
"AdjustmentAmount": null,
"AllowCustomAdjustmentsFlag": null,
"DateTerminated": null,
"HoldUntilDate": null,
"TrnCodeSetId": null,
"TrnCode": null,
"CloseReason": null,
"HoldReasonCodeSetId": null,
"HoldReasonCode": null,
"HoldReason": null,
"AtRiskYn": "N",
"PercentComplete": null,
"ShipToAccountId": null,
"ShipToAccount": null,
"ShipToSiteUseId": null,
"ShipToSite": null,
"ShipInvOrgId": null,
"WareHouse": null,
"BillPlanId": null,
"RevenuePlanId": null,
"RevenueAmount": "0",
"OutputTaxClassificationCode": null,
"ExemptReasonCode": null,
"ExemptReason": null,
"LastRevenueRecogDate": null,
"CustomerPONumber": null,
"DeliveryDate": "2009-10-28",
"SupplierId": 2960,
"Supplier": null,
"SupplierSiteId": 2641,
"SupplierSiteName": "1263",
"RecvInvOrgId": 911,
"RecvLocationId": 3248,
"ShipToOrgLocation": "CSP10002",
"AgreementPriceOverAllwdYn": "N",
"FOBCode": "Destination",
"FOB": "Destination",
"FreightTermsCode": "SHIP",
"FreightTerms": null,
"PaymentTermsId": 10042,
"PaymentTerms": "2N30",
"PurchasingCategoryId": 1,
"CarrierId": 12524,
"CarrierName": "Federal Express",
"VendorSiteId": null,
"OrigSystemReference": null,
"OrigSystemSourceCode": null,
"Cognomen": null,
"TaxAmount": null,
"ExternalSource": null,
"ExternalKey": null,
"ExternalItemKey": null,
"ExternalItemReference1": null,
"ExternalItemReference2": null,
"ExternalItemReference3": null,
"ExternalItemReference4": null,
"ExternalItemReference5": null,
"ExternalItemSource": null,
"AllowPromotionsYn": "N",
"BillToCustAccountNumber": null,
"BillToSiteUseName": null,
"BillToContactName": null,
"InvoiceRuleId": null,
"BillToAccountId": null,
"AccountRuleId": null,
"BillingFrequency": null,
"InvoiceText": null,
"OrderSource": null,
"PriceUOM": null,
"ShipToPartyId": null,
"ShipToPartySiteId": null,
"DurationQuantity": null,
"PricingEffectivityDate": null,
"PriceItemQuantity": 1,
"PriceItemUOM": "Ea",
"OnetimeAmount": null,
"RecurringAmount": null,
"TaxError": null,
"InstrAssignmentId": null,
"PaymentMethod": null,
"PoNumber": null,
"TrxnExtensionId": null,
"WireNumber": null,
"CreditCardNumber": null,
"CreditCardHolderName": null,
"CreditCardIssuerCode": null,
"CreditCardIssuerName": null,
"CreditCardExpiryDate": null,
"BillToAccountPartyId": null,
"links":
...,
}
],
},
 {
"LineNumber": "2",
"Id": 100000012640236,
"MajorVersion": 1,
"LineTypeId": 103,
"LineTypeName": "Free-form",
"StsCode": "DRAFT",
"LineStatus": "Draft",
"Object1Id1": null,
"Object1Id2": null,
"ItemName": "ff",
"ItemNameTxt": "ff",
"ItemDescription": "ff",
"StartDate": "2009-10-15",
"EndDate": null,
"PriceListId": null,
"UOMCode": null,
"FixedPriceServiceYn": "Y",
"ItemQuantity": null,
"UnitPrice": null,
"LineValueAmount": 55555555555,
"LineAmount": 55555555555,
"Comments": null,
"AgreedQuantity": null,
"AgreedAmount": null,
"AgreementQuantityLimit": null,
"AgreementAmountLimit": null,
"MinimumReleaseQuantity": null,
"MinimumReleaseAmount": null,
"PriceBookId": null,
"AllowPricelistOverrideYn": null,
"ListPrice": null,
"FloorPrice": null,
"AgreementPriceLimit": null,
"AgreementUnitPrice": null,
"AdjustmentTypeCode": null,
"AdjustmentType": null,
"AdjustmentBasisId": null,
"AdjustmentBasisCode": null,
"AdjustmentAmount": null,
"AllowCustomAdjustmentsFlag": null,
"DateTerminated": null,
"HoldUntilDate": null,
"TrnCodeSetId": null,
"TrnCode": null,
"CloseReason": null,
"HoldReasonCodeSetId": null,
"HoldReasonCode": null,
"HoldReason": null,
"AtRiskYn": "N",
"PercentComplete": null,
"ShipToAccountId": null,
"ShipToAccount": null,
"ShipToSiteUseId": null,
"ShipToSite": null,
"ShipInvOrgId": null,
"WareHouse": null,
"BillPlanId": null,
"RevenuePlanId": null,
"RevenueAmount": "0",
"OutputTaxClassificationCode": null,
"ExemptReasonCode": null,
"ExemptReason": null,
"LastRevenueRecogDate": null,
"CustomerPONumber": null,
"DeliveryDate": "2009-10-31",
"SupplierId": 2960,
"Supplier": null,
"SupplierSiteId": 2641,
"SupplierSiteName": "1263",
"RecvInvOrgId": 498,
"RecvLocationId": 3248,
"ShipToOrgLocation": "CSP10002",
"AgreementPriceOverAllwdYn": "N",
"FOBCode": "Destination",
"FOB": "Destination",
"FreightTermsCode": "SHIP",
"FreightTerms": null,
"PaymentTermsId": 10042,
"PaymentTerms": "2N30",
"PurchasingCategoryId": null,
"CarrierId": 12524,
"CarrierName": "Federal Express",
"VendorSiteId": null,
"OrigSystemReference": null,
"OrigSystemSourceCode": null,
"Cognomen": null,
"TaxAmount": null,
"ExternalSource": null,
"ExternalKey": null,
"ExternalItemKey": null,
"ExternalItemReference1": null,
"ExternalItemReference2": null,
"ExternalItemReference3": null,
"ExternalItemReference4": null,
"ExternalItemReference5": null,
"ExternalItemSource": null,
"AllowPromotionsYn": "N",
"BillToCustAccountNumber": null,
"BillToSiteUseName": null,
"BillToContactName": null,
"InvoiceRuleId": null,
"BillToAccountId": null,
"AccountRuleId": null,
"BillingFrequency": null,
"InvoiceText": null,
"OrderSource": null,
"PriceUOM": null,
"ShipToPartyId": null,
"ShipToPartySiteId": null,
"DurationQuantity": null,
"PricingEffectivityDate": null,
"PriceItemQuantity": null,
"PriceItemUOM": null,
"OnetimeAmount": null,
"RecurringAmount": null,
"TaxError": null,
"InstrAssignmentId": null,
"PaymentMethod": null,
"PoNumber": null,
"TrxnExtensionId": null,
"WireNumber": null,
"CreditCardNumber": null,
"CreditCardHolderName": null,
"CreditCardIssuerCode": null,
"CreditCardIssuerName": null,
"CreditCardExpiryDate": null,
"BillToAccountPartyId": null,
"links":
...
],
}
],
...

Back to Top