Get a contract line

get

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

Request

Path Parameters
  • The unique identifier of the contract line.
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
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
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
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
Nested Schema : Contract Line Translations
Type: array
Title: Contract Line Translations
The resource is used to view, update contract line translation information.
Show Source
Nested Schema : Milestones
Type: array
Title: Milestones
Milestones are single point-in-time events that can be used for billing, revenue recognition, or both. Milestones defined on a contract line are automatically created in the associated project plan upon contract approval. Upon completion of a milestone in the project plan, the corresponding billing event is automatically updated as eligible for invoicing and revenue recognition processing.
Show Source
Nested Schema : Pricing Terms
Type: array
Title: Pricing Terms
Pricing terms includes pricing term name, list price, adjustment type, adjustment amount, adjustment basis, and price periodicity attributes. You can view, create, update, and delete pricing terms for a sales agreement kind of contract.
Show Source
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
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
Nested Schema : contracts-ContractLine-AssociatedProject-item-response
Type: object
Show Source
Nested Schema : contracts-ContractLine-BillingControl-item-response
Type: object
Show Source
Nested Schema : contracts-ContractLine-ContractAllLineDesFlexVA-item-response
Type: object
Show Source
Nested Schema : contracts-ContractLine-ContractLineTranslation-item-response
Type: object
Show Source
Nested Schema : contracts-ContractLine-Milestone-item-response
Type: object
Show Source
  • Title: Actual Finish Date
    Read Only: true
    The actual finish date of the milestone in the project plan. This attribute is ignored when creating or updating a milestone on a contract line.
  • Title: Event Description
    Maximum Length: 240
    The description for the billing event created for the milestone. If you're creating a milestone and don't pass a value for this attribute, the milestone's name is used for the billing event description.
  • Title: Event ID
    Read Only: true
    The unique identifier of the billing event created for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.
  • Title: Event Number
    Read Only: true
    The number of the billing event created for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.
  • Title: Event Type ID
    The unique identifier of the event type of the billing event created for the milestone. Either EventTypeName or EventTypeId must be passed to create a milestone. If both EventTypeName and EventTypeId are provided, EventTypeName is used and EventTypeId is ignored.
  • Title: Event Type
    Maximum Length: 240
    The name of the event type of the billing event created for the milestone. Either EventTypeName or EventTypeId must be passed to create a milestone. If both EventTypeName and EventTypeId are provided, EventTypeName is used and EventTypeId is ignored.
  • Title: Exception Flag
    Read Only: true
    Indicates whether there are exceptions for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.
  • Title: External Reference Key
    Maximum Length: 150
    The external reference key of the milestone.
  • Title: External Source Key
    Maximum Length: 150
    The external source key of the milestone.
  • Links
  • Title: Major Version
    The contract major version of the milestone.
  • Title: Milestone Amount
    The bill transaction amount for the milestone. Milestone bill transaction amounts must be entered in the contract currency.
  • Title: Milestone ID
    The unique identifier of the milestone on the contract line.
  • Title: Milestone Name
    Maximum Length: 255
    The name of the milestone. If you're adding an existing project plan milestone to the contract line, this attribute is ignored. Instead, the project plan milestone name is used.
  • Title: Milestone Status Code
    Read Only: true
    Maximum Length: 20
    The status code of the milestone in the project plan. This attribute is ignored when creating or updating a milestone on a contract line.
  • Title: Parent Task ID
    The unique identifier of the project plan parent task under which the milestone is created. The parent task of a milestone must be on or below the level at which the project is associated with the contract line. Either ParentTaskId or ParentTaskNumber must be passed. If both ParentTaskId and ParentTaskNumber are provided, the ParentTaskNumber is used and ParentTaskId is ignored. Leave this attribute blank to create a milestone with the project as the parent. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.
  • Title: Parent Task Number
    Maximum Length: 100
    The unique number of the project plan parent task under which the milestone is created. The parent task of a milestone must be on or below the level at which the project is associated with the contract line. Either ParentTaskId or ParentTaskNumber must be passed. If both ParentTaskId and ParentTaskNumber are provided, the ParentTaskNumber is used and ParentTaskId is ignored. Leave this attribute blank to create a milestone with the project as the parent. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.
  • Title: Planned Finish Date
    The expected finish date of the milestone. The planned finish date must be within the effective dates of the milestone's parent in the project plan and the effectivity dates of the contract line. If the milestone is for an Award, then the planned finish date must be on or after the earlier of the preaward date or the contract line start date and on or before the later of the close date or contract line end date. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.
  • Title: Project ID
    The unique identifier of the project that owns the milestone. The project must have an active association with the contract line. Either ProjectId or ProjectNumber must be passed to create a milestone. If both ProjectId and ProjectNumber are provided, ProjectNumber is used and ProjectId is ignored.
  • Title: Project Number
    Maximum Length: 25
    The number of the project that owns the milestone. The project must have an active association with the contract line. Either ProjectId or ProjectNumber must be passed to create a milestone. If both ProjectId and ProjectNumber are provided, ProjectNumber is used and ProjectId is ignored.
  • Title: Project Plan Milestone ID
    The unique identifier of the milestone in the project plan. To add an existing project plan milestone to the contract line, either the ProjectPlanMilestoneId or ProjectPlanMilestoneNumber attribute must be passed. If both attributes are provided, the ProjectPlanMilestoneNumber is used and ProjectPlanMilestoneId is ignored.
  • Title: Project Plan Milestone Number
    Maximum Length: 100
    The unique number of the milestone in the project plan. To add an existing project plan milestone to the contract line, either the ProjectPlanMilestoneId or ProjectPlanMilestoneNumber attribute must be passed. If both attributes are provided, the ProjectPlanMilestoneNumber is used and ProjectPlanMilestoneId is ignored.
  • Title: Transaction Currency
    Maximum Length: 30
    The currency code of the bill transaction amount for the milestone. The bill transaction currency must be the same as the contract currency for milestones.
