Get revenue plans

get

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

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the revenue plan with the specified revenue plan ID and major version.
      Finder Variables:
      • BillPlanId; integer; The revenue plan identifier.
      • MajorVersion; integer; The revenue plan major version.
    • RevenuePlanExtAltKey: Finds the revenue plan with external alternate key.
      Finder Variables:
      • ExternalReferenceKey; string.
      • ExternalSourceKey; string.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BillMethodId; integer; Identifier of the Revenue Method
    • BillMethodName; string; Revenue Method name
    • BillPlanId; integer; Revenue Plan Identifier
    • BillPlanName; string; Revenue Plan name
    • BurdenSchFixedDate; string; The fixed date used to determine the effective rates of the burden schedule.
    • BurdenSchId; integer; Identifier of the burden schedule
    • BurdenSchedule; string; burden schedule on the Revenue plan
    • EnableLbrBillXtnsnFlag; boolean; Flag to allow usage of Labor Billing extensions
    • EnableNlBillXtnsnFlag; boolean; Flag to allow uasage of non labor Billing extensions
    • ExternalReferenceKey; string; Reference key in External source
    • ExternalSourceKey; string; External Source Key
    • JobBillRateSchId; integer; Identifier of the job bill rate schedule
    • JobRateSchedule; string; Job bill rate schedule
    • LaborBillBasisCode; string; Labor cost basis code for cost reimbursable
    • LaborCostBasis; string; Labor cost basis for cost reimbursable
    • LaborDiscountPercentage; number; The percentage to be discounted from the standard labor bill rate schedule.
    • LaborDiscountReasonCode; string; Labor rate change reason code
    • LaborMarkupPercentage; number; Labor Markup Percentage
    • LaborRateChangeReason; string; Labor rate change reason
    • LaborSchFixedDate; string; The fixed date used to determine the effective bill rates of the standard labor bill rate schedule.
    • LaborTpSchFixedDate; string; The fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule.
    • LaborTpScheduleId; integer; Labor Schedule Identifier for Inter Company Transfer Price.
    • LaborTransferPriceSchedule; string; Labor Schedule for Inter Company Transfer Price.
    • MajorVersion; integer; Contract Major version on which Revenue plan is defined
    • NlBillBasisCode; string; Non Labor cost basis code for cost reimbursable
    • NlBillRateSchId; integer; Identifier of the non labor bill rate schedule
    • NlDiscountPercentage; number; The percentage to be discounted from the standard non labor bill rate schedule.
    • NlDiscountReasonCode; string; Non labor rate change reason code
    • NlMarkupPercentage; number; Nonlabor Markup Percentage
    • NlSchFixedDate; string; The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule.
    • NlTpSchFixedDate; string; The fixed date used to determine the effective rates of Intercompany Labor Transfer Price Schedule.
    • NlTpScheduleId; integer; Non Labor Schedule Identifier for Inter Company Transfer Price.
    • NonlaborCostBasis; string; Non Labor cost basis for cost reimbursable
    • NonlaborRateChangeReason; string; Nonlabor rate change reason
    • NonlaborRateSchedule; string; Non labor bill rate schedule
    • NonlaborTransferPriceSchedule; string; Non Labor Schedule for Inter Company Transfer Price.
    • OnHoldFlag; boolean; Flag to check if Revenue plan can be used to recognize revenue.
    • PersonBillRateSchId; integer; Identifier of the employee bill rate schedule
    • PersonRateSchedule; string; Employee bill rate schedule
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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