1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Contracts

Get a contract

get

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

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.
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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
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 : Bill Plans
Type: array
Title: Bill Plans
The bill plans resource is used to view, create, update, and delete a bill plan. This includes bill plan name, invoice method, bill-to account number, bill-to contact, bill-to site, billing cycle, bill set, payment terms, invoice summarization options, currency conversions.
Show Source
Nested Schema : Contract Documents
Type: array
Title: Contract Documents
The resource is used to view, create, update, delete documents of contract documents category. The information includes file name, title, description, category.
Show Source
Nested Schema : Contract Header Flexfields
Type: array
Title: Contract Header Flexfields
The contract header flex field resource is used to view, create, update contract header flex field information.
Show Source
Nested Schema : Contract Header Translations
Type: array
Title: Contract Header Translations
The resource is used to view, update contract header translation information.
Show Source
Nested Schema : Contract Key Term
Type: array
Title: Contract Key Term
Contract key term extract captures the key term extraction process details of a contract version.
Show Source
Nested Schema : Contract Lines
Type: array
Title: Contract Lines
The contract line resource is used to view, create, update, delete contract line information. The line information includes name, description, start date, end date, line amount, ship-to account, ship-to site, warehouse.
Show Source
Nested Schema : Contract Parties
Type: array
Title: Contract Parties
The contract parties resource is used to view the details of a contract party. A party to a contract is one who holds the obligations and receives the benefits of a legally binding agreement.
Show Source
Nested Schema : External Shared Documents
Type: array
Title: External Shared Documents
The external shared documents resource is used to view, create, update, and delete documents of the external shared documents category. These are documents that have been shared on the contract by external users. The information includes the file name, title, description, and category.
Show Source
Nested Schema : Internal Shared Documents
Type: array
Title: Internal Shared Documents
The internal shared documents resource is used to view, create, update, and delete documents of the internal shared documents category. These are documents that have been shared on the contract by internal users. The information includes the file name, title, description, and category.
Show Source
Nested Schema : Related Documents
Type: array
Title: Related Documents
The resource is used to view, create, update, delete related contracts information.
Show Source
Nested Schema : Revenue Plans
Type: array
Title: Revenue Plans
The resource is used to view, create, update, delete a revenue plan. This includes revenue plan name and revenue method.
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 : Sections
Type: array
Title: Sections
The resource is used to view the sections of the contract terms.
Show Source
Nested Schema : Supporting Documents
Type: array
Title: Supporting Documents
The resource is used to view, create, update, delete documents of supporting documents category. The information includes file name, title, description, category.
Show Source
Nested Schema : contracts-AiGenerateSummaryDocs-item-response
Type: object
Show Source
Nested Schema : contracts-BillingControl-item-response
Type: object
Show Source
Nested Schema : contracts-BillPlan-item-response
Type: object
Show Source
Nested Schema : Bill Plan Flexfields
Type: array
Title: Bill Plan Flexfields
The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information.
Show Source
Nested Schema : Bill Plan Translations
Type: array
Title: Bill Plan Translations
The bill plan translations resource is used to view and update contract bill plan translation information.
Show Source
Nested Schema : Job Assignment Overrides
Type: array
Title: Job Assignment Overrides
The resource is used to view, create, update, delete job assignment override details
Show Source
Nested Schema : Job Rate Overrides
Type: array
Title: Job Rate Overrides
The resource is used to view, create, update, delete job rate override details.
Show Source
Nested Schema : Job Title Overrides
Type: array
Title: Job Title Overrides
The resource is used to view, create, update, delete job title override details.
Show Source
Nested Schema : Labor Multiplier Overrides
Type: array
Title: Labor Multiplier Overrides
The resource is used to view, create, update, delete labor multiplier override details.
Show Source
Nested Schema : Non Labor Rate Overrides
Type: array
Title: Non Labor Rate Overrides
The resource is used to view, create, update, delete non labor multiplier override details.
Show Source
Nested Schema : Person Rate Overrides
Type: array
Title: Person Rate Overrides
The resource is used to view, create, update, delete person rate override details.
Show Source
Nested Schema : contracts-BillPlan-BillPlanDescriptiveFlexField-item-response
Type: object
Show Source
Nested Schema : contracts-BillPlan-BillPlanTranslation-item-response
Type: object
Show Source
Nested Schema : contracts-BillPlan-JobAssignmentOverride-item-response
Type: object
Show Source
  • Title: Billing Title Override
    Maximum Length: 80
    Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer.
  • Title: Contract Line ID
    Unique identifier of the contract line for which the job assignment override is defined.
  • Title: Contract Line Number
    Maximum Length: 150
    The contract line for which the job assignment override is defined.
  • Title: Email
    Maximum Length: 240
    The email address for whom the job assignment override is defined.
  • Title: End Date
    The date to which a job assignment override applies.
  • Title: External Reference Key
    Maximum Length: 150
    Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices.
  • Title: External Source Key
    Maximum Length: 150
    Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices.
  • Title: Job Assignment Override ID
    The unique identifier of the job assignment override on the bill plan that identifies the negotiated job assigned to a specific person, rather than the normal job for that person.
  • Title: Job Code
    The job code of the override being assigned to the person for this bill or revenue plan.
  • Title: Job ID
    Unique identifier of the override job being assigned to the person for this bill or revenue plan.
  • Title: Job Name
    Maximum Length: 240
    The job name of the override being assigned to the person for this bill or revenue plan.
  • Links
  • Title: Version
    Default Value: 1
    The version of the contract containing this particular set of job assignment override details.
  • Title: Person ID
    Unique identifier of the person for whom the job assignment override is defined.
  • Title: Person
    Maximum Length: 2000
    The person for whom the job assignment override is defined.
  • Title: Person Number
    Maximum Length: 30
    The person number for whom the job assignment override is defined.
  • Title: Start Date
    The date from which a job assignment override applies.
