1. REST API for Project Portfolio ManagementREST API for Oracle Fusion Cloud Project Management
  2. Use Cases
  3. Manage Rates for Rate Schedules

Manage Rates for Rate Schedules

Use the Rate Schedules REST API resource to view, create, update and delete rates for rate schedules belonging to the schedule type of Job, Person, Nonlabor and Resource Class. Only attributes specific to the schedule type of the parent rate schedule are returned in the response payload for rate schedule lines. For example, only person related attribute details are returned in a response payload for rate schedule lines belonging to a rate schedule type of Employee.

Examples

Create Rates
  1. The following example shows how to create rates or rate schedule lines for a rate schedule with a schedule type of Person by submitting a POST request on the REST resource using cURL. 
    curl --user ppm_cloud_user https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleID}/child/Rates
    https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates

    Request

    The following shows an example of the request body in JSON format. In this example, we are creating a new rate schedule line by providing a rate, the active start date and the person number.
    {     
    "Rate" : 25,
    "MarkupPercent" : null,
    "StartDateActive" : "2020-01-01",
    "PersonNumber" : "955160008189513"
}
    Response
    {
    "RateId": 300100544651669,
    "UnitOfMeasureCode": "HOURS",
    "UnitOfMeasureName": "Hours",
    "Rate": 25,
    "MarkupPercent": null,
    "StartDateActive": "2020-01-01",
    "EndDateActive": null,
    "CreationDate": "2021-07-14T19:01:50.002+00:00",
    "CreatedBy": "DEVON.SMITH",
    "LastUpdateDate": "2021-07-14T19:01:50.084+00:00",
    "LastUpdatedBy": "DEVON.SMITH",
    "PersonId": 300100148045274,
    "PersonNumber": "955160008189513",
    "PersonName": "Neil, Sam",
    "PersonEmail": "sendmail-test-discard@oracle.com",
    "PersonJobId": null,
    "PersonJobCode": null,
    "PersonJobName": null,
    "PersonOrgId": null,
    "PersonOrgName": null,
    "links": [… ]
}
  2. The following example shows how to create rates or rate schedule lines for a rate schedule with a schedule type of Job by submitting a POST request on the REST resource using cURL. 
    https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624313/child/Rates

    Request

    The following shows an example of the request body in JSON format. In this example, we are creating a new rate schedule line for a product designer job, by providing a rate, the active start date and the job code.
    {
    "JobCode": "JOBCD2796",
    "Rate": 50,
    "StartDateActive": "2020-01-01"
}
    Response
    {
    "RateId": 300100544651670,
    "UnitOfMeasureCode": "HOURS",
    "UnitOfMeasureName": "Hours",
    "Rate": 50,
    "StartDateActive": "2020-01-01",
    "EndDateActive": null,
    "CreationDate": "2021-07-14T19:04:32.002+00:00",
    "CreatedBy": "DEVON.SMITH",
    "LastUpdateDate": "2021-07-14T19:04:32.033+00:00",
    "LastUpdatedBy": "DEVON.SMITH",
    "JobId": 2796,
    "JobCode": "JOBCD2796",
    "JobName": "ENG012.Assistant Engineer II",
    "links": [… ]
}
  3. The following example shows how to create rates for a rate schedule with a schedule type of Nonlabor by submitting a POST request on the REST resource using cURL. 
     https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624315/child/Rates

    Request

    The following shows an example of the request body in JSON format. In this example, we are creating a new rate schedule line for an expenditure type by providing a rate, the active start date, the required expenditure type name and unit of measure name for the specified rate.
    {     
    "Rate" : 10,
    "MarkupPercent" : null,
    "StartDateActive" : "2020-01-01",
    "ExpenditureTypeName" : "Computers",
    "UnitOfMeasureName" : "Hours"
}
    Response
    {
    "RateId": 300100541671782,
    "UnitOfMeasureCode": "HOURS",
    "UnitOfMeasureName": "Hours",
    "Rate": 10,
    "MarkupPercent": null,
    "StartDateActive": "2020-01-01",
    "EndDateActive": null,
    "CreationDate": "2021-03-17T22:28:28.001+00:00",
    "CreatedBy": "DEVON.SMITH",
    "LastUpdateDate": "2021-03-17T22:28:28.379+00:00",
    "LastUpdatedBy": "DEVON.SMITH",
    "ExpenditureTypeId": 10003,
    "ExpenditureTypeName": "Computers",
    "NonLaborResourceId": null,
    "NonLaborResourceName": null,
    "NonLaborResourceOrganizationId": null,
    "NonLaborResourceOrganizationName": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624315/child/Rates/300100541671782",
            "name": "Rates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624315/child/Rates/300100541671782",
            "name": "Rates",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624315",
            "name": "rateSchedules",
            "kind": "item"
        }
    ]
}
  4. The following example shows how to create rates for a rate schedule with a schedule type of Resource Class by submitting a POST request on the REST resource using cURL. 
     https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624318/child/Rates

    Request

    The following example shows the request body in JSON format. In this example, we are creating a new rate schedule line for a resource class by providing a rate, the active start date, the resource class name and the unit of measure name for the specified rate.
    {     
    "Rate" : 85,
    "StartDateActive" : "2020-01-01",
    "ResourceClassName" : "Equipment",
    "UnitOfMeasureName" : "Hours"
}
    Response
    {
    "RateId": 300100541737880,
    "UnitOfMeasureCode": "HOURS",
    "UnitOfMeasureName": "Hours",
    "Rate": 85,
    "MarkupPercent": null,
    "StartDateActive": "2020-01-01",
    "EndDateActive": null,
    "CreationDate": "2021-03-18T18:30:48.001+00:00",
    "CreatedBy": "DEVON.SMITH",
    "LastUpdateDate": "2021-03-18T18:30:48.063+00:00",
    "LastUpdatedBy": "DEVON.SMITH",
    "RateClassId": "2",
    "ResourceClassName": "Equipment",
    "ResourceClassOrgId": null,
    "ResourceClassOrgName": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624318/child/Rates/300100541737880",
            "name": "Rates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624318/child/Rates/300100541737880",
            "name": "Rates",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624318",
            "name": "rateSchedules",
            "kind": "item"
        }
    ]
}

