Create revenue plans
post
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan
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.
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BillMethodId(required): integer
(int64)
Title:
Bill Method ID
Identifier of the Revenue Method -
BillMethodName(required): string
Title:
Revenue Method Name
Maximum Length:30
Revenue Method name -
BillPlanId: integer
(int64)
Title:
Bill Plan ID
Revenue Plan Identifier -
BillPlanName(required): 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. -
MajorVersion(required): 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 : 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-post-request
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. -
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 : contracts-RevenuePlan-JobRateOverride-item-post-request
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Job 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. -
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. -
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 : schema
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. -
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 : contracts-RevenuePlan-NonLaborRateOverride-item-post-request
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. -
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 : schema
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. -
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 : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
BillPlanId: integer
(int64)
-
MajorVersion: integer
(int64)
Nested Schema : contracts-RevenuePlan-RevenuePlanTranslation-item-post-request
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 -
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
Response
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-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 : 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-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
Links
- JobAssignmentOverride
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete job assignment override details - RevenuePlanUniqID:
- JobRateOverride
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete job rate override details. - RevenuePlanUniqID:
- LaborMultiplierOverride
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete labor multiplier override details. - RevenuePlanUniqID:
- NonLaborRateOverride
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete non labor multiplier override details. - RevenuePlanUniqID:
- PersonRateOverride
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete person rate override details. - RevenuePlanUniqID:
- RevenuePlanDescriptiveFlexField
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The revenue plan flexfields resource is used to view, create, update, and delete contract revenue plan flexfield information. - RevenuePlanUniqID:
- RevenuePlanTranslation
-
Parameters:
- RevenuePlanUniqID:
$request.path.RevenuePlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The revenue plan transactions resource is used to view and update contract revenue plan translation information. - RevenuePlanUniqID: