Update a revenue plan

patch

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- BillPlanId and MajorVersion ---for the Revenue Plans resource and used to uniquely identify an instance of Revenue Plans. The client should not generate the hash key value. Instead, the client should query on the Revenue Plans collection resource with a filter on the primary key values in order to navigate to a specific instance of Revenue Plans.

    For example: RevenuePlan?q=BillPlanId=<value1>;MajorVersion=<value2>
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
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 : Labor Multiplier Overrides
Type: array
Title: Labor Multiplier Overrides
The resource is used to view, create, update, delete labor multiplier override details.
Show Source
Nested Schema : Non Labor Rate Overrides
Type: array
Title: Non Labor Rate Overrides
The resource is used to view, create, update, delete non labor multiplier override details.
Show Source
Nested Schema : Person Rate Overrides
Type: array
Title: Person Rate Overrides
The resource is used to view, create, update, delete person rate override details.
Show Source
Nested Schema : Revenue Plan Flexfields
Type: array
Title: Revenue Plan Flexfields
The revenue plan flexfields resource is used to view, create, update, and delete contract revenue plan flexfield information.
Show Source
Nested Schema : Revenue Plan Translations
Type: array
Title: Revenue Plan Translations
The revenue plan transactions resource is used to view and update contract revenue plan translation information.
Show Source
Nested Schema : contracts-RevenuePlan-JobAssignmentOverride-item-patch-request
Type: object
Show Source
  • 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.
  • Title: Contract Line ID
    Unique identifier of the contract line for which the job assignment override is defined.
  • Title: Contract Line Number
    Maximum Length: 150
    The contract line for which the job assignment override is defined.
  • Title: Email
    Maximum Length: 240
    The email address for whom the job assignment override is defined.
  • Title: End Date
    The date to which a job assignment override applies.
  • 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.
  • 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.
  • Title: Job Code
    The job code of the override being assigned to the person for this bill or revenue plan.
  • Title: Job ID
    Unique identifier of the override job being assigned to the person for this bill or revenue plan.
  • Title: Job Name
    Maximum Length: 240
    The job name of the override being assigned to the person for this bill or revenue plan.
  • Title: Version
    Default Value: 1
    The version of the contract containing this particular set of job assignment override details.
  • Title: Person ID
    Unique identifier of the person for whom the job assignment override is defined.
  • Title: Person
    Maximum Length: 2000
    The person for whom the job assignment override is defined.
  • Title: Person Number
    Maximum Length: 30
    The person number for whom the job assignment override is defined.
  • Title: Start Date
    The date from which a job assignment override applies.
Nested Schema : contracts-RevenuePlan-JobRateOverride-item-patch-request
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-LaborMultiplierOverride-item-patch-request
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-NonLaborRateOverride-item-patch-request
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-PersonRateOverride-item-patch-request
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanDescriptiveFlexField-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : contracts-RevenuePlan-item-response
Type: object
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 : Labor Multiplier Overrides
Type: array
Title: Labor Multiplier Overrides
The resource is used to view, create, update, delete labor multiplier override details.
Show Source
Nested Schema : Non Labor Rate Overrides
Type: array
Title: Non Labor Rate Overrides
The resource is used to view, create, update, delete non labor multiplier override details.
Show Source
Nested Schema : Person Rate Overrides
Type: array
Title: Person Rate Overrides
The resource is used to view, create, update, delete person rate override details.
Show Source
Nested Schema : Revenue Plan Flexfields
Type: array
Title: Revenue Plan Flexfields
The revenue plan flexfields resource is used to view, create, update, and delete contract revenue plan flexfield information.
Show Source
Nested Schema : Revenue Plan Translations
Type: array
Title: Revenue Plan Translations
The revenue plan transactions resource is used to view and update contract revenue plan translation information.
Show Source
Nested Schema : contracts-RevenuePlan-JobAssignmentOverride-item-response
Type: object
Show Source
  • 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.
  • Title: Contract Line ID
    Unique identifier of the contract line for which the job assignment override is defined.
  • Title: Contract Line Number
    Maximum Length: 150
    The contract line for which the job assignment override is defined.
  • Title: Email
    Maximum Length: 240
    The email address for whom the job assignment override is defined.
  • Title: End Date
    The date to which a job assignment override applies.
  • 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.
  • 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.
  • 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.
  • Title: Job Code
    The job code of the override being assigned to the person for this bill or revenue plan.
  • Title: Job ID
    Unique identifier of the override job being assigned to the person for this bill or revenue plan.
  • Title: Job Name
    Maximum Length: 240
    The job name of the override being assigned to the person for this bill or revenue plan.
  • Links
  • Title: Version
    Default Value: 1
    The version of the contract containing this particular set of job assignment override details.
  • Title: Person ID
    Unique identifier of the person for whom the job assignment override is defined.
  • Title: Person
    Maximum Length: 2000
    The person for whom the job assignment override is defined.
  • Title: Person Number
    Maximum Length: 30
    The person number for whom the job assignment override is defined.
  • Title: Start Date
    The date from which a job assignment override applies.
Nested Schema : contracts-RevenuePlan-JobRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-LaborMultiplierOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-NonLaborRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-PersonRateOverride-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanDescriptiveFlexField-item-response
Type: object
Show Source
Nested Schema : contracts-RevenuePlan-RevenuePlanTranslation-item-response
Type: object
Show Source
Back to Top