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

Get all contracts

get

/fscmRestApi/resources/11.13.18.05/contracts

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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
  • 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:

    • ContractHeaderAltKey: Finds a contract with the specified alternate keys ID and major version.
      Finder Variables:
      • Id; integer; The unique identifier of the contract.
      • MajorVersion; integer; The major version the contract.
    • ContractHeaderExtUniqueKey: Finds a contract with the specified external unique key.
      Finder Variables:
      • ExternalKey; string.
      • ExternalSource; string.
    • ContractHeaderPuidAltKey: Finds a contract with the specified alternate key PUID.
      Finder Variables:
      • ContractPuid; string; The public unique identifier of the contract.
    • PrimaryKey: Finds a contract with the specified contract identifier.
      Finder Variables:
      • ContractId; integer; The unique identifier of the contract.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AdjustmentBasis; string; The adjustment basis of the contract.
    • AgreedAmount; number; Agreed Amount
    • AgreementAmountLimit; number; Agreement Amount Limit
    • AmendmentEffectiveDate; string; The date when the amendment is effective.
    • ApTermsId; integer; The unique identifier of the payment terms.
    • Assignee; string; The assignee of the contract.
    • AssigneeId; integer; The unique identifier of the assignee.
    • AssigneeType; string; The type of assignee of the contract.
    • AuthoringPartyCode; string; The code indicating the authoring party of the contract.
    • AuthoringPartyMeaning; string; The display name of the authoring party.
    • AutoSendForSignature; string; Auto Send For Signature Flag.
    • BillSequence; integer; The bill sequence number of the contract.
    • BillToAccount; string; The name of the Bill-to account.
    • BillToAccountId; integer; The unique identifier of the Bill-to account.
    • BillToAccountNumber; string; The alternate key identifier of the Bill-to account.
    • BillToAccountPartyId; integer; The bill to account party ID.
    • BillToAddress; string; The address of the Bill-to site.
    • BillToLocation; string; The bill-to location.
    • BillToSiteUseId; integer; The unique identifier of the Bill-to site.
    • BillToSiteUseLocation; string; The location of the Bill-to site user.
    • BillingSalesrepId; integer; Billing Sales Rep ID
    • BillingSalesrepName; string; Billing Sales Rep Name
    • BilltoLocationId; integer; The bill-to location ID.
    • CancelReason; string; The reason for cancellation of the contract.
    • CarrierId; integer; Indicates whether agreement is enabled.
    • CloseReason; string; The reason for closing the contract.
    • Cognomen; string; The name of the contract.
    • ContractClass; string; The class of the contract.
    • ContractId; integer; The unique identifier of the contract.
    • ContractNumber; string; The alternate key identifier for the contract.
    • ContractNumberModifier; string; The contract number modifier.
    • ContractPuid; string; Contract PUID.
    • ContractTrueValue; number; The true value of a contract after considering the terminations.
    • ContractTypeId; integer; The unique identifier of the contract type.
    • ContractTypeName; string; The name of the contract type.
    • ContributionPercent; number; The percentage of contribution to the contract.
    • CorpCurrencyCode; string; The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup RatedCurrenciesVO.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • CurcyConvRateType; string; Currency Conversion Rate.
    • Currency; string; The currency of the contract.
    • CurrencyCode; string; The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup RatedCurrenciesVO.
    • CustomerPONumber; string; The PO number of the customer.
    • CustomerPartyName; string; Customer Party Name.
    • DateApproved; string; The date when the contract was approved.
    • DateSigned; string; The date when the contract was signed.
    • DateTerminated; string; The date when the contract was closed.
    • DatetimeCancelled; string; The date when the contract was cancelled.
    • Description; string; The description of the contract.
    • EnableElectronicSignFlag; boolean; Flag to enable electronic signature
    • EncumbranceLevel; string; The encumbrance level of the contract.
    • EndDate; string; The date when the contract ends.
    • EsignTemplateId; string; Esignature Template identifier.
    • EstimatedAmount; number; Indicates if the service is enabled.
    • ExemptCertificateNumber; string; The number of the tax exemption certificate.
    • ExemptReasonCode; string; The code that indicates the reason for tax exemption.
    • ExemptionReasonMeaning; string; The reason for the exemption of a contract.
    • ExternalKey; string; The key which identifies the contract in the external source system.
    • ExternalSource; string; The name of external source system from where the contract is imported.
    • FOB; string; The FOB of the contract.
    • FreightTerms; string; The freight terms of the contract.
    • GeneratedInvoiceStatus; string; The status of the generated invoice.
    • HoldReasonCode; string; The code that indicates the reason for holding the contract.
    • HoldReasonMeaning; string; The meaning of the hold reason.
    • HoldUntilDate; string; The date until when the contract is to be held.
    • Id; integer; The external ID of the contract.
    • InvConvRateDate; string; The date of the invoice conversion rate.
    • InvConvRateDateType; string; The date type of the invoice conversion rate.
    • InvConvRateDateTypeName; string; The name of the invoice conversion rate date type.
    • InvConvRateType; string; The type of the invoice conversion rate.
    • InvOrgName; string; The name of the invoice organization.
    • InvOrganizationId; integer; The unique identifier of the Item Master Organization.
    • InvTrxTypeId; integer; The invoice transaction type idetifier.
    • InvTrxTypeName; string; The invoide transaction type name.
    • LastUpdateDate; string; The tax amount of the contract.
    • LastUpdateLogin; string; The date on which the record was last updated.
    • LastUpdatedBy; string; The login of the user who last updated the record.
    • LegalEntityId; integer; The unique identifier of the Legal Entity.
    • LegalEntityName; string; The name of the legal entity.
    • MajorVersion; integer; The current version of the contract.
    • MinimumReleaseAmount; number; The minimum release amount.
    • NetInvoiceFlag; boolean; Indicating whether invoice should be netted.
    • NonStandardClauseCount; string; Nonstandard Clause Count.
    • OrgId; integer; The unique identifier of the business unit.
    • OrgName; string; The name of the business unit.
    • OrigSystemId; integer; The unique identifier of the source system.
    • OrigSystemReference; string; The unique identifier for the party from the external source system specified in the attribute source system.
    • OrigSystemSourceCode; string; The source code of the source system.
    • OutputTaxClassificationCode; string; The code for Output Tax Classification.
    • OverallRiskCode; string; The code for the overall risk of the contract.
    • OwningOrgId; integer; The unique identifier of the organization that owns the contract.
    • OwningOrgName; string; The name of the organization that owns the contract.
    • PriceApplicationRule; string; Price Application Rule.
    • PriceListName; string; The name of the price list used.
    • PricingEffectivityDate; string; The effective start date of pricing.
    • PricingSegmentCode; string; The code of the pricing segment used to determine the pricing strategy for the contract.
    • PricingStrategyId; integer; The unique identifier of the pricing strategy used to price the contract.
    • PrimaryPartyId; integer; The unique identifier of the primary party.
    • PrimarySalesrepId; integer; The primary sales rep resource identifier.
    • RecvInvOrg; string; The receiving inventory organization for the contract.
    • RecvInvOrgId; integer; The unique identifier of the Receiving Inventory Organization.
    • RenewalType; string; Renewal Type.
    • SendForSignature; string; The send for signature action. Discarded.
    • ShipInvOrg; string; The shipping inventory organization for the contract.
    • ShipInvOrgId; integer; The unique identifier of the Shipping Inventory Organization.
    • ShipToAccount; string; The name of the Ship-to account.
    • ShipToAccountDescription; string; The description of the Ship-to account.
    • ShipToAccountId; integer; The unique identifier of the Ship-to account.
    • ShipToAccountNumber; string; The alternate key identifier of the Ship-to account.
    • ShipToAddress; string; The address of the Ship-to site.
    • ShipToLocationId; integer; The ship-to location ID.
    • ShipToOrgLocation; string; The location of the Ship-to organization.
    • ShipToPartyId; integer; The unique identifier of the ship-to party location.
    • ShipToPartyName; string; Ship To Party Name
    • ShipToPartySiteLocation; string; Ship To Party Site Location
    • ShipToSiteUseId; integer; The unique identifier of the Ship-to site.
    • ShipToSiteUseLocation; string; The location of the Ship-to site user.
    • ShortDescription; string; The short description of the contract.
    • SignContract; string; The sign contract action.
    • SoldToAccount; string; The name of the Sold-to account.
    • SoldToAccountDescription; string; The description of the Sold-to account.
    • SoldToAccountId; integer; The unique identifier of the Sold-to account.
    • SoldToAccountNumber; string; The alternate key identifier of the Sold-to account.
    • SoldToAddress; string; The address of the Sold-to site.
    • SoldToNumber; string; The location of the Sold-to site user.
    • SoldToSiteId; integer; The unique identifier of the Sold-to site.
    • SourceDocumentId; integer; The unique identifier of the source document.
    • SourceDocumentSystemCode; string; The code identifying the source document system.
    • StartDate; string; The date when the contract was created.
    • StateTransitionFlowName; string; The name of the state transition flow.
    • StateTransitionFlowState; string; The state of the state transition flow.
    • Status; string; The status of the contract.
    • StsCode; string; The code indicating the status of the contract. You must not pass the StsCode attribute when updating (patching) a contract. To approve a contract, you must use the Submit a contract for approval (submitForApproval) method.
    • Supplier; string; The supplier of the contract.
    • SupplierId; integer; The unique identifier of the supplier.
    • SupplierSite; string; The address of the supplier.
    • SupplierSiteId; integer; The unique identifier of the supplier's address.
    • TargetLineId; string; The target line ID.
    • TargetLineMajorVer; string; The target line major version.
    • TargetLineName; string; The targer line name.
    • TaxAmount; number; The estimated amount of the contract.
    • TaxClassificationMeaning; string; A valid classification code corresponding to the classification category.
    • TaxExemptionControl; string; Tax Exemption Control
    • TerminateCancelSource; string; The source of the termination or cancelation request.
    • TrnCode; string; The cancel or close reason code.
    • TrxnExtensionId; integer; The unqiue identifier of the transaction extension.
    • UnderMigrationFlag; boolean; Indicates that the contract is currently under migration. It allows you to identify contracts as having the migration of their invoice and/or revenue recognition history in progress. When the contract is under migration, invoicing and revenue recognition can only occur for billing events with an event type enabled for migration. All other transactions, billing events with an event type NOT enabled for migration and cost transactions (for T&M billing), would be considered ineligible for invoicing and revenue recognition. Once the invoice and revenue history is migrated, processed, and reconciled, then the Under Migration flag can be turned off and any non-migration transaction can be processed in Fusion.
    • UserStatusCode; string; The code indicating the status of the user.
    • UserStatusMeaning; string; The display name of the user status.
    • VersionDescription; string; The description of the version of the contract.
  • 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
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : contracts-item-response
Type: object
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 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-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-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
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
Back to Top

