Update a bill plan
patch
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}
Request
Path Parameters
-
BillPlanUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BillPlanId and MajorVersion ---for the Bill Plans resource and used to uniquely identify an instance of Bill Plans. The client should not generate the hash key value. Instead, the client should query on the Bill Plans collection resource with a filter on the primary key values in order to navigate to a specific instance of Bill Plans.
For example: BillPlan?q=BillPlanId=<value1>;MajorVersion=<value2> -
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.
Supported Media Types
- application/json
Root Schema : schema
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. -
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 : 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 : 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-BillPlan-BillPlanTranslation-item-patch-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
Nested Schema : contracts-BillPlan-JobAssignmentOverride-item-patch-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. -
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-BillPlan-JobRateOverride-item-patch-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 : contracts-BillPlan-JobTitleOverride-item-patch-request
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. -
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 : contracts-BillPlan-LaborMultiplierOverride-item-patch-request
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. -
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-BillPlan-NonLaborRateOverride-item-patch-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 : contracts-BillPlan-PersonRateOverride-item-patch-request
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.
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-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 : 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-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
Links
- BillPlanDescriptiveFlexField
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information. - BillPlanUniqID:
- BillPlanTranslation
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The bill plan translations resource is used to view and update contract bill plan translation information. - BillPlanUniqID:
- JobAssignmentOverride
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete job assignment override details - BillPlanUniqID:
- JobRateOverride
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete job rate override details. - BillPlanUniqID:
- JobTitleOverride
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete job title override details. - BillPlanUniqID:
- LaborMultiplierOverride
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete labor multiplier override details. - BillPlanUniqID:
- NonLaborRateOverride
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete non labor multiplier override details. - BillPlanUniqID:
- PersonRateOverride
-
Parameters:
- BillPlanUniqID:
$request.path.BillPlanUniqID
- contractsUniqID:
$request.path.contractsUniqID
The resource is used to view, create, update, delete person rate override details. - BillPlanUniqID:
Examples
The following example shows how to update a bill plan from Letter of Credit to non-Letter of Credit in JSON format which will return successfully with a warning message in the response.
cURL Command
curl --user <username:password> -X PATCH -d @example_request_payload.json --header "REST-Framework-Version: 6" --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/contracts/{{ContractId}}/child/BillPlan/{{BillPlanUniqueId}}
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "LocFlag": false }
Example of Response Body
The following example shows the contents of the response body in JSON format. In the 'warnings' section you can see the corresponding message.
{ "BillPlanId": 300100128522054, "MajorVersion": 2, "BillMethodId": 300100039542367, "BillMethodName": "Cost Reimbursible Method", "BillPlanName": "Award Bill Plan", "InvoiceCurrencyOptCode": "CONTRACT", "BillingCurrencyType": "Contract", "PaymentTermsId": 5, "PaymentTerms": "IMMEDIATE", "BillSetNumber": 1, "InvHdrGroupingOptions": null, "InvoiceHdrGrpOptName": null, "BillToCustomerAccountId": 300100031628786, "BillToAccountNumber": "CDRM_4100", "BillToSiteUseId": 300100031628794, "BillToSite": "CDRM_2089", "BillToContactId": 300100031628833, "BillToContactName": "Charles Watson", "BillToContactEmail": null, "BillingCycleId": 1000000000003, "BillingCycle": "Monthly", "LaborInvoiceFormatId": 7004, "LaborInvoiceFormat": "Contract Line Project/Task Emp", "NlInvoiceFormatId": 7005, "NonlaborInvoiceFormat": "Contract Line Project/Task Exp", "EventsInvoiceFormatId": 100000011213026, "EventInvoiceFormat": "Cont Line Project/Task Event", "FirstBillingOffsetDays": null, "InvoiceInstructions": null, "InvoiceComment": null, "PersonBillRateSchId": null, "PersonRateSchedule": null, "JobBillRateSchId": null, "JobRateSchedule": null, "LaborSchFixedDate": null, "LaborDiscountPercentage": null, "LaborDiscountReasonCode": null, "LaborRateChangeReason": null, "NlBillRateSchId": null, "NonlaborRateSchedule": null, "NlSchFixedDate": null, "NlDiscountPercentage": null, "NlDiscountReasonCode": null, "NonlaborRateChangeReason": null, "BurdenSchId": null, "BurdenSchedule": null, "BurdenSchFixedDate": null, "LaborTpScheduleId": null, "LaborTransferPriceSchedule": null, "LaborTpSchFixedDate": null, "NlTpScheduleId": null, "NonlaborTransferPriceSchedule": null, "NlTpSchFixedDate": null, "OnHoldFlag": false, "ExternalSourceKey": "GMS-300100128003684", "ExternalReferenceKey": "Award Bill Plan", "InvoiceCurrencyDateType": null, "InvoiceCurrencyConversionDateType": null, "InvoiceCurrencyExchgDate": null, "InvoiceCurrencyRateType": null, "InvoiceCurrencyConversionRateType": null, "InvoiceCurrencyCode": null, "NlBillBasisCode": "BURDENED_COST", "NonlaborCostBasis": "Burdened Cost", "LaborBillBasisCode": "BURDENED_COST", "LaborCostBasis": "Burdened Cost", "LaborMarkupPercentage": 0, "NlMarkupPercentage": 0, "DocumentNumber": null, "LocFlag": false, "FederalInvoiceFormat": null, "@context": { "key": "00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878" }, "links": [ { "rel": "self", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002, "name": "BillPlan", "kind": "item" }, { "rel": "canonical", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002, "name": "BillPlan", "kind": "item" }, { "rel": "parent", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052, "name": "contracts", "kind": "item" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/LaborDiscountReasonVA, "name": "LaborDiscountReasonVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/LaborCostBasisVA, "name": "LaborCostBasisVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/InvoiceFormatPVA, "name": "InvoiceFormatPVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/InvoiceConversionRateTypeVA, "name": "InvoiceConversionRateTypeVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/NonLaborDiscountReasonVA, "name": "NonLaborDiscountReasonVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/JobBillRateSchIdVA, "name": "JobBillRateSchIdVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/BillingMethodVA, "name": "BillingMethodVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/PaymentTermVA, "name": "PaymentTermVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/NonLaborCostBasisVA, "name": "NonLaborCostBasisVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/LaborInvoiceFormatVA, "name": "LaborInvoiceFormatVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/NonLaborInvoiceFormatVA, "name": "NonLaborInvoiceFormatVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/InvoiceConvDateTypeLookupVA, "name": "InvoiceConvDateTypeLookupVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/NonLaborRateScheduleVA, "name": "NonLaborRateScheduleVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/JobRateScheduleVA, "name": "JobRateScheduleVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/InvHdrGrpOptionVA, "name": "InvHdrGrpOptionVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/BillToContactNameVA, "name": "BillToContactNameVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/EventsInvoiceFormatVA, "name": "EventsInvoiceFormatVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/CustomerAccountVA, "name": "CustomerAccountVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/BillingCurrencyTypeVA, "name": "BillingCurrencyTypeVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/BillingCycleVA, "name": "BillingCycleVA", "kind": "collection" }, { "rel": "lov", "href": https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069551052/child/BillPlan/00020000000EACED00057708000110F0818EBF460000000EACED000577080000000000000002/lov/TransferPriceScheduleVA, "name": "TransferPriceScheduleVA", "kind": "collection" }, { "r...