Nested Schema : contracts-BillPlan-JobRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-BillPlan-JobTitleOverride-item-response
Type: object
Show Source
  • Title: Billing Title Override
    Maximum Length: 80
    Name of the override job title being assigned to the job for this bill plan. Used to display on the invoice to the customer.
  • Title: Contract Line ID
    Unique identifier of the contract line for which the job title override is defined.
  • Title: Contract Line Number
    Maximum Length: 150
    The contract line number for which the job title override is defined.
  • Title: End Date
    The date to which a job title override applies.
  • Title: External Reference Key
    Maximum Length: 150
    Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.
  • Title: External Source Key
    Maximum Length: 150
    Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.
  • Title: Job Code
    Code of the job for which the job title override is defined.
  • Title: Job ID
    Unique identifier of the job for which the job title override is defined.
  • Title: Job Name
    Maximum Length: 240
    Name for the Job for which the job title override is defined.
  • Title: Job Title Override ID
    Unique identifier of the job title override on the bill plan that identifies the negotiated job title assigned to a specific person, rather than the normal title for that person.
  • Links
  • Title: Version
    Default Value: 1
    Version of the contract containing this particular set of job title override details.
  • Title: Start Date
    The date from which a job title override applies.
Nested Schema : contracts-BillPlan-LaborMultiplierOverride-item-response
Type: object
Show Source
Nested Schema : contracts-BillPlan-NonLaborRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-BillPlan-PersonRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-ContractDocuments-item-response
Type: object
Show Source
Nested Schema : contracts-ContractHeaderFlexfieldVA-item-response
Type: object
Show Source
Nested Schema : contracts-ContractHeaderTranslation-item-response
Type: object
Show Source
Nested Schema : contracts-contractKeyTermExtracts-item-response
Type: object
Show Source
Nested Schema : Contract Key Term Extract Documents
Type: array
Title: Contract Key Term Extract Documents
Contract key term extract document is used to view the documents consumed by key term extraction process.
Show Source
Nested Schema : Contract Key Terms
Type: array
Title: Contract Key Terms
Contract key terms is used to view the key term values extracted by the process.
Show Source
Nested Schema : contracts-contractKeyTermExtracts-contractKeyTermExtractDocuments-item-response
Type: object
Show Source
Nested Schema : contracts-contractKeyTermExtracts-contractKeyTerms-item-response
Type: object
Show Source
Nested Schema : Contract Key Term Citations
Type: array
Title: Contract Key Term Citations
Contract key term citation is used to view the citations for each of the contract key terms.
Show Source
Nested Schema : contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-response
Type: object
Show Source
Nested 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
Nested Schema : contracts-ContractParty-item-response
Type: object
Show Source
Nested Schema : Contract Party Contacts
Type: array
Title: Contract Party Contacts
The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.
Show Source
Nested Schema : Contract Party Flexfields
Type: array
Title: Contract Party Flexfields
The contract party flex fields is used to view, create, update contract party flex field information.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-item-response
Type: object
Show Source
Nested Schema : Contract Party Contact Flexfields
Type: array
Title: Contract Party Contact Flexfields
The contract party contact flex field resource is used to view, create, update contract party contact flex field information.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response
Type: object
Show Source
Nested Schema : contracts-ContractParty-ContractPartyFlexfieldVA-item-response
Type: object
Show Source
Nested Schema : contracts-ExternalSharedDocuments-item-response
Type: object
Show Source
Nested Schema : contracts-InternalSharedDocuments-item-response
Type: object
Show Source
Nested Schema : contracts-RelatedDocument-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-item-response
Type: object
Show Source
Nested Schema : Job Assignment Overrides
Type: array
Title: Job Assignment Overrides
The resource is used to view, create, update, delete job assignment override details
Show Source
Nested Schema : Job Rate Overrides
Type: array
Title: Job Rate Overrides
The resource is used to view, create, update, delete job rate override details.
Show Source
Nested Schema : Labor Multiplier Overrides
Type: array
Title: Labor Multiplier Overrides
The resource is used to view, create, update, delete labor multiplier override details.
Show Source
Nested Schema : Non Labor Rate Overrides
Type: array
Title: Non Labor Rate Overrides
The resource is used to view, create, update, delete non labor multiplier override details.
Show Source
Nested Schema : Person Rate Overrides
Type: array
Title: Person Rate Overrides
The resource is used to view, create, update, delete person rate override details.
Show Source
Nested Schema : Revenue Plan Flexfields
Type: array
Title: Revenue Plan Flexfields
The revenue plan flexfields resource is used to view, create, update, and delete contract revenue plan flexfield information.
Show Source
Nested Schema : Revenue Plan Translations
Type: array
Title: Revenue Plan Translations
The revenue plan transactions resource is used to view and update contract revenue plan translation information.
Show Source
Nested Schema : contracts-RevenuePlan-JobAssignmentOverride-item-response
Type: object
Show Source
  • Title: Billing Title Override
    Maximum Length: 80
    Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer.
  • Title: Contract Line ID
    Unique identifier of the contract line for which the job assignment override is defined.
  • Title: Contract Line Number
    Maximum Length: 150
    The contract line for which the job assignment override is defined.
  • Title: Email
    Maximum Length: 240
    The email address for whom the job assignment override is defined.
  • Title: End Date
    The date to which a job assignment override applies.
  • Title: External Reference Key
    Maximum Length: 150
    Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices.
  • Title: External Source Key
    Maximum Length: 150
    Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices.
  • Title: Job Assignment Override ID
    The unique identifier of the job assignment override on the bill plan that identifies the negotiated job assigned to a specific person, rather than the normal job for that person.
  • Title: Job Code
    The job code of the override being assigned to the person for this bill or revenue plan.
  • Title: Job ID
    Unique identifier of the override job being assigned to the person for this bill or revenue plan.
  • Title: Job Name
    Maximum Length: 240
    The job name of the override being assigned to the person for this bill or revenue plan.
  • Links
  • Title: Version
    Default Value: 1
    The version of the contract containing this particular set of job assignment override details.
  • Title: Person ID
    Unique identifier of the person for whom the job assignment override is defined.
  • Title: Person
    Maximum Length: 2000
    The person for whom the job assignment override is defined.
  • Title: Person Number
    Maximum Length: 30
    The person number for whom the job assignment override is defined.
  • Title: Start Date
    The date from which a job assignment override applies.
