Rate Schedule Configuration Upload
This integration uploads rate schedule setup data.
Rates 2.0 is not supported. If ‘Rates 1.0 compatible’ is enabled, any rates uploaded are flagged as Rates 1.0.
Connector Overview
|
Component |
Detail |
|---|---|
|
Company Type |
Buyer |
|
Version Type |
API-A-V1.0 |
|
Format |
CSV |
|
Prerequisites |
Company plug-ins must be turned on for Integration – Rate Schedule Configuration Upload. Company configuration ‘Rate schedule’ must be turned on. User role permission must be turned on for Upload Data and Download Data. |
|
Predecessors |
Rate Codes Shift Schedules Rate Rules |
|
Related Connectors |
Rate Schedule Configuration Download |
File Formatting
Header
|
Component |
Required? |
Definition/Use |
Notes |
Value |
|---|---|---|---|---|
|
Type |
Yes |
Time Sheet |
If you have a custom connector name for a standard connector, you may use the exact same custom name for the Type header; otherwise, you must use the standard name shown in the Value field. |
Rate Schedule Configuration Upload |
Immediately following the Header section of the upload is one blank line.
Detail
|
Column Header Name |
Data Type |
Length |
Required? |
Value(s)/Format |
Description/Use/Field Rules |
|---|---|---|---|---|---|
|
Modification Type |
Char |
1 |
Yes |
Valid values:
|
A – Add record D – Delete record U – Update record Blank – If record already exists, update, else add. |
|
Service Type |
Text |
100 |
No |
Valid values are:
|
Indicates service type for rate schedule. When company has enabled configs for both Temp and Statement of Work, if field is left blank, Service Type will default to Temp and Rate Schedule will be validated as Temp. When company only uses Temp, if field is left blank, has invalid value, or is set to Services, system will default value to Temp and Rate Schedule will be validated as Temp. When company only uses Statement of Work, if field is left blank, has invalid value, or is set to Temp, system will default value to Services and Rate Schedule will be validated as Services. Company config Assignment Management must be enabled for entering ‘Assignment’. |
|
Rate Schedule Code |
Text |
200 |
Yes |
Valid SAP Fieldglass Rate Schedule code |
Code identifying the rate schedule. |
|
Rate Schedule Name |
Text |
200 |
Yes, only in case of adding new rate schedule. |
Name of rate schedule. |
|
|
Description |
Text |
200 |
No |
Rate schedule description. |
|
|
MSP Company |
Text |
6 |
Yes, if the company has multiple MSP and new rate schedule is being added. |
Valid SAP Fieldglass MSP supplier code for buyer company |
Only applicable if buyer has MSP company. Not applicable for assignment or resource modules. |
|
Type |
Text |
100 |
Yes, only in case of adding new rate schedule. |
Valid rate schedule type. Valid values are:
|
Type of rate schedule. If Service Type = Assignment, only Rate type will be accepted. If Service Type = Services, only these five types will be accepted:
|
|
Currency |
Text |
3 |
Yes |
Examples:
|
Currency associated with rate schedule. |
|
Use Admin Structure |
Text |
3 |
Yes |
Valid values are:
|
If this flag is set to Yes, then changes on the Rate Schedule will effect the creation of the work order and work order revision. Default value is ‘No’. |
|
Capture Time Worked On Time Sheet |
Text |
3 |
Yes |
Valid values are:
|
This field displays for rate schedules with the types, Unit Pay Rate and Coefficient or Unit Bill Rate. It defaults to Yes. When 0 (No) is selected, users do not enter ‘Time Worked’ when creating or editing a time sheet. Once the rate schedule is created, this field cannot be changed. If field left blank, it defaults to 1 (Yes). |
|
Rate Section Name |
Text |
100 |
Yes |
Examples:
|
Indicates the section of the rate schedule. The rate section name ‘Base Section’ must always be included. Other rate sections names can also be added by the buyer after ‘Base Section’. |
|
Section Type |
Text |
100 |
Yes |
Examples:
|
Indicates type of rate section. |
|
Include Rate on |
Text |
100 |
Yes, if Service Type is Temp. |
Valid values are:
|
The base rate must appear on the work order details, however you can determine if any other rates need to appear (in additional sections). If Service Type = Services, system will ignore the contents of this column, and when the upload completes, the Include Rate on value will default to ‘Work Order Details’. |
|
Rate Code |
Text |
100 |
Yes |
Indicates Rate code for rate schedule. |
|
|
Associated Shift Schedules |
Text |
100 |
Yes |
Indicates shift schedules associated to rate code. | |
|
Time Sheet Rule |
Text |
100 |
No |
Indicates rate rule or custom script associated to rate code. If the Time Sheet Allotment is set to ‘No Time Sheet Entry’, the system will ignore any entry in this field. If the 'No Time Sheet Entry' Allotment is set to ''Populate using Script', the Rate Rule from the Allotment's admin object will be copied to the Rate Schedule. |
|
|
Frequency |
Text |
100 |
Yes |
Valid values are:
|
The Frequency determines when a time sheet entry can be made either by the worker or via the rate rule. If Daily is selected, the worker (or rate rule) will be able to make an entry on every day. If Weekly is selected, the worker (or rate rule) will be able to make an entry on the last day of the time sheet. If Monthly is selected, the worker (or rate rule) will be able to make an entry on the last day of the month. If a value is entered for a Time Sheet Allotment that has enabled ‘No Time Sheet Entry’, the system will ignore the value and will default to ‘Once per Time Sheet’. |
|
Allow Worker to Edit Cost Allocation |
Integer |
No |
Valid values are:
|
This field defaults to 0 (No). It can be changed to 1 (Yes) either during the creation of the rate schedule or when editing the rate schedule. When Yes is selected, workers on work orders using this rate schedule are able to manually allocate their time to task codes and cost centers when creating/editing their time sheets. |
|
|
Time Sheet Allotment Section Name |
Text |
100 |
Conditional |
Examples:
|
Indicates the Time Sheet Allotment Section Name of the rate schedule. Applicable only when the rate schedule includes a Time Sheet Allotment section. |
|
Time Sheet Allotment Code |
Text |
100 |
Conditional |
Valid Fieldglass Time Sheet Allotment Code |
Indicates Time Sheet Allotment Code for Rate Schedules. Applicable only when the rate schedule includes a Time Sheet Allotment section. |
|
Time Sheet Allotment Name |
Text |
100 |
Conditional |
Indicates Time Sheet Allotment name associated with Time Sheet Allotment Code. Applicable only when the rate schedule includes a Time Sheet Allotment section. |
Unique Identifier
-
Rate Schedule Code field
-
Rate Code field
Assumptions/Tips
-
The configuration Rate schedule must be enabled for the buyer company.
-
Buyer will be able to upload rate schedules for the Service Type 'Assignment' with Type value of 'Rate' only. All other Type values will receive an error. Service Type 'Resource' is not supported. MSP Company will be ignored, since Assignments and Resources are not supported.
-
Rate Type of 'Markup' on rate schedule for services is not supported at this time.
-
A Time Sheet Allotment is a section of the rate schedule, not a value of the Type field. Complete the Time Sheet Allotment Section Name, Time Sheet Allotment Code, and Time Sheet Allotment Name columns only when the rate schedule includes a Time Sheet Allotment section.