Pre-Time Card Batch
Use this service to import Pre-Time Card Batch information.
Connection Information
URL: https://<SPECTRUM-SERVER>:8482/timecard/timecards
Authentication: Basic Authentication, Enhanced Authentication
Supported methods: POST
Supported formats: JSON
Sample JSON Body
[
{
"companyCode": "MD2",
"serviceUniqueID": "7385673F-5CEE-40E5-9447-7A0AA61A64A3",
"systemKey": "20170407KSM000000d009964",
"employeeCode": "",
"checkSequenceNumber": "",
"checkType": "",
"checkNumber": "",
"payType": "Q",
"dayOfWeek": "",
"unionCode": "",
"certifiedFlag": "",
"hours": 0,
"payRateCode": 0,
"payRate": 0,
"payExtension": 0,
"departmentCode": "",
"jobNumber": " AR0448U",
"phaseCode": "000001",
"costType": "L",
"burdenAmount": 0,
"workerCompCode": "",
"updateFlag": "",
"equipmentCode": "",
"costCategoryCode": "",
"equipmentHours": 0,
"equipmentRate": 0,
"wageCode": "",
"batchCode": "MLD0421Q",
"billRate": 0,
"equipmentBillRate": 0,
"laborBillCode": "",
"equipmentBillCode": "",
"companyCode2": "",
"dayOfMonth": "04/21/2021",
"tmUpdateFlag": "",
"state": "",
"workCounty": "",
"workLocality": "",
"message": "",
"unionFringe": 0,
"workerCompBurden": 0,
"workerCompDeduct": 0,
"pmWorkOrder": "",
"equipmentRateType": "",
"certifiedJobNumber": "",
"statusFlag": "",
"quantityFlag": "",
"compRate": 0,
"companyCode3": "",
"prevailingWageRate": 0,
"crewNumber": "",
"costCenter": "102",
"additionalJTDQuantity": 4.00,
"userID": "",
"woNumber": "",
"woEquipment": "",
"woComponent": "",
"scContract": "",
"incentivePayFlag": ""
}
]
Underlying File Maintenance
Prior to importing Pre-Time Card Transaction information, the following file maintenance screens must be completed. To access any one of these, begin with
:- Tax Table Maintenance
- Deduction/Add-on Code Maintenance
- Department Expense Maintenance
- Worker's Comp Base Code
- Worker's Compensation Code Maintenance
- Non-Union Pay Group Maintenance
- Union File Maintenance
- Wage Code File Maintenance
- Crew Maintenance
- Employee Status Code Maintenance
- Employees Maintenance
- G/L Department File Maintenance
- G/L Master File Maintenance
- Triggers Maintenance
- Jobs Maintenance
- Cost Type Maintenance
- Phases Maintenance
- Equipment Status File Maintenance
- Equipment Maintenance
- Equipment Components File Maintenance
- Cost Category Maintenance
- Job Specific Equipment Charge Rates
- Equipment Work Order Entry
- Site File Maintenance
- G/L Department File Maintenance
- Work Order Type File Maintenance
- Labor Category File Maintenance
- Labor Billing Rates Maintenance
- Work Order Standard Phase
- Work Order Entry
- Contract Type File Maintenance
- Service Contract File Maintenance
- Job Billing Maintenance
- Labor Billing Rates
- Job Labor Billing Rates Maintenance
- Equipment Billing Rates
- Job Equipment Billing Rates Maintenance
- Cost Center Maintenance
Assumptions & Dependencies
General Guidelines
- The transaction data being submitted using this web service are stored within the Payroll Pre-Time Card Import Errors screen by Employee or by Quantity and requires the data to be manually rechecked within Spectrum using the Recheck button on the screen.
- To maintain Spectrum's flexibility, the Data Exchange logic will validate the web service authorization, required fields, numeric, date, and generic validations only.
- The Payroll and General Ledger Modules must be setup.
- The flexibility within the Pre-Time Card web service creates new employee and quantity records. The SDX manual defines the specific guidelines for each type of record.
- Validation will be performed on the CompanyCode, WorkDate, and PayType.
- Cost center information will only be allowed if the Company is set to a Yes status.
Employee Record Guidelines
- Any PayType other than Q(uantity) will be sent to the Pre-Time Card Import Errors screen located within the Pre-Time Card Import logic.
- Non-direct departments should not have any Job, Equipment, or Work Order details defined.
- All standard Spectrum Pay Types and Add-on / Deduction codes are supported and validated to the CompanyCode. See the Pay Types options defined in layout.
Quantity Record Guidelines
- The Quantity pay type 'Q' is used to designate that a quantity record is to be created and submitted to the Pre-time Card Quantity Import Errors screen within the Pre-Time Card Import logic.
Field Descriptions
Use the table below for reference when using this service.
Field Name | Description | REQ? | Type | Max | Field Information | Validation |
---|---|---|---|---|---|---|
companyCode | Company Code | Text | 3 | Company where the records will be created. | Valid Company in Spectrum. Defaults from the Authorization ID if not populated. | |
batchCode | Batch Code | YES | Text | 8 | New or existing batch code | |
employeeCode | Employee | Text | 11 | Must exist in company per the CompanyCode entry. Not required for quantity records. | ||
checkSequenceNumber | Check Sequence Number | Numeric | 1 | Not required; must be an integer from 1 to 9 | ||
departmentCode | Department | Text | 6 | Not required for quantity records. | ||
payType | Pay Type | YES | Text | 10 | (R)egular; (O)vertime; (D)ouble time; (H)oliday; (V)acation; (S)ick; (M)iscellaneous; (SA)-Special amount; (ER)- Equipment- Regular; (EO)- Equipment- Overtime; (ED)- Equipment-Double time; (EU)- Equipment usage; (RP)-Retro-pay; (JX)-Job only adjustment hours; (1,2 or 3)- Description set in Payroll Installation screen; (Q)uantity entries only; (I)ncentive pay or (U)npaid time and Add-on or Deduction codes. | Validates to the defined CompanyCode field name. All pay types supported including Incentive pay types when specified on the Payroll Installation screen (for example, IR, IO, ID when "I" is specified), Add-on and Deduction codes. |
hours | Employee Hours | Numeric | 8 | Enter decimals but no $ signs or commas. Can be positive or negative; Not required for quantity records. | ||
jobNumber | Job | Text | 10 | Required for Quantity records. | ||
phaseCode | Phase | Text | 20 | No dashes. Required for Quantity records. | ||
costType | Cost type | Text | 1 | Required for Quantity records. | ||
dayOfMonth | Date | YES | Text | 10 | Enter as: MM/DD/CCYY (such as 01/05/2010). | Within P/R processing date range |
message | Message | Text | 30 | |||
payRateCode | Rate level | Text | 1 | 1 thru 9 only | ||
wageCode | Wage code | Text | 10 | |||
unionCode | Union code OR Pay group | Text | 10 | |||
workerCompCode | Work Comp | Text | 6 | |||
state | Work state | Text | 10 | |||
workCounty | Work county | Text | 10 | |||
workLocality | Work local | Text | 10 | |||
equipmentCode | Equipment | Text | 10 | |||
equipmentHours | Equipment Hours | Numeric | 8 | Enter decimals but no $ signs or commas. Can be positive or negative | ||
additionalJTDQuantity | Add'l JTD Qty | Numeric | 14 | Enter decimals but no $ signs or commas. Can be positive or negative | ||
companyCode2 | Company Code 2 | Text | 3 | For use with inter-company payroll. | ||
companyCode3 | Company Code 3 | Text | 3 | For use with inter-company payroll. | ||
payRate | Pay Rate | Numeric | 12 | Enter decimals but no $ signs or commas. Can be positive or negative | ||
costCategoryCode | Cost Category | Text | 4 | |||
crewNumber | Crew | Text | 10 | |||
woNumber | Work Order | Text | 10 | |||
woEquipment | WO Site Equipment | Text | 8 | |||
woComponent | WO Component | Text | 2 | |||
scContract | WO Contract | Text | 10 | |||
pmWorkOrder | Equipment Work Order | Text | 10 | |||
costCenter | Cost Center | Text | 10 | Cost Center Maintenance; G/L Account Cost Center; Job Cost Center; Phase Cost Center; Equipment Cost Center; Equipment Type Cost Center and Work Order Cost Center |