Nested Schema : contracts-ContractLine-PricingTerm-item-response
Type: object
Show Source
Nested Schema : Pricing Term Tier Headers
Type: array
Title: Pricing Term Tier Headers
Pricing term tier headers is used to view, create, update and delete header attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier basis type, adjustment type, aggregation method, application method pricing attributes.
Show Source
Nested Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-item-response
Type: object
Show Source
Nested Schema : Pricing Term Tier Lines
Type: array
Title: Pricing Term Tier Lines
Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.
Show Source
Nested Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-response
Type: object
Show Source
Nested Schema : contracts-ContractLine-ProjectContractLineInternalAttributes-item-response
Type: object
Show Source
  • Unique identifier of the contract.
  • Unique identifier of the contract line.
  • 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.
  • Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • Title: Expenditure Type Name
    Maximum Length: 240
    Name of the expenditure type that's recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • 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.
  • 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.
  • Maximum Length: 150
    The external reference key.
  • Maximum Length: 150
    The external source key.
  • Links
  • Identification of the version of the contract, created by amending the contract.
  • Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • Title: Expenditure Organization Name
    Maximum Length: 240
    Name of the expenditure organization that's recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • Title: Provider Business Unit ID
    Unique identifier for the business unit that provides goods or services which are charged using the internal contract line.
  • 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.
  • The unique identifier of the receiver business unit.
  • Title: Receiver Business Unit
    Maximum Length: 240
    The receiver business unit name.
  • Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • Title: Receiver Project Name
    Maximum Length: 240
    Name of the project that's recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • Title: Receiver Task Name
    Maximum Length: 255
    Name of the task that's recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
Nested Schema : contracts-ContractLine-SalesCredit-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get a contract line 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/100100069430785/child/ContractLine/100100095837776

