Get a contract
get
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}
Request
Path Parameters
-
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
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. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : contracts-item-response
Type:
Show Source
object
-
AccessLevel: string
Maximum Length:
80
The access level of a contract team member. -
AdjustmentBasis: string
Title:
Adjustment Basis
Maximum Length:30
The adjustment basis of the contract. -
AgreedAmount: number
Title:
Agreed Amount
Agreed Amount -
AgreementAmountLimit: number
Title:
Amount Limit
Agreement Amount Limit -
AmendmentEffectiveDate: string
(date)
Title:
Amendment Effective Date
The date when the amendment is effective. -
ApTermsId: integer
(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
ApTermsName: string
The unique identifier of the payment terms.
-
Assignee: string
Title:
Assignee
The assignee of the contract. -
AssigneeId: integer
(int64)
The unique identifier of the assignee.
-
AssigneeType: string
Maximum Length:
30
The type of assignee of the contract. -
AuthoringPartyCode: string
Title:
Authoring Party
Maximum Length:30
The code indicating the authoring party of the contract. -
AuthoringPartyMeaning: string
Title:
Authoring Party
The display name of the authoring party. -
AutoSendForSignature: string
Maximum Length:
1
Default Value:N
Auto Send For Signature Flag. -
BaseContractYN: string
Title:
Base Contract
Maximum Length:1
Indicates whether or not the current contract is a negotiated base contract. -
BillingControl: array
Billing Controls
Title:
Billing Controls
The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc. -
BillingSalesrepId: integer
Title:
Salesperson
Billing Sales Rep ID -
BillingSalesrepName: string
Title:
Salesperson
Billing Sales Rep Name -
BillPlan: array
Bill Plans
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. -
BillSequence: integer
(int64)
Title:
Billing Sequence
The bill sequence number of the contract. -
BillToAccount: string
Title:
Bill-to Party
The name of the Bill-to account. -
BillToAccountId: integer
(int64)
Title:
Bill-to Account
The unique identifier of the Bill-to account. -
BillToAccountNumber: string
Title:
Bill-to Account Number
Maximum Length:255
The alternate key identifier of the Bill-to account. -
BillToAccountPartyId: integer
The bill to account party ID.
-
BillToAddress: string
Title:
Bill-to Address
The address of the Bill-to site. -
BillToLocation: string
Title:
Bill-to Location
Maximum Length:240
The bill-to location. -
BilltoLocationId: integer
(int64)
Title:
Bill-to Location
The bill-to location ID. -
BillToSiteUseId: integer
(int64)
Title:
Bill-to Site
The unique identifier of the Bill-to site. -
BillToSiteUseLocation: string
Title:
Bill-to Site
The location of the Bill-to site user. -
CancelReason: string
Title:
Cancellation Reason
The reason for cancellation of the contract. -
CancelReasonSetCode: string
The unique identifier of the set used for cancel or close reason code.
-
CarrierId: integer
(int64)
Title:
Carrier
Indicates whether agreement is enabled. -
CarrierName: string
Title:
Carrier
The name of the contract carrier. -
CloseReason: string
Title:
Close Reason
The reason for closing the contract. -
CloseReasonSetCode: string
The unique identifier of the set used for the hold reason code.
-
Cognomen: string
Title:
Name
Maximum Length:300
The name of the contract. -
CommitmentAmount: number
Title:
Committed Amount
The amount that is commited. -
ContractClass: string
Read Only:
true
Maximum Length:30
The class of the contract. -
ContractDocuments: array
Contract Documents
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. -
ContractHeaderFlexfieldVA: array
Contract Header Flexfields
Title:
Contract Header Flexfields
The contract header flex field resource is used to view, create, update contract header flex field information. -
ContractHeaderTranslation: array
Contract Header Translations
Title:
Contract Header Translations
The resource is used to view, update contract header translation information. -
ContractId: integer
(int64)
The unique identifier of the contract.
-
ContractLine: array
Contract Lines
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. -
ContractNumber: string
Title:
Number
Maximum Length:120
The alternate key identifier for the contract. -
ContractNumberModifier: string
Title:
Modifier
Read Only:true
Maximum Length:120
The contract number modifier. -
ContractOwnerId: integer
The unique identifier of the contract owner.
-
ContractParty: array
Contract Parties
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. -
ContractPuid: string
Title:
Contract PUID
Maximum Length:120
Contract PUID. -
ContractTrueValue: number
The true value of a contract after considering the terminations.
-
ContractTypeId: integer
(int64)
Title:
Type
The unique identifier of the contract type. -
ContractTypeName: string
Title:
Type
Maximum Length:150
The name of the contract type. -
ContributionPercent: number
Title:
Contribution Percent
The percentage of contribution to the contract. -
CorpCurrencyCode: string
Maximum Length:
15
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup RatedCurrenciesVO. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
Maximum Length:
30
Currency Conversion Rate. -
Currency: string
Title:
Currency Name
Maximum Length:80
The currency of the contract. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup RatedCurrenciesVO. -
CustomerPartyId: integer
Read Only:
true
The unique identifier of the party. -
CustomerPartyName: string
Read Only:
true
Customer Party Name. -
CustomerPartySiteId: integer
Read Only:
true
The unique identifier of the customer party site. -
CustomerPONumber: string
Title:
PO Number
Maximum Length:50
The PO number of the customer. -
DateApproved: string
(date)
Title:
Approved Date
The date when the contract was approved. -
DateSigned: string
(date)
Title:
Signed Date
The date when the contract was signed. -
DateTerminated: string
(date)
Title:
Closed Date
The date when the contract was closed. -
DatetimeCancelled: string
(date)
Title:
Canceled Date
The date when the contract was cancelled. -
Description: string
Title:
Description
Maximum Length:1995
The description of the contract. -
DiscountPercent: number
Title:
Discount Percent
The percentage of discount provided. -
EnableElectronicSignFlag: boolean
Title:
Enable electronic signature
Maximum Length:1
Flag to enable electronic signature -
EncumbranceLevel: string
Title:
Encumbrance Level
Maximum Length:30
The encumbrance level of the contract. -
EncumbranceLevelMeaning: string
The encumbrance level of the contract.
-
EndDate: string
(date)
Title:
End Date
The date when the contract ends. -
EsignTemplateId: string
Maximum Length:
120
Esignature Template identifier. -
EstimatedAmount: number
Title:
Amount
Default Value:0
Indicates if the service is enabled. -
ExemptCertificateNumber: string
Title:
Exemption Certificate Number
Maximum Length:80
The number of the tax exemption certificate. -
ExemptionReasonMeaning: string
Title:
Exemption Reason
The reason for the exemption of a contract. -
ExemptReasonCode: string
Title:
Exemption Reason
Maximum Length:30
The code that indicates the reason for tax exemption. -
ExternalKey: string
Maximum Length:
120
The key which identifies the contract in the external source system. - ExternalSharedDocuments: array External Shared Documents
-
ExternalSource: string
Maximum Length:
120
The name of external source system from where the contract is imported. -
FOB: string
Title:
FOB
Maximum Length:230
The FOB of the contract. -
FOBMeaning: string
The code that indicates the freight terms of the contract line.
-
FreightTerms: string
Title:
Freight Terms
Maximum Length:230
The freight terms of the contract. -
FreightTermsMeaning: string
The Freight Terms.
-
GeneratedInvoiceStatus: string
Title:
Generated Invoice Status
Maximum Length:1
The status of the generated invoice. -
HoldReasonCode: string
Title:
Hold Reason
Maximum Length:30
The code that indicates the reason for holding the contract. -
HoldReasonCodeSetId: integer
(int64)
The unique identifier of the set used for the hold reason code.
-
HoldReasonMeaning: string
The meaning of the hold reason.
-
HoldReasonSetCode: string
The unique identifier of the set used for the hold reason code.
-
HoldUntilDate: string
(date)
Title:
Hold Until Date
The date until when the contract is to be held. -
Id: integer
(int64)
The external ID of the contract.
- InternalSharedDocuments: array Internal Shared Documents
-
InvConvRateDate: string
(date)
Title:
Conversion Date
The date of the invoice conversion rate. -
InvConvRateDateType: string
Title:
Conversion Date Type
Maximum Length:15
The date type of the invoice conversion rate. -
InvConvRateDateTypeName: string
The name of the invoice conversion rate date type.
-
InvConvRateType: string
Title:
Conversion Rate Type
Maximum Length:15
The type of the invoice conversion rate. -
InvConvRateTypeName: string
Title:
Conversion Rate Type
The name of the invoice conversion rate type. -
InvOrganizationId: integer
(int64)
Title:
Item Master
The unique identifier of the Item Master Organization. -
InvOrgName: string
Title:
Item Master
Maximum Length:240
The name of the invoice organization. -
InvTrxTypeId: integer
(int64)
Title:
Transaction Type
The invoice transaction type idetifier. -
InvTrxTypeName: string
Title:
Transaction Type
The invoide transaction type name. -
ItemSourceCode: string
Read Only:
true
The source code of the item. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The tax amount of the contract. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The login of the user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The date on which the record was last updated. -
LedgerCurrency: string
The ledger currency of the contract.
-
LegalEntityId: integer
(int64)
Title:
Legal Entity
The unique identifier of the Legal Entity. -
LegalEntityName: string
Title:
Legal Entity
Maximum Length:240
The name of the legal entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Read Only:true
Default Value:1
The current version of the contract. -
MinimumReleaseAmount: number
Title:
Minimum Release Amount
The minimum release amount. -
NetInvoiceFlag: boolean
Title:
Net invoice
Maximum Length:1
Indicating whether invoice should be netted. -
NonStandardClauseCount: string
Read Only:
true
Nonstandard Clause Count. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
OrgName: string
Title:
Business Unit
The name of the business unit. -
OrigSystemId: integer
(int64)
Read Only:
true
The unique identifier of the source system. -
OrigSystemReference: string
Read Only:
true
Maximum Length:30
The unique identifier for the party from the external source system specified in the attribute source system. -
OrigSystemSourceCode: string
Read Only:
true
Maximum Length:30
The source code of the source system. -
OutputTaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:50
The code for Output Tax Classification. -
OutputTaxSetId: integer
Read Only:
true
The unique identifier of the output tax set. -
OverallRiskCode: string
Title:
Overall Risk
Maximum Length:30
The code for the overall risk of the contract. -
OwningOrgId: integer
(int64)
Title:
Contract Organization
The unique identifier of the organization that owns the contract. -
OwningOrgName: string
Title:
Contract Organization
The name of the organization that owns the contract. -
PartyId: integer
The unique identifier of the primary party.
-
PartyName: string
Title:
Primary Party
The name of the primary party. -
PartyObjectType: string
Read Only:
true
The type of the party object. -
PriceApplicationRule: string
Title:
Price Application Rule
Maximum Length:30
Price Application Rule. -
PriceList: string
Title:
Price Book
Maximum Length:30
The price list of the contract. -
PriceListName: string
Title:
Price Book
The name of the price list used. -
PricingEffectivityDate: string
(date-time)
Title:
Pricing Effective Date
The effective start date of pricing. -
PricingSegmentCode: string
Maximum Length:
30
The code of the pricing segment used to determine the pricing strategy for the contract. -
PricingStrategyId: integer
(int64)
The unique identifier of the pricing strategy used to price the contract.
-
PrimaryLedgerId: integer
Read Only:
true
Default Value:1
The unique identifier of the primary ledger. -
PrimaryPartyId: integer
The unique identifier of the primary party.
-
PrimarySalesrepId: integer
(int64)
The primary sales rep resource identifier.
-
ProjectEnabledFlag: boolean
Read Only:
true
Indicates whether the project is enabled. -
RecvInvOrg: string
Title:
Ship-to Organization
Maximum Length:240
The receiving inventory organization for the contract. -
RecvInvOrgId: integer
(int64)
Title:
Ship-to Organization
The unique identifier of the Receiving Inventory Organization. -
RelatedDocument: array
Related Documents
Title:
Related Documents
The resource is used to view, create, update, delete related contracts information. -
RenewalType: string
Title:
Renewal Process
Maximum Length:30
Renewal Type. -
RevenuePlan: array
Revenue Plans
Title:
Revenue Plans
The resource is used to view, create, update, delete a revenue plan. This includes revenue plan name and revenue method. -
RunContractExpertFlag: boolean
Default Value:
true
Indicates whether to run expert after defaulting terms during contract creation or updation. -
SalesCredit: array
Sales Credits
Title:
Sales Credits
The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date. -
Section: array
Sections
Title:
Sections
The resource is used to view the sections of the contract terms. -
SendForSignature: string
The send for signature action. Discarded.
-
ServiceEnabledFlag: boolean
Read Only:
true
Service Enabled Flag - ShareWithExternalPartyYn: string
-
ShipInvOrg: string
Title:
Warehouse
Maximum Length:240
The shipping inventory organization for the contract. -
ShipInvOrgId: integer
(int64)
Title:
Warehouse
The unique identifier of the Shipping Inventory Organization. -
ShipToAccount: string
Title:
Ship-to Party
The name of the Ship-to account. -
ShipToAccountDescription: string
Title:
Ship-to Account Description
The description of the Ship-to account. -
ShipToAccountId: integer
(int64)
Title:
Ship-to Account
The unique identifier of the Ship-to account. -
ShipToAccountNumber: string
Title:
Ship-to Account Number
Maximum Length:255
The alternate key identifier of the Ship-to account. -
ShipToAddress: string
Title:
Ship-to Address
The address of the Ship-to site. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location
The ship-to location ID. -
ShipToOrgLocation: string
Title:
Ship-to Location
Maximum Length:240
The location of the Ship-to organization. -
ShipToPartyId: integer
(int64)
Title:
Ship-to Party
The unique identifier of the ship-to party location. -
ShipToPartyName: string
Title:
Ship-to Party
Ship To Party Name -
ShipToPartySiteLocation: string
Title:
Ship-to Site
Ship To Party Site Location -
ShipToSiteUseId: integer
(int64)
Title:
Ship-to Site
The unique identifier of the Ship-to site. -
ShipToSiteUseLocation: string
Title:
Ship-to Site
The location of the Ship-to site user. -
ShortDescription: string
Maximum Length:
600
The short description of the contract. -
SignContract: string
The sign contract action.
-
SoldToAccount: string
Title:
Sold-to Party
The name of the Sold-to account. -
SoldToAccountDescription: string
Title:
Sold-to Account Description
The description of the Sold-to account. -
SoldToAccountId: integer
(int64)
Title:
Sold-to Account
The unique identifier of the Sold-to account. -
SoldToAccountNumber: string
Title:
Sold-to Account Number
Maximum Length:255
The alternate key identifier of the Sold-to account. -
SoldToAddress: string
Title:
Sold-to Address
The address of the Sold-to site. -
SoldToNumber: string
Title:
Sold-to Site
The location of the Sold-to site user. -
SoldToSiteId: integer
(int64)
Title:
Sold-to Site
The unique identifier of the Sold-to site. -
SourceDocumentId: integer
(int64)
Title:
Source Document Number
The unique identifier of the source document. -
SourceDocumentSystemCode: string
Title:
Source Application
Maximum Length:30
The code identifying the source document system. -
StartDate: string
(date)
Title:
Start Date
The date when the contract was created. -
StateTransitionFlowName: string
Maximum Length:
240
The name of the state transition flow. -
StateTransitionFlowState: string
Maximum Length:
240
The state of the state transition flow. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
The status of the contract. -
StsCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
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
Title:
Supplier
Maximum Length:360
The supplier of the contract. -
SupplierId: integer
(int64)
Title:
Supplier
The unique identifier of the supplier. -
SupplierSite: string
Title:
Supplier Address
Maximum Length:240
The address of the supplier. -
SupplierSiteId: integer
(int64)
Title:
Supplier Address
The unique identifier of the supplier's address. -
SupportingDocuments: array
Supporting Documents
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. -
TargetLineId: string
Read Only:
true
The target line ID. -
TargetLineMajorVer: string
Read Only:
true
The target line major version. -
TargetLineName: string
Read Only:
true
The targer line name. -
TaxAmount: number
Title:
Tax Amount
The estimated amount of the contract. -
TaxClassificationMeaning: string
Title:
Classification Code
A valid classification code corresponding to the classification category. -
TaxExemptionControl: string
Title:
Exemption Handling
Maximum Length:30
Tax Exemption Control -
TaxExemptionControlMeaning: string
The tax exemption control.
-
TemplateFlag: boolean
Maximum Length:
3
Default Value:false
Indicates the template of the contract. -
TerminateCancelSource: string
Maximum Length:
30
The source of the termination or cancelation request. -
TermsTemplateId: integer
Terms Template ID
-
TrnCode: string
Title:
Close Reason
Maximum Length:30
The cancel or close reason code. -
TrnCodeSetId: integer
(int64)
The unique identifier of the set used for cancel or close reason code.
-
TrxnExtensionId: integer
(int64)
The unqiue identifier of the transaction extension.
-
UnderMigrationFlag: boolean
Title:
Migration in progress
Maximum Length:1
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
Title:
User Status
Maximum Length:30
The code indicating the status of the user. -
UserStatusMeaning: string
Title:
User Status
Read Only:true
Maximum Length:150
The display name of the user status. -
VersionDescription: string
Title:
Version Description
Maximum Length:1995
The description of the version of the contract. -
WebServiceFlag: boolean
Default Value:
false
Indicates if the web service is available.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the billing control is active. -
BillingControlId: integer
(int64)
The unique identifier of the billing control.
-
BillingResource: string
Title:
Billing Resource
The Resource Breakdown structure Element for which Billing control is defined. -
EndDate: string
(date)
Title:
End Date
The date when the billing control ends. -
ExternalReferenceKey: string
Maximum Length:
150
The reference key in the external source. -
ExternalSourceKey: string
Maximum Length:
150
The external source key of the billing control. -
HardLimitAmount: number
Title:
Hard Limit
The hard limit for the billing control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
The contract version of the billing control.
-
RbsElementId: integer
(int64)
Title:
Billing Resource ID
The identifier of the Resource Breakdown structure Element for which Billing control is defined. -
SoftLimitAmount: number
Title:
Soft Limit
The soft limit for the billing control. -
StartDate: string
(date)
Title:
Start Date
The date when the billing control starts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : contracts-BillPlan-item-response
Type:
Show Source
object
-
BillingCurrencyType: string
Title:
Billing Currency Type
Maximum Length:80
The currency option for the bill plan. -
BillingCycle: string
Title:
Billing Cycle
Maximum Length:30
The time period of the billing. -
BillingCycleId: integer
(int64)
Title:
Billing Cycle ID
The unique identifier of the billing cycle. -
BillMethodId: integer
(int64)
Title:
Bill Method ID
The unique identifier of the bill method. -
BillMethodName: string
Title:
Method Name
Maximum Length:30
The name of the bill method. -
BillPlanDescriptiveFlexField: array
Bill Plan Flexfields
Title:
Bill Plan Flexfields
The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information. -
BillPlanId: integer
(int64)
Title:
Bill Plan ID
The unique identifier of the bill plan. -
BillPlanName: string
Title:
Name
Maximum Length:30
The name of the bill plan. -
BillPlanTranslation: array
Bill Plan Translations
Title:
Bill Plan Translations
The bill plan translations resource is used to view and update contract bill plan translation information. -
BillSetNumber: number
Title:
Bill Set
The billing set number is used to group invoices. -
BillToAccountNumber: string
Title:
Bill-to Account Number
Maximum Length:30
The alternate identifier of the customer to whom invoices should be sent to and is responsible for the payment. -
BillToContactEmail: string
Title:
Bill-to Contact E-mail
The email address of the contact person from the Bill-To Customer Site. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact
The unique identifier of the contact person from the Bill-To Customer Site. -
BillToContactName: string
Title:
Bill-to Contact
Maximum Length:360
The name of the contact person from the Bill-To Customer Site. -
BillToCustomerAccountId: integer
(int64)
Title:
Bill-to Account Number
The unique identifier of the customer to whom invoices should be sent and is responsible for the payment. -
BillToSite: string
Title:
Bill-to Site
Maximum Length:150
The customer site where the invoices should be sent. -
BillToSiteUseId: integer
(int64)
Title:
Bill-to Site
The unique identifier of the site where the invoices should be sent. -
BurdenSchedule: string
Title:
Burden Schedule
Maximum Length:30
The burden schedule on the Revenue plan. -
BurdenSchFixedDate: string
(date)
Title:
Fixed Date
The fixed date used to determine the effective rates of the burden schedule. -
BurdenSchId: integer
(int64)
Title:
Burden Schedule ID
The identifier of the burden schedule. -
DocumentNumber: string
Title:
Document Number
Maximum Length:240
The document number on bill plan for letter of credit enabled grants. -
EventInvoiceFormat: string
Title:
Event Format
Maximum Length:30
The events invoice identifier which summarizes invoice distributions into invoice lines. This option is applicable for events transactions. -
EventsInvoiceFormatId: integer
(int64)
Title:
Event Invoice Format ID
The unique identifier of the Events invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for events transactions. -
ExternalReferenceKey: string
Maximum Length:
150
Reference key in External source -
ExternalSourceKey: string
Maximum Length:
150
External Source Key -
FederalInvoiceFormat: string
Title:
Federal Invoice Format
Maximum Length:80
The invoice format for GMS contract invoices. -
FirstBillingOffsetDays: number
Title:
First Bill Offset Days
The number of days that elapse between the project start date and the date of the project???s first invoice. -
InvHdrGroupingOptions: string
Title:
Invoice Grouping
Maximum Length:2000
The invoice header grouping options of the bill plan. -
InvoiceComment: string
Title:
Invoice Comment
Maximum Length:240
Comments on Invoice -
InvoiceCurrencyCode: string
Title:
Invoice Revenue Currency
Maximum Length:30
The invoice currency code. -
InvoiceCurrencyConversionDateType: string
Title:
Conversion Date Type
Maximum Length:80
The invoice currency date type. -
InvoiceCurrencyConversionRateType: string
Title:
Conversion Rate Type
Maximum Length:30
The invoice currency rate type code. -
InvoiceCurrencyDateType: string
Title:
Currency Conversion Date Type Code
Maximum Length:30
The invoice currency date type code. -
InvoiceCurrencyExchgDate: string
(date)
Title:
Conversion Date
The invoice currency exchange date. -
InvoiceCurrencyOptCode: string
Title:
Billing Currency Type Code
Maximum Length:30
The currency option code for bill plan. -
InvoiceCurrencyRateType: string
Title:
Currency Conversion Rate Type Code
Maximum Length:30
The invoice currency rate type code. -
InvoiceHdrGrpOptName: string
Title:
Invoice Grouping
Maximum Length:80
The invoice header grouping option name of the bill plan. -
InvoiceInstructions: string
Title:
Billing Instructions
Maximum Length:240
Invoice instructions -
JobAssignmentOverride: array
Job Assignment Overrides
Title:
Job Assignment Overrides
The resource is used to view, create, update, delete job assignment override details -
JobBillRateSchId: integer
(int64)
Title:
Job Rate Schedule
The unique identifier of the job bill rate schedule. -
JobRateOverride: array
Job Rate Overrides
Title:
Job Rate Overrides
The resource is used to view, create, update, delete job rate override details. -
JobRateSchedule: string
Title:
Job Rate Schedule
Maximum Length:30
The job bill rate schedule. -
JobTitleOverride: array
Job Title Overrides
Title:
Job Title Overrides
The resource is used to view, create, update, delete job title override details. -
LaborBillBasisCode: string
Title:
Labor Cost Basis Code
Maximum Length:30
The labor cost basis code for cost reimbursable. -
LaborCostBasis: string
Title:
Labor Cost Basis
Maximum Length:80
The labor cost basis for cost reimbursable. -
LaborDiscountPercentage: number
Title:
Discount Percentage
The percentage to be discounted from the standard labor bill rate schedule. -
LaborDiscountReasonCode: string
Title:
Labor Discount Reason Code
Maximum Length:30
The labor rate change reason code. -
LaborInvoiceFormat: string
Maximum Length:
30
The labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions. -
LaborInvoiceFormatId: integer
(int64)
Title:
Labor Invoice Format ID
The unique identifier of the labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions. -
LaborMarkupPercentage: number
Title:
Labor Markup Percentage
The labor markup percentage. -
LaborMultiplierOverride: array
Labor Multiplier Overrides
Title:
Labor Multiplier Overrides
The resource is used to view, create, update, delete labor multiplier override details. -
LaborRateChangeReason: string
Title:
Labor Rate Change Reason
Maximum Length:80
The labor rate change reason. -
LaborSchFixedDate: string
(date)
Title:
Fixed Date
The fixed date used to determine the effective bill rates of the standard labor bill rate schedule. -
LaborTpScheduleId: integer
Title:
Labor Transfer Price Schedule ID
The unique identifier of the labor schedule for Inter Company Transfer Price. -
LaborTpSchFixedDate: string
(date)
Title:
Fixed Date
The fixed date used to determine the effective rates of the Intercompany Labor Transfer Price Schedule. -
LaborTransferPriceSchedule: string
Title:
Labor Transfer Price Schedule
Maximum Length:50
The labor schedule for Inter Company Transfer Price. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocFlag: boolean
Title:
Enable letter of credit
Maximum Length:1
Indicates whether the letter of credit is enabled. -
MajorVersion: integer
(int64)
The contract Major Version of the bill plan.
-
NlBillBasisCode: string
Title:
Nonlabor Cost Basis Code
Maximum Length:30
The non labor cost basis code for cost reimbursable. -
NlBillRateSchId: integer
(int64)
Title:
Nonlabor Rate Schedule
The identifier of the non labor bill rate schedule. -
NlDiscountPercentage: number
Title:
Discount Percentage
The percentage to be discounted from the standard non labor bill rate schedule. -
NlDiscountReasonCode: string
Title:
Nonlabor Discount Reason Code
Maximum Length:30
The non labor rate change reason code. -
NlInvoiceFormatId: integer
(int64)
Title:
Nonlabor Invoice Format ID
The unique identifier of the non labor invoice format identifier which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions. -
NlMarkupPercentage: number
Title:
Nonlabor Markup Percentage
The non labor markup percentage. -
NlSchFixedDate: string
(date)
Title:
Fixed Date
The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule. -
NlTpScheduleId: integer
Title:
Nonlabor Transfer Price Schedule ID
The unique identifier of the non labor Schedule for Inter Company Transfer Price. -
NlTpSchFixedDate: string
(date)
Title:
Fixed Date
The fixed date used to determine the effective rates of the Intercompany Nonlabor Transfer Price Schedule. -
NonlaborCostBasis: string
Title:
Nonlabor Cost Basis
Maximum Length:80
The non labor cost basis for cost reimbursable. -
NonlaborInvoiceFormat: string
Title:
Nonlabor Format
Maximum Length:30
The Non Labor invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions. -
NonlaborRateChangeReason: string
Title:
Nonlabor Rate Change Reason
Maximum Length:80
The non labor rate change reason. -
NonLaborRateOverride: array
Non Labor Rate Overrides
Title:
Non Labor Rate Overrides
The resource is used to view, create, update, delete non labor multiplier override details. -
NonlaborRateSchedule: string
Title:
Nonlabor Rate Schedule
Maximum Length:30
The non labor bill rate schedule. -
NonlaborTransferPriceSchedule: string
Title:
Nonlabor Transfer Price Schedule
Maximum Length:50
The non labor Schedule for Inter Company Transfer Price. -
OnHoldFlag: boolean
Title:
On hold
Maximum Length:1
Default Value:false
Indicates whether bill plan can be used to generate invoice. -
PaymentTerms: string
Title:
Payment Terms
Maximum Length:15
The terms of the payment. -
PaymentTermsId: integer
(int64)
Title:
Payment Term ID
The unique identifier of the payment terms. -
PersonBillRateSchId: integer
(int64)
Title:
Person Rate Schedule
The identifier of the employee bill rate schedule. -
PersonRateOverride: array
Person Rate Overrides
Title:
Person Rate Overrides
The resource is used to view, create, update, delete person rate override details. -
PersonRateSchedule: string
Title:
Person Rate Schedule
Maximum Length:30
The employee bill rate schedule.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
BillPlanId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-BillPlanTranslation-item-response
Type:
Show Source
object
-
BillPlanDesc: string
Maximum Length:
240
The revenue plan description. -
BillPlanId: integer
(int64)
Bill Plan Identifier
-
BillPlanName: string
Maximum Length:
30
Bill Plan Name -
InvoiceComment: string
Maximum Length:
240
Comments of the Invoice -
InvoiceInstructions: string
Maximum Length:
240
Invoice Instructions -
Language: string
Maximum Length:
4
Translation Language -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Contract version of the Bill Plan Translation
-
ObjectVersionNumber: integer
(int32)
The revenue plan object version.
-
SourceLang: string
Maximum Length:
4
Source Language
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-JobAssignmentOverride-item-response
Type:
Show Source
object
-
BillingTitle: string
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. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the job assignment override is defined. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
The contract line for which the job assignment override is defined. -
EmailAddress: string
Title:
Email
Maximum Length:240
The email address for whom the job assignment override is defined. -
EndDateActive: string
(date)
Title:
End Date
The date to which a job assignment override applies. -
ExternalReferenceKey: string
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. -
ExternalSourceKey: string
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. -
JobAssignmentOverrideId: integer
(int64)
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. -
JobCode: string
Title:
Job Code
The job code of the override being assigned to the person for this bill or revenue plan. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the override job being assigned to the person for this bill or revenue plan. -
JobName: string
Title:
Job Name
Maximum Length:240
The job name of the override being assigned to the person for this bill or revenue plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
The version of the contract containing this particular set of job assignment override details. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person for whom the job assignment override is defined. -
PersonName: string
Title:
Person
Maximum Length:2000
The person for whom the job assignment override is defined. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
The person number for whom the job assignment override is defined. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a job assignment override applies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-JobRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Job Rate Override ID
Unique identifier of the bill rate override. -
BillRateUnitCode: string
Title:
Unit of Measure
Read Only:true
Maximum Length:30
Default Value:HOURS
The bill rate unit code. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount Percentage
Discount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End Date
Date till which bill rate override is effective. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
JobCode: string
Title:
Job Code
Code of the job for which bill rate is being overriden. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the job for which bill rate is being overridden. -
JobName: string
Title:
Job
Maximum Length:240
Name of the job for which bill rate is being overridden. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
Rate: number
Title:
Rate
Amount billed to the customer for an item. -
RateCurrency: string
Title:
Currency
Maximum Length:80
Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Discount Reason
Maximum Length:80
Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Discount Reason
Maximum Length:30
Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start Date
Date from which bill rate override is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-JobTitleOverride-item-response
Type:
Show Source
object
-
BillingTitle: string
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. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the job title override is defined. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
The contract line number for which the job title override is defined. -
EndDateActive: string
(date)
Title:
End Date
The date to which a job title override applies. -
ExternalReferenceKey: string
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. -
ExternalSourceKey: string
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. -
JobCode: string
Title:
Job Code
Code of the job for which the job title override is defined. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the job for which the job title override is defined. -
JobName: string
Title:
Job Name
Maximum Length:240
Name for the Job for which the job title override is defined. -
JobTitleOverrideId: integer
(int64)
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Version of the contract containing this particular set of job title override details. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a job title override applies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-LaborMultiplierOverride-item-response
Type:
Show Source
object
-
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the labor multiplier override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which labor mutliplier override applies. -
EndDateActive: string
(date)
Title:
End Date
The date to which a labor multiplier override applies. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
LaborMultiplier: number
Title:
Multiplier
Labor multiplier. -
LaborMultiplierId: integer
(int64)
Title:
Labor Multiplier ID
Unique identifier of the labor multiplier override on the bill plan or revenue plan that identifies the negotiated value to be multiplied by the cost rate for labor. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Version of the contract containing this particular set of labor multiplier override details. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a labor multiplier override applies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-NonLaborRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Nonlabor Rate Override ID
Unique identifier of the bill rate override. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount Percentage
Discount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End Date
Date till which bill rate override is effective. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Unique identifier of the expenditure type for which the bill rate is being overridden. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Expenditure type name for which the bill rate is being overridden. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
MarkupPercentage: number
Title:
Markup Percentage
Markup percentage applied to the bill rate. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Unique identifier of the non labor resource for which the bill rate is being overridden. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
Non labor resource name for which the bill rate is being overridden. -
OrganizationId: integer
(int64)
Title:
Organization ID
Unique identifier of the organization for which the bill rate overrides are being defined. -
OrganizationName: string
Title:
Organization
Maximum Length:240
Name of the organization for which the bill rate overrides are being defined. -
Rate: number
Title:
Rate
Amount billed to the customer for an item. -
RateCurrency: string
Title:
Currency
Maximum Length:80
Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Rate Change Reason
Maximum Length:80
Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Rate Change Reason Code
Maximum Length:30
Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start Date
Date from which bill rate override is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-BillPlan-PersonRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Person Rate Override ID
Unique identifier of the bill rate override. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount Percentage
Discount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End Date
Date till which bill rate override is effective. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
PersonEmail: string
Title:
Person Email
Maximum Length:240
Email of the person whose bill rate is being overridden. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person whose bill rate is being overridden. -
PersonName: string
Title:
Person
Maximum Length:240
Name of the person whose bill rate is being overridden. -
Rate: number
Title:
Rate
Amount billed to the customer for an item. -
RateCurrency: string
Title:
Currency
Maximum Length:80
Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Rate Change Reason
Maximum Length:80
Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Rate Change Reason Code
Maximum Length:30
Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start Date
Date from which bill rate override is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractDocuments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The async tracker ID of the internal shared document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached internal shared document. -
CategoryName: string
Title:
Category
Maximum Length:30
The code for the category to which the internal shared document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the internal shared document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the internal shared document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the internal shared document was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that identifies if the external shared document is a file or a URL. -
Description: string
Title:
Description
Maximum Length:255
The description of the internal shared document. -
DmDocumentId: string
Maximum Length:
255
The Dm document id of the internal shared document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The Dm folder path of the internal shared document. -
DmVersionNumber: string
Maximum Length:
255
The Dm version number of the internal shared document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error status code for the internal shared document. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the internal shared document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the internal shared document. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the internal shared document. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the internal shared document. A file name or URL is required. -
FileUrl: string
Title:
File Url
The URL location of the internal shared document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the internal shared document was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The login user name associated with the user who last updated the internal shared document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the internal shared document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the internal shared document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The uploaded file content type of the internal shared document. -
UploadedFileLength: integer
Title:
File Size
The uploaded file length of the internal shared document. -
UploadedFileName: string
Title:
Uploaded File Name
The uploaded file name of the internal shared document. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the internal shared document. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the internal shared document. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the internal shared document. A file name or URL is required. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The name of the category to which the internal shared document is assigned.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractHeaderFlexfieldVA-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ContractId: integer
(int64)
Contract Header Flexfield Unique ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractHeaderTranslation-item-response
Type:
Show Source
object
-
Cognomen: string
Maximum Length:
300
Contract Name -
Description: string
Maximum Length:
1995
Description of the Contract -
Id: integer
(int64)
Contract Translation ID
-
Language: string
Maximum Length:
12
Indicates the code of the language into which the contents of the translatable columns are translated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Major Version
-
ShortDescription: string
Maximum Length:
600
Short Description -
SourceLang: string
Maximum Length:
12
Source Language -
VersionDescription: string
Maximum Length:
1995
Version Description
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Title:
Adjustment
The adjustment amount of the contract line. -
AdjustmentBasisCode: string
Title:
Adjustment Basis
The code that indicates the adjustment basis. -
AdjustmentBasisId: integer
Title:
Adjustment Basis
The unique identifier of the adjustment basis. -
AdjustmentType: string
The type of adjustment of the contract line.
-
AdjustmentTypeCode: string
Title:
Adjustment Type
The code that indicates the type of adjustment. -
AgreedAmount: number
Title:
AgreedAmount
The agreed amount of the contract line. -
AgreedQuantity: number
Title:
Committed Quantity
The agreed quantity to be shipped of the contract line. -
AgreementAmountLimit: number
Title:
Amount Limit
The limit on the agreed amount. -
AgreementPriceLimit: number
Title:
Price Limit
The price limit of the agreement line. -
AgreementPriceOverAllwdYn: string
Title:
Allow Price Override
Maximum Length:1
Default Value:N
Indicates if the agreement price can be overridden. -
AgreementQuantityLimit: number
Title:
Quantity Limit
The limit on the agreed quantity to be shipped. -
AgreementUnitPrice: number
Title:
Unit Price
The unit price of the agreement line. -
AllowCustomAdjustmentsFlag: boolean
Title:
Allow Price Override on Order
Indicates whether a custom adjustment can be made. -
AllowPricelistOverrideYn: string
Title:
Allow Price Book Override on Order
Maximum Length:1
Indicates whether price list override is allowed. -
AllowPromotionsYn: string
Title:
Allow Promotions
Maximum Length:1
Default Value:N
Indicates whether promotions are allowed. -
AssociatedProject: array
Associated Projects
Title:
Associated Projects
The resource is used to view, create, update, delete associated project information. This includes the project number, task number, percent complete, funded amount etc. -
AtRiskYn: string
Title:
At risk
Maximum Length:1
Default Value:N
Indicating whether the contract line is at risk. -
AutoApplyStrategyPriceAdjustmentFlag: boolean
Title:
Apply Pricing Strategy Adjustments
Maximum Length:1
Auto Apply Strategy Price Adjustment Flag -
BillingControl: array
Billing Controls
Title:
Billing Controls
The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc. -
BillPlan: string
Title:
Bill Plan
Bill Plan Name -
BillPlanExternalKey: string
The bill plan external key.
-
BillPlanExternalSource: string
The bill plan external source.
-
BillPlanId: integer
(int64)
Title:
Bill Plan
The unique identifier of the bill plan. -
CancelReason: string
Title:
Cancellation Reason
The cancel reason. -
CarrierId: integer
(int64)
Title:
Carrier
The unique identifier of the carrier. -
CarrierName: string
Title:
Carrier
The name of the carrier. -
CloseReason: string
Title:
Close Reason
The reason for closing a contract line. -
Cognomen: string
Maximum Length:
300
The name of the contract line. -
Comments: string
Title:
Comments
Maximum Length:1995
The comments on the contract line. -
CommitLevel: string
Commit Level
-
CommitLevelCode: string
Title:
Commitment Level
Maximum Length:30
Default Value:ESTIMATED
Commit Level Code -
ContractAllLineDesFlexVA: array
Contract Line Flexfields
Title:
Contract Line Flexfields
The resource is used to view, create, update contract line flex field information. -
ContractLineTranslation: array
Contract Line Translations
Title:
Contract Line Translations
The resource is used to view, update contract line translation information. -
ContractPuid: string
The contract PUID.
-
CustomerPONumber: string
Title:
PO Number
Maximum Length:50
The PO number of the customer. -
DateCancelled: string
(date)
The date cancelled.
-
DateTerminated: string
(date)
Title:
Closed Date
The date when the contract line is terminated. -
DeliveryDate: string
(date)
Title:
Need-by Date
The date when the items are expected to be delivered. -
EndDate: string
(date)
Title:
End Date
The date when the contract line ends. -
EstimatedVariableConsiderationAmount: number
Title:
Estimated Variable Consideration Amount
Estimated Variable Consideration Amount -
ExemptCertificateNumber: string
Title:
Exemption Certificate Number
Maximum Length:80
Exempt Certificate Number -
ExemptReason: string
Title:
Exemption Reason
Exempt Reason Name -
ExemptReasonCode: string
Title:
Exemption Reason
Maximum Length:30
Exempt Reason Code -
ExternalKey: string
Maximum Length:
150
The key identifier of the contract line in the external source system. -
ExternalSource: string
Maximum Length:
150
The name of external source system where the contract line is imported from. -
FixedPriceServiceYn: string
Title:
Fixed price
Maximum Length:1
Default Value:N
Indicates that the service has a fixed price. -
FloorPrice: number
Title:
Floor Price
Read Only:true
The floor price of the contract line. -
FOB: string
The FOB of the contract line.
-
FOBCode: string
Title:
FOB
Maximum Length:30
The code that indicates the FOB of the contract line. -
FreightTerms: string
The display name of the freight terms of the contract line.
-
FreightTermsCode: string
Title:
Freight Terms
Maximum Length:30
The code that indicates the freight terms of the contract line. -
HoldReason: string
Title:
Hold Reason
The reason for holding a contract line. -
HoldReasonCode: string
Title:
Hold Reason
Maximum Length:30
The code that indicates the reason for holding a contract line. -
HoldReasonCodeSetId: integer
(int64)
The unique identifier of the set used for the hold reason code of the contract line.
-
HoldReasonSetCode: string
The hold reason set code
-
HoldUntilDate: string
(date)
Title:
Hold Until Date
The date until when the contract line is put of hold. -
Id: integer
(int64)
Contract Line ID
-
ItemDescription: string
Title:
Description
Maximum Length:1995
The description of the contract line item. -
ItemName: string
Title:
Name
Maximum Length:1995
The name of the contract line item. -
ItemNameTxt: string
Title:
Name
Maximum Length:1995
The column that stores the actual name of the contract line item. -
ItemQuantity: number
Title:
Line Quantity
The quantity of the contract line. -
LastRevenueRecogDate: string
(date)
Title:
Last Revenue Recognized Date
The date when the last revenue is recognized. -
LineAmount: number
Title:
Line Total
The total amount of the contract line. -
LineId: integer
(int64)
The unique identifier of the contract line.
-
LineNumber: string
Title:
Number
Maximum Length:150
The line number of the contract. -
LinePuid: string
Title:
Line PUID
Maximum Length:120
Line PUID -
LineStatus: string
Title:
Status
The status of the contract line. -
LineTypeId: integer
(int64)
Title:
Type
The unique identifier of the contract line type. -
LineTypeName: string
Title:
Type
The name of the contract line type. -
LineValueAmount: number
Title:
Line Amount
The value of the contract line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The list price of the contract line. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
The version of the contract line. -
MinimumReleaseAmount: number
Title:
Minimum Release Amount
The minimum release amount per order of the contract line. -
MinimumReleaseQuantity: number
Title:
Minimum Quantity per Order
The minimum release quantity to be shipped per order. -
Object1Id1: integer
(int64)
The unique identifier of the object.
-
Object1Id2: integer
(int64)
The alternate key identifier of the object.
-
OrigSystemReference: string
Maximum Length:
30
The originating system reference of the contract line. -
OrigSystemSourceCode: string
Maximum Length:
30
The source code of the originating system. -
OutputTaxClassificationCode: string
Title:
Classification Code
Maximum Length:50
The code that indicates the classification of the output tax. -
OutputTaxClassMeaning: string
Title:
Classification Code
The classification of the output tax. -
PaymentTerms: string
Title:
Payment Terms
The display name of the payment terms. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
PercentComplete: number
Title:
Percent Complete
The completeness of the contract line in percentage. -
PriceApplicationRule: string
Title:
Price Application Rule
Maximum Length:30
Price Application Rule -
PriceAsOf: string
(date)
Title:
Price as of Date
The date as of which a contract line or asset line is priced. -
PriceBook: string
Title:
Price Book
Price Book -
PriceBookId: integer
(int64)
The unique identifier of the price book.
-
PriceList: string
Title:
Price List
Price List -
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PricingEffectivityDate: string
(date-time)
Read Only:
true
The price effectivity date. -
ProjectContractLineInternalAttributes: array
Contract Line Internal Attributes
Title:
Contract Line Internal Attributes
The contract line internal attributes resource is used to view, create, update, and delete internal contract line attributes. -
PurchasingCategory: string
Title:
Purchasing Category
Purchasing Category -
PurchasingCategoryId: integer
(int64)
Title:
Item Class
The unique identifier of the purchasing category. -
RecInvOrgName: string
Title:
Ship-to Organization
Receiving Inventory Organization Name -
RecvInvOrgId: integer
(int64)
Title:
Ship-to Organization
The unique identifier of the receiving inventory organization. -
RecvLocationId: integer
(int64)
Title:
Ship-to Location
The unique identifier of the receiving location. -
RevenueAmount: string
Title:
Revenue Amount
Read Only:true
The revenue amount of the contract line. -
RevenuePlan: string
Title:
Revenue Plan
The revenue amount of the contract line. -
RevenuePlanExternalKey: string
The revenue plan external key.
-
RevenuePlanExternalSource: string
The revenue plan external source.
-
RevenuePlanId: integer
(int64)
Title:
Revenue Plan
The unique identifier of the revenue plan. -
SalesCredit: array
Sales Credits
Title:
Sales Credits
The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date. -
ShipInvOrgId: integer
(int64)
Title:
Warehouse
The unique identifier of the ship inventory organization. -
ShipToAccount: string
Title:
Ship-to Party
The name of the ship-to account. -
ShipToAccountId: integer
(int64)
Title:
Ship-to Account
The unique identifier of the ship-to account. -
ShipToAccountNumber: string
Title:
Ship-to Account Number
The alternate unique identifier of the Ship-to site. -
ShipToOrgLocation: string
Title:
Ship-to Location
The location of the Ship-to organization. -
ShipToSite: string
Title:
Ship-to Site
The display name of the Ship-to site. -
ShipToSiteUseId: integer
(int64)
Title:
Ship-to Site
The unique identifier of the Ship-to site. -
SourceDocumentId: integer
(int64)
Title:
Source Document Number
Source Document Id -
SourceDocumentLineId: integer
(int64)
Title:
Source Document Line Number
Source Document Line Id -
SourceDocumentSystemCode: string
Title:
Source Application
Maximum Length:30
Source Application Code -
SourceSystemAttributes: string
(byte)
Source System Attributes
-
StandaloneSellingPrice: number
Title:
Standalone Selling Price
Standalone Selling Price -
StartDate: string
(date)
Title:
Start Date
The date when the contract line was created. -
StsCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code that indicates the status of the contract line. -
Supplier: string
Title:
Supplier
The name of the supplier. -
SupplierId: integer
(int64)
Title:
Supplier
The unique identifier of the supplier. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site
The unique identifier of the supplier's address. -
SupplierSiteName: string
Title:
Supplier Address
The address of the supplier. -
TaxAmount: number
The tax amount of the contract line.
-
TaxExemptionControl: string
Title:
Exemption Handling
Maximum Length:30
The code that indicates the reason for tax exemption. -
TaxExemptionControlMeaning: string
The reason of the tax exemption.
-
TrnCode: string
Title:
Close Reason
Maximum Length:30
The unique identifier of the set used for the hold reason code of the contract line. -
TrnCodeSetId: integer
(int64)
The unique identifier of the set used for cancel or close reason code of the contract line.
-
TrnSetCode: string
The transaction set code.
-
UnitOfMeasure: string
Title:
UOM
Unit Of Measure -
UnitPrice: number
Title:
Unit Price
The unit price of the contract line. -
UOMCode: string
Title:
UOM
Maximum Length:15
The code that indicates the Unit Of Measure of a contract line. -
VendorSiteId: integer
Read Only:
true
The unique identifier of the vendor site. -
WareHouse: string
Title:
Warehouse
The warehouse of the contract line.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Flag to check if linkage is still valid -
CurrencyCode: string
Title:
Contract Currency
The currency code. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Reference key in External source -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
External Source Key -
FundingAmount: number
Title:
Contract Funding
Linkage funding amount -
LastRevRecogDate: string
(date)
Title:
Last Revenue Recognized Date
Read Only:true
The date revenue was last recognized for this associated project within this contract line. -
LinkId: integer
(int64)
Title:
Contract Project Association ID
The unique identifier of the Contract project linkage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Contract Version on which linkage is defined -
PercentComplete: number
Title:
Percent Complete
Percentage Complete -
ProjectId: integer
(int64)
Title:
Project ID
Project Identifier for the project on Linkage -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Project Number of the project on Linkage -
ProjElementId: integer
(int64)
Title:
Project Task ID
Task Identifier for the the task on linkage -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Task Number of the Task on the linkage
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-BillingControl-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the billing control is active. -
BillingControlId: integer
(int64)
The unique identifier of the billing control.
-
BillingResource: string
Title:
Billing Resource
The Resource Breakdown structure Element for which Billing control is defined. -
EndDate: string
(date)
Title:
End Date
The date when the billing control ends. -
ExternalReferenceKey: string
Maximum Length:
150
The reference key in the external source. -
ExternalSourceKey: string
Maximum Length:
150
The external source key of the billing control. -
HardLimitAmount: number
Title:
Hard Limit
The hard limit for the billing control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
The contract version of the billing control.
-
RbsElementId: integer
(int64)
Title:
Billing Resource ID
The identifier of the Resource Breakdown structure Element for which Billing control is defined. -
SoftLimitAmount: number
Title:
Soft Limit
The soft limit for the billing control. -
StartDate: string
(date)
Title:
Start Date
The date when the billing control starts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-ContractAllLineDesFlexVA-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
LineId: integer
(int64)
Line Id
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-ContractLineTranslation-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
1995
Contract Line Comments -
Id: integer
Contract Line ID
-
ItemDescription: string
Maximum Length:
1995
Item Description -
ItemName: string
Maximum Length:
1995
Item Name -
Language: string
Maximum Length:
12
Indicates the code of the language into which the contents of the translatable columns are translated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Major Version
-
SourceLanguage: string
Maximum Length:
12
Source Language
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-ProjectContractLineInternalAttributes-item-response
Type:
Show Source
object
-
ContractId: integer
Unique identifier of the contract.
-
ContractLineId: integer
Unique identifier of the contract line.
-
ControlMilestoneDatesFlag: boolean
Maximum Length:
1
Indicates whether project managers can change the planned finish date of a milestone once created in the project plan. The default value is Y, which allows project managers to manage planned finish dates for milestones in the project plan. -
ExpenditureTypeId: integer
Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
-
ExpenditureTypeName: string
Title:
Expenditure Type Name
Maximum Length:240
Name of the expenditure type that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line. -
ExpOrgSourceFlag: boolean
Title:
Use original task owning organization
Maximum Length:20
Indicates whether the expenditure organization populated on the intercompany invoice line sent to payables comes from the task owning organization on the original expenditure item or the expenditure organization on the intercompany contract line. -
ExpTypeOrigEiFlag: boolean
Title:
Use original expenditure type
Maximum Length:1
Indicates whether the expenditure type populated on the internal invoice line sent to payables comes from the expenditure type on the original expenditure item or the expenditure type on the internal contract line.. -
ExternalReferenceKey: string
Maximum Length:
150
The external reference key. -
ExternalSourceKey: string
Maximum Length:
150
The external source key. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.
-
OrganizationId: integer
Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
-
OrganizationName: string
Title:
Expenditure Organization Name
Maximum Length:240
Name of the organization that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line. -
ProviderBusinessUnitId: integer
Title:
Provider Business Unit ID
Unique identifier for the business unit that provides goods or services which are charged using the internal contract line. -
ProviderBusinessUnitName: string
Title:
Provider Business Unit Name
Maximum Length:240
Name of the business unit that provides goods or services which are charged using the internal contract line. -
RcvrBusinessUnitId: integer
(int64)
The unique identifier of the receiver business unit.
-
RcvrBusinessUnitName: string
Title:
Receiver Business Unit
Maximum Length:240
The receiver business unit name. -
ReceiverProjectId: integer
Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
-
ReceiverProjectName: string
Title:
Receiver Project Name
Maximum Length:240
Name of the project that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line. -
ReceiverTaskId: integer
Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
-
ReceiverTaskName: string
Title:
Receiver Task Name
Maximum Length:255
Name of the task that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-SalesCredit-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:false
Active Flag -
EndDate: string
(date)
Title:
End Date
sales Credit End Date -
ExternalReferenceKey: string
Maximum Length:
120
External Reference Key -
ExternalSourceKey: string
Maximum Length:
120
External Source Key -
Id: integer
(int64)
Sales Credit Id
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Major Version
-
Percent: number
Title:
Percent
Sales Credit Percent -
SalesCreditPuid: string
Title:
Sales Credit PUID
Maximum Length:120
sales Credit PUID -
SalesCreditType: string
Maximum Length:
240
Sales Credit Type -
SalesCreditTypeId: integer
Title:
Credit Type
Sales Credit Type Id -
SalesrepId: integer
(int64)
Salesrep Id
-
SalesrepName: string
Title:
Salesperson
Maximum Length:360
Sales Representative Name -
StartDate: string
(date)
Title:
Start Date
sales Credit Start Date
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractParty-item-response
Type:
Show Source
object
-
ContractClass: string
Maximum Length:
80
The contract class. -
ContractPartyContact: array
Contract Party Contacts
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. -
ContractPartyFlexfieldVA: array
Contract Party Flexfields
Title:
Contract Party Flexfields
The contract party flex fields is used to view, create, update contract party flex field information. -
DeleteFlag: boolean
Default Value:
false
Delete Flag -
ExternalKey: string
Maximum Length:
120
The key identifier of the contract party in the external source system. -
ExternalSource: string
Maximum Length:
120
The name of external source system where the contract party is imported from. -
HeaderStartDate: string
Read Only:
true
The header start date. -
Id: integer
(int64)
The unique identifier of the contract party.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
The version of the contract party. -
PartyId: integer
(int64)
The unique identifier of the contract party.
-
PartyName: string
Title:
Name
The name of the contract party. -
PartyNameLOVSwitcher: string
The party name LOV switcher.
-
PartyRoleCode: string
Title:
Role
Maximum Length:30
The code that indicates the party role. -
PartyRolePuid: string
Title:
Party Role PUID
Maximum Length:120
Party Role PUID -
Role: string
The name of the party role.
-
SignedBy: string
Title:
Signed By
Maximum Length:100
The party that signed the contract. -
SignedDate: string
(date)
Title:
Signed Date
The date on which the party signed the contract. -
SignerRole: string
Title:
Signer Role
Maximum Length:100
Signer Role
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-item-response
Type:
Show Source
object
-
AccessLevel: string
Title:
Access
Maximum Length:30
The access level of a contract party contact. -
AccessLevelName: string
The name of the access level of the contract party contact.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactPuid: string
Title:
Party Contact PUID
Maximum Length:120
Contact PUID -
ContactRoleCode: string
Title:
Role
Maximum Length:30
The code indicating the role of the contract party contact. -
ContractPartyContactFlexfieldVA: array
Contract Party Contact Flexfields
Title:
Contract Party Contact Flexfields
The contract party contact flex field resource is used to view, create, update contract party contact flex field information. -
EndDate: string
(date)
Title:
End Date
End Date -
ExternalKey: string
Maximum Length:
120
The key identifier of the contract party contact in the external source system. -
ExternalSource: string
Maximum Length:
120
The name of external source system where the contract party contact is imported from. -
Id: integer
(int64)
The unique identifier of the contract party contact.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
The version of the contract party contact. -
OwnerFlag: boolean
Title:
Owner
indicates whether the contact is the owner of the contract. -
PartyContactName: string
The name of the contract party contact.
-
Role: string
The role of the contract party contact.
-
RoutingSequence: number
Title:
Signing Sequence
Signing Sequence -
SignatureRole: string
Title:
Signature Role
Maximum Length:30
Signatory Role Code -
SignatureRoleMeaning: string
Signatory Role
-
SignerSequence: integer
Title:
Display Sequence
Singer Sequence -
StartDate: string
(date)
Title:
Start Date
Start Date
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:90
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
Contract Party Contact Flexfield ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
Major Version
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyFlexfieldVA-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:90
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
Contract Party Flexfield ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
Major Version
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RelatedDocument-item-response
Type:
Show Source
object
-
Attribute26: string
Maximum Length:
150
The attribute26. -
BuyOrSell: string
Title:
Intent
Read Only:true
Maximum Length:3
The intent flag. -
ChrId: integer
(int64)
The contract ID
-
CleId: integer
(int64)
The contract line ID
-
Cognomen: string
Title:
Name
Read Only:true
Maximum Length:300
The contract name. -
ContractHeaderId: integer
(int64)
Read Only:
true
The contract header ID. -
ContractId: integer
(int64)
Read Only:
true
Related Document Unique ID -
ContractMajorVersion: integer
(int64)
Title:
Version
Read Only:true
Default Value:1
The contract major version. -
ContractNumber: string
Title:
Document Reference
Maximum Length:120
Related Contract Number -
ContractTypeDescription: string
Read Only:
true
Maximum Length:1995
The contract type description. -
ContractTypeId: integer
Read Only:
true
The contract type ID. -
CreateEnableFlag: boolean
The create enable flag.
-
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency code. -
DeleteEnableFlag: boolean
The delete enable flag.
-
Description: string
Title:
Description
Read Only:true
Maximum Length:1995
The description. -
DocumentTypeNew: string
Title:
Document Type
The document type new. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The end date. -
EstimatedAmount: number
Title:
Amount
Read Only:true
Default Value:0
The estimated amount. -
ExternalKey: string
Maximum Length:
120
External Key -
ExternalSource: string
Maximum Length:
120
External Source -
Id: integer
(int64)
Related Document ID
-
IntentMeaning: string
Title:
Intent
Maximum Length:80
The intent. -
JtotObject1Code: string
Maximum Length:
30
Default Value:OKX_ECMCONTRACT
The jtot object1 code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The object version number1. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The object version number2. -
OrgName: string
Read Only:
true
The org name. -
RelatedContractId: integer
(int64)
Title:
Document Reference
Related Contract ID -
RelatedObjPuid: string
Title:
Related Object PUID
Maximum Length:120
The related obj PUID. -
Relationship: string
Relationship name
-
RelationshipCode: string
Title:
Relationship
Maximum Length:30
Relationship Code -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The start date. -
StsCode: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:DRAFT
The status code. -
Type: string
Read Only:
true
Maximum Length:150
The type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-item-response
Type:
Show Source
object
-
BillMethodId: integer
(int64)
Title:
Bill Method ID
Identifier of the Revenue Method -
BillMethodName: string
Title:
Revenue Method Name
Maximum Length:30
Revenue Method name -
BillPlanId: integer
(int64)
Title:
Bill Plan ID
Revenue Plan Identifier -
BillPlanName: string
Title:
Bill Plan Name
Maximum Length:30
Revenue Plan name -
BurdenSchedule: string
Title:
Burden Schedule
Maximum Length:30
burden schedule on the Revenue plan -
BurdenSchFixedDate: string
(date)
Title:
Burden Schedule Fixed Date
The fixed date used to determine the effective rates of the burden schedule. -
BurdenSchId: integer
(int64)
Title:
Burden Schedule ID
Identifier of the burden schedule -
EnableLbrBillXtnsnFlag: boolean
Title:
Enable Labor Billing Extension
Maximum Length:1
Flag to allow usage of Labor Billing extensions -
EnableNlBillXtnsnFlag: boolean
Title:
Enable Nonlabor Billing Extension
Maximum Length:1
Flag to allow uasage of non labor Billing extensions -
ExternalReferenceKey: string
Maximum Length:
150
Reference key in External source -
ExternalSourceKey: string
Maximum Length:
150
External Source Key -
JobAssignmentOverride: array
Job Assignment Overrides
Title:
Job Assignment Overrides
The resource is used to view, create, update, delete job assignment override details -
JobBillRateSchId: integer
(int64)
Title:
Job Rate Schedule ID
Identifier of the job bill rate schedule -
JobRateOverride: array
Job Rate Overrides
Title:
Job Rate Overrides
The resource is used to view, create, update, delete job rate override details. -
JobRateSchedule: string
Title:
Job Rate Schedule
Maximum Length:30
Job bill rate schedule -
LaborBillBasisCode: string
Title:
Labor Cost Basis Code
Maximum Length:30
Labor cost basis code for cost reimbursable -
LaborCostBasis: string
Title:
Labor Cost Basis
Maximum Length:80
Labor cost basis for cost reimbursable -
LaborDiscountPercentage: number
Title:
Labor Discount Percentage
The percentage to be discounted from the standard labor bill rate schedule. -
LaborDiscountReasonCode: string
Title:
Labor Discount Reason Code
Maximum Length:30
Labor rate change reason code -
LaborMarkupPercentage: number
Title:
Labor Markup Percentage
Labor Markup Percentage -
LaborMultiplierOverride: array
Labor Multiplier Overrides
Title:
Labor Multiplier Overrides
The resource is used to view, create, update, delete labor multiplier override details. -
LaborRateChangeReason: string
Title:
Labor Rate Change Reason
Maximum Length:80
Labor rate change reason -
LaborSchFixedDate: string
(date)
Title:
Labor Schedule Fixed Date
The fixed date used to determine the effective bill rates of the standard labor bill rate schedule. -
LaborTpScheduleId: integer
Title:
Labor Transfer Price Schedule ID
Labor Schedule Identifier for Inter Company Transfer Price. -
LaborTpSchFixedDate: string
(date)
Title:
Labor Transfer Price Schedule Fixed Date
The fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule. -
LaborTransferPriceSchedule: string
Title:
Labor Transfer Price Schedule
Maximum Length:50
Labor Schedule for Inter Company Transfer Price. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Contract Major version on which Revenue plan is defined
-
NlBillBasisCode: string
Title:
Nonlabor Cost Basis Code
Maximum Length:30
Non Labor cost basis code for cost reimbursable -
NlBillRateSchId: integer
(int64)
Title:
Nonlabor Rate Schedule ID
Identifier of the non labor bill rate schedule -
NlDiscountPercentage: number
Title:
Nonlabor Discount Percentage
The percentage to be discounted from the standard non labor bill rate schedule. -
NlDiscountReasonCode: string
Title:
Nonlabor Discount Reason Code
Maximum Length:30
Non labor rate change reason code -
NlMarkupPercentage: number
Title:
Nonlabor Markup Percentage
Nonlabor Markup Percentage -
NlSchFixedDate: string
(date)
Title:
Nonlabor Schedule Fixed Date
The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule. -
NlTpScheduleId: integer
Title:
Nonlabor Transfer Price Schedule ID
Non Labor Schedule Identifier for Inter Company Transfer Price. -
NlTpSchFixedDate: string
(date)
Title:
Nonlabor Transfer Price Schedule Fixed Date
The fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule. -
NonlaborCostBasis: string
Title:
Nonlabor Cost Basis
Maximum Length:80
Non Labor cost basis for cost reimbursable -
NonlaborRateChangeReason: string
Title:
Nonlabor Rate Change Reason
Maximum Length:80
Nonlabor rate change reason -
NonLaborRateOverride: array
Non Labor Rate Overrides
Title:
Non Labor Rate Overrides
The resource is used to view, create, update, delete non labor multiplier override details. -
NonlaborRateSchedule: string
Title:
Nonlabor Rate Schedule
Maximum Length:30
Non labor bill rate schedule -
NonlaborTransferPriceSchedule: string
Title:
Nonlabor Transfer Price Schedule
Maximum Length:50
Non Labor Schedule for Inter Company Transfer Price. -
OnHoldFlag: boolean
Title:
On Hold
Maximum Length:1
Default Value:false
Flag to check if Revenue plan can be used to recognize revenue. -
PersonBillRateSchId: integer
(int64)
Title:
Person Rate Schedule ID
Identifier of the employee bill rate schedule -
PersonRateOverride: array
Person Rate Overrides
Title:
Person Rate Overrides
The resource is used to view, create, update, delete person rate override details. -
PersonRateSchedule: string
Title:
Person Rate Schedule
Maximum Length:30
Employee bill rate schedule -
RevenuePlanDescriptiveFlexField: array
Revenue Plan Flexfields
Title:
Revenue Plan Flexfields
The revenue plan flexfields resource is used to view, create, update, and delete contract revenue plan flexfield information. -
RevenuePlanTranslation: array
Revenue Plan Translations
Title:
Revenue Plan Translations
The revenue plan transactions resource is used to view and update contract revenue plan translation information.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
BillingTitle: string
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. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the job assignment override is defined. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
The contract line for which the job assignment override is defined. -
EmailAddress: string
Title:
Email
Maximum Length:240
The email address for whom the job assignment override is defined. -
EndDateActive: string
(date)
Title:
End Date
The date to which a job assignment override applies. -
ExternalReferenceKey: string
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. -
ExternalSourceKey: string
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. -
JobAssignmentOverrideId: integer
(int64)
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. -
JobCode: string
Title:
Job Code
The job code of the override being assigned to the person for this bill or revenue plan. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the override job being assigned to the person for this bill or revenue plan. -
JobName: string
Title:
Job Name
Maximum Length:240
The job name of the override being assigned to the person for this bill or revenue plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
The version of the contract containing this particular set of job assignment override details. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person for whom the job assignment override is defined. -
PersonName: string
Title:
Person
Maximum Length:2000
The person for whom the job assignment override is defined. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
The person number for whom the job assignment override is defined. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a job assignment override applies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-JobRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Job Rate Override ID
Unique identifier of the bill rate override. -
BillRateUnitCode: string
Title:
Unit of Measure
Read Only:true
Maximum Length:30
Default Value:HOURS
The bill rate unit code. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount Percentage
Discount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End Date
Date till which bill rate override is effective. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
JobCode: string
Title:
Job Code
Code of the job for which bill rate is being overriden. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the job for which bill rate is being overridden. -
JobName: string
Title:
Job
Maximum Length:240
Name of the job for which bill rate is being overridden. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
Rate: number
Title:
Rate
Amount billed to the customer for an item. -
RateCurrency: string
Title:
Currency
Maximum Length:80
Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Discount Reason
Maximum Length:80
Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Discount Reason
Maximum Length:30
Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start Date
Date from which bill rate override is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-LaborMultiplierOverride-item-response
Type:
Show Source
object
-
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the labor multiplier override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which labor mutliplier override applies. -
EndDateActive: string
(date)
Title:
End Date
The date to which a labor multiplier override applies. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
LaborMultiplier: number
Title:
Multiplier
Labor multiplier. -
LaborMultiplierId: integer
(int64)
Title:
Labor Multiplier ID
Unique identifier of the labor multiplier override on the bill plan or revenue plan that identifies the negotiated value to be multiplied by the cost rate for labor. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Version of the contract containing this particular set of labor multiplier override details. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a labor multiplier override applies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-NonLaborRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Nonlabor Rate Override ID
Unique identifier of the bill rate override. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount Percentage
Discount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End Date
Date till which bill rate override is effective. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Unique identifier of the expenditure type for which the bill rate is being overridden. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Expenditure type name for which the bill rate is being overridden. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
MarkupPercentage: number
Title:
Markup Percentage
Markup percentage applied to the bill rate. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Unique identifier of the non labor resource for which the bill rate is being overridden. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
Non labor resource name for which the bill rate is being overridden. -
OrganizationId: integer
(int64)
Title:
Organization ID
Unique identifier of the organization for which the bill rate overrides are being defined. -
OrganizationName: string
Title:
Organization
Maximum Length:240
Name of the organization for which the bill rate overrides are being defined. -
Rate: number
Title:
Rate
Amount billed to the customer for an item. -
RateCurrency: string
Title:
Currency
Maximum Length:80
Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Rate Change Reason
Maximum Length:80
Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Rate Change Reason Code
Maximum Length:30
Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start Date
Date from which bill rate override is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-PersonRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Person Rate Override ID
Unique identifier of the bill rate override. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount Percentage
Discount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End Date
Date till which bill rate override is effective. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
PersonEmail: string
Title:
Person Email
Maximum Length:240
Email of the person whose bill rate is being overridden. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person whose bill rate is being overridden. -
PersonName: string
Title:
Person
Maximum Length:240
Name of the person whose bill rate is being overridden. -
Rate: number
Title:
Rate
Amount billed to the customer for an item. -
RateCurrency: string
Title:
Currency
Maximum Length:80
Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Rate Change Reason
Maximum Length:80
Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Rate Change Reason Code
Maximum Length:30
Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start Date
Date from which bill rate override is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanDescriptiveFlexField-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
BillPlanId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanTranslation-item-response
Type:
Show Source
object
-
BillPlanDesc: string
Maximum Length:
240
The revenue plan description. -
BillPlanId: integer
(int64)
Bill Plan Identifier
-
BillPlanName: string
Maximum Length:
30
Bill Plan Name -
InvoiceComment: string
Maximum Length:
240
Comments of the Invoice -
InvoiceInstructions: string
Maximum Length:
240
Invoice Instructions -
Language: string
Maximum Length:
4
Translation Language -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Contract version of the Bill Plan Translation
-
ObjectVersionNumber: integer
(int32)
The revenue plan object version.
-
SourceLang: string
Maximum Length:
4
Source Language
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-SalesCredit-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:false
Active Flag -
EndDate: string
(date)
Title:
End Date
sales Credit End Date -
ExternalReferenceKey: string
Maximum Length:
120
External Reference Key -
ExternalSourceKey: string
Maximum Length:
120
External Source Key -
Id: integer
(int64)
Sales Credit Id
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Major Version
-
Percent: number
Title:
Percent
Sales Credit Percent -
SalesCreditPuid: string
Title:
Sales Credit PUID
Maximum Length:120
sales Credit PUID -
SalesCreditType: string
Maximum Length:
240
Sales Credit Type -
SalesCreditTypeId: integer
Title:
Credit Type
Sales Credit Type Id -
SalesrepId: integer
(int64)
Salesrep Id
-
SalesrepName: string
Title:
Salesperson
Maximum Length:360
Sales Representative Name -
StartDate: string
(date)
Title:
Start Date
sales Credit Start Date
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-Section-item-response
Type:
Show Source
object
-
Alignment: string
Maximum Length:
80
The alignment. -
Clause: array
Clauses
Title:
Clauses
The resource is used to view the clauses of the contract terms. -
Description: string
Title:
Description
Maximum Length:2000
The description. -
Heading: string
Title:
Section
Maximum Length:300
The heading. -
Id: integer
The unique identifier of the section.
-
Label: string
Maximum Length:
60
The label. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScnId: number
The section ID.
-
SkipNumbering: string
Maximum Length:
1
The skip numbering flag. -
StartOnNewPage: string
Maximum Length:
1
The start on new page flag. -
SubSection: array
Sub Sections
Title:
Sub Sections
The resource is used to view the sub sections of the contract terms. -
SuppressScnNamePrint: string
Maximum Length:
1
The suppress section name print flag.
Nested Schema : Clauses
Type:
array
Title:
Clauses
The resource is used to view the clauses of the contract terms.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ArticleId: integer
(int64)
Read Only:
true
The clause ID. -
ArticleVersionId: number
Read Only:
true
The clause version ID. -
ArticleVersionNumber: integer
(int64)
Read Only:
true
The clause version number. -
ClauseDescription: string
Read Only:
true
Maximum Length:2000
The clause description. -
ClauseDisplayTitle: string
Read Only:
true
Maximum Length:450
The clause display title. -
ClauseLabel: string
Read Only:
true
Maximum Length:60
The clause label. -
ClauseNumber: string
Read Only:
true
Maximum Length:240
The clause number. -
ClauseSection: string
Read Only:
true
Maximum Length:300
The clause section. -
ClauseTextInHTML: string
(byte)
Read Only:
true
The clause title in HTML. -
ClauseTextInWord: string
(byte)
Read Only:
true
The clause title in Word. -
ClauseTitle: string
Read Only:
true
Maximum Length:450
The clause title. -
ClauseType: string
The clause type.
-
ContractExpertFlag: boolean
Read Only:
true
Maximum Length:1
The contract expert flag. -
DocumentId: number
Read Only:
true
The document ID. -
Id: integer
(int64)
Read Only:
true
The unqiue identifier of the clause. -
IncludeByReferenceFlag: boolean
Read Only:
true
Maximum Length:1
The include by reference flag. -
Instructions: string
Read Only:
true
Maximum Length:2000
The instructions for the clause. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Read Only:
true
The major version associated with the clause. -
MandatoryFlag: boolean
Read Only:
true
Maximum Length:1
The mandatory flag. -
NonstandardFlag: boolean
Read Only:
true
Maximum Length:1
The non standard flag. -
ProtectedTextFlag: boolean
Read Only:
true
Maximum Length:1
The protected text flag. -
ScnId: number
Read Only:
true
The section ID. -
SkipNumberingFlag: boolean
Read Only:
true
Maximum Length:1
The skip numbering flag. -
SuppressTitleFlag: boolean
Read Only:
true
Maximum Length:1
The suppress title flag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-Section-SubSection-item-response
Type:
Show Source
object
-
Alignment: string
Maximum Length:
80
The alignment. -
Description: string
Title:
Description
Maximum Length:2000
The description. -
Heading: string
Title:
Section
Maximum Length:300
The heading. -
Id: integer
The unique identifier of the section.
-
Label: string
Maximum Length:
60
The label. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScnId: number
The section ID.
-
SkipNumbering: string
Maximum Length:
1
The skip numbering flag. -
StartOnNewPage: string
Maximum Length:
1
The start on new page flag. -
SuppressScnNamePrint: string
Maximum Length:
1
The suppress section name print flag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-SupportingDocuments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The async tracker ID of the internal shared document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached internal shared document. -
CategoryName: string
Title:
Category
Maximum Length:30
The code for the category to which the internal shared document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the internal shared document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the internal shared document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the internal shared document was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that identifies if the external shared document is a file or a URL. -
Description: string
Title:
Description
Maximum Length:255
The description of the internal shared document. -
DmDocumentId: string
Maximum Length:
255
The Dm document id of the internal shared document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The Dm folder path of the internal shared document. -
DmVersionNumber: string
Maximum Length:
255
The Dm version number of the internal shared document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error status code for the internal shared document. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the internal shared document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the internal shared document. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the internal shared document. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the internal shared document. A file name or URL is required. -
FileUrl: string
Title:
File Url
The URL location of the internal shared document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the internal shared document was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The login user name associated with the user who last updated the internal shared document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the internal shared document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the internal shared document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The uploaded file content type of the internal shared document. -
UploadedFileLength: integer
Title:
File Size
The uploaded file length of the internal shared document. -
UploadedFileName: string
Title:
Uploaded File Name
The uploaded file name of the internal shared document. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the internal shared document. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the internal shared document. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the internal shared document. A file name or URL is required. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The name of the category to which the internal shared document is assigned.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- 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. - contractsUniqID:
- 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. - contractsUniqID:
- 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. - contractsUniqID:
- ContractHeaderFlexfieldVA
-
Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderFlexfieldVAParameters:
- contractsUniqID:
$request.path.contractsUniqID
The contract header flex field resource is used to view, create, update contract header flex field information. - contractsUniqID:
- ContractHeaderTranslation
-
Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderTranslationParameters:
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, update contract header translation information. - contractsUniqID:
- 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. - contractsUniqID:
- 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. - contractsUniqID:
- ExternalSharedDocuments
-
Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocumentsParameters:
- 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. - contractsUniqID:
- InternalSharedDocuments
-
Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocumentsParameters:
- 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. - contractsUniqID:
- RelatedDocument
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete related contracts information. - contractsUniqID:
- 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. - contractsUniqID:
- 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. - contractsUniqID:
- Section
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view the sections of the contract terms. - contractsUniqID:
- 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. - contractsUniqID:
- amend
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you amend a contract. This can be done only for an active contract. - contractsUniqID:
- applyHold
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you apply hold on a contract. - contractsUniqID:
- cancel
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you cancel a contract with the specified reason. - contractsUniqID:
- close
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you close the specified contract with the given reason on a date. - contractsUniqID:
- 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. - contractsUniqID:
- duplicate
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you duplicate an existing contract while selecting which portions of the contract are duplicated. - contractsUniqID:
- preview
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you generate a preview of the contract in PDF, HTML, or RTF format. - contractsUniqID:
- removeHold
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you remove hold on a contract on a given date. - contractsUniqID:
- revertContract
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you revert a contract amendment. - contractsUniqID:
- 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. - contractsUniqID:
- 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. - contractsUniqID:
- validateContract
-
Parameters:
- contractsUniqID:
$request.path.contractsUniqID
This method lets you validate a contract and returns errors and warnings as a string. - contractsUniqID:
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" : [ { … } ] }