Get revenue plans
get
/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.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the revenue plan with the specified revenue plan ID and major version.
Finder Variables:- BillPlanId; integer; The revenue plan identifier.
- MajorVersion; integer; The revenue plan major version.
- RevenuePlanExtAltKey: Finds the revenue plan with external alternate key.
Finder Variables:- ExternalReferenceKey; string.
- ExternalSourceKey; string.
- PrimaryKey: Finds the revenue plan with the specified revenue plan ID and major version.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BillMethodId; integer; Identifier of the Revenue Method
- BillMethodName; string; Revenue Method name
- BillPlanId; integer; Revenue Plan Identifier
- BillPlanName; string; Revenue Plan name
- BurdenSchFixedDate; string; The fixed date used to determine the effective rates of the burden schedule.
- BurdenSchId; integer; Identifier of the burden schedule
- BurdenSchedule; string; burden schedule on the Revenue plan
- EnableLbrBillXtnsnFlag; boolean; Flag to allow usage of Labor Billing extensions
- EnableNlBillXtnsnFlag; boolean; Flag to allow uasage of non labor Billing extensions
- ExternalReferenceKey; string; Reference key in External source
- ExternalSourceKey; string; External Source Key
- JobBillRateSchId; integer; Identifier of the job bill rate schedule
- JobRateSchedule; string; Job bill rate schedule
- LaborBillBasisCode; string; Labor cost basis code for cost reimbursable
- LaborCostBasis; string; Labor cost basis for cost reimbursable
- LaborDiscountPercentage; number; The percentage to be discounted from the standard labor bill rate schedule.
- LaborDiscountReasonCode; string; Labor rate change reason code
- LaborMarkupPercentage; number; Labor Markup Percentage
- LaborRateChangeReason; string; Labor rate change reason
- LaborSchFixedDate; string; The fixed date used to determine the effective bill rates of the standard labor bill rate schedule.
- LaborTpSchFixedDate; string; The fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule.
- LaborTpScheduleId; integer; Labor Schedule Identifier for Inter Company Transfer Price.
- LaborTransferPriceSchedule; string; Labor Schedule for Inter Company Transfer Price.
- MajorVersion; integer; Contract Major version on which Revenue plan is defined
- NlBillBasisCode; string; Non Labor cost basis code for cost reimbursable
- NlBillRateSchId; integer; Identifier of the non labor bill rate schedule
- NlDiscountPercentage; number; The percentage to be discounted from the standard non labor bill rate schedule.
- NlDiscountReasonCode; string; Non labor rate change reason code
- NlMarkupPercentage; number; Nonlabor Markup Percentage
- NlSchFixedDate; string; The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule.
- NlTpSchFixedDate; string; The fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule.
- NlTpScheduleId; integer; Non Labor Schedule Identifier for Inter Company Transfer Price.
- NonlaborCostBasis; string; Non Labor cost basis for cost reimbursable
- NonlaborRateChangeReason; string; Nonlabor rate change reason
- NonlaborRateSchedule; string; Non labor bill rate schedule
- NonlaborTransferPriceSchedule; string; Non Labor Schedule for Inter Company Transfer Price.
- OnHoldFlag; boolean; Flag to check if Revenue plan can be used to recognize revenue.
- PersonBillRateSchId; integer; Identifier of the employee bill rate schedule
- PersonRateSchedule; string; Employee bill rate schedule
- ProjectRoleBillRateSchId; integer; Unique identifier of the project role bill rate schedule
- ProjectRoleRateScheduleName; string; The project role bill rate schedule name
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context: string
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: string
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-RevenuePlan
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 IDIdentifier of the Revenue Method -
BillMethodName: string
Title:
Revenue Method NameMaximum Length:30Revenue Method name -
BillPlanId: integer
(int64)
Title:
Bill Plan IDRevenue Plan Identifier -
BillPlanName: string
Title:
Bill Plan NameMaximum Length:30Revenue Plan name -
BurdenSchedule: string
Title:
Burden ScheduleMaximum Length:30burden schedule on the Revenue plan -
BurdenSchFixedDate: string
(date)
Title:
Burden Schedule Fixed DateThe fixed date used to determine the effective rates of the burden schedule. -
BurdenSchId: integer
(int64)
Title:
Burden Schedule IDIdentifier of the burden schedule -
EnableLbrBillXtnsnFlag: boolean
Title:
Enable Labor Billing ExtensionMaximum Length:1Flag to allow usage of Labor Billing extensions -
EnableNlBillXtnsnFlag: boolean
Title:
Enable Nonlabor Billing ExtensionMaximum Length:1Flag to allow uasage of non labor Billing extensions -
ExternalReferenceKey: string
Maximum Length:
150Reference key in External source -
ExternalSourceKey: string
Maximum Length:
150External Source Key -
JobAssignmentOverride: array
Job Assignment Overrides
Title:
Job Assignment OverridesThe resource is used to view, create, update, delete job assignment override details -
JobBillRateSchId: integer
(int64)
Title:
Job Rate Schedule IDIdentifier of the job bill rate schedule -
JobRateOverride: array
Job Rate Overrides
Title:
Job Rate OverridesThe resource is used to view, create, update, delete job rate override details. -
JobRateSchedule: string
Title:
Job Rate ScheduleMaximum Length:30Job bill rate schedule -
LaborBillBasisCode: string
Title:
Labor Cost Basis CodeMaximum Length:30Labor cost basis code for cost reimbursable -
LaborCostBasis: string
Title:
Labor Cost BasisMaximum Length:80Labor cost basis for cost reimbursable -
LaborDiscountPercentage: number
Title:
Labor Discount PercentageThe percentage to be discounted from the standard labor bill rate schedule. -
LaborDiscountReasonCode: string
Title:
Labor Discount Reason CodeMaximum Length:30Labor rate change reason code -
LaborMarkupPercentage: number
Title:
Labor Markup PercentageLabor Markup Percentage -
LaborMultiplierOverride: array
Labor Multiplier Overrides
Title:
Labor Multiplier OverridesThe resource is used to view, create, update, delete labor multiplier override details. -
LaborRateChangeReason: string
Title:
Labor Rate Change ReasonMaximum Length:80Labor rate change reason -
LaborSchFixedDate: string
(date)
Title:
Labor Schedule Fixed DateThe fixed date used to determine the effective bill rates of the standard labor bill rate schedule. -
LaborTpScheduleId: integer
Title:
Labor Transfer Price Schedule IDLabor Schedule Identifier for Inter Company Transfer Price. -
LaborTpSchFixedDate: string
(date)
Title:
Labor Transfer Price Schedule Fixed DateThe fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule. -
LaborTransferPriceSchedule: string
Title:
Labor Transfer Price ScheduleMaximum Length:50Labor Schedule for Inter Company Transfer Price. -
links: array
Links
Title:
LinksThe 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 CodeMaximum Length:30Non Labor cost basis code for cost reimbursable -
NlBillRateSchId: integer
(int64)
Title:
Nonlabor Rate Schedule IDIdentifier of the non labor bill rate schedule -
NlDiscountPercentage: number
Title:
Nonlabor Discount PercentageThe percentage to be discounted from the standard non labor bill rate schedule. -
NlDiscountReasonCode: string
Title:
Nonlabor Discount Reason CodeMaximum Length:30Non labor rate change reason code -
NlMarkupPercentage: number
Title:
Nonlabor Markup PercentageNonlabor Markup Percentage -
NlSchFixedDate: string
(date)
Title:
Nonlabor Schedule Fixed DateThe fixed date used to determine the effective bill rates of the standard non labor bill rate schedule. -
NlTpScheduleId: integer
Title:
Nonlabor Transfer Price Schedule IDNon Labor Schedule Identifier for Inter Company Transfer Price. -
NlTpSchFixedDate: string
(date)
Title:
Nonlabor Transfer Price Schedule Fixed DateThe fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule. -
NonlaborCostBasis: string
Title:
Nonlabor Cost BasisMaximum Length:80Non Labor cost basis for cost reimbursable -
NonlaborRateChangeReason: string
Title:
Nonlabor Rate Change ReasonMaximum Length:80Nonlabor rate change reason -
NonLaborRateOverride: array
Non Labor Rate Overrides
Title:
Non Labor Rate OverridesThe resource is used to view, create, update, delete non labor multiplier override details. -
NonlaborRateSchedule: string
Title:
Nonlabor Rate ScheduleMaximum Length:30Non labor bill rate schedule -
NonlaborTransferPriceSchedule: string
Title:
Nonlabor Transfer Price ScheduleMaximum Length:50Non Labor Schedule for Inter Company Transfer Price. -
OnHoldFlag: boolean
Title:
On HoldMaximum Length:1Default Value:falseFlag to check if Revenue plan can be used to recognize revenue. -
PersonBillRateSchId: integer
(int64)
Title:
Person Rate Schedule IDIdentifier of the employee bill rate schedule -
PersonRateOverride: array
Person Rate Overrides
Title:
Person Rate OverridesThe resource is used to view, create, update, delete person rate override details. -
PersonRateSchedule: string
Title:
Person Rate ScheduleMaximum Length:30Employee bill rate schedule -
ProjectRoleBillRateSchId: integer
(int64)
Title:
Project Role Rate Schedule IDUnique identifier of the project role bill rate schedule -
ProjectRoleRateScheduleName: string
Title:
Project Role Rate ScheduleMaximum Length:30The project role bill rate schedule name -
RevenuePlanDescriptiveFlexField: array
Revenue Plan Flexfields
Title:
Revenue Plan FlexfieldsThe 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 TranslationsThe revenue plan transactions resource is used to view and update contract revenue plan translation information.
Nested Schema : Job Assignment Overrides
Type:
arrayTitle:
Job Assignment OverridesThe resource is used to view, create, update, delete job assignment override details
Show Source
Nested Schema : Job Rate Overrides
Type:
arrayTitle:
Job Rate OverridesThe resource is used to view, create, update, delete job rate override details.
Show Source
Nested Schema : Labor Multiplier Overrides
Type:
arrayTitle:
Labor Multiplier OverridesThe resource is used to view, create, update, delete labor multiplier override details.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Non Labor Rate Overrides
Type:
arrayTitle:
Non Labor Rate OverridesThe resource is used to view, create, update, delete non labor multiplier override details.
Show Source
Nested Schema : Person Rate Overrides
Type:
arrayTitle:
Person Rate OverridesThe resource is used to view, create, update, delete person rate override details.
Show Source
Nested Schema : Revenue Plan Flexfields
Type:
arrayTitle:
Revenue Plan FlexfieldsThe 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:
arrayTitle:
Revenue Plan TranslationsThe 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 OverrideMaximum Length:80Name 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 IDUnique identifier of the contract line for which the job assignment override is defined. -
ContractLineNumber: string
Title:
Contract Line NumberMaximum Length:150The contract line for which the job assignment override is defined. -
EmailAddress: string
Title:
EmailMaximum Length:240The email address for whom the job assignment override is defined. -
EndDateActive: string
(date)
Title:
End DateThe date to which a job assignment override applies. -
ExternalReferenceKey: string
Title:
External Reference KeyMaximum Length:150Unique 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 KeyMaximum Length:150Unique 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 IDThe 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 CodeThe job code of the override being assigned to the person for this bill or revenue plan. -
JobId: integer
(int64)
Title:
Job IDUnique identifier of the override job being assigned to the person for this bill or revenue plan. -
JobName: string
Title:
Job NameMaximum Length:240The job name of the override being assigned to the person for this bill or revenue plan. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
VersionDefault Value:1The version of the contract containing this particular set of job assignment override details. -
PersonId: integer
(int64)
Title:
Person IDUnique identifier of the person for whom the job assignment override is defined. -
PersonName: string
Title:
PersonMaximum Length:2000The person for whom the job assignment override is defined. -
PersonNumber: string
Title:
Person NumberMaximum Length:30The person number for whom the job assignment override is defined. -
StartDateActive: string
(date)
Title:
Start DateThe date from which a job assignment override applies.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 IDUnique identifier of the bill rate override. -
BillRateUnitCode: string
Title:
Unit of MeasureRead Only:trueMaximum Length:30Default Value:HOURSThe bill rate unit code. -
ContractLineId: integer
(int64)
Title:
Contract Line IDUnique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line NumberMaximum Length:150Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount PercentageDiscount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End DateDate till which bill rate override is effective. -
ExternalReferenceKey: string
Title:
External Reference KeyMaximum Length:150Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source KeyMaximum Length:150Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
JobCode: string
Title:
Job CodeCode of the job for which bill rate is being overriden. -
JobId: integer
(int64)
Title:
Job IDUnique identifier of the job for which bill rate is being overridden. -
JobName: string
Title:
JobMaximum Length:240Name of the job for which bill rate is being overridden. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
VersionDefault Value:1Current version of a record. -
Rate: number
Title:
RateAmount billed to the customer for an item. -
RateCurrency: string
Title:
CurrencyMaximum Length:80Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency CodeMaximum Length:30Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Discount ReasonMaximum Length:80Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Discount ReasonMaximum Length:30Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start DateDate from which bill rate override is effective.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 IDUnique identifier of the contract line for which the labor multiplier override applies. -
ContractLineNumber: string
Title:
Contract Line NumberMaximum Length:150Contract line number for which labor mutliplier override applies. -
EndDateActive: string
(date)
Title:
End DateThe date to which a labor multiplier override applies. -
ExternalReferenceKey: string
Title:
External Reference KeyMaximum Length:150Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source KeyMaximum Length:150Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
LaborMultiplier: number
Title:
MultiplierLabor multiplier. -
LaborMultiplierId: integer
(int64)
Title:
Labor Multiplier IDUnique 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:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
VersionDefault Value:1Version of the contract containing this particular set of labor multiplier override details. -
StartDateActive: string
(date)
Title:
Start DateThe date from which a labor multiplier override applies.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 IDUnique identifier of the bill rate override. -
ContractLineId: integer
(int64)
Title:
Contract Line IDUnique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line NumberMaximum Length:150Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount PercentageDiscount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End DateDate till which bill rate override is effective. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type IDUnique identifier of the expenditure type for which the bill rate is being overridden. -
ExpenditureTypeName: string
Title:
Expenditure TypeMaximum Length:240Expenditure type name for which the bill rate is being overridden. -
ExternalReferenceKey: string
Title:
External Reference KeyMaximum Length:150Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source KeyMaximum Length:150Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
VersionDefault Value:1Current version of a record. -
MarkupPercentage: number
Title:
Markup PercentageMarkup percentage applied to the bill rate. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource IDUnique identifier of the non labor resource for which the bill rate is being overridden. -
NonLaborResourceName: string
Title:
Nonlabor ResourceMaximum Length:240Non labor resource name for which the bill rate is being overridden. -
OrganizationId: integer
(int64)
Title:
Organization IDUnique identifier of the organization for which the bill rate overrides are being defined. -
OrganizationName: string
Title:
OrganizationMaximum Length:240Name of the organization for which the bill rate overrides are being defined. -
Rate: number
Title:
RateAmount billed to the customer for an item. -
RateCurrency: string
Title:
CurrencyMaximum Length:80Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency CodeMaximum Length:30Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Rate Change ReasonMaximum Length:80Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Rate Change Reason CodeMaximum Length:30Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start DateDate from which bill rate override is effective.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 IDUnique identifier of the bill rate override. -
ContractLineId: integer
(int64)
Title:
Contract Line IDUnique identifier of the contract line for which the bill rate override applies. -
ContractLineNumber: string
Title:
Contract Line NumberMaximum Length:150Contract line number for which the bill rate override applies. -
DiscountPercentage: number
Title:
Discount PercentageDiscount percentage applied to the bill rate. -
EndDateActive: string
(date)
Title:
End DateDate till which bill rate override is effective. -
ExternalReferenceKey: string
Title:
External Reference KeyMaximum Length:150Unique identifier of the override in the source application. Used to identify overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source KeyMaximum Length:150Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
VersionDefault Value:1Current version of a record. -
PersonEmail: string
Title:
Person EmailMaximum Length:240Email of the person whose bill rate is being overridden. -
PersonId: integer
(int64)
Title:
Person IDUnique identifier of the person whose bill rate is being overridden. -
PersonName: string
Title:
PersonMaximum Length:240Name of the person whose bill rate is being overridden. -
Rate: number
Title:
RateAmount billed to the customer for an item. -
RateCurrency: string
Title:
CurrencyMaximum Length:80Currency of the bill rate override. -
RateCurrencyCode: string
Title:
Currency CodeMaximum Length:30Currency code of the bill rate override. -
RateDiscountReason: string
Title:
Rate Change ReasonMaximum Length:80Reason for applying a discount. -
RateDiscReasonCode: string
Title:
Rate Change Reason CodeMaximum Length:30Reason code for applying a discount. -
StartDateActive: string
(date)
Title:
Start DateDate from which bill rate override is effective.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
BillPlanId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanTranslation-item-response
Type:
Show Source
object-
BillPlanDesc: string
Maximum Length:
240The revenue plan description. -
BillPlanId: integer
(int64)
The unique identifier of the bill or revenue plan in the bill or revenue plan translation resource.
-
BillPlanName: string
Maximum Length:
30The bill or revenue plan name in the bill or revenue plan translation resource. -
InvoiceComment: string
Maximum Length:
240The invoice comment in the bill plan translation resource. -
InvoiceInstructions: string
Maximum Length:
240The billing instructions in the bill plan translation resource. -
Language: string
Maximum Length:
4The translation language in the bill or revenue plan translation resource. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
The contract version in the bill or revenue plan translation resource.
-
ObjectVersionNumber: integer
(int32)
The revenue plan object version.
-
SourceLang: string
Maximum Length:
4The source language in the bill or revenue plan translation resource.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source