Nested Schema : contracts-RevenuePlan-JobRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-LaborMultiplierOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-NonLaborRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-PersonRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanDescriptiveFlexField-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanTranslation-item-response
Type: object
Show Source
Nested Schema : contracts-SalesCredit-item-response
Type: object
Show Source
Nested Schema : contracts-Section-item-response
Type: object
Show Source
Nested Schema : Clauses
Type: array
Title: Clauses
The resource is used to view the clauses of the contract terms.
Show Source
Nested Schema : Sub Sections
Type: array
Title: Sub Sections
The resource is used to view the sub sections of the contract terms.
Show Source
Nested Schema : contracts-Section-Clause-item-response
Type: object
Show Source
Nested Schema : contracts-Section-SubSection-item-response
Type: object
Show Source
Nested Schema : contracts-SupportingDocuments-item-response
Type: object
Show Source
Links
AiGenerateSummaryDocs
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The attachments resource is used to view, create, and update attachments.
BillPlan
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The bill plans resource is used to view, create, update, and delete a bill plan. This includes bill plan name, invoice method, bill-to account number, bill-to contact, bill-to site, billing cycle, bill set, payment terms, invoice summarization options, currency conversions.
BillingControl
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.
ContractDocuments
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The resource is used to view, create, update, delete documents of contract documents category. The information includes file name, title, description, category.
ContractHeaderFlexfieldVA
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The contract header flex field resource is used to view, create, update contract header flex field information.
ContractHeaderTranslation
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The resource is used to view, update contract header translation information.
ContractLine
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The contract line resource is used to view, create, update, delete contract line information. The line information includes name, description, start date, end date, line amount, ship-to account, ship-to site, warehouse.
ContractParty
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The contract parties resource is used to view the details of a contract party. A party to a contract is one who holds the obligations and receives the benefits of a legally binding agreement.
ExternalSharedDocuments
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The external shared documents resource is used to view, create, update, and delete documents of the external shared documents category. These are documents that have been shared on the contract by external users. The information includes the file name, title, description, and category.
InternalSharedDocuments
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The internal shared documents resource is used to view, create, update, and delete documents of the internal shared documents category. These are documents that have been shared on the contract by internal users. The information includes the file name, title, description, and category.
RelatedDocument
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The resource is used to view, create, update, delete related contracts information.
RevenuePlan
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The resource is used to view, create, update, delete a revenue plan. This includes revenue plan name and revenue method.
SalesCredit
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
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.
Section
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The resource is used to view the sections of the contract terms.
SupportingDocuments
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
The resource is used to view, create, update, delete documents of supporting documents category. The information includes file name, title, description, category.
amend
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you amend a contract. This can be done only for an active contract.
applyHold
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you apply hold on a contract.
cancel
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you cancel a contract with the specified reason.
classifyKeyTerms
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you classify the extracted key terms of a contract.
close
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you close the specified contract with the given reason on a date.
contractKeyTermExtracts
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
Contract key term extract captures the key term extraction process details of a contract version.
createVersion
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you create a new version for the contract. This can be done only for a draft or under amendment contract.
downloadContractTermsInWord
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you download the contract terms and conditions in Word DOCX format that can be shared with external parties for negotiation of the contract terms.
downloadLatestContractDocument
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you download the contract terms and conditions in Word DOCX format that can be shared with external parties for negotiation of the contract terms.
duplicate
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you duplicate an existing contract while selecting which portions of the contract are duplicated.
extractKeyTermValues
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you extract key term values given attached documents.
generateContractSummary
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you generate an AI summary of a contract.
preview
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you generate a preview of the contract in PDF, HTML, or RTF format.
removeHold
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you remove hold on a contract on a given date.
revertContract
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you revert a contract amendment.
sign
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you sign a contract. This can be done for a contract in pending for signature status.
submitForApproval
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you submit a contract for approval. You cannot activate a contract directly using rest or soap webservices. To activate a contract, you must use this method to first submit the contract for approval.
validateContract
Parameters:
  • contractsUniqID: $request.path.contractsUniqID
