Get a person rate override
get
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}
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> -
PersonRateOverrideUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BillRateOverrideId and MajorVersion ---for the Person Rate Overrides resource and used to uniquely identify an instance of Person Rate Overrides. The client should not generate the hash key value. Instead, the client should query on the Person Rate Overrides collection resource with a filter on the primary key values in order to navigate to a specific instance of Person Rate Overrides.
For example: PersonRateOverride?q=BillRateOverrideId=<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.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
There's no request body for this operation.
Back to TopResponse
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-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
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.