Update a Rate

The following example shows a resource URL to update the rate for a Rate ID belonging to a Rate Schedule by submitting a PATCH request on the REST resource using cURL. 

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleID/child/Rates/{RateID}
https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates/300100541737809

Request

The following is an example of the request body in JSON format. In this example, we are updating the rate for a rate schedule line which was previously created.
{     
    "Rate" : 30
}
Response
{
    "RateId": 300100541737809,
    "UnitOfMeasureCode": "HOURS",
    "UnitOfMeasureName": "Hours",
    "Rate": 30,
    "MarkupPercent": null,
    "StartDateActive": "2020-01-01",
    "EndDateActive": null,
    "CreationDate": "2021-03-18T18:03:02.001+00:00",
    "CreatedBy": "DEVON.SMITH",
    "LastUpdateDate": "2021-03-18T18:39:17.004+00:00",
    "LastUpdatedBy": "DEVON.SMITH",
    "PersonId": 300100148045274,
    "PersonNumber": "955160008189513",
    "PersonName": "Neil, Sam",
    "PersonEmail": "sam.neil@oracle.com",
    "PersonJobId": null,
    "PersonJobCode": null,
    "PersonJobName": null,
    "PersonOrgId": null,
    "PersonOrgName": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates/300100541737809",
            "name": "Rates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates/300100541737809",
            "name": "Rates",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309",
            "name": "rateSchedules",
            "kind": "item"
        }
    ]
}

Get all Rates

Here is an example of a resource URL to get all the rates for a Rate Schedule ID by submitting a GET request on the REST resource using cURL. 

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleID}/child/Rates/
https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates/

Ge a Rate

Here is an example of a resource URL to get the rates for a specific Rate ID belonging to a Rate Schedule ID by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleID}/child/Rates/{RateID}
https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates/300100541737809

Delete a Specific Rate for a Rate Schedule

Here is an example of a resource URL to delete a specific Rate ID for Rate Schedule by submitting a DELETE request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleID}/child/Rates/{RateID}
https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100541624309/child/Rates/300100541737809