This method lets you validate a contract and returns errors and warnings as a string.
Back to Top

Examples

The following example shows how to get a contract 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

Example of Response Body

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

{
  "items" : [ {
    "Id" : 100000012640230,
    "MajorVersion" : 1,
    "ExternalSource" : null,
    "ExternalKey" : null,
    "InvConvRateTypeName" : null,
    "InvConvRateDateTypeName" : null,
    "OrgName" : "Vision Operations",
    "OrgId" : 204,
    "ContractTypeName" : "Buy : Project lines",
    "ContractClass" : "CONTRACT",
    "ContractTypeId" : 102,
    "ContractNumber" : "ZOKC_DTS_CON_01",
    "ContractNumberModifier" : null,
    "Cognomen" : null,
    "PartyId" : 1005,
    "PartyName" : "AT&T Universal Card",
    "InvOrganizationId" : 204,
    "StsCode" : "DRAFT",
    "CurrencyCode" : "USD",
    "StartDate" : "2009-10-15",
    "EndDate" : null,
    "SupplierId" : 2960,
    "SupplierSiteId" : 2641,
    "InvConvRateType" : null,
    "InvConvRateDate" : null,
    "BillToAccountId" : null,
    "BillToAccount" : null,
    "BillToAccountNumber" : null,
    "BillToSiteUseId" : null,
    "BillToSiteUseLocation" : null,
    "BillToAddress" : null,
    "ShipToAccountId" : null,
    "ShipToAccount" : null,
    "ShipToAccountNumber" : null,
    "ShipToSiteUseId" : null,
    "ShipToSiteUseLocation" : null,
    "ShipToAddress" : null,
    "ShipToAccountDescription" : null,
    "SoldToAccountId" : null,
    "SoldToAccount" : null,
    "SoldToAccountNumber" : null,
    "SoldToSiteId" : null,
    "SoldToNumber" : null,
    "SoldToAddress" : null,
    "SoldToAccountDescription" : null,
    "ShipInvOrgId" : null,
    "RecvInvOrgId" : 498,
    "LegalEntityId" : 204,
    "OutputTaxClassificationCode" : null,
    "DateApproved" : null,
    "DatetimeCancelled" : null,
    "DateSigned" : null,
    "DateTerminated" : null,
    "TerminateCancelSource" : null,
    "ContributionPercent" : null,
    "BillSequence" : null,
    "OverallRiskCode" : null,
    "ShortDescription" : null,
    "Description" : null,
    "HoldReasonCode" : null,
    "HoldUntilDate" : null,
    "AmendmentEffectiveDate" : null,
    "ExemptCertificateNumber" : null,
    "ExemptReasonCode" : null,
    "ProjectEnabledFlag" : false,
    "OutputTaxSetId" : null,
    "PartyObjectType" : "OKX_VENDOR",
    "PrimaryLedgerId" : 1,
    "CustomerPartyId" : null,
    "CustomerPartySiteId" : null,
    "GeneratedInvoiceStatus" : null,
    "OwningOrgId" : null,
    "NetInvoiceFlag" : null,
    "OwningOrgName" : null,
    "TaxClassificationMeaning" : null,
    "ExemptionReasonMeaning" : null,
    "FreightTerms" : "SHIP",
    "FOB" : "Destination",
    "ApTermsId" : 10042,
    "ServiceEnabledFlag" : "false",
    "EstimatedAmount" : 4499999999999,
    "TaxAmount" : null,
    "LastUpdateDate" : "2009-10-15T03:56:41-07:00",
    "LastUpdateLogin" : "75F800C4CE194F7AE04044987CF0768F",
    "CreatedBy" : "OPERATIONS",
    "CreationDate" : "2009-10-15T03:50:00-07:00",
    "LedgerCurrency" : "USD",
    "EncumbranceLevel" : null,
    "AgreementEnabledFlag" : false,
    "CarrierName" : "Federal Express",
    "CloseReason" : null,
    "CancelReason" : null,
    "AuthoringPartyCode" : "INTERNAL",
    "HoldReasonMeaning" : null,
    "PrimaryPartyId" : 1005,
    "PersonId" : 100010024202242,
    "SalesAccountId" : null,
    "OrigSystemId" : null,
    "OrigSystemReference" : null,
    "OrigSystemSourceCode" : null,
    "AllowExternalItemFlag" : false,
    "SalesAccountName" : null,
    "ItemSourceCode" : "PRODUCT_MASTER",
    "StateTransitionFlowName" : null,
    "StateTransitionFlowState" : "DRAFT",
    "UserStatusCode" : null,
    "AssigneeType" : null,
    "AssigneeId" : null,
    "Assignee" : null,
    "CustomerPONumber" : null,
    "AccessLevel" : "UPDATE",
    "TemplateFlag" : false,
    "VersionDescription" : null,
    "Comment" : null,
    "PriceList" : null,
    "AdjustmentBasis" : null,
    "PricingCalendarId" : null,
    "PricingPeriodType" : null,
    "PricingCalendarName" : null,
    "DiscountPercent" : null,
    "PriceListName" : null,
    "OraPricingInteg" : "NONE",
    "TrnCodeSetId" : null,
    "HoldReasonCodeSetId" : null,
    "WebServiceFlag" : null,
    "ContractOwnerId" : null,
    "Status" : "Draft",
    "AuthoringPartyMeaning" : "Internal",
    "InvOrgName" : "Vision Operations",
    "Supplier" : "Costco Wholesale Corp.",
    "SupplierSite" : null,
    "ShipInvOrg" : null,
    "RecvInvOrg" : "Vision ADB",
    "Currency" : "US Dollar",
    "UserStatusMeaning" : null,
    "LegalEntityName" : "Vision Operations",
    "ShipToOrgLocation" : "CSP10002",
    "ChrType" : null,
    "AccountRuleId" : null,
    "AllowCurrencyOverrideFlag" : null,
    "ContractTrueValue" : null,
    "InvoiceRuleId" : null,
    "PricingSegmentExplanation" : null,
    "PricingStrategyExplanation" : null,
    "SegmentExplanationMessageName" : null,
    "ShipToPartyId" : null,
    "ShipToPartySiteId" : null,
    "Subtotal" : null,
    "ShipToPartyName" : null,
    "ShipToPartySiteLocation" : null,
    "ArInterfaceYn" : null,
    "PaymentTermId" : null,
    "CustomerPartyName" : null,
    "CustomerPartySiteName" : null,
    "DocumentSubType" : 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