Update Job
Use this service to update any existing data for the defined job.
WSDL: UpdateJob.jws
Method: UpdateJob
Underlying File Maintenance
Prior to importing Job-Update information, these maintenance areas in
must be completed.- Job Cost
Assumptions and Dependencies
- The Job Master Update web service will update any existing data for the defined Job.
- The Job Master cost center flag is validated against the customer cost center.
- The Job Master Update does not modify existing AR Contracts for the Job.
- It creates new AR Contract for the Job if the Customer_Code is defined. It will use the Original_Amount field as well if defined but it is not required to create the AR Contract.
- If the AR Contract exists then a message is provided that it cannot be changed. The user will have to manually change the information on the Contract itself via Accounts Receivable.
- A new Contract is set up when a NEW Customer code and Original_Contract is defined in the layout.
- An existing Contract will not be update if the Customer code and Original_Contract is defined. This is an Accounts Receivable function not a Job function.
- The T+M Billing setup occurs when the Price_Method_Code is defined as Cost Plus or Time+Material and the Customer code is defined.
- The Report_Calc_Override field controls the 'Override Calculation for the contract status and profitability reports?' option. If defined as Y then one of the following fields needs to be defined
- Entered_Perecent_Complete
- Entered_Projected_Complete
- The Override Payroll work tax codes must be unique for each of the three defined.
- The earned calculation logic is based on the Price type defined on the Job.
- Phase mask, start/end major group and start/end minor group default from the Job Installation screen if fields are blank.
- Master Job logic
- The Master Job tied to the Sub Job must be valid and not have a complete status.
- The Master Job and Sub Job must have the same Phase length.
- The Sub Job will be created with the same Phase setup as the Master Job.
- The Sub Job will default the Master Job's Customer and Tax classification if left blank.
- The T+M billing submitted by each Sub Job option is selected on the Master Job and defaults to unselected unless a Sub Job defines the Bill_From_Master field option. The last created Sub Job controls this feature on the Master Job.
- The Job Setup page has an option to setup the Default Job Address used on the Purchase Orders. The 'Ship-to name' must be defined in order to modify the other fields such as address information and/or comments as needed.
- The Job cannot have both the Davis-Bacon and Prevailing wage options selected.
- The Estimated and Actual complete dates must be greater than or equal to the Estimated and Actual start dates.
- The Key personnel display as Job contacts if the Job Cost Installation option validates to the Employee code.
- The PR_OH_Type_Code field
- The following fields are not dependent on the PR_OH_Type Code field being defined -
- Payroll_OH_Percent
- PR_OH_Amount
- OH_Phase
- OH_Cost_Type
- If any of the above fields are populated they will be updated if they meet the PR_OH_Type_Code current setting.
- If the PR_OH_Type_Code field is defined as (N)one then it will ignore the above four fields.
- The following fields are not dependent on the PR_OH_Type Code field being defined -
- Cost center information will only be allowed in if the Company is set to a Pending or Yes status.
- Any field that is left blank will not be updated in Spectrum. The service does not delete values that exist in Spectrum; it only changes data defined in the layout.
Field Descriptions
Use the table below for reference when using this service.Excel | Element Name | Description | Req | Type | Max | Format | Validation |
---|---|---|---|---|---|---|---|
Authorization_ID | Authorization ID to access the server | YES | Text | 20 | Data Exchange Installation Screen | ||
GUID | Unique reference number created by programming | Text | 36 | ** See GUID definition | |||
B | Company_Code | Company Code | YES | Text | 3 | Valid Company in Spectrum. If blank, defaults from Authorization ID. | |
C | Job_Number | Job Number | YES | Text | 10 | No duplicates | |
D | Job_Description | Job Name | 25 | ||||
E | Division | Division Number | Numeric | 5 | Required if Job Cost installation option is selected. | ||
F | Address_1 | Address Line 1 | Text | 30 | |||
G | Address_2 | Address Line 2 | 30 | ||||
H | City | City | 25 | ||||
I | State | State | 2 | 2-digit postal abbreviation | |||
J | Zip_Code | Zip Code | 10 | ||||
K | Phone | Phone number | 14 | One of these formats:
| |||
L | Fax_Phone | Fax Number | |||||
M | Job_Site_Phone | Job Site Phone Number | |||||
N | Superintendent | Superintendent | Text | 15 | Employee Code if installation screen selected. | ||
O | Estimator | Estimator | |||||
P | Project_Manager | Project Manager | |||||
Q | Customer_Code | Customer Code | Text | 10 | **See Assumptions and Dependencies. | Customer Maintenance File | |
R | Contract_Number | Contract Number | 30 | ||||
S | Job_Type | Contract Type | 10 | ||||
T | Tax_Class_Code | Tax classification -Use Tax Code or A/R Sales Tax Code. | Text | 15 | Required based on the Job Cost installation settings. | JC Tax Classification Maintenance file. If JC install screen is set to 'Y' for Use Tax Classification. Or to A/R Sales Tax Maintenance File if Use Tax Classification flag is 'N'. | |
U | Taxable_Flag | Taxable Flag | 1 | Y(es) or N(o) only. | |||
V | Total_Units | Job Units | Numeric | 9 | Positive numbers only. | ||
W | Unit_of_Measure | Unit of Measure | Text | 5 | Units of Measure Maintenance File | ||
X | Certified_Flag | Certified Flag | Text | 1 | Y(es) or N(o) only. | ||
Y | Work_Comp_Code | Worker's Compensation Code | Text | 6 | Workers' Compensation Code Maintenance File | ||
Z | Wage_Rate_Level | Wage Rate Level | Numeric | 1 | Numbers 1-9 only | ||
AA | Price_Method_Code | Price Type Code | Text | 1 | (F)ixed Price, (T)ime & Material, (C)ost Plus, or (U)nit Price | ||
AB | Est_Start_Date | Estimated Start Date | Date | 10 | Text format for import MM/DD/CCYY | ||
AC | Est_Complete_Date | Estimated Complete Date | |||||
AD | Start_Date | Actual Start Date | |||||
AE | Complete_Date | Actual Complete Date | If Status_Code is Completed and this field is blank, the default value is the Job Cost processing date. | ||||
AF | Work_State_Tax_Code | Work State Tax Code | Text | 10 | The Work Tax codes must be unique. | Tax Table Maintenance | |
AG | Work_County_Tax_Code | Work County Tax Code | |||||
AH | Work_Local_Tax_Code | Work Local Tax Code | |||||
AI | Original_Contract | Original Contract Amount | Numeric | 14 | No change to Schedule of Values. **See Assumptions and Dependencies. | ||
AJ | WO_Site | Work Order Site | Text | 10 | Work Order Site Maintenance File | ||
AK | Latitude | Latitude | Numeric | 11 | Format for import - XXX.XXXXXX. | ||
AL | Longitude | Longitude | |||||
AM | Track_Davis_Bacon | Davis-Bacon Job | Text | 1 | Y(es) or N(o) only. | ||
AN | Track_Prevailing_Wage | Prevailing Wage Job and option | Y=Prevailing Wage, F=Regular wages include non-stated Fringes OR N=Not Prevailing Wage only | ||||
AO | Create_Date | Job Create Date | Date | 10 | Text format for import MM/DD/CCYY. If left blank it will use the date it was imported. | ||
AP | Cost_Center | Job Cost Center | Text | 10 | Cost Center Maintenance and Customer Code Cost Center | ||
AQ | Master_Job | Master Job | Text | 10 | Valid Job that does not have a complete status. Master Job must have the same Phase length as Job. | ||
AR | Bill_From_Master | Submit sub-job billings from the Master Job? | Text | 1 | Y(es) or N(o) only. Defined on the Master Job only. | Used in the Time+Material Module. Ignore if module is not active. | |
AS | Standard_Phase_Category | Phase setup category | Text | 10 | If defined, displays the Phase information as setup for each field. **See Assumptions and Dependencies. | Validates to the Phase Category | |
AT | Phase_Display_Code | Phase setup mask | 20 | If blank, defaults from Job Installation. If Sub-Job, defaults from Master Job. **See Assumptions and Dependencies.. | |||
AU | Major_Group_Start | Phase Major group start position | Numeric | 2 | |||
AV | Major_Group_End | Phase Major group end position | |||||
AW | Minor_Group_Start | Phase Minor group start position | |||||
AX | Minor_Group_End | Phase Minor group end position | |||||
AY | Status_Code | Status | Text | 1 | (A)ctive, (I)nactive or (C)omplete. Default is A. | ||
AZ | Owner_Name | Owner name | Text | 50 | |||
BA | Comment | Comment | Text | 125 | |||
BB | Reports_Calc_Override | Override calculation for contract status and profitability reports? | Text | 1 | Y(es) or N(o) only. | ||
BC | Entered_Percent_Complete | % complete - Override | Numeric | 5 | Format xxx.x Positive only. Field works with the Projected Cost Amount Override. **See Assumptions and Dependencies. | ||
BD | Entered_Projected_Cost | Projected Cost - Override | Numeric | 14 | Format -10.2 Field works with the Percent Complete Override. **See Assumptions and Dependencies. | ||
BE | Legal_Desc | Legal description | Text | 350 | |||
BF | Job_Oh_Batch_Code | Job overhead batch | Text | 10 | |||
BG | Routing_Code1 | A/P invoice approval default routing code | Text | 10 | Routing Code | ||
BH | Routing_Limit | A/P invoice approval invoice dollar limit | Numeric | 13 | Positive numbers only. | ||
BI | Routing_Code2 | A/P invoice approval routing code if overlimit | Text | 10 | Routing Code | ||
BJ | PO_Ship_Name | Override job address on PO- Ship-to name | Text | 30 | If defined, creates a new Job PO Ship-to address for the Job if it doesn't exist. If the Job has a defined PO Ship-to address, it modifies the information. Required if a PO_Ship_Name does not exist in Spectrum. | ||
BK | PO_Ship_Address1 | Override job address on PO- Ship-to address 1 | **See Assumptions and Dependencies. | ||||
BL | PO_Ship_Address2 | Override job address on PO- Ship-to address 2 | |||||
BM | PO_Ship_City | Override job address on PO- Ship-to city | 25 | ||||
BN | PO_Ship_State | Override job address on PO- Ship-to state | 2 | 2 digit postal abbreviation. **See Assumptions and Dependencies. | |||
BO | PO_Ship_Zip_Code | Override job address on PO- Ship-to zip code | 10 | **See Assumptions and Dependencies. | |||
BP | PO_Ship_Country | Override job address on PO- Ship-to country | 25 | ||||
BQ | PO_Ship_Comment | Override job address on PO- Ship-to address comment | 250 | ||||
BR | Earned_Calc_Type | Earned revenue calculation | Text | 1 | (P)ercent, (B)illed, (C)ost, or (M)aster job calculation. | ||
BS | Under_Billed | Unbilled Amount | Numeric | 12 | Used with the 'Billed' Earned_Calc_Type only. Otherwise ignore. Negative numbers allowed. Format = -xxxxxxxx.xx | ||
BT | Cost_Markup_Percent | Cost % | Numeric | 5 | Used with the 'Cost' Earned_Calc_Type only. Otherwise ignore. Positive number only and format = xxx.x | ||
BU | Job_Pay_When_Paid | Pay A/P invoice on this Job based on customer payment? | Text | 1 | Y(es) or N(o) only. | ||
BV | Job_Auto_Release_Percent | Percentage of non-retention portion of customer billing is paid for auto-release | Numeric | 5 | Cannot be zero. Positive number only and format = xxx.x or xx.xx | ||
BW | Job_Review_Percent | Percentage of non-retention portion of customer billing is paid to flag for review | |||||
BX | Auto_Ot_Flag | Apply Federal rules for auto-overtime? | Text | 1 | Y(es) or N(o) only. | ||
BY | Certified_Project_ID | Certified Payroll ID | Text | 50 | |||
BZ | Burden_Flag | Post actual burden to job? | Text | 1 | Y(es) or N(o) only. | ||
CA | Pre_TC_Burden_Percent | Payroll burden percentage | Numeric | 5 | Cannot be zero. Positive number only and format = xxx.x or xx.xx | ||
CB | Burden_Phase | Payroll burden phase | Text | 20 | Phase | ||
CC | Burden_Cost_Type | Payroll burden cost type | Text | 3 | Cost type | ||
CD | PR_OH_Type_Code | Payroll overhead type | Text | 1 | (N)one, (P)ercent or (A)mount/Hour **See Assumptions and Dependencies. | ||
CE | Payroll_OH_Percent | Payroll overhead percent | Numeric | 5 | Cannot be zero. Positive number only and format = xxx.x **See Assumptions and Dependencies. | ||
CF | PR_OH_Amount | Payroll overhead rate | |||||
CG | OH_Phase | Payroll overhead phase | Text | 20 | **See Assumptions and Dependencies. | ||
CH | OH_Cost_Type | Payroll overhead cost type | Text | 3 | Cost type | ||
CI | Lock_Revenue_Entry | Disallow revenue entry? | Text | 1 | Y(es) or N(o) only. Only used for Jobs with a complete job status. | ||
CJ | Certified_Week_Type | Certified Week numbering | Text | 1 | (F)-From first time card date, (W)=work weeks only, or (C) =calender year (starting 01/01). | ||
CK | Override_By_Job | Auto-overtime for this Job? | Text | 1 | Y(es) or N(o) only. | Must be Y to set Auto-overtime rules. | |
CL | Daily_OT_Start | Daily overtime starts at ? | Numeric | 5 | Positive numbers only. Format = 2.2 Cannot exceed 24 hours. | If Override_By_Job is Y and field is blank, defaults to 8. | |
CM | Weekly_OT_Start | Weekly overtime starts at ? | Numeric | 6 | Positive numbers only. Format = 3.2 Cannot exceed 168 hours. | If Override_By_Job is Y and field is blank, defaults to 40. | |
CN | Saturday_OT | Saturday overtime | Text | 1 | (S)ame rules as weekday, set all hours to (O)vertime, or set all hours to (D)oubletime. | If Override_By_Job is Y and field is blank, defaults to S. | |
CO | Sunday_OT | Sunday overtime | If Override_By_Job is Y and field is blank, defaults to S. |