Create non labor rate overrides
post
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/NonLaborRateOverride
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> -
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.
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.
-
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
-
BillRateOverrideId: integer
(int64)
Title:
Nonlabor 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. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Unique identifier of the expenditure type for which the bill rate is being overridden. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Expenditure type name for which the bill rate is being overridden. -
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. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
Current version of a record. -
MarkupPercentage: number
Title:
Markup Percentage
Markup percentage applied to the bill rate. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Unique identifier of the non labor resource for which the bill rate is being overridden. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
Non labor resource name for which the bill rate is being overridden. -
OrganizationId: integer
(int64)
Title:
Organization ID
Unique identifier of the organization for which the bill rate overrides are being defined. -
OrganizationName: string
Title:
Organization
Maximum Length:240
Name of the organization for which the bill rate overrides are being defined. -
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.
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 : contracts-BillPlan-NonLaborRateOverride-item-response
Type:
Show Source
object
-
BillRateOverrideId: integer
(int64)
Title:
Nonlabor 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. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Unique identifier of the expenditure type for which the bill rate is being overridden. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Expenditure type name for which the bill rate is being overridden. -
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. -
MarkupPercentage: number
Title:
Markup Percentage
Markup percentage applied to the bill rate. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Unique identifier of the non labor resource for which the bill rate is being overridden. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
Non labor resource name for which the bill rate is being overridden. -
OrganizationId: integer
(int64)
Title:
Organization ID
Unique identifier of the organization for which the bill rate overrides are being defined. -
OrganizationName: string
Title:
Organization
Maximum Length:240
Name of the organization for which the bill rate overrides are being defined. -
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.