Example of Response Body

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

{
    "LineNumber": "1",
    "Id": 999990000054090,
    "LineId": 100100095837776,
    "MajorVersion": 1,
    "LineTypeId": 102,
    "LineTypeName": "Item, project",
    "StsCode": "ACTIVE",
    "LineStatus": "Active",
    "Object1Id1": 63,
    "Object1Id2": 458,
    "ItemName": "f80000",
    "ItemNameTxt": "f80000",
    "ItemDescription": "Sentinal Multimedia",
    "StartDate": "2008-08-06",
    "EndDate": "2009-08-06",
    "PriceListId": null,
    "PriceList": null,
    "UOMCode": "EA",
    "UnitOfMeasure": "EA",
    "FixedPriceServiceYn": "N",
    "ItemQuantity": 1,
    "UnitPrice": null,
    "LineValueAmount": null,
    "LineAmount": 1000,
    "Comments": null,
    "AgreedQuantity": null,
    "AgreedAmount": null,
    "AgreementQuantityLimit": null,
    "AgreementAmountLimit": null,
    "MinimumReleaseQuantity": null,
    "MinimumReleaseAmount": null,
    "CommitLevelCode": null,
    "CommitLevel": null,
    "PriceBookId": null,
    "PriceBook": 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": 1001,
    "ShipToAccount": "A T & T SOLUTIONS INC",
    "ShipToAccountNumber": "1001",
    "ShipToSiteUseId": 1064,
    "ShipToSite": "New York",
    "ShipInvOrgId": 458,
    "WareHouse": "Vision Services",
    "BillPlanId": null,
    "BillPlan": null,
    "RevenuePlanId": null,
    "RevenuePlan": null,
    "RevenueAmount": "0",
    "OutputTaxClassificationCode": null,
    "OutputTaxClassMeaning": null,
    "TaxExemptionControl": null,
    "TaxExemptionControlMeaning": null,
    "ExemptCertificateNumber": null,
    "ExemptReasonCode": null,
    "ExemptReason": null,
    "LastRevenueRecogDate": null,
    "CustomerPONumber": null,
    "DeliveryDate": null,
    "SupplierId": null,
    "Supplier": null,
    "SupplierSiteId": null,
    "SupplierSiteName": null,
    "RecvInvOrgId": null,
    "RecInvOrgName": null,
    "RecvLocationId": null,
    "ShipToOrgLocation": null,
    "AgreementPriceOverAllwdYn": "Y",
    "FOBCode": null,
    "FOB": null,
    "FreightTermsCode": null,
    "FreightTerms": null,
    "PaymentTermsId": null,
    "PaymentTerms": null,
    "PurchasingCategoryId": null,
    "PurchasingCategory": null,
    "CarrierId": null,
    "CarrierName": null,
    "VendorSiteId": null,
    "OrigSystemReference": null,
    "OrigSystemSourceCode": null,
    "Cognomen": "ECM Contract ",
    "TaxAmount": null,
    "ExternalSource": null,
    "ExternalKey": null,
    "AllowPromotionsYn": "N",
    "PricingEffectivityDate": null,
    "DateCancelled": null,
    "CancelReason": null,
    "EstimatedVariableConsiderationAmount": null,
    "StandaloneSellingPrice": null,
    "PriceApplicationRule": null,
    "AutoApplyStrategyPriceAdjustmentFlag": null,
    "LinePuid": "LINE-8764-1",
    "SourceDocumentId": null,
    "SourceDocumentLineId": null,
    "SourceDocumentSystemCode": null,
    "BillPlanExternalSource": null,
    "BillPlanExternalKey": null,
    "RevenuePlanExternalSource": null,
    "RevenuePlanExternalKey": null,
    "TrnSetCode": null,
    "HoldReasonSetCode": null,
    "ContractPuid": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/ContractLine/100100095837776",
            "name": "ContractLine",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
.....
}
Back to Top