Create contract lines

post

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

Request

Path Parameters
  • 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.
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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 : 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-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : contracts-ContractLine-ContractAllLineDesFlexVA-item-post-request
Type: object
Show Source
Nested Schema : contracts-ContractLine-ContractLineTranslation-item-post-request
Type: object
Show Source
Nested Schema : contracts-ContractLine-ProjectContractLineInternalAttributes-item-post-request
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 is 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.
  • Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.
  • 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 organization that is 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 is 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 is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
Nested Schema : schema
Type: object
Show Source
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 : 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-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 is 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, used to generate the revenue distribution.
  • 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 organization that is 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 is 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 is 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 create a contract line by submitting a POST request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100543663792/child/ContractLine

Example of Request Body

The following shows the contents of the request body in JSON format.

{
"LineNumber": "1",
"LineTypeId": 100000014995506,
"LineTypeName": "Item",
"ItemName": "AS92689",
"ItemNameTxt": "AS92689",
"PurchasingCategoryId": 91,
"ItemDescription": "Envoy Standard Laptop"
}

Example of Response Body

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

{
    "LineNumber": "1",
    "Id": 300100543663821,
    "LineId": 300100543663822,
    "MajorVersion": 1,
    "LineTypeId": 100000014995506,
    "LineTypeName": "Item",
    "StsCode": "DRAFT",
    "LineStatus": "Draft",
    "Object1Id1": 151,
    "Object1Id2": 204,
    "ItemName": "AS92689",
    "ItemNameTxt": "AS92689",
    "ItemDescription": "Envoy Standard Laptop",
    "StartDate": "2021-04-19",
    "EndDate": null,
    "PriceListId": null,
    "PriceList": null,
    "UOMCode": "Ea",
    "UnitOfMeasure": "Each",
    "FixedPriceServiceYn": "N",
    "ItemQuantity": null,
    "UnitPrice": null,
    "LineValueAmount": null,
    "LineAmount": null,
    "Comments": null,
    "AgreedQuantity": null,
    "AgreedAmount": null,
    "AgreementQuantityLimit": null,
    "AgreementAmountLimit": null,
    "MinimumReleaseQuantity": null,
    "MinimumReleaseAmount": null,
    "CommitLevelCode": "ESTIMATED",
    "CommitLevel": "Estimated",
    "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": null,
    "ShipToAccount": null,
    "ShipToAccountNumber": null,
    "ShipToSiteUseId": null,
    "ShipToSite": null,
    "ShipInvOrgId": null,
    "WareHouse": null,
    "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": "N",
    "FOBCode": null,
    "FOB": null,
    "FreightTermsCode": null,
    "FreightTerms": null,
    "PaymentTermsId": null,
    "PaymentTerms": null,
    "PurchasingCategoryId": 91,
    "PurchasingCategory": "Finished Goods_91",
    "CarrierId": null,
    "CarrierName": null,
    "VendorSiteId": null,
    "OrigSystemReference": null,
    "OrigSystemSourceCode": null,
    "Cognomen": null,
    "TaxAmount": null,
    "ExternalSource": "FUSION",
    "ExternalKey": "300100543663821",
    "AllowPromotionsYn": "N",
    "PricingEffectivityDate": "2021-04-19T00:00:00+00:00",
    "DateCancelled": null,
    "CancelReason": null,
    "EstimatedVariableConsiderationAmount": null,
    "StandaloneSellingPrice": null,
    "PriceApplicationRule": null,
    "AutoApplyStrategyPriceAdjustmentFlag": null,
    "LinePuid": "KHDR-19013-LINE-39668",
    "SourceDocumentId": null,
    "SourceDocumentLineId": null,
    "SourceDocumentSystemCode": null,
    "BillPlanExternalSource": null,
    "BillPlanExternalKey": null,
    "RevenuePlanExternalSource": null,
    "RevenuePlanExternalKey": null,
    "TrnSetCode": null,
    "HoldReasonSetCode": null,
    "ContractPuid": null,
    "links": [
...
}

Note:

  • If the contract type you're using has Automatic Numbering in place, then you should not provide LineNumber in the payload. The system will automatically provide numbers to lines. The operation will fail if you still provide the Line Number.
  • When creating a contract line using free-form project such as Line Type, you must not include the ItemName attribute in the payload. Instead, you must use the ItemNameTxt and ItemDescription.
Back to Top