Examples

The following example shows how to get all contracts 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

Example of Response Body

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

Get all – 
{
  "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" : [ {
...,
} ]
  }, {
    "Id" : 300100036628512,
    "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_AUDIT003",
    "ContractNumberModifier" : null,
    "Cognomen" : "ZOKC_audit",
    "PartyId" : 1000,
    "PartyName" : "World of Business",
    "InvOrganizationId" : 204,
    "StsCode" : "DRAFT",
    "CurrencyCode" : "USD",
    "StartDate" : "2014-08-04",
    "EndDate" : "2015-08-31",
    "SupplierId" : 1000,
    "SupplierSiteId" : null,
    "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" : null,
    "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" : null,
    "FOB" : null,
    "ApTermsId" : null,
    "ServiceEnabledFlag" : "false",
    "EstimatedAmount" : 30000,
    "TaxAmount" : null,
    "LastUpdateDate" : "2014-08-05T00:07:17-07:00",
    "LastUpdateLogin" : "FFDBECFAC8F44AF2E0435160F00A2D57",
    "CreatedBy" : "CONMGR",
    "CreationDate" : "2014-08-04T23:59:17-07:00",
    "LedgerCurrency" : "USD",
    "EncumbranceLevel" : null,
    "AgreementEnabledFlag" : false,
    "CarrierName" : null,
    "CloseReason" : null,
    "CancelReason" : null,
    "AuthoringPartyCode" : "INTERNAL",
    "HoldReasonMeaning" : null,
    "PrimaryPartyId" : 1000,
    "PersonId" : 300100005242507,
    "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" : "World of Business",
    "SupplierSite" : null,
    "ShipInvOrg" : null,
    "RecvInvOrg" : null,
    "Currency" : "US Dollar",
    "UserStatusMeaning" : null,
    "LegalEntityName" : "Vision Operations",
    "ShipToOrgLocation" : null,
    "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