Create a Bill Rate Override
post
/fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BillPlanId: integer
(int64)
Title:
Bill Plan ID
Identifier of the plan to which the rate override belongs. -
BillPlanName: string
Title:
Bill Plan Name
Maximum Length:255
Name of the bill plan to which the rate override belongs. -
ContractId: integer
(int64)
Title:
Contract ID
Identifier of the contract to which the rate override belongs. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Identifier of the contract line to which the rate override belongs. -
ContractLineName: string
Title:
Contract Line Name
Name of the contract line to which the rate override belongs. -
ContractLineNumber: string
Title:
Contract Line Number
Number of the contract line to which the rate override belongs. -
ContractNumber: string
Title:
Contract Number
Maximum Length:255
Number of the contract to which the rate override belongs. -
ContractType: string
Title:
Contract Type
Maximum Length:255
Name of the type of contract to which the rate override belongs. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Currency code associated with the rate override. -
CurrencyName: string
Title:
Currency Name
Maximum Length:255
Currency name associated with the rate override. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Identifier of the expenditure type to which the rate override belongs. -
ExpenditureTypeName: string
Title:
Expenditure Type Name
Name of the expenditure type to which the rate override belongs. -
FromDate: string
(date)
Title:
From Date
Date from which the rate override is effective. The date format is YYYY-MM-DD. -
JobCode: string
Title:
Job Code
Maximum Length:255
Code of the job to which the rate override belongs. -
JobId: integer
(int64)
Title:
Job ID
Identifier of the job to which the rate override belongs. -
JobName: string
Title:
Job Name
Name of the job to which the rate override belongs. -
PersonEmail: string
Title:
Person Email
Maximum Length:255
Email of the person to which the rate override belongs. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the person to which the rate override belongs. -
PersonName: string
Title:
Person Name
Name of the person to which the rate override belongs. -
PersonNumber: string
Title:
Person Number
Number of the person to which the rate override belongs. -
PlanType: string
Title:
Plan Type
Maximum Length:255
Name of the type of plan to which the rate override belongs. You must enter either Bill Plan or Revenue Plan. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project to which the rate override belongs. -
ProjectName: string
Title:
Project Name
Name of the project to which the rate override belongs. -
ProjectNumber: string
Title:
Project Number
Number of the project to which the rate override belongs. -
ProjectRoleId: integer
(int64)
Title:
Project Role ID
Identifier of the project role to which the rate override belongs. -
ProjectRoleName: string
Title:
Project Role Name
Name of the project role to which the rate override belongs. -
Rate: number
Title:
Rate
The rate assigned to the rate override. -
RateOverrideReason: string
Title:
Rate Override Reason
The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type. -
RateOverrideReasonCode: string
Title:
Rate Override Reason Code
Maximum Length:30
The reason code for changing the rate override. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the rate override belongs. -
TaskName: string
Title:
Task Name
Name of the task to which the rate override belongs. -
TaskNumber: string
Title:
Task Number
Number of the task to which the rate override belongs. -
ToDate: string
(date)
Title:
To Date
Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.
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 : contractProjectandTaskBillRateOverrides-item-response
Type:
Show Source
object
-
BillPlanId: integer
(int64)
Title:
Bill Plan ID
Identifier of the plan to which the rate override belongs. -
BillPlanName: string
Title:
Bill Plan Name
Maximum Length:255
Name of the bill plan to which the rate override belongs. -
ContractId: integer
(int64)
Title:
Contract ID
Identifier of the contract to which the rate override belongs. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Identifier of the contract line to which the rate override belongs. -
ContractLineName: string
Title:
Contract Line Name
Name of the contract line to which the rate override belongs. -
ContractLineNumber: string
Title:
Contract Line Number
Number of the contract line to which the rate override belongs. -
ContractNumber: string
Title:
Contract Number
Maximum Length:255
Number of the contract to which the rate override belongs. -
ContractType: string
Title:
Contract Type
Maximum Length:255
Name of the type of contract to which the rate override belongs. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Currency code associated with the rate override. -
CurrencyName: string
Title:
Currency Name
Maximum Length:255
Currency name associated with the rate override. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Identifier of the expenditure type to which the rate override belongs. -
ExpenditureTypeName: string
Title:
Expenditure Type Name
Name of the expenditure type to which the rate override belongs. -
FromDate: string
(date)
Title:
From Date
Date from which the rate override is effective. The date format is YYYY-MM-DD. -
JobCode: string
Title:
Job Code
Maximum Length:255
Code of the job to which the rate override belongs. -
JobId: integer
(int64)
Title:
Job ID
Identifier of the job to which the rate override belongs. -
JobName: string
Title:
Job Name
Name of the job to which the rate override belongs. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Update By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonEmail: string
Title:
Person Email
Maximum Length:255
Email of the person to which the rate override belongs. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the person to which the rate override belongs. -
PersonName: string
Title:
Person Name
Name of the person to which the rate override belongs. -
PersonNumber: string
Title:
Person Number
Number of the person to which the rate override belongs. -
PlanType: string
Title:
Plan Type
Maximum Length:255
Name of the type of plan to which the rate override belongs. You must enter either Bill Plan or Revenue Plan. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project to which the rate override belongs. -
ProjectName: string
Title:
Project Name
Name of the project to which the rate override belongs. -
ProjectNumber: string
Title:
Project Number
Number of the project to which the rate override belongs. -
ProjectRoleId: integer
(int64)
Title:
Project Role ID
Identifier of the project role to which the rate override belongs. -
ProjectRoleName: string
Title:
Project Role Name
Name of the project role to which the rate override belongs. -
Rate: number
Title:
Rate
The rate assigned to the rate override. -
RateOverrideId: integer
(int64)
Title:
Rate Override ID
Read Only:true
The unique identifier of the rate override. -
RateOverrideReason: string
Title:
Rate Override Reason
The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type. -
RateOverrideReasonCode: string
Title:
Rate Override Reason Code
Maximum Length:30
The reason code for changing the rate override. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the rate override belongs. -
TaskName: string
Title:
Task Name
Name of the task to which the rate override belongs. -
TaskNumber: string
Title:
Task Number
Number of the task to which the rate override belongs. -
ToDate: string
(date)
Title:
To Date
Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.
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.
Examples
The following example shows how to create a bill rate override by submitting a POST request on the REST resource using cURL.
curl -H "Content-Type: application/vnd.oracle.adf.action+json" --user ppm_cloud_user -X POST -d @example_request_payload.json https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides/
Request Body Example
The following shows an example of the request body in JSON format.
{ "ContractId":100000015235919, "BillPlanName":"billplan1", "ContractLineNumber":"Line1", "ProjectName":"Vision_Projinv-02", "TaskName":"Financials Familiarization", "PersonId":1561, "ProjectRoleId":11, "ExpenditureTypeId":10000, "Rate":50, "CurrencyCode":"USD", "FromDate":"2024-01-01", "ToDate":"2024-05-01" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "RateOverrideId": 300100587540619, "ContractId": 100000015235919, "ContractNumber": null, "ContractType": null, "BillPlanId": 100000015265079, "BillPlanName": "billplan1", "PlanType": null, "ContractLineId": 100000015265221, "ContractLineNumber": "Line1", "ContractLineName": null, "ProjectId": 100000015107566, "ProjectNumber": null, "ProjectName": "Vision_Projinv-02", "TaskId": 100000015107588, "TaskNumber": null, "TaskName": "Financials Familiarization", "PersonId": 1561, "PersonNumber": null, "PersonName": null, "PersonEmail": null, "ProjectRoleId": 11, "ProjectRoleName": null, "JobId": null, "JobCode": null, "JobName": null, "ExpenditureTypeId": 10000, "ExpenditureTypeName": null, "Rate": 50, "CurrencyCode": "USD", "CurrencyName": null, "FromDate": "2024-01-01", "ToDate": "2024-05-01", "RateOverrideReasonCode": null, "RateOverrideReason": null, "CreationDate": "2024-03-07T06:33:41+00:00", "CreatedBy": "carlton.baugh", "LastUpdateDate": "2024-03-07T06:33:41.815+00:00", "LastUpdatedBy": "carlton.baugh", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides/300100587540619", "name": "contractProjectandTaskBillRateOverrides", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides/300100587540619", "name": "contractProjectandTaskBillRateOverrides", "kind": "item" } ] }