Data Exchange Module Web Services Manual - cdp-inc.com · PDF filethem prior to updating to Spectrum. User-Defined Fields User-defined fields (UDF) allow the importing of additional

Data Exchange Module

Web Services Manual

Information in this document is subject to change without notice and does not represent a commitment on the part of Dexter + Chaney. The software described in this document is furnished under a license agreement. The software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specifically allowed in the agreement. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of Dexter + Chaney.

Spectrum®

Program Copyright 2016 © Dexter & Chaney, LLC. All rights reserved. v14 Spectrum Web Services © 2016 Dexter & Chaney, LLC.

All rights reserved. Spectrum®, Spectrum® Construction Software, Venture®, Venture® Project Collaboration Software, and Dexter + Chaney®

are registered trademarks of Dexter & Chaney, LLC. Other products and company names mentioned herein may be the trademarks of their respective owners.

Last revised on: July 29, 2016

TABLE OF CONTENTS

SPECTRUM WEB SERVICES ..................................................................................................... 1

OVERVIEW .................................................................................................................................. 1

WEB SERVICES TYPES.............................................................................................................. 2

FORMATTING GUIDELINES ....................................................................................................... 3 Date Fields ........................................................................................................................... 3 Numeric Fields .................................................................................................................... 3 Formatting Tips ................................................................................................................... 3 User-Defined Fields ............................................................................................................ 4 Layout Definitions ............................................................................................................... 4

ACCOUNTS PAYABLE ............................................................................................................... 6 Vendor .................................................................................................................................. 6 Vendor - Update ................................................................................................................ 13 Vendor – User-Defined Field ............................................................................................ 20 Vendor – Locations ........................................................................................................... 22 Vendor Notes ..................................................................................................................... 24 Vendor (AP) Use Tax ........................................................................................................ 25 Subcontract ....................................................................................................................... 27 Subcontract - Phases ....................................................................................................... 31 Subcontract – User-Defined Field ................................................................................... 34 Subcontract Notes ............................................................................................................ 37 Vendor Invoices ................................................................................................................ 38

ACCOUNTS RECEIVABLE ....................................................................................................... 46 Customer ........................................................................................................................... 46 Customer Bill-to ................................................................................................................ 50 Customer Ship-to .............................................................................................................. 52 Customer – User-Defined Field ....................................................................................... 54 Customer Notes ................................................................................................................ 57 Customer (AR) Sales Tax ................................................................................................. 58 Customer Invoices ............................................................................................................ 60 Cash Receipts ................................................................................................................... 64 AR Change Request.......................................................................................................... 68 AR Change Order .............................................................................................................. 75 AR Change Request or Change Order Notes ................................................................. 79 AR Pre-Billing Quantity .................................................................................................... 81

EQUIPMENT CONTROL ............................................................................................................ 84

Equipment – Required ...................................................................................................... 84 Equipment – Charges ....................................................................................................... 90 Equipment – Warranty ...................................................................................................... 93 Equipment – User-Defined Field ...................................................................................... 94 Equipment Notes ............................................................................................................... 96 Equipment Cost Transactions ......................................................................................... 97 Equipment Revenue Transactions .................................................................................. 99 Get Equipment Cost Category ....................................................................................... 103 Get Equipment ................................................................................................................. 105

EQUIPMENT TRACKING......................................................................................................... 107 Equipment Tracking Requisition ................................................................................... 107

GENERAL LEDGER ................................................................................................................ 111 G/L Account ..................................................................................................................... 111 G/L Account – User-Defined Field ................................................................................. 112 G/L Journal Entries ......................................................................................................... 115

INVENTORY ............................................................................................................................. 118 Inventory Items ................................................................................................................ 118 Inventory Items – Sell Price ........................................................................................... 122 Inventory Items – User-Defined Field ............................................................................ 123 Inventory Item Notes ...................................................................................................... 125 Inventory Receipts Transactions .................................................................................. 126 Inventory Job Requisitions ............................................................................................ 128 Get Inventory Items......................................................................................................... 132

JOB COST ............................................................................................................................... 134 Jobs .................................................................................................................................. 134 Job - Update .................................................................................................................... 140 Job – User-Defined Field ................................................................................................ 147 Job Cost Phase ............................................................................................................... 150 Job Notes ......................................................................................................................... 155 Phase Notes ..................................................................................................................... 156 Job Cost Transactions ................................................................................................... 157 Job Cost Projections ...................................................................................................... 159 Get Job ............................................................................................................................. 161 Get Job Main .................................................................................................................... 163 Get Job Dates .................................................................................................................. 166 Get Job Contacts ............................................................................................................ 168 Get Job UDF .................................................................................................................... 171 Get Phase ......................................................................................................................... 173 Get Phase - Enhanced .................................................................................................... 175

PAYROLL ................................................................................................................................. 177 Employee – Required ..................................................................................................... 177 Employee – Required Update ........................................................................................ 182 Employee – Personal ...................................................................................................... 188 Employee – Payroll Tax .................................................................................................. 192 Employee – User-Defined Field ..................................................................................... 200 Employee – Deduction/Add-ons .................................................................................... 202 Employee Notes .............................................................................................................. 204 Employee Entity .............................................................................................................. 205 Employee Entity Ded/Add-on Code ............................................................................... 206 Employee Entity Time Bank ........................................................................................... 209 Pre-Time Card Transactions .......................................................................................... 211 Get Employee .................................................................................................................. 217 Get Pay Types ................................................................................................................. 219 Get Wage Codes .............................................................................................................. 220

PROJECT MANAGEMENT ...................................................................................................... 222 Project Log ...................................................................................................................... 222 Project Log Notes ........................................................................................................... 227 Job Spec Section ............................................................................................................ 229 Project Log Recipient ..................................................................................................... 230 Get Discipline .................................................................................................................. 232 Get Project Log Jobs ...................................................................................................... 233

WORK ORDER......................................................................................................................... 234 Work Order Site Address ............................................................................................... 234 Work Order Site Equipment ........................................................................................... 237 Work Order Site Address – User-Defined Field ........................................................... 238 Work Order Header ......................................................................................................... 241 Work Order Header – User-Defined Field ..................................................................... 246 Work Order Header Notes .............................................................................................. 248 Work Order Labor Cost .................................................................................................. 249 Work Order Material Cost ............................................................................................... 254 Work Order Other Charges ............................................................................................ 258

Spectrum Web Services | 1

SPECTRUM WEB SERVICES

Dexter + Chaney created the Data Exchange Web Services to provide a secure, quick, and easy way to transfer data into Spectrum Construction Software. Using the Web Service’s three components will streamline time-consuming data entry processes via a secure web connection. The Spectrum Data Exchange Web Services provides the following benefits:

User friendly, Excel®-based interface Direct integration with Spectrum using a secure connection Instant validation and error display with the Spectrum Office Add-In Reduces administrative costs Automates internal processes Eliminates repetitive data entry and manual entry errors

OVERVIEW

The Spectrum Data Exchange’s Web Service contains three components:

Web Services Authorization ID with optional settings Spectrum Office Add-in

A Web Service is a method of communication between electronic devices over the web. Within Spectrum we have created a group of Web Services; each Web Service has predefined layouts with specific requirements and validation rules for the field names. The Web Services can be accessed using our Spectrum Office Add-in, which links data via Microsoft® Excel® or by connecting with a third-party website.

The secure Authorization ID is created in the Data Exchange Installation screen and provides access to the individual Web Services to send data to Spectrum. The Authorization ID can be set up for specific companies and Web Services. You can define specific options such as default options for field names, mapping user-defined fields, or creating counter overrides. Please see the Spectrum Help, Data Exchange Authorization Setup Guide for more details.

The Spectrum Office Add-in allows you to use Excel to create the necessary files to import into Spectrum via our Web Services within the Data Exchange module. The Spectrum Office Add-in needs to be updated (e.g., downloaded and installed) after each new release of Spectrum v14 is installed. Each Web Service has its own template that can be used to bring data into Spectrum. Each Web Service is defined below with specific requirements and validation rules for field names.


The Data Exchange Web Services has a predefined operator (e.g., *WS) that is defined during installation. The Operator ID displays anywhere an Operator ID is needed when a Web Service is used to import data into Spectrum.

The Data Exchange Web Service contains a validation hierarchy. Each Web Service follows the same logic and provides error reporting at each level. The logic is as follows:

1. Authorization and required fields. 2. Numeric, date, and generic validation (such as lengths, field type, field mask, defaults, and user-

defined fields mapping). 3. Validation that applies to the specific Web Service.

WEB SERVICES TYPES

A Web Service is a method of communication between electronic devices over the web. This communication can be used to add, update or retrieve data from the data base. The Data Exchange Web Services provide the following types of services:

A ‘Put’ Web Service provides the user the ability to add or update information within Spectrum. A ‘Get’ Web Service provide the user the ability to define a specific set of parameters which

then returns the defined data for the user to use.

The Authorization ID associated with a ‘Get’ Web Service requires a Spectrum operator to provide access based on the operator’s job based security and cost center logic. The Parameter fields are the available selection criteria used to collect the data. The Return fields are the results provided back from the web service.

Each ‘Get web service contains three fields at the end of each return layout that is used to provide information regarding any errors that may occur. The fields are defined as:

Error_Code – displays the web service sync status code. The same codes are used with the Spectrum Office Add-in in the Sync_Status column.

Error_Description – displays the associated description that applies to the error that is occurring. Error_Column – displays the parameter field name that is causing the error.

An example would be as follows: Error_Code = E Error_Description = The web service is not Authorized Error_Column = Authorization_ID


FORMATTING GUIDELINES

Date Fields The Web Services require that all dates use the following format: MM/DD/CCYY where MM is a two-digit month (01 = January, etc.), DD is a two-digit date (01, 14, 31, etc.) and CCYY is a four-digit year (1999, 2008, 2012, etc.). The date fields must have a separator between the month, day, and year (such as a slash (/) or dash (-) between the digits) for the Web Services to work.

Acceptable date formats: 01/02/1999, 05/22/2006, 12/31/2012, 05-22-2006 Unacceptable date formats: 1/2/99, 20060522, December 31, 2012

Numeric Fields The Web Service layouts have specific formats and length requirements for each numeric field which are defined within each layout. Some general guidelines for the numeric fields are as follows:

The Field Information column defines the specific rules and provides format examples if needed. The Field Information column defines whether the numeric field is a positive number only. Do not include dollar signs ($) or commas (,) in numeric fields. Negative numbers must be defined with the negative sign (-) at the beginning of the number and

without a space. o Acceptable: -10.2, -6785.52, -15000 o Unacceptable: 10.2-, 6785.52 -, 15000 –

The Max column defines the total number of characters that can be defined for each field. For numeric fields, the total number includes the negative sign (-) and the decimal place (.) if allowed.

o Example: Max value is 14 with no limitations defined in the Field Information column in the layout. Allows -1234567890.12

o Example: Max value is 6 for a positive percentage definition in the layout. Allows 123.12

o Example: Max value is 10 for a ‘Positive numeric format of XXX.XXXXXX’ defined in the layout. Allows 123.456789

Formatting Tips A variety of programming products have data formatting restrictions. Below are some tips to assist with the web service logic.

Limiting the use of special characters is beneficial in all field however Spectrum has key fields (e.g., Vendor code, Customer code, etc.) that cannot contain the following special characters:

o / forward slash o * asterisk o ? question mark o “ double quote


o ‘ single quote o > greater than o < less than o # pound sign o , comma o & ampersand o ~ tilde

Each element in the Web Service method contains a maximum field length (defined in the Max column). If the data defined exceeds the defined length then the value will be cut off which may result in bad data transferring into the Spectrum database.

Phone numbers and Social Security numbers are stored in the Spectrum database without dashes.

o The Excel Office Add-in allows the dashes to be defined and the programming removes them prior to updating to Spectrum.

User-Defined Fields User-defined fields (UDF) allow the importing of additional information into the Spectrum system. In Spectrum, these fields are controlled based on what the default user-defined field settings on the specific module installation screens are, and how they are set up. If a Web Service contains the UDF field names, then the UDF field names must be defined, or mapped, to the Authorization ID in order to import the fields. To map the fields, go to the Data Exchange Installation screen. Please see the Spectrum Help, Data Exchange Authorization Setup Guide for details on how to map the Web Services user-defined field options.

Layout Definitions Each Web Service created in the Spectrum Data Exchange module has a specific pre-defined layout with rules and definitions for each field. Each Web Service has some underlying file maintenance areas that need to be completed prior to using the Data Exchange along with specific assumptions and dependencies for the Web Service. The file format provides the following details.

Excel

o Defines the Excel column that ties to the Spectrum Office Add-in template. Field Name

o If the field name is bold and highlighted in yellow, then it is a required field for the service. Example: Company_Code

o If the field name is highlighted in blue, then it is a cost center field for the service and would be required if bringing data into a company using cost center logic. Example: Cost_Center

o Defines the field name that ties to the Spectrum Office Add-in along with the mapping logic for the Web Service.

Description o Provides a description for the field name and relates to the name shown on the

Spectrum entry screen.


Type o Defines the data type required for the field such as text, numeric, or date.

Max o Defines the total number of characters allowed for the field name. o The total amount of characters includes any character needed for a numeric or date

field. Example: Date field = 10 characters, including slashes.

10/12/2012 Example: Numeric field = 8 characters, including the negative sign and decimal.

-1525.66

Field Information o Provides rules for the specific field such as:

Format rules Character options allowed Rules if field is left blank Specific rules that may apply

Validation o Defines the tables that the field will be validating against. o Provides any specific logic used for the field.


ACCOUNTS PAYABLE

Vendor

Web Service name = AddVendor – Add Vendor

Underlying File Maintenance Prior to importing Vendor information, the following file maintenance areas must be completed:

Accounts Payable Installation screen General Ledger | G/L Master File Maintenance Accounts Payable | Use Tax Code Maintenance (if applicable) Accounts Payable | Invoice Approval Routing Maintenance (if applicable) Accounts Payable | Vendor User-Defined Fields Maintenance (if applicable)

Assumptions and Dependencies The Vendor Master cost center flag is shared. The Vendor import will validate that the company has the

cost center option set to Pending or Yes and will set the default for the new Vendor to Shared. The Vendor status will default to (A)ctive. The defined Contact_Name will be the primary contact. The Vendor-Add Web service supports the USA Year End Reporting information. The Vendor-Update

Web service supports the Canadian Year End Reporting information. The Fed_1099_Indicator will defaults to 7 if the field is blank and the Send_1099_Flag is set to Y. If the Send_1099_Flag is blank or N and the Fed_1099_Indicator, Social_Sec_Number and/or the

Fed_Id_Number are defined they will be added to the Vendor. The Social_Sec_Number and Fed_Id_Number cannot be populated at the same time. Each Vendor can

only contain one of those two fields. If the Send_1099_Flag is set to Y, it is highly recommended that you include either the social security

number or the Federal Tax ID number, along with the 1099 indicator (7 is non-employee compensation). The combined value of the Distribution % fields must equal 100%. For each G/L Account defined, a

corresponding Distribution % must exist. This Web Service works with the defined Workflow process in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.

Excel Field Name Description Type Max Field

Information Validation

B Company_Code Company Code Text 3 Valid Company in Spectrum

C Vendor_Code Vendor Code Text 10 Unique identifier / No commas

UPPERCASE FORMAT-NO SYMBOLS

D Vendor_Name Vendor Name Text 30 No commas

E Alpha_Sort Vendor Alpha Ref Text 6 No commas

F Type Vendor Type Text 6

G Address_1 Address 1 Text 30

H Address_2 Address 2 Text 30

I Address_3 City Text 25




J State State/province Text 2

2 character postal abbreviation

K Zip_Code Postal code Text 10

L Phone Phone Number Text 14

Formatted e.g., (206) 555-1212 or 123-123-1224 or 123-1233 or 1231231235.

M Fax_Phone Fax # Text 14


N Contact_Name Contact Name Text 20

O Our_Account_Number Account reference Text 25

P Terms_Code

Payment due terms (A or B only) Text 1

Enter 'A' if based on invoice date. Enter 'B' if based on 1st of next month.

Q Terms_Days Days Payment Due Numeric 3

Positive numbers only.

R Terms_Disc_Code Discount Due (A or B only) Text 1


S Terms_Disc_Days Days Discount Due Numeric 3


T Terms_Disc_Percent Discount % Numeric 6

Enter 10.25% as 10.25. Positive numbers only.

U Insurance_Cert_Flag Ins Cert Text 1 (Y)es or(N)o only

V Insurance_Exp_Date Ins Expiration Date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010)

W Hold_Flag On Hold? Text 1 (Y)es or(N)o only

X Default_GL_Account Default G/L Code Numeric 12

Code must have an Active status. No dashes.

G/L Master File Maintenance

Y GL_Distribution_Acct_List1

Multiple G/L Code (1) Numeric 12

Must be a Non-Direct G/L code with an Active





status. No dashes.

Z GL_Distribution_Acct_List2


Must be a Non-Direct G/L code with an Active status. No dashes.


AA GL_Distribution_Acct_List3




AB GL_Distribution_Acct_List4




AC GL_Distribution_Acct_List5




AD GL_Distribution_Acct_List6




AE GL_Distribution_Acct_List7




AF GL_Distribution_Acct_List8




AG GL_Distribution_Acct_List9




AH GL_Distribution_Acct_List10

Multiple G/L Codes (10) Numeric 12






AI GL_Distrib_Percent_List1 Distribution % (1) Numeric 5


The combined value of the 'Distribution %' fields must = 100%. For each GL Account defined a corresponding Distribution % must exist.

AJ GL_Distrib_Percent_List2 Distribution % (2) Numeric 5



AK GL_Distrib_Percent_List3 Distribution % (3) Numeric 5



AL GL_Distrib_Percent_List4 Distribution % (4) Numeric 5



AM GL_Distrib_Percent_List5 Distribution % (5) Numeric 5



AN GL_Distrib_Percent_List6 Distribution % (6) Numeric 5






AO GL_Distrib_Percent_List7 Distribution % (7) Numeric 5



AP GL_Distrib_Percent_List8 Distribution % (8) Numeric 5



AQ GL_Distrib_Percent_List9 Distribution % (9) Numeric 5



AR GL_Distrib_Percent_List10

Distribution % (10) Numeric 5



AS Use_Tax_Code Sales/Use Tax Code Text 15

Use Tax Code Maintenance

AT Send_1099_Flag 1099-Misc applicable? Text 1

(Y)es or(N)o only

*See Assumptions and Dependencies.

AU Alt_1099_Name Alternate Name Text 30 No commas

AV Fed_1099_Indicator 1099 Pmt Indicator Text 1

1; 2; 3; 4; 5; 6; 7; 8; 9 or A only (7 for non-employee compensation box)

*See Assumptions and Dependencies. Defaults to 7 if blank and the Send_1099_Flag = Y.

AW Social_Sec_Number Social Security # Text 9

Format = 123456789. If defined then Fed_Id_Number must be blank.





AX Fed_Id_Number Federal ID # Text 12

If defined then Social_Soc_Number must be blank.


AY Disadv_Business_Flag DBE Text 1 (Y)es or(N)o only

AZ Disadv_Business_Type DBE Type Text 10

BA Routing_Code1 Routing Code for Invoice Approval Text 10

Routing Code Maintenance

BB Routing_Code2

Routing Code for Over Limit Invoice Approval Text 10


BC Routing_Limit Routing Limit Invoice Approval Numeric 13


BD Vendor_Email Vendor Email Text 80 Example: [email protected]

Must be the basic layout for an email address.

BE Contact_Phone Contact Phone Text 14


BF UDF1

User Defined Alpha/ Numeric/Date 1 + 20

Web Service Authorization ID Service UDF defined.

BG UDF2



BH UDF3



BI UDF4



BJ UDF5



BK UDF6

User Defined Alpha/Numeric/Date 6 + 20


BL UDF7



BM UDF8



BN UDF9






BO UDF10



BP UDF11



BQ UDF12



BR UDF13



BS UDF14



BT UDF15



BU UDF16



BV UDF17



BW UDF18



BX UDF19



BY UDF20




Vendor - Update

Web Service name = UpdateVendor – Change Vendor

Underlying File Maintenance Prior to importing Vendor information, the following file maintenance areas must be completed:

Accounts Payable Installation screen General Ledger | G/L Master File Maintenance Accounts Payable | Vendor Accounts Payable | Use Tax Codes (if applicable) Accounts Payable | Invoice Approval Routing Maintenance (if applicable) Cash Management | Accounts (if applicable)

Assumptions and Dependencies The Vendor code must exist in the defined Company code. The Vendor-Update Web Service updates an existing Vendor’s information for the defined fields only. The Vendor-Update Web Service updates the Canadian Year End Reporting. 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. The Payroll Installation | Properties Tab | Payroll reporting field controls the fields displayed on the Year

End Reporting Page for the Vendor Master. o The Web Service contains fields for both the US 1099 and the Canadian T5018. o If data is defined in a field that is not supported based on the Payroll reporting option then it will

be ignored. United States 1099 fields

o The Fed_1099_Indicator will defaults to 7 if the field is blank and the Send_1099_Flag is set to Y. o If the Send_1099_Flag is blank or N and the Fed_1099_Indicator, Social_Sec_Number and/or the

Fed_Id_Number are defined they will be added to the Vendor. o The Social_Sec_Number and Fed_Id_Number cannot be populated at the same time. Each

Vendor can only contain one of those two fields. o If the Send_1099_Flag is set to Y, it is highly recommended that you include either the social

security number or the Federal Tax ID number, along with the 1099 indicator (7 is non-employee compensation).

Canadian T5018 fields o The Social_Insurance_Number and Recipient_Account_Number cannot be populated at the

same time. Each Vendor can only contain one of those two fields and are available to each Recipient Type defined.

o The Recipient_Type_Code defined controls specific fields that are available and may be required. Type = 1 (Individual)

Individual_First_Name and Individual_Last_Name are required. Partnership_Filer_ID_Number and Alternate_T5018_Name are not available.

Type = 3 (Corporation) Partnership_Filer_ID_Number , Individual_First_Name, Individual_Middle_initial

and Individual_Last_Name are not available. Type = 4 (Partnership)

Partnership_Filer_ID_Number is required. Individual_First_Name, Individual_Middle_initial, and Individual_Last_Name are

not available. The combined value of the Distribution % fields must equal 100%. For each G/L Account defined, a

corresponding Distribution % must exist. This Web Service will ignore the defined Workflow process in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.


Excel Field Name Descriptio

n Type Max

Field Information

Validation

B Company_Code Company Code Text 3

Valid Company in Spectrum

C Vendor_Code Vendor Code Text 10 Vendor

D Vendor_Name Vendor Name Text 30 No commas

E Alpha_Sort Vendor Alpha Ref Text 6 No commas

F Type Vendor Type Text 6

G Our_Account_Number Account reference Text 25

H Address_1 Address 1 Text 30

I Address_2 Address 2 Text 30

J City City Text 25

K State State/province Text 2


L Zip_Code Postal code Text 10

M Addr_Country Country Alpha 25

N Phone Phone Number Text 14


O Fax_Phone Fax # Text 14


P Vendor_Email Vendor Email Text 80 Example: [email protected]


Q Web_Site Website Alpha 80 Example: xxx.com

R Disadv_Business_Flag DBE Text 1 (Y)es or(N)o only

S Disadv_Business_Type DBE Type Text 10

T Small_Business

Small business enterprise (SBE)? Text 1 (Y)es or(N)o only

U Minority_Business Minority-owned Text 1 (Y)es or(N)o only



n Type Max

Field Information

Validation

business enterprise (MBE)?

V Woman_Business

Woman-owned business enterprise (WBE)? Text 1 (Y)es or(N)o only

W Veteran_Business

Veteran-owned business enterprise (VBE)? Text 1 (Y)es or(N)o only

X Status Status Alpha 1 (A)ctive, (I)nactive or (N)ot used

Y Routing_Code1

Routing Code for Invoice Approval Text 10


Z Routing_Limit

Routing Limit Invoice Approval

Numeric 13


AA Routing_Code2

Routing Code for Over Limit Invoice Approval Text 10


AB Use_Tax_Code Sales/Use Tax Code Text 15


AC Default_GL_Account Default G/L Code

Numeric 12

Code must have an Active status.


AD Hold_Flag On Hold? Text 1 (Y)es or(N)o only

AE GL_Distribution_Acct_List1

Multiple G/L Code (1)

Numeric 12

Must be a Non-Direct G/L code with an Active status.


AF GL_Distribution_Acct_List2


Numeric 12



AG GL_Distribution_Acct_List3


Numeric 12



AH GL_Distribution_Acct_List4


Numeric 12





n Type Max

Field Information

Validation

AI GL_Distribution_Acct_List5


Numeric 12



AJ GL_Distribution_Acct_List6


Numeric 12



AK GL_Distribution_Acct_List7


Numeric 12



AL GL_Distribution_Acct_List8


Numeric 12



AM GL_Distribution_Acct_List9


Numeric 12



AN GL_Distribution_Acct_List10

Multiple G/L Codes (10)

Numeric 12



AO GL_Distrib_Percent_List1 Distribution % (1)

Numeric 5

Enter 10.5% as 10.5. Positive number only.


AP GL_Distrib_Percent_List2 Distribution % (2)

Numeric 5



AQ GL_Distrib_Percent_List3 Distribution % (3)

Numeric 5



AR GL_Distrib_Percent_List4 Distribution % (4)

Numeric 5


The combined value of the 'Distribution %' fields must = 100%. For each GL Account defined a corresponding



n Type Max

Field Information

Validation

Distribution % must exist.

AS GL_Distrib_Percent_List5 Distribution % (5)

Numeric 5



AT GL_Distrib_Percent_List6 Distribution % (6)

Numeric 5



AU GL_Distrib_Percent_List7 Distribution % (7)

Numeric 5



AV GL_Distrib_Percent_List8 Distribution % (8)

Numeric 5



AW GL_Distrib_Percent_List9 Distribution % (9)

Numeric 5



AX GL_Distrib_Percent_List10 Distribution % (10)

Numeric 5



AY Terms_Code

Payment due terms (A or B only) Text 1




n Type Max

Field Information

Validation

AZ Terms_Days Days Payment Due

Numeric 3


BA Terms_Disc_Code Discount Due (A or B only) Text 1


BB Terms_Disc_Days Days Discount Due

Numeric 3


BC Terms_Disc_Percent Discount % Numeri

c 6


BD Insurance_Cert_Flag Ins Cert Text 1 (Y)es or(N)o only

BE Insurance_Exp_Date Ins Expiration Date Date 10


BF PO_Method

Purchase Order Default? Text 1

1 = One Step Receiving, 2 = Two Step Receiving

BG Vendor_Status Payment method Text 1

(P)rint Check, (S)end electronic pre-note, (E)lectronic payment, or (C )omdata

BH Checking_Account_Code

Electronic payment account code Text 17

BI Account_Type

Electronic payment account type Text 1

(C )hecking or (S)aving

BJ ABA_Number

Electronic payment ABA routing #

Numeric 9

BK Bank_Account_Code Credit Card account code Text 15

Cash Management Credit Card account code

BL Send_1099_Flag 1099-Misc applicable? Text 1 (Y)es or(N)o only

Used for United States 1099. *See Assumptions and Dependencies.

BM Alt_1099_Name Alternate Name Text 30 No commas.


BN Fed_1099_Indicator 1099 Pmt Indicator Text 1

1; 2; 3; 4; 5; 6; 7; 8; 9 or A only (7 for non-employee compensation box)

Used for United States 1099. Defaults to 7 if blank and the Send_1099_Flag = Y



n Type Max

Field Information

Validation

BO Social_Sec_Number Social Security # Text 9

Format = 123456789. If defined then Fed_Id_Number must be blank.


BP Fed_Id_Number Federal ID # Text 12

If defined then Social_Soc_Number must be blank.


BQ Recipient_Type_Code Recipient type Text 1

(1) - Individual, (3) - Corporation or (4) - Partnership only

Used for Canadian T5018. *See Assumptions and Dependencies

BR Social_Insurance_Number Social insurance #

Numeric 9

If defined then Recipient_Account_Number must be blank. No dashes. Must be 9 characters.


BS Recipient_Account_Number

Recipient account # Text 15

If defined then Social_Insurance_Number must be blank. No dashes. Must be 15 characters.


BT Partnership_Filer_ID_Number

Partnership filer # Text 9

Required when Recipient type = 4


BU Alternate_T5018_Name Alternate Name Text 30

Not available when Recipient type = 1


BV Individual_First_Name First name Text 12 Required when Recipient type = 1


BW Individual_Middle_Initial Middle initial Text 1 Available when Recipient type = 1


BX Individual_Last_Name Last name Text 20 Required when Recipient type = 1



Vendor – User-Defined Field

Web Service name = UpdateVendor_UDF – Change Vendor UDF

Underlying File Maintenance Prior to importing Vendor-UDF information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Accounts Payable | Vendor Accounts Payable | Vendor User-Defined Fields Maintenance

Assumptions and Dependencies The Vendor code must exist in the defined Company code. The Vendor-UDF Web Service adds or updates an existing Vendor’s User Defined Field information for

the defined fields only. 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. The Vendor user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.




C Vendor_Code Vendor Code Text 10

Vendor Code must exist for the defined Company Code.

D UDF1 User Defined Alpha/Numeric/Date 1 + 20


E UDF2 User Defined Alpha/Numeric/Date 2 + 20


F UDF3 User Defined Alpha/Numeric/Date 3 + 20


G UDF4 User Defined Alpha/Numeric/Date 4 + 20


H UDF5 User Defined Alpha/Numeric/Date 5 + 20


I UDF6 User Defined Alpha/Numeric/Date 6 + 20


J UDF7 User Defined Alpha/Numeric/Date 7 + 20


K UDF8 User Defined Alpha/Numeric/Date 8 + 20





L UDF9 User Defined Alpha/Numeric/Date 9 + 20


M UDF10



N UDF11



O UDF12



P UDF13



Q UDF14



R UDF15



S UDF16



T UDF17



U UDF18



V UDF19



W UDF20




Vendor – Locations

Web Service name = UpdateVendor_Locations – Change Vendor Locations

Underlying File Maintenance Prior to importing Vendor-Locations information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Accounts Payable | Vendor Accounts Payable | Vendor Locations

Assumptions and Dependencies The Vendor code must exist in the defined Company code. The Vendor-Location web service will either create a new Location code or update an existing Location

code. o To add a new Location_Code, leave this field blank and it will use the next available numeric

sequence number. o To change information, define the unique Vendor_Code and Location_Code fields in the layout.

This will update all the detail information provided. 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 If the Status is blank and a new Location is being created it will default to be Active. The Default_Payment_Loc field selection can only exist with one Location code. If defined it the layout it

will change the Vendor default logic to use that code. The Default_Purchase_Loc field selections can only exist with one Location code. If defined it the layout it

will change the Vendor default logic to use that code. If the Location_Status is Inactive then the Default_Payment_Loc and Default_Purchase_Loc fields default

to N and are not available on the screen. Records cannot be updated when user is locking the entry screen.




Valid Company in Spectrum. Defaults from the Authorization ID if not populated.


Vendor Code must exist for the defined Company Code.

D Location_Code Location code Text 4

Unique combination of Vendor code and Location code. If blank auto populate with next available number. If exists then modify data otherwise add new location. Vendor Location




E Location_Name Location name Text 30

Required if creating a new Location code.

F Loc_Telephone Location telephone Numeric 14


G Loc_Fax Location fax Numeric 14


H Loc_Addr_1 Location Address 1 Text 30

I Loc_Addr_2 Location Address 2 Text 30

J Loc_Addr_City Location city Text 25

K Loc_Addr_State Location state/province Text 2


L Loc_Addr_Zip Location postal code Text 10

M Loc_Addr_Country Location country Text 25

N Location_Remarks Location remarks Text 250

O Default_Payment_Loc Default payment location? Text 1

(Y)es or(N)o only. Defaults to N if left blank. Ignore if Status is Inactive.

Exists for only one Location code and will overwrite current setting if defined.

P Default_Purchase_Loc Default 'purchase from 'location? Text 1

(Y)es or(N)o only. Defaults to N if left blank. Ignore if Status is Inactive.

Exists for only one Location code and will overwrite current setting if defined.

Q Location_Status Location status Text 1

'A'ctive or 'I'nactive. Defaults to A if left blank.


Vendor Notes

Web Service name = VendorNotes – Vendor Notes

Underlying File Maintenance Prior to importing Vendor Notes information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Accounts Payable | Vendor Maintenance Accounts Payable | Vendor Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Vendor_Code and Notes_Topic must exist in order to add the notes. The Vendor Notes web service has an option to append to the current Note Topic.

o If not defined then the Notes will be replaced. o The formatting options available within the Notes are not supported.

The Notes_Text can hold up to 1000 characters total in the table therefore if appending the notes and the value of the current notes plus the web service notes exceeds the limit, the web service notes will be truncated.

If duplicate records exist to be updated, then they will all be updated as they are processed.

Excel Field Name Description Type Max Field Information

Validation



C Vendor_Code Vendor Code Text 10 Valid Vendor

D Notes_Topic Notes Topic Text 20 Vendor Note Topics Maintenance

E Notes_Text Notes Text 1000

F Append_Note Append Notes? Text 1

(Y) to append. Blank = Replace all notes


Vendor (AP) Use Tax

Web Service name = Update_AP_Use_Tax – Add or Change AP Use Tax

Underlying File Maintenance Prior to importing Accounts Payable Use Tax information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Processing Dates Installation screen General Ledger | G/L Account Master File Maintenance Accounts Payable | Use Tax Maintenance Accounts Payable | Use Tax Rate History Maintenance

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Accounts Payable Use Tax web service will either create a new Use Tax code or update an existing

Use Tax code. The changes are recorded in the Rate History information. o If the Use_Tax_Code combination field does not exist then it will be added.

The Rate History will populate using the current AP processing date and display Initial Entry in the Comments field.

If the Effective_Date and Comments fields are populated they will be ignored since they are used changes and defined on the Rate History information.

o If the Use_Tax_Code combination field does exist then it will update all the detail information provided.

The Effective_Date and Comments fields are used for the Rate History information. Duplicate Effective dates cannot exist for a given Use_Tax_Code.

o The service does not delete values that exist in Spectrum; it only changes data defined in the layout.

Comments that exceed the Max character length will be truncated.

Excel Field Name Description Type Max Field Information Validation



C Use_Tax_Code Use tax code Text 15 If it exists then update the information.

Accounts Payable Use Tax Maintenance

D Use_Tax_Description Description Text 20

E Tax_GL_Account G/L account code Text 12

Must be a non-direct GL Account. No dashes.

General Ledger Account Maintenance

F Tax_Type Tax Type Text 1 S(ales) or U(se) only. Defaults to U(se) if blank.

G Tax_Percent Tax rate Numeri

c 7 Positive number only. Format = xx.xxxx

H Effective_Date Effective as of Date 10

If blank then uses current processing date. Enter as: MM/DD/CCYY (e.g.,

Must be current or future date for AP Processing date.



01/05/2010). **See Assumptions and Dependencies

Rate change cannot exist for the defined date.

I Comments Comments Text 40 **See Assumptions and Dependencies


Subcontract

Web Service name = UpdateSubcontract – Add or Change Subcontract

Underlying File Maintenance Prior to importing Subcontract information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Accounts Payable | Subcontract Accounts Payable | Vendor File Maintenance Job Cost Installation screen Job Cost | Jobs Job Cost | Job Phases Job Cost | Cost Type File Maintenance General Ledger | G/L Master File Maintenance

Assumptions and Dependencies The Subcontract Web Service adds or updates existing Subcontract information for the defined fields

only. The unique combination of the Vendor code and Subcontract number must exist in the defined Company

code to change the data provided. The following fields are required when creating a new Subcontract record.

o Company_Code o Vendor_Code o Subcontract_Number o Job_Number o GL_Account

The following fields are required to change an existing Subcontract record. o Company_Code o Vendor_Code o Subcontract_Number o If the Job_Number is defined it must be valid for the above data.

The Date_Issued field must exist within the Fiscal Calendar and will default to the current processing date if left blank.

In order to override the Vendor defaults for the Payment terms or the Discount terms their associated Override options must be defined as Y. The web service will only change the data if the override is marked with a Y.

The Contact_Person field is not associated with the Spectrum Contacts. It is a text field for the Subcontract only.

The standard Module Installation options will be used to create the Subcontract. 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.









D Subcontract_Number Subcontract Number Text 10

No duplicate combination of Vendor and Subcontract number.

E Job_Number Job Text 10

Required for new record only. The Job cannot be changed on an existing Subcontract. Jobs

F Default_Phase_Code Phase Text 20 No dashes. Phases

G Default_Cost_Type Cost type Text 3 Cost Type

H Status_Code Status Text 1

(A)ctive, (I)nactive or (C )omplete. If blank then default to Active when creating a new record.

I Contract_Type Contract type Text 15

J Insurance_Cert_Flag Insurance Text 1

(Y)es, (N)o or (A)for not applicable. Defaults from Vendor if blank.

K Sent_Date Date sent Date 10


L Date_Issued Date issued Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). Defaults to current processing date if blank.

Fiscal Calendar must exist.

M Contact_Person Contact Text 20

Not part of the Contact Master in Spectrum.

N Unit_Price_Flag Unit price contract? Text 1

(Y)es or (N)o. Defaults as yes if Unit Price Job. Defaults to N if blank.

O Comment Comment Text 120




P Routing_Code1 Invoice approval default routing code Text 10


Q Routing_Limit Invoice approval invoice dollar limit

Numeric 13

Positive numbers only. Format = -10.2

R Routing_Code2

Invoice approval routing code over limit Text 10


S GL_Account GL Account Numeri

c 12

Required when creating a new Subcontract. The GL Account code must be a direct Job cost account.


T Retention_Percent Invoice default Retention %

Numeric 5

Enter 10.2% as 10.2. Positive numbers only. Format = 2.1

U Next_Payment_Number Invoice default next payment

Numeric 5

Positive numbers only. Defaults to 1 if adding a new subcontract.

V Pay_Override

Override standard vendor payment terms? Text 1

Enter (Y)es to override. Defaults to N if blank.

W Pay_Terms Payment due Based on Text 1

Enter 'A' if based on invoice date.Enter 'B' if based on 1st of next month.

Defaults from Vendor, if Pay_Override is not a Y.

X Pay_Days Payment Due - number of days

Numeric 3


Defaults from Vendor, if Pay_Override is not a Y.

Y Disc_Override

Override standard vendor discount terms? Text 1

Enter (Y)es to override. Defaults to N if blank.

Z Disc_Terms Discount due based on Text 1


Defaults from Vendor, if Disc_Override is not a Y.

AA Disc_Days Discount due - number of days

Numeric 3






AB Disc_Perc Discount % Numeri

c 6




Subcontract - Phases

Web Service name = UpdateSubcontractPhases – Add or Change Subcontract Phases

Underlying File Maintenance Prior to importing Subcontract-Phases information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Accounts Payable | Subcontract Accounts Payable | Vendor File Maintenance Job Cost Installation screen Job Cost | Jobs Job Cost | Job Phases Job Cost | Cost Type File Maintenance General Ledger | G/L Master File Maintenance

Assumptions and Dependencies The Subcontract-Phase Web Service adds or updates existing Subcontract information for the defined

fields only. The unique combination of the following must exist in order to change the data otherwise create a new

subcontract phase. The standard Spectrum logic will automatically default any missing information when looking for an existing Subcontract Phase detail.

o Company_Code o Vendor_code o Subcontract_number o Phase_Code o Cost_type o Bid_Item_Number

Duplicates cannot exist in the Phase Detail of the Subcontract record for the required fields. o The same Phase/Cost Type can exist on the Subcontract as long as the Billing Items are unique.

The standard GL Account logic will be used for validation for the Job and Cost type defaults. If the Phase_Code and Cost_Type are blank then it will default from the Subcontract if they are defined

otherwise these fields will be required. If the Phase_Code and Cost_Type are defined and the following fields are blank then they will default

from the Phase_Code: o Bid_Item_Number o Bill_Description o Unit_Of_Measure o Rentention_Flag o Unit_Price

The Bid_Item_Number field will use the first two characters as the Billing Group if the Job is a unit price Job.

For Unit Price Subcontracts, if a phase price type is set to Job default or Unit Price then only the UM (unit of measure) of LS (lump sum) can change the record to a Fixed Price amount. All other Job Phase price types act as a fixed price.

The Unit of Measure’s price method controls the fields (dollars and quantity) that can be populated. If it is defined as Fixed Price then only the Orginal_Contract_Amount field will be updated and all other fields will be ignored.

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.


Excel

Field Name Description Type Max Field Information Validation





No duplicate combination of Vendor and Subcontract number.

E Phase_Code Phase Text 20

No dashes. Must exist on the Job and required if not defined on Subcontract. *See Assumptions and Dependencies. Phases

F Cost_Type Cost type Text 3

Must exist on the Job and required if not defined on Subcontract. *See Assumptions and Dependencies. Cost Type

G Bid_Item_Number Billing Item Text 10

The billing item is broken into Group and Item for Unit Price jobs. The first 2 characters will be defined as the Group when the Job is Unit Price. *See Assumptions and Dependencies.

H Bill_Description Description Text 25 *See Assumptions and Dependencies.

I Unit_Of_Measure Unit of Measure Text 2 *See Assumptions and Dependencies.

J Retention_Flag Retainage? Text 1

(Y)es or (N)o. Defaults to N if blank or based on Phase. *See Assumptions and Dependencies.

K Unit_Price Unit Price Numeri

c 12

Allows negatives. Format = -6.4 *See Assumptions and Dependencies.

L Original_Contract_Quantity Original Quantity

Numeric 12

Allows negatives. Format = -8.2


Excel

Field Name Description Type Max Field Information Validation

M Original_Contract_Amount Original Amount Numeri

c 13

If Unit_Price and Original_Contract_Quantity are populated then Original_Contract_Amount is calculated. Allows negatives. Format = -9.2 *See Assumptions and Dependencies.


Subcontract – User-Defined Field

Web Service name = UpdateSubcontract_UDF – Change Subcontract UDF

Underlying File Maintenance Prior to importing Subcontract User-Defined Field information, the following file maintenance areas must be completed:

Accounts Payable Installation screen Accounts Payable | Subcontract Maintenance Accounts Payable | Subcontract User_Defined Fields Maintenance

Assumptions and Dependencies The unique combination of the Vendor code and Subcontract number must exist in the defined Company

code. The Subcontract-UDF Web Service adds or updates an existing Subcontract’s User Defined Field

information for the defined fields only. 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. The Subcontract user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.






Valid combination of Vendor_Code and Subcontract_Number Vendor


Valid combination of Vendor_Code and Subcontract_Number Subcontract




















M UDF9 User Defined Alpha/Numeric/Date 9 + 20


N UDF10



O UDF11



P UDF12



Q UDF13



R UDF14



S UDF15



T UDF16



U UDF17


Web Service Authorization ID




Service UDF defined.

V UDF18



W UDF19



X UDF20




Subcontract Notes

Web Service name = SubcontractNotes – Subcontract Notes

Underlying File Maintenance Prior to importing Subcontract Notes information, the following file maintenance areas must be completed:

Accounts Payables Installation screen Accounts Payables | Subcontract Accounts Payables | Subcontract Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Vendor_Code, Subcontract_Number and Notes_Topic must exist in order to add the notes. The Subcontract Notes web service has an option to append to the current Note Topic.








Valid combination of Vendor_Code and Subcontract_Number Vendor


Valid combination of Vendor_Code and Subcontract_Number Subcontract

E Notes_Topic Notes Topic Text 20 Customer Note Topics Maintenance

F Notes_Text Notes Text 1000

G Append_Note Append Notes? Text 1 (Y) to append. Blank = Replace all notes


Vendor Invoices

Web Service name = AddAPInvoice – Add Vendor Invoices

Underlying File Maintenance Prior to importing Vendor Invoice information, the following file maintenance areas must be completed:

Accounts Payable Installation screen General Ledger | G/L Master File Maintenance General Ledger | Value Added Tax Code Maintenance (if applicable) Accounts Payable | Vendors Accounts Payable | Subcontracts (for job/customer combinations) Accounts Payable | Use Tax Code Maintenance (if applicable) Job Cost | Jobs (if applicable) Job Cost | Job Phases (if applicable) Job Cost | Cost Type File Maintenance (if applicable) Equipment Control | Equipment (if applicable) Equipment Control | Cost Category File Maintenance (if applicable) Work Order | Site File Maintenance (if applicable) Work Order | Work Order Entry (with site equipment and components—if applicable) Work Order | Material Item Code File Maintenance (if applicable) Inventory Control | Inventory Items (if applicable) Service Contracts | Service Contract File Maintenance (if applicable) Accounts Payable | Invoice User-Defined Fields Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The import file contains one detail line per header record. The Distribution_GL_Account controls the logic based on the type of direct cost options selected for the

G/L Code. o If the General Ledger Code is set to Direct Cost = N (Non-direct):

Then any data defined in the Job Cost, Equipment, or Work Order fields will be ignored and not populated.

o If the General Ledger Code is set to Direct Cost = Y (Job Cost): The Job number, Phase code, and Cost type are mandatory and validated.

o If the General Ledger Code is set to Direct Cost = E (Equipment): The Equipment Code and Equipment Cost Category are both mandatory and validated. The Equipment_Work_Order is required optional or not allowed (none) based on the

defined Equipment Cost Category data entry rule. o If the General Ledger Code is set to Direct Cost = W (Work Order):

The Work Order Number and Item Code are required. The Item Code must be set up when the Inventory Control module is turned on. If the Inventory Control module is not on, then the Item Code is validated to the W/O Item

file maintenance. If the code exists, populate the Item Description, Unit Cost, and WO Unit Price

using standard Spectrum logic. If the code is not a WO Item, allow it to be entered as a ‘generic’ code using

Spectrum standard logic (Item_Desc and Unit_Cost are not populated).


Non-stock items are not supported and will be considered as ‘generic’ codes when the IC module is not present.

The Quantity, WO Service Contract, and WO Unit Price are NOT required. However the W/O Service Contract will be validated if populated. If the quantity field is populated, it updates only when the General Ledger Code is set to Direct Cost = W.

The W/O Equipment and W/O Component are required and validated when the W/O Installation ‘Require equipment code for work order transactions?’ and the ‘Require component code for work order transactions?’ boxes are selected.

Sales_Tax_Amount works in conjunction with the Tax_Code field and follows the logic defined with regards to the Distribution_GL_Account defined.

o For non-direct, Equipment or Work Order direct cost records: If the Sales_Tax_Amount is left blank then:

When the Tax_Code is populated or it defaults from the Vendor’s Sales/Use Tax code it must have a tax type defined as use tax.

When the Tax_Code is not populated and defaults blank because the Vendor’s Sales/Use Tax code is blank, the invoice is considered non-taxable.

If the Sales_Tax_Amount is populated then The Tax_Code entered or if blank and defaults from the Vendor’s Sales/Use Tax

code, it must have a tax type of sales tax. The Sales_Tax_Amount will be allocated to the detail lines when it doesn’t equal

the detail’s total tax calculation. o For Job Cost direct cost records:

If the Job Tax Classification features are not used then it follows the Vendor’s Tax code hierarchy.

If the Job Tax Classification features are used: When the Tax_Code is populated, the Job Tax Classification setup is ignored. If the Tax Class defaults by Vendor and the Vendor’s Sales/Use Tax code is

populated then it follows the Vendor’s hierarchy. If the Vendor’s Sales/Use Tax code is blank it uses the Job’s Tax Classification code; if it is defined as blank, then the invoice is considered non-taxable.

When the Tax Class defaults by Job and the Job has a Tax Classification code, then if follows the Tax Classification code hierarchy:

o If an A/P Override exists then it will follow standard Spectrum logic. o If the Job’s Tax Classification code is blank, it uses the Vendor’s

Sales/Use Tax code, unless it is blank, then the invoice is considered non-taxable.

If the Sales_Tax_Amount is blank then o The Tax code defaulted must have a tax type defined as use tax, or if an

A/P Override exists it must be set as tax exempt. If the Sales_Tax_Amount is populated then

o The Tax code defaulted must have a tax type of sales tax or if an A/P Override exists it must be set as taxable.

o The Sales_Tax_Amount will be allocated to the detail lines when it doesn’t equal the detail’s total tax calculation.

Value Added Tax (VAT) o The Company Installation allows the user to add functionality to use Value Added Tax logic and

to define a default code.


If selected then the Invoice header contains additional fields appear for the VAT code and amount and the Sales Tax field name changes to PST and the Retention name changes to Holdback.

The VAT is calculated on the total Invoice amount. o If selected then the VAT_Code and Total_VAT_Amt can be defined on the Invoice header. o VAT_Code can be defaulted from the GL Installation screen or defined on the Invoice. If it is not

valid then both the VAT_Code and Total_VAT_Amt information defined in the record. o Total_VAT_Amt can be either calculated based on the defined VAT_Code or overwritten by the

defined value in the record. Follows standard Spectrum logic to define the ‘Pay when Paid’ setting. PO_Number is no longer used. Leave this field blank. If defined then it will be stored in the Remarks field

if it is blank, otherwise it will cause an error. Cost Center information will only be allowed in if the Company is set to a Yes status. Cost Center Logic:

o The Liability_Cost_Center (Header Cost Center) is required if a cost center company is specified, it must be active, valid for the AP GL Account and Vendor Code.

o The Expense_Cost_Center (Detail Cost Center) field name is required, however it can be defaulted if left blank and will use the following logic:

For a non-direct Distribution_GL_Account: If the Expense_Cost_Center is defined then the cost center must

be active, a valid cost center for the Distribution_GL_Account and the Vendor_Code.

If the Expense_Cost_Center is not entered, it will attempt to use the Liability_Cost_Center as long as it is valid for the Distribution_GL_Account and the Vendor_Code.

When a direct Distribution_GL_Account is defined in the layout, then the Expense_Cost_Center (if entered) must be a valid and active cost center. However, it could be overwritten based on the following standard Spectrum logic:

For a direct Job cost distribution G/L code it will attempt to use the Phase cost center; if the field is blank then it will use the Job cost center.

For a direct Equipment cost distribution G/L code it will attempt to use the Equipment cost category’s cost center; if the field is blank then it will use the Equipment cost center.

For a direct Work Order cost distribution G/L code it will attempt to use the Work Order’s cost center.

Once the Expense_Cost_Center is determined for direct cost records, it is then validated against the Distribution G/L code’s cost centers.

The transaction data being submitted using this web service are stored within the Vendor Invoice Entry screen; the data must be manually updated within Spectrum.





C GL_Date G/L Date Date 10


Within A/P processing date range.

D Batch_Code Batch Text 10

E Vendor_Code Vendor Text 10 Vendor File Maintenance

F Contract_Number Subcontract Text 10 Subcontract File Maintenance

G Invoice_Number Invoice Number Text 20

Unique invoice number within each vendor code.

H Invoice_Type_Code Invoice Type Text 1 (I)nvoice or (C)redit only

I Invoice_Date Invoice Date Date 10


Cannot exceed A/P maximum processing date if A/P installation option selected.

J Invoice_Amount Invoice Amount before tax

Numeric 12

Positive Amounts only. Must be greater than Discount amount

Total Invoice including retention portion. (If record is the retention only value then Invoice_Amount field and Retention_Amount field will be the same value)

K Sales_Tax_Amount Sales (PST) Tax Amount

Numeric 12

Positive Amounts only.

L Retention_Amount Retention (Holdback) Amount

Numeric 12

Positive Amounts only. Must be greater than Discount amount

This is the retention portion only of the invoice

M PO_Number ***LEAVE BLANK*** Text 10

Vendor's P. O. number. Reference only. **See Assumptions and Dependencies.

If defined will be stored in the 'Remarks' field if blank. Otherwise user must define.

N Payment_Due_Date Payment Due Date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). If blank then




defaults from Vendor's defined Payment Terms.

O Status On hold? Text 1

(H)old or (O)nly. If left blank defaults to O status.

P Discount_Due_Date Discount Due Date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). If blank then defaults from Vendor's defined Payment Terms.

Q Discount_Amount Discount Amount Numeri

c 12

Positive Amounts only. Must be greater than zero and less than the Invoice Amount.

R Remarks Invoice Remarks Text 30

S AP_GL_Account A/P G/L Code Text 12

GL account must be active and a non-direct account. No dashes.


T Distribution_GL_Account Distribution G/L Account Text 12

*See Assumptions for Rules. No dashes.


U Job_Number Job Number Text 10

Job's status cannot be Complete.

Job File Maintenance

V Phase_Code Phase Code Text 20 No dashes. Phase File Maintenance

W Cost_Type Cost Type Text 3 Cost Type File Maintenance

X Equipment_Code Equipment Code Text 10

Equipment's status type cannot be Retired.

Equipment File Maintenance

Y Equipment_Category Equipment Cost Category Text 4

Equipment Cost Category Maintenance

Z Equipment_Work_Order Equipment Work Order Text 10

Equipment Work Order is required, optional or none based on

Equipment Item must exist on the Equipment Work Order for required




Equipment Cost Category data entry rule.

or optional settings.

AA WO_Number Work Order # Text 10

Work Order status cannot be (C)omplete. Cannot be a job WO.

Work Order Maintenance

AB Item_Code Item Code Text 15

Inventory Item File Maintenance when Inventory Control is installed; Work Order Item File Maintenance when Inventory Control is not installed

AC Quantity Quantity Numeri

c 11

AD WO_Equipment WO Site Equipment Text 8

Required if Work Order installation flag is selected.

Work Order Site Master File/Equipment Tab

AE WO_Component WO Component Text 2

Required if Work Order installation flag is selected.

Work Order Site Master File/Equipment Tab /Component Tab (old systems)

AF WO_SC_Contract WO Service Contract Text 10

Work Order Site Master File/Service Contract Tab

AG WO_Unit_Price Unit billing price Numeri

c 13

AH Tax_Code Tax code Text 15

Dependent on the Sales_Tax_Amount field and the Tax Type defined. **See Assumptions for Rules


AI VAT_Code VAT code Text 10

Defaults from Company Installation option if defined. Can override.

Value Added Tax Maintenance

AJ Total_VAT_Amt VAT tax amount Numeri

c 13

Positive Amounts only. If defined then




overrides calculated value.

AK UDF1



AL UDF2



AM UDF3



AN UDF4



AO UDF5



AP UDF6



AQ UDF7



AR UDF8



AS UDF9



AT UDF10



AU UDF11



AV UDF12






AW UDF13



AX UDF14



AY UDF15



AZ UDF16



BA UDF17



BB UDF18



BC UDF19



BD UDF20



BE Liablility_Cost_Center Liability Cost Center Text 10

Must be valid for the AP_GL_Account field.

Cost Center Maintenance, Vendor Code

BF Expense_Cost_Center Expense Cost Center Text 10

Must be valid for the Distribution_GL_Account field.

Cost Center Maintenance; Vendor Cost Center; Job Cost Center; Phase Cost Center; Equipment Cost Center; Equipment Category Cost Center and Work Order Cost Center


ACCOUNTS RECEIVABLE

Customer

Web Service name = AddCustomer – Add Customer

Underlying File Maintenance Prior to importing Customer information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen General Ledger | G/L Master File Maintenance Accounts Receivable | Sales Tax Code Maintenance Accounts Receivable | Transaction Code File Maintenance Accounts Receivable | Salesperson Code Maintenance (if applicable) Accounts Receivable | Terms Code File Maintenance (if applicable) Accounts Receivable | Customer User-Defined Fields Maintenance (if applicable)

Assumptions and Dependencies The Customer Master cost center flag is shared. The Customer import will validate that the company has

the cost center option set to Pending or Yes and will set the default for the new Customer to Shared. The Customers status will default to (A)ctive. The Contact_1 field will be defined as the Primary Contact. The Contact_2 and Contact_3 fields will be additional contacts. The following field names will be defined by the Accounts Receivable Installation screen if left blank:

o Standard_Retention_Percent o Statement_Flag o Finance_Charge_Tran_Code o Finance_Charge

This Web Service will work with the defined Workflow process in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped, for this Web Service.




C Customer_Code Customer Code Text 10 Unique identifier / No commas


D Name Customer Name Text 30 No commas

E Alpha_Sort Customer Alpha Ref Text 8 No commas, created if blank

F Type Customer Type Text 10 G Address_1 Address 1 Text 30 H Address_2 Address 2 Text 30 I City City Text 25




J State State Text 2 2 character postal abbreviation

K Zip_Code Zip Code Text 10

L Phone Phone Number Text 14


M Fax_Phone Fax # Text 14


N Contact_1 Contact 1 Text 20 No commas O Contact_2 Contact 2 Text 20 No commas P Contact_3 Contact 3 Text 20 No commas

Q Salesperson Salesman Code Text 3 Salesperson Code Maintenance

R Terms_Code Terms Code Text 1 Terms Code File Maintenance

S Standard_Retention_Percent

Default Retention (Holdback) % Numeric 7


Defaults from AR Installation screen if left blank.

T Taxable_Flag Taxable Text 1 (Y)es or(N)o only

U Sales_Tax_Code Sales (Providence) Tax Code Text 15

Sales Tax Code Maintenance

V Resale_Number Resale Cert. # Text 15

W Resale_Exp_Date Resale Exp. Date Date 10


X Statement_Flag Send Statement? Text 1

(Y)es or(N)o only. Defaults to Y if left blank.

Y Finance_Charge_Tran_Code Finance Charge Code Text 10

Transaction Code File Maintenance. Defaults from AR Installation screen if left blank.

Z Finance_Charge Finance Charge % Numeric 6


If Finance_Charge_Tran_Code is blank then defaults from AR Installation screen if left blank.

AA Price_Level_Material Work Order Material Level Numeric 1 1 – 5 only

Recommend input for clients with the




WO : TM : OP or SI modules

AB Price_Level_Labor Work Order Labor Level Numeric 1 1 – 5 only

Recommend input for clients with the WO : TM : OP or SI modules

AC Credit_Limit Credit Limit Numeric 14

AD Date_Created Date Established Date 10


If left blank then it will use the current date in the system

AE Customer_Email Customer Email Text 70 Example: [email protected]


AF Markup_Code Non-stock Markup Text 10 Non-Stock Markup Codes

AG UDF1 User Defined Alpha/Numeric/Date 1 + 20


AH UDF2 User Defined Alpha/Numeric/Date 2 + 20


AI UDF3 User Defined Alpha/Numeric/Date 3 + 20


AJ UDF4 User Defined Alpha/Numeric/Date 4 + 20


AK UDF5 User Defined Alpha/Numeric/Date 5 + 20


AL UDF6 User Defined Alpha/Numeric/Date 6 + 20


AM UDF7 User Defined Alpha/Numeric/Date 7 + 20


AN UDF8 User Defined Alpha/Numeric/Date 8 + 20


AO UDF9 User Defined Alpha/Numeric/Date 9 + 20






AP UDF10 User Defined Alpha/Numeric/Date 10 + 20


AQ UDF11 User Defined Alpha/Numeric/Date 11 + 20


AR UDF12 User Defined Alpha/Numeric/Date 12 + 20


AS UDF13 User Defined Alpha/Numeric/Date 13 + 20


AT UDF14 User Defined Alpha/Numeric/Date 14 + 20


AU UDF15 User Defined Alpha/Numeric/Date 15 + 20


AV UDF16 User Defined Alpha/Numeric/Date 16 + 20


AW UDF17 User Defined Alpha/Numeric/Date 17 + 20


AX UDF18 User Defined Alpha/Numeric/Date 18 + 20


AY UDF19 User Defined Alpha/Numeric/Date 19 + 20


AZ UDF20 User Defined Alpha/Numeric/Date 20 + 20



Customer Bill-to

Web Service name = CustomerBillto – Customer Bill-to

Underlying File Maintenance Prior to importing Customer Bill-to information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Accounts Receivable | Customer Maintenance Accounts Receivable | Bill-to Code Maintenance (if applicable)

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Customer Bill-to Address web service will either create a new Bill-to code or update an existing Bill-to

code. o To add a new Billto_Code, leave this field blank and it will use the next available sequence

number. o To change information, define the unique Customer_Code and Billto_Code fields in the layout.

This will update all the detail information provided. The service does not delete values that exist in Spectrum; it only changes data defined in the layout. If the Billto_Code is not defined then then next available number will be used. If the Status is blank and a new Bill-to code is being created it will default to be Active. Records cannot be updated when user is locking the entry screen.





C Customer_Code Customer code Text 10 Customer Maintenance

D Billto_Code Bill-to code Text 4

Unique combination of Customer code and Bill-to code. If blank auto populate with next available number.

Customer and Bill-to Maintenance

E AltName Bill-to name Text 30

Required if creating a new Bill-to code.

F AltPhone Telephone Numeric 14


G AltFax Fax Numeric 14 Formatted e.g., (206) 555-1212




or 123-123-1224 or 123-1233 or 1231231235.

H AltAddr1 Bill-to Address 1 Text 30

I AltAddr2 Bill-to Address 2 Text 30

J AltCity Bill-to City Text 25

K AltState Bill-to State/province Text 2


L AltZip Bill-to Postal code Text 10

M AltCountry Bill-to Country Text 25

N AltContact Bill-to Contact Text 20

O AltEmail Bill-to Email Text 80 Example: [email protected]


P Remark Bill-to Remarks Text 250

Q Status Status Text 1

A(ctive) or I(nactive) only. If blank then defaults to A for new billto_codes.


Customer Ship-to

Web Service name = CustomerShipto – Customer Ship-to

Underlying File Maintenance Prior to importing Customer Ship-to information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Accounts Receivable | Customer Maintenance Accounts Receivable | Ship-to Code Maintenance (if applicable)

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Customer Ship-to Address web service will either create a new Ship-to code or update an existing

Ship-to code. o To add a new Ship_Code, leave this field blank and it will use the next available sequence

number. o To change information, define the unique Customer_Code and Ship_Code fields in the layout.

This will update all the detail information provided. The service does not delete values that exist in Spectrum; it only changes data defined in the layout. The Ship_Code only allows up to 999 per Customer_Code to be created. If the Ship_Code is not defined then then next available number will be used. Records cannot be updated when user is locking the entry screen.





C Customer_Code Customer code Text 10 Customer Maintenance

D Ship_Code Ship-to code Numeric 3

Unique combination of Customer code and Ship-to code. Define code to change information; leave blank to add new code and uses next sequence available.

Customer and Ship-to Maintenance

E Ship_Name Ship-to name Text 30

Required if creating a new Ship-to code.

F Ship_Cust_Job Customer's job Text 10

G Ship_Address1 Ship-to Address 1 Text 30




H Ship_Address2 Ship-to Address 2 Text 30

I Ship_City Ship-to City Text 25

J Ship_State Ship-to State/province Text 2


K Ship_Zip_Code Ship-to Postal code Text 10

L Ship_Contact Ship-to Contact name Text 20

M Ship_Phone Telephone Numeric 14



Customer – User-Defined Field

Web Service name = UpdateCustomer_UDF – Change Customer UDF

Underlying File Maintenance Prior to importing Customer User-Defined Field information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Accounts Receivable | Customer Maintenance Accounts Receivable | Customer User_Defined Fields Maintenance

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Customer code must exist in the defined Company code. The Customer-UDF Web Service adds or updates an existing Customer’s User Defined Field information

for the defined fields only. 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. The Customer user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.





C Customer_Code Customer Code Text 10 Valid Customer
























N UDF11 User Defined Alpha/Numeric/Date 11 + 20


O UDF12 User Defined Alpha/Numeric/Date 12 + 20


P UDF13 User Defined Alpha/Numeric/Date 13 + 20


Q UDF14 User Defined Alpha/Numeric/Date 14 + 20


R UDF15 User Defined Alpha/Numeric/Date 15 + 20


S UDF16 User Defined Alpha/Numeric/Date 16 + 20


T UDF17 User Defined Alpha/Numeric/Date 17 + 20


U UDF18 User Defined Alpha/Numeric/Date 18 + 20






V UDF19 User Defined Alpha/Numeric/Date 19 + 20


W UDF20 User Defined Alpha/Numeric/Date 20 + 20



Customer Notes

Web Service name = CustomerNotes – Customer Notes

Underlying File Maintenance Prior to importing Customer Notes information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Accounts Receivable | Customer Maintenance Accounts Receivable | Customer Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Customer_Code and Notes_Topic must exist in order to add the notes. The Customer Notes web service has an option to append to the current Note Topic.





Validation



C Customer_Code Customer Code Text 10 Valid Customer

D Notes_Topic Notes Topic Text 20 Customer Note Topics Maintenance





Customer (AR) Sales Tax

Web Service name = Update_AR_Sales_Tax – Add or Change AR Sales Tax

Underlying File Maintenance Prior to importing Accounts Receivable Sales Tax information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Processing Dates Installation screen General Ledger | G/L Account Master File Maintenance Accounts Receivable | Sales Tax Maintenance Accounts Receivable | Sales Tax Rate History Maintenance

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Accounts Receivable Sales Tax web service will either create a new Sales Tax code or update an

existing Sales Tax code. The changes are recorded in the Rate History information. o If the Sales_Tax_Code field does not exist then it will be added.

The Rate History will populate using the current AR processing date and display Initial Entry in the Comments field.

If the Effective_Date and Comments fields are populated they will be ignored since they are used for changes and defined on the Rate History information.

o If the Sales_Tax_Code field does exist then it will update all the detail information provided. The Effective_Date and Comments fields are used for the Rate History information. Duplicate Effective dates cannot exist for a given Use_Tax_Code.

o The service does not delete values that exist in Spectrum; it only changes data defined in the layout.

Comments that exceed the Max character length will be truncated.




C Sales_Tax_Code Sales tax code Text 15 If it exists then update the information.

Accounts Receivable Sales Tax Maintenance

D Description Description Text 20

E GL_Account G/L account code

Numeric 12

Must be a non-direct GL Account. No dashes.

General Ledger Account Maintenance

F Freight_Tax_Flag Tax on freight? Text 1 Y(es) or N(o) only. Default to N if blank.

G Sales_Tax_Percent Tax rate Numeri

c 7 Positive number only. Format = xx.xxxx

H Effective_Date Effective as of Date 10

If blank then use current processing date. Enter as: MM/DD/CCYY (e.g., 01/05/2010). **See

Must be current or future date for AP Processing date. Rate change cannot



Assumptions and Dependencies

exist for the defined date.

I Comments Comments Text 40 **See Assumptions and Dependencies


Customer Invoices

Web Service name = AddARInvoice – Add Customer Invoice

Underlying File Maintenance Prior to importing Customer Invoices information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen General Ledger | G/L Master File Maintenance General Ledger | Value Added Tax Code Maintenance Accounts Receivable | Customers Accounts Receivable | Contracts (for job/customer combinations) Accounts Receivable | Terms Code File Maintenance Accounts Receivable | Sales Tax Code Maintenance Job Cost | Jobs (if applicable) Accounts Receivable | Salesperson Code Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The import file contains one detail line per header record. The General Ledger date and Invoice date must be within the Accounts Receivable processing date.

Based on the Accounts Receivable Installation option the General Ledger date and Invoice date may need to be in the same GL period.

The import requires that Line_Extension, Sales_Tax_Amount, and Retention_Amount contain a positive number. If a negative retention is needed, then the Transaction_Type needs to be defined as a C(redit Memo) to provide a negative retention number.

The import allows the user to import retention-only records which will require the Line_Extension and Retention_Amount to have the same defined value.

Sales tax code and Invoice date will be used to define the percentage for the header. Sales tax codes must be set up; if the rates are different than the rates defined in the Historical table, Spectrum will use the closest date.

Value Added Tax (VAT) o GL Installation option that allows the user to add functionality to use Value Added Tax logic.

If selected then the Invoice header contains additional fields appear for the VAT code and amount and the Sales Tax field name changes to PST and the Retention name changes to Holdback.

The VAT is calculated on the total Invoice amount. o If selected then the VAT_Code and Total_VAT_Amt can be defined on the Invoice header. o VAT_Code default hierarchy

The Job Classification File Maintenance provides an option to override the default VAT on the Customer invoice. If defined then use this code.

If the Job Classification is not selected then default from the GL Installation screen otherwise use the defined code contained in the service.

o Total_VAT_Amt can be either calculated based on the defined VAT_Code or overwritten by the defined value in the layout.

Cost center information will only be allowed if the Company is set to a ‘Yes’ status. The transaction data being submitted using this web service are stored within the Customer Invoice Entry

screen; the data must manually be updated within Spectrum.



Validation


C GL_Date General Ledger Date Date 10


Within AR processing date range.

D Batch_Code Batch Code Text 10

E Customer_Code Customer Code Text 10 Customer File Maintenance

F Job_Number Job Number / AR Contract Text 10

Job File Maintenance and Contract File Maintenance

G Invoice_Or_Transaction Invoice Number Text 10

Unique invoice number – no duplicates

H Transaction_Type (I)nvoice or (C)redit Memo Text 1

(I)nvoice or (C)redit memo only

I Invoice_Date Invoice Date Date 10


Within AR processing date range. AR Installation option forces Invoice date to match the GL period.

J Terms_Code Payment Terms Code Text 1

Defaults from the Customer Master if left blank.

Terms Code File Maintenance

K Salesperson_Code Salesperson Code Text 3

Defaults from the Contract then the Customer Master if left blank.

Salesperson Code Maintenance

L Sales_Tax_Code Invoice Tax Code Text 15

Defaults from the Contract, then the Job's Tax Class code and then the Customer Master if left blank. If set to 'No Default' then field is required.

Sales Tax Code Maintenance

M Taxable_Flag Invoice Taxable? Text 1

(Y)es or (N)o only. Defaults from the Contract, then the Customer if left blank. If set to 'No Default' then field is required.

N Retention_Percent Retention (Holdback) % Numeric 6

Example: Enter 10.5% as 10.5. Positive Amounts only.

If Retention invoice only then % = 100 and the entry is required. If Retention % is blank then default the % from the contract master.



Validation

O Print_Job_Address_Flag Print Job Address? Text 1 (Y)es or (N)o only.

If left blank it will default to Y.

P Remarks Invoice Remarks Text 65

Q Customer_PO Customer PO # Text 25

R AR_GL_Account A/R G/L Code Text 12

AR G/L Account code must be a non-direct cost account. Defaults from the Installation Screen if left blank. No dashes.


S Detail_Description Line Item Description Text 30

T Line_Extension Line Item Extension Numeric 13


Total Invoice Amount including retention portion.(If record is the retention only value then Line_Extension field and Rentention_Amount field will be the same value).

U GL_Account Line Item G/L Code Text 12

G/L Account code must be a non-direct cost account. Defaults from GL installation screen or Job Contract. If defined as 'No Default' then it will be required. No dashes.


V Sales_Tax_Amount Invoice Tax Amount Numeric 13


W Retention_Amount Invoice Retention (Holdback) Numeric 13


Retention Amount only. (If record is the retention only value then Line_Extension field and Rentention_Amount field will be the same value).

X VAT_Code VAT Code Text 10

Defaults from Job Classification File Maintenance, or the GL Installation option if defined. Can override both default locations.

Value Added Tax Maintenance

Y Total_VAT_Amt VAT tax amount Numeric 12 Positive Amounts only. If defined



Validation

then overrides calculated value.

Z Asset_Cost_Center Asset Cost Center Text 10

Will tie to the AR_GL_Account field. Defaults from the Contract if left blank. If set to 'No Default' then field is required.

Cost Center Maintenance; Customer Cost Center; Job Contract Cost Center and AR_GL_Account Cost Center, Sales Tax Code GL Account CC

AA Income_Cost_Center Income Cost Center Text 10

Will tie to the GL_Account field.

Cost Center Maint, Customer CC, G/L Account Cost Center


Cash Receipts

Web Service name = AddCash_Receipts – Add Cash Receipts

Underlying File Maintenance Prior to importing Cash Receipts information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen General Ledger Installation screen General Ledger | G/L Master File Maintenance Accounts Receivable | Customers Accounts Receivable | Transaction Code File Maintenance Job Cost | Jobs (if applicable) Job Cost | Job Phases (if applicable) Job Cost | Cost Type File Maintenance (if applicable) Equipment Control | Equipment File Maintenance (if applicable) Equipment Control | Cost Category File Maintenance (if applicable) Preventive Maintenance | Equipment Work Order Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. Multiple details lines may exist for a given Reference_Number (i.e.,i.e.,, Check number) therefore the

header fields must be repeated for each detail line. The Cash Receipts header contains the following fields which must match in order to add detail lines to

an existing receipt. o Company_Code o Batch_Code o Transaction_Code o Reference_Number o Reference_Date o Transaction_Amount o ABA_Number o Cost_Center_Header (if applicable)

The Transaction_Amount field has the following logic associated. o Based on the defined Transaction code controls whether or not the value is positive or negative.

Payments are positive numbers. Adjustments are negative numbers.

o If the Transaction_Amount field is left blank then the Cash Receipt is considered ‘undistributed’ and will be updated as a payment to the Customer.

o If the Transaction_Amount field is defined then the Cash Receipt will post to the specified Invoices and will update accordingly. If there is excess value then it will create a payment to the Customer for that amount.

o If multiple detail lines are associated with a Transaction_Amount then define the Total amount per the Refence_Number and each detail line with its specific Payment_Amount so that there is NOT an undistributed value for the Cash Receipts.

If multiple unposted detail lines exist for a Cash Receipts header then the web service will combine the Customer specific receipts and non-customer receipts will create additional detail lines.

An amount must exist in one of the following fields per web service record: o Payment_Amount o Discount_Taken

The Invoice being paid must be an open Item for the Customer.


If the Customer_Code is defined then the following fields will be ignored if defined due to they are used for non-customer entries:

o Payer_Name o Misc_Cash_Remarks o GL_Account o Remarks o Job_Number o Phase_Code o Cost_Type o Equipment_Code o Cost_Category_Code o PM_Work_Order

If the Customer_Code is NOT defined then the following fields will be ignored if defined due to they are used for customer specific entries:

o Invoice_Number o Invoice_Type

The Misc_Cash_Remarks and Remark fields will be truncated if they exceed the Max character length. Cost center information will only be allowed if the Company is set to a Yes status. The transaction data being submitted using this web service are stored within the Cash Receipts /

Adjustment Entry screen; the data must be manually updated within Spectrum.


Validation



C Batch_Code Batch Code Text 10

D Customer_Code Customer Code Text 10

Customer must have an Active or Inactive status.

Customer File Maintenance

E Transaction_Code Transaction Code Text 10 Transaction Code File Maintenance

F Reference_Number Check # (Reference) Text 10

Required for payment type Transaction codes.

Must be unique Customer_Code and Reference_Number

G Reference_Date G/L date Date 10

If blank defaults to current AR Processing date.

Must be within the AR Processing dates.

H Transaction_Amount Amount (Check) Numeric 14

Total value of Reference_Number and used to apply to specific invoices.

**See Assumptions and Dependencies.

I ABA_Number ABA routing # Text 10 Cannot exceed 8 characters

J Invoice_Number Invoice # Text 10

Required for customer specific transactions.

Invoice must be an Open Item for the Customer.



Validation

K Invoice_Type Transaction Text 1

(I)nvoice, (C )redit, (P)ayment, (A)djustment OR (R )etention portion for customer specific transactions. Blank for non-customer.


L Payment_Amount Applied Amount (Detail line) Numeric 14

If Discount_Taken is blank then this field is required. Allows negatives.

M Discount_Taken Discount Taken Numeric 14

If Payment_Amount is blank then this field is required. Allows negatives.

N Cost_Center_Header Cost Center (header) Numeric 10

Cost Center Maintenance. Follows standard invoice hierarchy.

O Payer_Name Payer Text 30

Used for non-customer entries only.

P Misc_Cash_Remark Remarks-Header Text 100


Q GL_Account G/L account Numeric 12

Used for non-customer entries only. Required if Customer_Code is blank. No dashes.

GL_Account cannot be a 'direct work order cost' code.

R Remark Remarks-Detail Text 100


S Job_Number Job Text 10

Used for non-customer entries only. Jobs

T Phase_Code Phase Text 20

Used for non-customer entries only. No dashes. Phases

U Cost_Type Cost type Text 3

Used for non-customer entries only. Cost Type

V Equipment_Code Equipment Code Text 10


Equipment Master File

W Cost_Category_Code Equipment Cost Category Text 4


Equipment Cost Categories

X PM_Work_Order Equipment W/O Text 10


Equipment Item must exist on the Equipment Work Order for required or optional settings.

Y Cost_Center_Detail Cost Center (detail) Numeric 10

Used for non-customer entries

Cost Center Maintenance



Validation

only. Defaults based on cost center hierarchy for GL Account logic.


AR Change Request

Web Service name = ARChangeRequest – Add or Change AR Change Request

Underlying File Maintenance Prior to importing AR Change Request information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen General Ledger | G/L Master File Maintenance Accounts Receivable | Customers Accounts Receivable | Contract Accounts Receivable | Contract Schedule of Values (if applicable) Accounts Receivable | Change Request Status Accounts Receivable | Pricing Add-ons (if applicable) Accounts Payable | Vendor (if applicable) Accounts Payable | Subcontract (if applicable) Job Cost | Jobs Job Cost | Job Phases (if applicable) Job Cost | Cost Type File Maintenance (if applicable)

Assumptions and Dependencies The AR Change Request Web service adds or updates existing Change Requests information for the

defined fields only. The Web Service will not create new phase or Billing Items automatically, therefore the Phase/Cost type

and Billing Item codes defined in this web services will be required to add or change data. The Web Service follows the majority of the same logic as manually entering a Change Request with the

exceptions of the data defined here. The Spectrum Help files can be used for troubleshooting errors along with the details defined here.

The unique combination of the Company Code, Job, Customer and Change Request # must exist in the defined Company code to change the data provided. If not then it will create a new Change Request.

If the Change_Request_Number is left blank then the number will be auto created. To add multiple detail lines to a Change Request the Company Code, Job, Customer and Change

Request # must be defined for each record along with the following fields to define the Header information:

o Description o Status o Cost_Reimbursable_Flag o Origination_Date o Approved_Date o Fee_Percent o Fee_Amount

To change data within the Change Request then it must have all the Header information AND The exact information for the given ‘section’ (i.e. costs, markups, pricing add-ons and billings) that is defined

o If multiple duplicate cost or revenue lines exist, then the web service will update the first record. o Cost Tab must have:

CR_Phase_Code CR_Cost_Type Subcontractor_Code Subcontractor_Number Sub_Bid_Group_Item_Code Sub_Bid_Item_Code

o Revenue Tab must have: CR_Billing_Group_Code


CR_Billing_Item_Code The Status of the Change Request controls the following

o The Cost Reimbursable option o Access to the Cost tab information o Access to override the Markups and Add-ons tabs o If Billing information is needed or not. Status codes with Action type of 3, 4 or 5 on a Fixed Price

Job can be blank. The Approved_Date can only be defined if the status is Approved or Executed. The Fee Percent defaults from the Pricing Defaults for Contract Changes if not defined in the record. If

defined in the record then it can be overwritten. If the Fee_Percent and Fee_Amount are both populated, then the Fee_Percent will be used and the

Fee_Amount will be calculated. The CR_Phase_Code and CR_Cost_Type combination must exist and not have a completed status. The CR_ Phase_Code and CR_ Cost_Type are required if the Subcontractor detail provided in the record

are valid. Any data defined for a Subcontract will appear on the Subcontract Change Order Log. A Billing Item can exists within the Change Request as part of a Subcontract Costs and/or as part of the

Billing section. The type of Job or Subcontract defines how the billing item will be defined in the layout. o Unit Price contract’s require both the billing group and billing items to be defined with a max

number of 10 characters between the two fields. This applies to the Subcontract and Contract fields.

o Fixed Price contracts require only the billing item field be populated in the layout with a max number of 10 characters. The ‘Group’ fields will be ignored if defined.

If the Subcontractor_Code and Subcontract_Number are blank then any data defined for the Subcontract information fields will be ignored.

The CR_Billing_Group_Code and CR_Billing_Item_Code must exist for the Contract in order to be added or changed.

The CR_Billing_Group_Code and CR_Billing_Item_Code are blank then the other fields associated with the Billing tab will be ignored.

For unit price jobs the following will apply to the CR_Unit_Price, CR_Quantity and CR_Revenue. o Two of the above fields must be populated. o If any two fields are populated, then they will be used to calculate the other value. o CR_Unit_Price will default from the Contract if left blank in the web service and it exists on the

contract. o If CR_Revenue is defined then it will be ignored if both the CR_Unit_Price and CR_Quantity are

defined. o All fields will be ignored if the CR_Billing_Group_Code and CR_Billing_Item_Code are blank.

The Unit of Measure in the Billing Tab will default from the Schedule of Values for the defined Billing Item. The number of Billing entries per Change Request cannot exceed 990 records. Markups and Add-ons tabs on the Change Request are populated from the Contracts Pricing Default

page. o The Change Request status dictates if the amounts can be modified. o User cannot add new Markups or Add-ons codes via a Change Request.

Markup values are added when the associated Cost entry is made to the Change Request or the Markup must already exist on the Change Request.

The Pricing Add-on information o The contract controls the Pricing Add-ons that are allowed to be added to the Change Request. o A phase and cost type is required for each Pricing Add-on to be used on Change Requests. o The Phase and Cost type are defined on the Contract or within the Change Request. o The Pricing Defaults on the Contract are AUTOMATICALLY added to the Change Request AND

need to have the Phase/Cost type defined on the contract in order to prevent errors when being added to the Change Order.

If the Quotation_Submitted_Date is blank, it will default from the Origination_Date if the Change Request is for Costs only and not billed.

This Web Service will work with the defined Workflow process in Spectrum.






C Job_Number Job Text 10

Unique combination of Job, Customer and Change Request Number. *See Assumption and Dependencies. Job

D Customer_Code Customer Text 10

Unique combination of Job, Customer and Change Request Number. *See Assumption and Dependencies. Customer

E Change_Request_Number Change Request # Text 8

Unique combination of Job, Customer and Change Request Number. If left blank then a new number will be auto-created. *See Assumption and Dependencies.

F CR_Description Description Text 250

G CR_Status Current Status Text 2

Required if creating a new Change Request. The 'action type' of the status code controls the fields that can be added or updated.

Change Request Status

H Cost_Reimbursable_Flag

Cost Reimbursable Text 1

(Y)es or (N)o only. The Status dictates whether or not the Cost Reimbursable option can be selected.

I Origination_Date Origination date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010) If blank then defaults to AR Current processing date. **See Assumptions and Dependencies.

J Approved_Date Approved date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010). Must be within current AP processing dates.



K Fee_Percent Fee % Numeric 7

Allows negative numbers. Format = -3.2 *See Assumptions and Dependencies.

L Fee_Amount Fee Amount Numeric 12


M CR_Phase_Code Phase Text 20

No dashes. Must exist on the Job. Required if the valid Subcontractor details are defined in this record. *See Assumptions and Dependencies. Phases

N CR_Cost_Type Cost type Text 3

Must exist on the Job. Required if Phase_Code is defined. *See Assumptions and Dependencies. Cost Type

O Change_Request_Quantity Cost Quantity Numeric 10

Allows negative numbers and can be blank. Format = -6.2

P Change_Request_Hours Cost hours Numeric 10


Q Change_Request_Amount Cost Est Amount Numeric 14


R Subcontractor_Code Subcontractor (Vendor code) Text 10

Must be a valid combination of Subcontractor_Code and Subcontract_Number. Vendor

S Subcontract_Number Subcontract # Text 10

Must be a valid combination of Subcontractor_Code and Subcontract_Number. Subcontract

T Sub_Amount Sub CO Amount Numeric 14

If blank then defaults from Subcontract. Format = -10.2

U Sub_Bid_Group_Item_Code

Sub group (billing item) Text 2

Define the Sub_Bid_Group_Item_Code and Sub_Bid_Item_Code for Unit Price jobs. *See Assumptions and Dependencies.

Subcontract Phase Details

V Sub_Bid_Item_Code Sub item (billing item) Text 10

For Fixed Price Jobs define the Sub item

Subcontract Phase Details



(billing item) and leave the Sub_Bid_Group_Item_Code blank. *See Assumptions and Dependencies.

W Sub_Status Sub Status Text 1

(P)roposed, (E )xeuted or (R )ejected only. Required if Subcontractor_Code defined.

X Sub_Change_Order_Number Sub CO# Text 8

Must exist for the Job. Required if status is Executed.

Subcontract Change Order

Y Sub_Change_Order_Date Sub CO date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010) If left blank then defaults to the Origination_Date.

Must be within the A/R processing date range.

Z Sub_Signed_Date Sub signed date Date 10

Update when Sub_Status = Executed only. Enter as: MM/DD/CCYY (e.g. 01/05/2010)

AA Sub_Description Sub CR Description Text 30

AB Sub_Type Sub CR Type Text 15

AC Sub_Proposal_Date Sub proposal date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010)

AD Sub_Sent_Date Sub sent date Date 10


AE Sub_Due_Date Sub due date Date 10


AF Sub_Comments Sub Comments Text 250

AG Markup_Cost_Type Markup Cost type Text 3 *See Assumptions and Dependencies. Cost Type

AH Markup_Percent Markup % Numeric 6

If defined then Markup_Amount must be blank. Positive numbers only. Format = 3.2 *See Assumptions and Dependencies.

AI Markup_Amount Markup Amount Numeric 14

If defined then Markup_Percent must be blank. Allows negative numbers. Format = -10.2 *See



Assumptions and Dependencies.

AJ Pricing_Addon_Code Pricing Addon Text 10 *See Assumptions and Dependencies. Pricing Add-ons

AK Pricing_Addon_MU_Percent

Pricing Addon Percent Numeric 6


AL Pricing_Addon_MU_Amount

Pricing Addon Amount Numeric 14

For Fixed Price Addon only. Allows negative numbers. Format = -10.2

AM Pricing_Addon_Phase

Pricing Addon Phase Text 20

No dashes. Must exist on the Job. Required if the status action type = 3. *See Assumptions and Dependencies. Phases

AN Pricing_Addon_Cost_Type

Pricing Addon Cost Type Text 3

Must exist on the Job. Required if Phase_Code is defined. *See Assumptions and Dependencies. Cost Type

AO CR_Billing_Group_Code Billing Group Text 2

Define the CR_Billing_Group_Code and CR_Billing_Item_Code for Unit Price jobs. *See Assumptions and Dependencies.

Contract Schedule of Value

AP CR_Billing_Item_Code Billing Item Text 10

For Fixed Price Jobs define the Billing Item and leave the CR_Billing_Group_Code blank. *See Assumptions and Dependencies.


AQ CR_Billing_Item_Description

Billing Item Description Text 30

Defaults from Billing_Item_Code if left blank. Otherwise overwrite.

AR CR_Additional_Description

Additional Description Text 40

Defaults from Billing_Item_Code if left blank. Otherwise overwrite.

AS CR_Unit_Price Unit Price Numeric 11

Required for Unit Price Jobs only. Allows negative numbers and can be blank. Format = -5.4 *See Assumptions and Dependencies.

AT CR_Quantity Quantity Numeric 11

Required for Unit Price Jobs only. Allows negative numbers and can be blank. Format = -7.2




AU CR_Revenue Billing Amount Numeric 14

Calculated for Unit Price Jobs and rounds to 2 decimal places. Allows Negative numbers. Format = -10.2 *See Assumptions and Dependencies.

AV Proceed_Submitted_Date

Notice to Proceed Submitted date Date 10

AW Proceed_Received_Date

Notice to Proceed Received date Date 10

AX Rough_Estimate Notice to Proceed Rough Estimate Numeric 12


AY Quotation_Submitted_Date

Quotation Submitted date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010). **See Assumptions and Dependencies.

AZ Quotation_Due_Date Quotation Due date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010).

BA Requested_Days Quotation Requested days Numeric 4

Whole numbers only. Allows negative numbers and can be blank. Format = -3

BB Approved_Days Approval Approved Days Numeric 4

Whole numbers only. Allows negative numbers and can be blank. Format = -3


AR Change Order

Web Service name = ARChangeOrder – Add or Change AR Change Order

Underlying File Maintenance Prior to importing AR Change Order information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen General Ledger | G/L Master File Maintenance Accounts Receivable | Customers Accounts Receivable | Contract Accounts Receivable | Contract Schedule of Values (if applicable) Accounts Receivable | Change Order Status Accounts Receivable | Change Request Job Cost | Jobs

Assumptions and Dependencies The AR Change Order Web service adds or updates existing Change Orders information for the defined fields

only. The Web Service will not create new phase or Billing Items automatically. The Web Service follows the majority of the same logic as manually entering a Change Order with the

exceptions of the data defined here. The Spectrum Help files can be used for troubleshooting errors along with the details defined here.

The unique combination of the Company Code, Job, Customer and Change Order # must exist in the defined Company code to change the data provided and NOT be tied to a draw request or change request. If not then it will create a new Change Order.

To add multiple detail lines to a Change Order the Company Code, Job, Customer and Change Order # must be defined for each record along with the following fields to define the Header information:

o Description o Status_Code o Change_Order_Date o Approved_Date o Approved_Days o Fee_Percent o Fee_Amount

The Fee_Percent and Fee_Amount fields o They defaults from the Change Request but can be overwritten. o If the Fee_Percent and Fee_Amount are both populated, then the Fee_Percent will be used and the

Fee_Amount will be calculated. o If the Fee_Amount field is defined and a Change Request is being added in the same record with a

Fee associated, the defined Fee_Amount value in this record will be used. It will not be added to the Change Request associated Fee.

Adding Change Requests to a Change Order. o The Change Request Number is defined then its associated records will appear within the defined

tabs on the Change Order when reviewing from within Spectrum. o The billing item cannot be blank within the change request and must be modified on the change

request. o The Phase and Cost Type for the Pricing Add-on must be defined on the Change Request. o The Web service will not create billing items automatically. o The Change Request cannot be added if Change Order is tied to a draw request.

To change billing dollars the following fields must be defined along with the correct dollar fields based on the Job type:

o Job_Number


o Customer_Code o Change_Order_Number o CO_Billing_Group_Code o CO_Billing_Item_Code

The type of the Job defines how the billing item will be defined in the layout o Unit Price contract’s require both the billing group and billing item to be defined with a max number of

10 characters between the two fields. o Fixed Price contracts require only the billing item field be populated in the layout with a max number

of 10 characters. The ‘Group’ fields will be ignored if defined. o The Billing_Item_Code must exist for the Contract in order to be added or changed.

The fields defined on the Billing Tab are used to add charges to the Change Order itself. The Unit of Measure in the Billing Tab will default from the Schedule of Values for the defined Billing Item. This Web Service will ignore the defined Workflow process in Spectrum. Any field that is left blank will not be updated in Spectrum. The service does not delete values that exist in



Validation




Unique combination of Job, Customer and Change Order Number. *See Assumption and Dependencies. Job


Unique combination of Job, Customer and Change Order Number. *See Assumption and Dependencies. Customer

E Change_Order_Number Change Order # Text 8

Unique combination of Job, Customer and Change Order Number. *See Assumption and Dependencies.

F Description Description Text 250

G Status_Code Current Status Text 2

Required if creating a new Change Order.

Change Order Status Codes

H Change_Order_Date Origination Date Date 10

Enter as: MM/DD/CCYY (e.g. 01/05/2010) If blank then defaults to AR Current




Validation

processing date. Must be within

I Approved_Date Approved Date Date 10



J Approved_Days Approved Days Numeric 4

Whole numbers only. Positive numbers only and can be blank. Format = 4

K Fee_Percent Fee % Numeric 6

Positive numbers only. Format = 3.2 *See Assumptions and Dependencies.

L Fee_Amount Fee Amount Numeric 14


M Change_Request_Number

Change Request Number Text 8

Must exist for Job/Customer combination. Cannot be tied to existing Change Order#. Must have all details defined. *See Assumptions and Dependencies. Change Request

N CO_Billing_Group_Code Billing Group Numeric 2

Define the CO_Billing_Group_Code and CO_Billing_Item_Code for Unit Price jobs. *See Assumptions and Dependencies.


O CO_Billing_Item_Code Billing Item Numeric 10

For Fixed Price Jobs define the Billing Item and leave the CO_Billing_Group_Code blank. *See Assumptions and Dependencies.


P Additional_Description

Additional Description Text 40

Defaults from Billing_Item_Code if left blank

Q Unit_Price Unit Price Numeric 11




Validation

R Quantity Quantity Numeric 11


S Revenue Amount Numeric 14

Calculated for Unit Price Jobs and rounds to 2 decimal places. Allows Negative numbers. Format = -10.2 *See Assumptions and Dependencies.


AR Change Request or Change Order Notes

Web Service name = ChgReqChgOrderNotes – Change Request or Change Order Notes

Underlying File Maintenance Prior to importing AR Change Request or Change Order Notes information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Accounts Receivable | Customers Accounts Receivable | Change Request Accounts Receivable | Change Order Job Cost | Jobs

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Job_Number, Customer_Code, Type, and CR_CO_Number must exist in order to add the notes. The Change Request or Change Order Notes web service has an option to append to the current Note

Topic. o If not defined then the Notes will be replaced. o The formatting options available within the Notes are not supported.




Validation




Unique combination of Job, Customer, Type and Number. *See Assumption and Dependencies. Job


Unique combination of Job, Customer, Type and Number. *See Assumption and Dependencies. Customer

E Type Type of Note Text 2

(CR)Change Request or (CO)Change Order only.



Validation

F CR_CO_Number Change Request or Change Order # Text 8

Number must exist for the unique combination of Job, Customer and Type. *See Assumption and Dependencies.

G Notes_Text Notes Text 1000

H Append_Note Append Notes? Text 1



AR Pre-Billing Quantity

Web Service name = ARPreBillingQuantity – Add or Change AR Pre-Billing Quantity

Underlying File Maintenance Prior to importing AR Pre-Billing Quantity information, the following file maintenance areas must be completed:

Accounts Receivable Installation screen Job Cost Installation screen Accounts Receivable | Customers Accounts Receivable | Contracts Accounts Receivable | Contracts | Schedule of Values Job Cost | Jobs Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The AR Pre-Billing Quantity web service will add or update to the existing unique combination of Job

number, Customer and Batch code defined. If it does not exist then it will be created. A Billing Item exists on the Schedule of Values for the Contract. The type of Job defines how the billing

item will be defined in the layout. o Unit Price contract require both the billing group and billing items to be defined with a max

number of 10 characters between the two fields. o Fixed Price contracts require only the billing item field be populated in the layout with a max

number of 10 characters. The Billing_Group_Code field will be ignored if defined. The Web Service will not create new Billing Item automatically. The Billing Item must exist on the

Contract. Quantity Type field will default from the Accounts Receivable Installation screen based on the data

defined on the Draw Request Tab. Quantity field

o The Accounts Receivable > Draw Request Installation screen controls whether the Pre-Billing Quantities are enter for the Period or Job-to-Date.

o Based on your installation setting and the ‘Unit of Measure’s’ price method defined on a Unit Price Contract, the ‘Quantity’ field can have one of the following formats -

-9.2 -8.2 -7.2 -3.2

o For Unit Price jobs, the quantity defined multiplied by the unit price on the Contract will override the records defined Amount.

o For non-unit price jobs this field is considered a percentage and is calculates as a percentage of the Amount divided by the Bid $ Amount field value.

Amount field o If the field is defined for a non-unit price job then this value will be used in the transaction. o If this field is defined for a unit price job along with the Quantity value and the Amount value

based on the defined Quantity multiplied by the Unit Price on the Contract does not match then the calculated value will used.

To change data for an existing entry then the following fields must exist- o Job_Number o Customer_Code o Batch_Code o Billing_Group_Code o Billing_Item_Code o Quantity_Date


o Quantity_Type 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. The transaction data being submitted using this web service are stored within the Customer AR Pre-

Billing Quantity screen; the data must be manually updated within Spectrum.


Validation



C Job_Number Job Number / AR Contract Text 10

Unique combination of Job and Customer must exist. *See Assumption and Dependencies. Job

D Customer_Code Customer Code Text 10

Unique combination of Job and Customer must exist. *See Assumption and Dependencies. Customer

E Batch_Code Batch code Text 10

If Job, Customer and Batch combination exists add to the existing batch.

F Billing_Group_Code Billing Group Text 2

Define the CO_Billing_Group_Code and CO_Billing_Item_Code for Unit Price jobs. *See Assumptions and Dependencies.


G Billing_Item_Code Billing Item Text 10

For Fixed Price Jobs define the Billing Item and leave the CO_Billing_Group_Code blank. *See Assumptions and Dependencies.


H Quantity_Date Date Date 10

If left blank then use system date. Enter as: MM/DD/CCYY (e.g.: 01/05/2011)

I Quantity_Type Type Text 1

(A)ctual or (E )ngineering. If blank then will default from the AR Installation screen.

Installation screen default

J Quantity Quantity Numeric 12

Allows negative numbers. Format is either -9.2, -8.2,



Validation

-7.2 or -3.2 based on the installation settings. **See Assumption and Dependencies.

K Amount Amount Numeric 13

Allows negative numbers. Format = -9.2 If defined then the Quantity value is recalculated. If blank then calculated for unit price jobs. **See Assumption and Dependencies.


EQUIPMENT CONTROL

Equipment – Required

Web Service name = AddEquip_Req – Add Equipment (Required Fields)

Underlying File Maintenance Prior to importing Equipment information, the following file maintenance screens must be completed:

Equipment Control Installation screen Equipment Control | Cost Category File Maintenance Equipment Control | Equipment Status File Maintenance Equipment Control | Equipment Type File Maintenance Equipment Control | Fuel / Oil File Maintenance (if applicable) Equipment Control | Equipment Location File Maintenance (if applicable) Equipment Control | Yard File Maintenance (if applicable) Equipment Control | Tire File Maintenance (if applicable) Equipment Control | Warranty Type File Maintenance Equipment Control | Warrantor File Maintenance Equipment Control | Equipment User-Defined Fields

General Ledger | G/L Master File Maintenance General Ledger | G/L Department File Maintenance (if equipment divisions are validated to the G/L

departments in the Equipment Control Installation screen) Payroll | Wage Code Maintenance (if applicable) Payroll | Union Maintenance (if applicable) Time & Material | Job Equipment Billing Code Maintenance (if applicable) Time & Material | Equipment Billing Code Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies Depends on flag for “validate equipment division with G/L department” in the Equipment Control

installation screen. o If selected, then field entry is mandatory. o The users will press F4 to select from the G/L Department File Maintenance. o If not selected, this field is not mandatory and can be used to enter other information in

alphanumeric format, up to 5 characters. If a Meter type is populated then the Meter description is required. The cost accruals method defaults to Year when the item is created. The Make and Model fields validate based on the Equipment Control Installation screen validation option

for make and model. If the Equipment_Retired field is defined then the Equipment_Status field must have a status type of

Retired. If the Equipment_Sold field is defined as Y(es) then the Sell Price, Sold Date, and Sold To fields are

required. Cost center information will only be allowed if the Company is set to a Pending or Yes status. Cost centers will validate against the Cost Center Maintenance Table.





C Equipment_Code Equipment Code Text 10 Unique identifier-No commas

UPPERCASE FORMAT- NO SYMBOLS

D Division_Code Division Text 5

Depends on flag for “validate equipment division with G/L department” in the Equipment Control installation screen. If selected, then field entry is mandatory.

E Equipment_Type Equipment Type Text 4 Equipment Type Maintenance


G Year Year Numeri

c 2

H Equipment_Make Make Text 20

Validated if Equipment installation option selected.

I Equipment_Model Model Text 20


J Serial_Number Serial No. Text 50

K On_Road_Code Road Usage Text 1

(1) for on-road or (2) for off road. If blank then defaults to 1.

L Meter_Type Primary Meter Type Text 1

(M)iles, (H)ours, (K)ilometers, or (U)sage

M Fuel_Oil_Code Fuel Code Text 2

Must have a fuel type of Gas or Diesel only.

Fuel/Oil Maintenance

N Capacity Capacity Wt. Numeri

c 6 Positive numbers only.

O Gross_Weight Vehicle Gross Wt. Numeri


P Scale_Weight Vehicle Scale Wt. Numeri


Q Owned_Flag Aquisition Type Text 1 (O)wned, (R)ent, or (L)ease




R Condition_Code Condition: New or Used? Text 1 (N)ew or (U)sed

S Billing_Rate_Code Billing Code Text 10

T&M billing code file in EQ Billing Rates

T Last_Job Last Job No. Text 10

Valid Job number or data entry field.

Jobs Maintenance (if applicable)

U Wage_Code Wage Code Text 10

Payroll Wage Code file in combination with Union Code

V Union_Code Union Code Text 10

Payroll Wage Code file in combination with Union Code

W Equipment_Status Equipment status Text 4

Equipment Status Code Maintenance

X Purchase_Date Purchase Date Date 10


Y Purchased_From Purchased From Text 15

Z Purchase_Cost Original Cost Numeri

c 14

Enter decimals but no $ or commas.

AA Last_Meter Primary Last Meter Reading

Numeric 10

No entry allowed in start screen field. If field is defined then Meter_Type must be defined.

AB Last_Meter_Date Primary Last Meter Read Date Date 8


No entry allowed in start screen field. If field is defined then Meter_Type must be defined.

AC Engine_Make Engine Make Text 20


AD Engine_Model Engine Model Text 20


AE Transmission_Make Transmission Make Text 20 Validated if Equipment




installation option selected.

AF Transmission_Model Transmission Model Text 20


AG Power_Axle_Make Power Axle Make #1 Text 20


AH Power_Axle_Model Power Axle Model #1 Text 20


AI Tire_Code_1 Tire Code 1 Text 14 Equipment Tire Maintenance

AJ Tire_Code_2 Tire Code 2 Text 14 Equipment Tire Maintenance

AK Yard_Code Yard No. Text 5 Yard Maintenance

AL Location Yard Location Text 8

Equipment Location Maintenance

AM Equipment_RFID Equipment RFID Text 30

AN Equipment_GPS Equipment GPS Text 30

AO Equipment_Meter_Type2 Equipment Meter #2 Type Text 1

(M)iles; (H)ours; (K)ilometers or (U)sage

AP Equipment_Meter_Type3 Equipment Meter #3 Type Text 1


AQ Equipment_Meter_Type4 Equipment Meter #4Type Text 1


AR Equipment_Meter_Desc1 Equipment Meter #1 Description Text 20

Meter type must be defined in order to have a Meter description defined.

AS Equipment_Meter_Desc2 Equipment Meter #2 Description Text 20


AT Equipment_Meter_Desc3 Equipment Meter #3 Description Text 20

Meter type must be defined in order to have a




Meter description defined.

AU Equipment_Meter_Desc4 Equipment Meter #4 Description Text 20


AV Equipment_Engine_Yr Engine Year Numeri

c 4 Enter the year

AW Equipment_Trans_Yr Transmission Year Numeri

c 4 Enter the year

AX Equipment_Power_Axle1_Yr Power Axle #1 Year

Numeric 4 Enter the year

AY Equipment_Power_Axle2_Yr Power Axle #2 Year


AZ Equipment_Power_Axle2_Make

Power Axle #2 Make Text 20


BA Equipment_Power_Axle2_Model

Power Axle #2 Model Text 20


BB Equipment_Power_Axle3_Yr Power Axle #3 Year


BC Equipment_Power_Axle3_Make

Power Axle #3 Make Text 20


BD Equipment_Power_Axle3_Model

Power Axle #3 Model Text 20


BE Equipment_Height Transportation Height

Numeric 10

Positive numbers only. Decimal ok

BF Equipment_Width Transportation Width

Numeric 10


BG Equipment_Length Transportation Length

Numeric 10


BH Equipment_Dim_UOM Transportation Unit of Measure Text 2

Unit of Measure File

BI Equipment_Weight_UOM Weight Unit of Measure Text 2

Unit of Measure File

BJ Equipment_Weight_Class Weight Class Text 10 Weight Class Code




BK Equipment_Retired Retired Date Date 8

Enter as: MM/DD/CCYY (e.g., 01/05/2010). If defined then Equipment_Status field must have a Status Type of Retired.

BL Equipment_Sold Equipment Sold? Text 1 (Y)es or (N)o.

If yes then the Equipment_Sell_Price; Equipment_Sell_Date and Equipment_Sell_To fields are required.

BM Equipment_Sell_Price Equipment Sold Price

Numeric 11 Decimal ok

Required if Equipment_Sold = Y

BN Equipment_Sell_Date Equipment Sold Date Date 8



BO Equipment_Sell_To Equipment Sold To Text 15


BP Market_Value Current Market Value

Numeric 9


BQ Entry_Date Entry Date Date 8

Enter as: MM/DD/CCYY (e.g., 01/05/2014) If left blank then defaults to the system date.

BR Cost_Center Equipment Cost Center Text 10



Equipment – Charges

Web Service name = UpdateEquip_Charges – Change Equipment Charges

Assumptions and Dependencies The Equipment module must be set up. The Equipment code must exist in the defined Company code. The Equipment Items - Charges Information Web Service updates existing Equipment’s information for

the defined fields only. 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 the data with the defined data in the field name.


n Type Max

Field Information

Validation



C Equipment_Code Equipment Code Text 10

Valid Equipment Code in Spectrum

D Insurance_Cost_Per_Year Insurance Cost/Yr. Numeric 10


E License_Per_Year License Cost/Yr. Numeric 10


F Depreciation_Cost Depreciation Cost/Yr. Numeric 10


G Depreciation_Method Depreciation Method Text 1

(Y)ear, (M)eter, or (H)ours

H Rate_Per_Hour Job Rate/Full Charge/Hourly Numeric 8

Enter decimals but no $ or commas. Positive number only.

I Rate_Per_Day Job Rate/Full Charge/Daily Numeric 8


J Rate_Per_Week

Job Rate//Full Charge/Weekly Numeric 8


K Rate_Per_Month

Job Rate/Full Charge/Monthly Numeric 8


L Job_Operating_Rate_Hour

Job Rate/ Operating//Hourly Numeric 8


M Job_Operating_Rate_Day

Job Rate/ Operating/Daily Numeric 8




n Type Max

Field Information

Validation

N Job_Operating_Rate_Week

Job Rate/ Operating/Weekly Numeric 8


O Job_Operating_Rate_Month

Job Rate/ Operating/Monthly Numeric 8


P Stand_By_Rate_Hour Job Stand By Rate/Hourly Numeric 8


Q Stand_By_Rate_Day Job Stand By Rate/Daily Numeric 8


R Stand_By_Rate_Week Job Stand By Rate/Weekly Numeric 8


S Stand_By_Rate_Month Job Stand By Rate/Monthly Numeric 8


T Hourly_Rental_Rate

Rental Rate/Full Charge/Hourly Numeric 8


U Daily_Rental_Rate

Rental Rate/Full Charge/Daily Numeric 8


V Weekly_Rental_Rate

Rental Rate/Full Charge/Weekly Numeric 8


W Monthly_Rental_Rate

Rental Rate/Full Charge/Monthly Numeric 8


X Rent_Operating_Rate_Hour

Rental Rate/ Operating/Hourly Numeric 8


Y Rent_Operating_Rate_Day

Rental Rate/ Operating/Daily Numeric 8


Z Rent_Operating_Rate_Week

Rental Rate/ Operating/Weekly Numeric 8




n Type Max

Field Information

Validation

Positive number only.

AA Rent_Operating_Rate_Month

Rental Rate/ Operating/Monthly Numeric 8


AB Rental_Stand_By_Hour

Rental Rate/ Stand By/Hourly Numeric 8


AC Rental_Stand_By_Day Rental Rate/ Stand By/Daily Numeric 8


AD Rental_Stand_By_Week

Rental Rate/ Stand By/Weekly Numeric 8


AE Rental_Stand_By_Month

Rental Rate/ Stand By/Monthly Numeric 8



Equipment – Warranty

Web Service name = AddEquip_Warranty – Add Equipment Warranty

Assumptions and Dependencies The Equipment module must be set up. The Equipment code must exist in the defined Company code. The Equipment Warranty type and Warrantor code must exist in the defined Company code. The Equipment Items - Warranty Information Web Service adds Warranty information to existing

Equipment’s Item. The Warranty information will be for the Equipment level only. The Warranty_Meter must exist on the Equipment and have a defined start and expired meter readings to

be added. The Warranty can be added to the Equipment repeatedly if desired based on the Spectrum Database.




C Equipment_Code Equipment Code Text 10 Valid Equipment Code in Spectrum

D Warranty_Type Warranty Type Text 10 Equipment Warranty File

E Warrantor_Code Warrantor Text 10 Equipment Warrantor File

F Warranty_Start Warranty Start Date Date 10


Valid date corresponding to expiration date if entered

G Warranty_Expiration Warranty Expiration Date Date 10


Valid date corresponding to start date if entered

H Warranty_Strt_Meter Warranty Start Meter Reading Numeric 9

Positive numbers only

Valid number corresponding to expiration meter reading if entered

I Warranty_Expire_Meter

Warranty Expiration Meter Reading Numeric 9

Positive numbers only

Valid number corresponding to start meter reading if entered

J Warranty_Meter Warranty Meter Number Text 1

Enter Meter number (1, 2, 3 or 4). Warranty_Strt_Meter and Warranty_Expire_Meter must be populated if defined.

Meter must be defined on the Equipment.

K Warranty_Comments Warranty Comments Text 100


Equipment – User-Defined Field

Web Service name = UpdateEquip_UDF – Change Equipment UDF

Assumptions and Dependencies The Equipment module must be set up. The Equipment code must exist in the defined Company code. The Equipment Items user-defined field Information Web Service updates existing equipment’s

information for the defined fields only. 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. The Equipment user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined or mapped for this Web Service.




C Equipment_Code Equipment Code Text 10

Equipment Code must exist for the defined Company Code.



















M UDF10






N UDF11



O UDF12



P UDF13



Q UDF14



R UDF15



S UDF16



T UDF17



U UDF18



V UDF19



W UDF20




Equipment Notes

Web Service name = EquipmentNotes – Equipment Notes

Underlying File Maintenance Prior to importing Equipment Notes information, the following file maintenance areas must be completed:

Equipment Control Installation screen Equipment Control | Equipment Maintenance Equipment Control | Equipment Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Equipment_Code and Notes_Topic must exist in order to add the notes. The Equipment Notes web service has an option to append to the current Note Topic.





Validation



C Equipment_Code Equipment Code Text 10 Valid Equipment

D Notes_Topic Notes Topic Text 20 Equipment Note Topics Maintenance





Equipment Cost Transactions

Web Service name = AddEquip_Cost – Add Equipment Costs

Underlying File Maintenance Prior to importing Equipment Cost Transaction information, the following file maintenance screens must be completed:

Equipment Control Installation screen General Ledger | G/L Master File Maintenance Equipment Control | Equipment File Maintenance Equipment Control | Cost Category File Maintenance Equipment Control | Equipment Status File Maintenance Equipment Control | Equipment Type File Maintenance Equipment Control | Fuel / Oil File Maintenance (if applicable) Equipment Control | Equipment Location File Maintenance (if applicable) Equipment Control | Yard File Maintenance (if applicable) Equipment Control | Job/Equipment Rates File Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The import file has a recommended record limitation of 9000 records per batch. All transactions will be assigned a source code of “EC”. Transaction_Amount field hierarchy

o If the Fuel_Oil_Code is defined then the Transaction_Quantity will be required and the Transaction_Amount will be calculated.

o If the Fuel_Oil_Code is not defined then the Transaction_Amount field is required and the value defined will be used.

o If the Transaction_Quantity, Fuel_Oil_Code and Transaction_Amount are defined and valid then the Transaction_Amount will be used for the import and the calculation logic for the Fuel_Oil_Code logic will be ignored.

The Fuel_Oil_Code is available based on the defined Cost_Category_Code. The standard Cost_Category_Code heirarchy applies and if a Fuel_Oil_Code is defined that does not tie to the Cost Category Code defined then it will be an error.

The Debit G/L Code must use a Direct Cost Equipment Cost Account for these transactions. The Credit G/L Code must us a Non-direct Cost Account for these transactions. Cost center information will only be allowed in if the Company is set to a Yes status. The transaction data being submitted using this web service are stored within the Equipment Cost

Transaction Entry screen; the data must manually be updated within Spectrum.



C Transaction_Date Transaction Date Date 10 Format MM/DD/CCYY

Within Fiscal Year Calendar and Equipment Cost Processing Date Range



D Batch_ID Batch Text 10

Recommend using a unique batch code to keep them separate while validating and updating Equipment Cost Transactions.

Recommend limiting the 'Batch Code/Tran Date' quantity of Record to 9000.

E Equipment_Code Equipment Text 10 Equipment File Maintenance

F Cost_Category_Code Cost Category Text 4 Equipment Cost Category File

G Transaction_Quantity Quantity Numeric 10

Allows negative. Decimals ok. Required if Fuel_Oil_Code defined.

H Fuel_Oil_Code Fuel/Oil Text 2

Cost_Category_Code controls the logic for this field. Codes tied to Fuel or Oil will use the associated rate for the Transaction amount calculation.

Fuel/Oil File Maintenance

I Transaction_Amount Amount Numeric 11

Allows negative. Zero value not allowed. Decimals ok.

Defined amount overrides hierarchy. **See Assumptions and Dependencies for field logic.

J GL_Debit_Account Debit G/L Code Text 12 No dashes.

G/L Master File – use a Direct Cost = Equipment

K GL_Credit_Account Credit G/L Code Text 12 No dashes.

G/L Master File – use a Non-direct Cost Account

L Equipment_WO_Number

Equipment Work Order Text 10

Equipment Work Order is either required or optional based on Equipment Cost Category data entry rule.

Equipment Item must exist on the Equipment Work Order and not have a closed status.

M Remarks Remarks Text 30

N Credit_Cost_Center Credit Cost Center Text 10

Cost Center Maintenance; Equipment Cost Center; Cost Category Cost Center and G/L Account Cost Center


Equipment Revenue Transactions

Web Service name = AddEquip_Revenue – Add Equipment Revenue

Underlying File Maintenance Prior to importing Equipment Revenue Transaction information, the following file maintenance screens must be completed:

Equipment Control Installation screen General Ledger | G/L Master File Maintenance General Ledger | G/L Department File Maintenance Equipment Control | Equipment File Maintenance Equipment Control | Cost Category File Maintenance Equipment Control | Equipment Status File Maintenance Equipment Control | Equipment Type File Maintenance Equipment Control | Fuel / Oil File Maintenance (if applicable) Equipment Control | Equipment Location File Maintenance (if applicable) Equipment Control | Yard File Maintenance (if applicable) Equipment Control | Job/Equipment Rates File Maintenance (if applicable) Job Cost | Jobs (if applicable) Job Cost | Job Phases (if applicable) Job Cost | Cost Type File Maintenance (if applicable) Time + Material | Job Equipment Billing Rates (if applicable) Time + Material | Equipment Billing Rates (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The import file has a recommended record limitation of 9000 records per batch. The Rate_Type_Code field

If defined as Job then the Job information is required and the GL_Debit_Account will be a direct cost account.

If defined as Rental then the Job information will be ignored if defined and the GL_Debit_Account will be a non-direct cost account.

The Job_number field If defined then the Phase_Code and Cost_Type are both validated and mandatory. If not defined then the ‘Rental Debit Cost Center’ is both validated and mandatory.

Two of the following fields must be defined in order to create a record: Transaction_Hours Transaction_Rate

Can be blank as long as the Time+Material rate hierarchy logic exists for the Time+Material Job. Transaction_Amount

If the Transaction_Amount is defined and the calculation of the Transaction_Hour and Transaction_Rate fields don’t match, then the Transaction_Rate value will be recalculated. If no hours exist then the rate will store what is defined in the record. The amount defined for the Transaction_Amount field will overrule all other values.

For rental-related transactions, neither of the GL_Debit_Account or GL_Credit_Account can be direct, equipment or a work order cost code.


The GL_Debit_Account Subject to the Job Cost Installation flag to “validate job division with G/L department”. If this is set to

yes, then the G/L code must match the job division code. The Debit code must be a direct cost code for job-related transactions, and a non-direct cost account

for rental transactions. The GL_Credit_Account

Subject to the Equipment Control Installation flag to “validate equipment division with G/L department”. If this is set to yes, then the G/L code must match the equipment division code.

The Credit code must be a non-direct cost account for both job and rental type transactions. Defaults from the Equipment Control Installation GL Codes tabs if field is not populated.

The Billing_Rate field Available if the Time + Material module is installed. Used on Job’s with a price type of Cost Plus or Time + Material only. Hierarchy logic for the field (requires Time + Material module installed). Rates defined are based on

the TM billing details defined. Use the defined value in the file. Use the default value from Time + Material Equipment Billing Rate by Job. Use the default value from Equipment Billing Rate in Time + Material module. Follows standard Master Job and Sub-Job hierarchy.

The Inter_Company_Code field is allowed if the Equipment Control Installation ‘Multi Company?’ is selected. If selected then the Job information must match this company code.

Cost center information will only be allowed in if the Company is set to a Yes status. The transaction data being submitted using this web service are stored within the Equipment Revenue

Transaction Entry screen; the data must manually be updated within Spectrum.


Validation


Define the Company the Equipment is created in Spectrum.


C Transaction_Date Transaction Date Date 10

Format MM/DD/CCYY. If blank defaults to system date.

Within Fiscal Year Calendar and Equipment Cost Processing Date Range

D Batch_ID Batch Text 10

Recommend using a unique batch code to keep them separate while validating and updating Equipment Cost Transactions.

Recommend limiting the 'Batch Code/Tran Date' quantity of Record to 9000. Defaults from the Authorization ID's defined Operator Code if not populated.

E Equipment_Code Equipment Text 10 Equipment File Maintenance

F Source_Code Source Text 2 (EU) Equipment Usage or (ES)



Validation

Equipment Standby only

G Rate_Type_Code Activity Text 1 (J)ob or (R)ental

If (J)ob defined then Job fields are required. If (R)ental then fields are ignored if populated.

H Rate_Flag Rate Type Text 1

(H)ourly, (D)aily, (W)eekly, or (M)onthly

I Tran_Type Transaction Type Text 1 (F)ull or (O)perating.

Used for EU-Equipment Usage Transactions only.

J Transaction_Hours Hours Numeric 10

Format = -6.2 Allows negatives. **See Assumptions and Dependencies.

K Transaction_Rate Rate Numeric 9

Format = -2.2 Allows negative. Default using standard Spectrum Hierarchy if blank. **See Assumptions and Dependencies.

L Transaction_Amount Extension Numeric 11

Format = -7.2 Required if Transaction_Hours and/or Transaction _Rate are blank. Allows negative. If Extension is different from the calculated value for hours and rate then use Extension and calculate the rate. **See Assumptions and Dependencies.

M GL_Debit_Account Debit G/L Code Numeric 12 No dashes.

G/L Master File - Subject to the Job Cost Installation options defined. **See Assumptions.

N GL_Credit_Account Credit G/L Code Numeric 12

No dashes. Defaults from Equipment Control Installation if not populated.

G/L Master File - Subject to the Equipment Control Installation options defined. **See Assumptions.



Validation

O Job_Number Job Text 10 Job File Maintenance

P Phase_Code Phase Text 20 No dashes.

Q Cost_Type Cost Type Text 3 Cost Type File Maintenance

R Remarks Remarks Text 30

S Billing_Rate Billing Rate Numeric 11

Allows negative. Decimals ok (3 decimal places)

*See Assumptions for hierarchy. Time & Material module and Job specific billing rates. Job Cost type specific.

T Debit_Cost_Center Rental Debit Cost Center Text 10

Cost Center Maintenance; Equipment Cost Center; Job Cost Center; Phase Cost Center; G/L Account Cost Center

U Inter_Company_Code Job Company Code Text 3

Valid Company in Spectrum. **See Assumptions and Dependencies.


Get Equipment Cost Category

Web Service name = GetEqCostCategory – Get Equipment Cost Category

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank in the

parameter fields. All parameter fields have SuperSelect logic except the following-

o pStatus o pCost_Center o pSort_By

Parameter Fields

Parameter Field Name

Description Type Max Field Information

pCompany_Code Company Code Text 3 Valid Spectrum Company

pCost_Category_Type Cost Category Type Text 1

Equipment Cost Category File Maintenance

pStatus Status Text 1

Define one specific Status or leave blank to see Active and Inactive only

pCost_Center Cost Category Cost Center Text 10

Define one specific Cost Center or leave blank to see all based on Authorization ID

pSort_By Sort By Options Text 1

Blank = Cost Category Code or T= Cost Category Type

Return Fields

Return Field Name Description Type Max Field Information

Company_Code Company Code Text 3 Valid Spectrum Company

Cost_Category_Code Cost Category Code Text 4

Equipment Cost Category File Maintenance

Cost_Category_Description Cost Category Description Text 30

Cost_Category_Type Cost Category Type Text 1

Status Status Text 1

Cost_Center Cost Category Cost Center Text 10

Error_Code Error Code Text 1 Used for Error information if needed



Error_Description Error Description Text 250 Used for Error information if needed

Error_Column Error Column Text 100 Used for Error information if needed


Get Equipment

Web Service name = GetEquipment – Get Equipment


parameter fields. Equipment Status is based on the status type defined for each status code. All parameter fields have SuperSelect logic except the following-

o pStatus_Type o pCost_Center o pSort_By

Parameter Fields




pEquipment_Type Equipment Type Text 4 Equipment Type File Maintenance

pEquipment_Make Make Text 20

Equipment Make Maintenance based on Install option

pEquipment_Model Model Text 20

Equipment Model Maintenance based on Install option

pYear Year Numeric 2

pStatus_Code Equipment Status Text 4

Define one specific Status type or leave blank to see Active and Inactive status types only

pCost_Center Equipment Cost Center Text 10



Blank = Equipment Code, K= Make, D= Model, Y= Year or T= Equipment Type

Return Fields



Equipment_Code Equipment Code Text 4 Equipment File Maintenance

Equipment_Type Equipment Type Text 4



Description Equipment Description Text 30

Equipment_Status Status Text 4

Displays data based on the Equipment Status type

Year Year Numeric 2

Equipment_Make Make Text 20

Equipment_Model Model Text 20

Owned_Flag Acquisition Type Text 1 O(wned), R(ent) or L(ease)

License_Number License # Text 15

Serial_Number Serial # / VIN Text 50

Division_Code Division Text 5

Cost_Center Equipment Cost Center Text 10





EQUIPMENT TRACKING

Equipment Tracking Requisition

Web Service name = AddET_Requisition – Add ET Requisitions

Underlying File Maintenance Prior to importing Equipment Tracking Requisitions information, the following file maintenance areas must be completed:

Equipment Tracking Installation screen Inventory Control Installation screen Equipment Tracking | Transaction Code Maintenance Equipment Control | Equipment Code Maintenance Inventory Control | Inventory Item File Maintenance Inventory Control | Warehouse File Maintenance Inventory Control | G/L Department File Maintenance General Ledger | G/L Master File Maintenance Job Cost | Jobs Job Cost | Job Phases Job Cost | Cost Type File Maintenance System Administration | Security | Operator Maintenance

Assumptions and Dependencies The Equipment Tracking Requisition web service updates the History tables automatically due to how

they are created in Spectrum using the ‘Continue’ logic and bypasses the Data Entry tables. **WARNING**

The Equipment Tracking Requisition web service checks the Historical SQL tables to define whether or not to create a new Requisition or to add detail lines to an existing Requisition based on the required fields matching. The data is appended to an existing Requisition only.

The Equipment Tracking Requisition header contains the following fields which must match in order to add detail lines to the History table. **WARNING** If all fields match in History they will be added as detail lines.

o Company_Code o Tool_Requisition_Number o Transaction_Code o Job_Company_Code o Job_Number o Site_ID o Requistition_Date o Expected_Billing_Period

If the Tool_Requisition_Number exists in the standard Data Entry table then it will not be created. If the Tool_Requisition_Number exists in History but none of the other required fields needed for the

Requisition header match, then the service will prevent the information from being added. The import has a record limit of 990 records per Equipment Requisition and the service will prevent any

additional detail lines to be added. If the Company_Code is blank then use the Authorization ID default value. The Tool_Requisition_Number and Transaction_Code are required fields. The Transaction_Code defines whether or not the requisition will be for a Job or Site. The Expected_Billing_Period field defaults from the Installation option if defined and not supplied in the

record. The Inventory Item must exist for the defined warehouse.


Inventory Non-stock items cannot be created. When an Equipment item exists on a current Equipment Tracking Requisition the system automatically

creates the ‘Return’ within Spectrum using the next available Requisition number based on the Installation setting. Therefore if you have defined that number to be used within the web service an error will be returned because that number has already been used.

Equipment Tracking Requisitions are not created when Physical Inventory is in progress. For Intercompany Equipment Tracking Requisitions

o The options and setup must be completed on the company Inventory and/or Equipment Control Installation screens.

o Available for requisitions with direct cost transaction codes (i.e.,i.e.,, Job deployment type for Transaction Code) and defined in the Equipment’s primary company.

The Quantity field logic o Required for a requisition that has a defined Item_Code. o Some requisitions that have a define Equipment_Code require the Quantity to be populated.

The Expected_Billing_Period field logic o This is not a required field. o If field is blank then it will defaults from the Equipment Tracking Installation unless NONE is

selected then it will be blank. The Notes and Message fields will be truncated if they exceed the Max character length.





C Tool_Requisition_Number Requisition Text 10

**See Assumptions and Dependencies for multiple detail line logic.

Requisition History Table ( defines whether or not to add as a detail line or create new)

D Transaction_Code Transaction Code Text 5

Code defines whether it’s a job or site requisition. **See Assumptions and Dependencies for multiple detail line logic.

Equipment Tracking Transaction Code

E Job_Company_Code

Issue to Job Company Code Text 3

Used for Multi-company requisition feature for Job type Transaction Codes. If blank or option not selected use the Company_Code field for Job Transaction codes. **See Assumptions and

Inventory Control or Equipment Control installation option for Multi-company requisition is defined. Valid Company in Spectrum.




Dependencies for multiple detail line logic.

F Job_Number Job Text 10

If defined then Site_ID must be blank and Transaction_Code is for Job type. **See Assumptions and Dependencies for multiple detail line logic.

Valid Job in defined Job_Company_Code otherwise valid for defined Company_Code

G Site_ID Site Text 10

If defined then Job_Number must be blank and Transaction_Code is for Non-job type. Must have an active status. **See Assumptions and Dependencies for multiple detail line logic.

Work Order Site File Maintenance

H Requisition_Date Requistion date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). Use Current Date for Equipment Tracking module if blank. **See Assumptions and Dependencies for multiple detail line logic.

Must be within the Equipment Tracking min/max dates.

I Expected_Billing_Period Minimum billing period Text 1

D(aily), W(eekly), M(onthly) or blank only. If blank then use the selected default installation setting. **See Assumptions and Dependencies for multiple detail line logic.

**See Assumptions and Dependencies

J Notes Notes Text 1000

K Item_Code Item Text 15

If defined then Equipment_Code must be blank.

Inventory Item Maintenance




L Equipment_Code Equipment Text 10

If defined then Item_Code must be blank.

Equipment Code Maintenance

M Phase_Code Phase Text 20

Defaults from Item_Code if left blank.

Phase File Maintenance

N Cost_Type Cost type Text 3

Defaults from Item_code if left blank. Validates to the defined GL_Debit_Account for direct job cost.

Cost Type Maintenance

O Yard_Or_Warehouse Text 10

Used for Inventory Type only. Warehouse must be defined for Item_Code field. If blank defaults from Inventory Control Installation screen.

Warehouse File Maintenance

P Quantity Quantity Numeric 9

Allows negative. Whole numbers only.


Q Message Message Text 30 Detail line message


GENERAL LEDGER

G/L Account

Web Service name = AddGLAccount – Add GL Account

Underlying File Maintenance Prior to importing G/L Account information, the following file maintenance areas must be completed:

General Ledger Installation screen General Ledger | G/L Department File Maintenance (if applicable) General Ledger | G/L User-Defined Fields Maintenance (if applicable) Job Cost | Cost Type File Maintenance (if applicable)

Assumptions and Dependencies The GL Account Master cost center flag is shared. The GL Account import will validate that the company

has the cost center option set to Pending or Yes and will set the default for the new G/L Account to Shared.

If the Direct_Cost_Flag field is defined with a Y then the Cost_Type field is required. All General Ledger accounts will post in detail.



Valid company in Spectrum

C GL_Account G/L Account Numeric 12

Verifies the GL mask and department prefix for the account code from install screen. Positive numbers only. No dashes.

D Description Description Text 30

E Short_Description Abbreviated Description Text 18

F Account_Type_Code Account Type Text 1

(A)ssets; (L)iabilities; (C)apital; (I)ncome; (E)xpense; or (S)tatistic only

G Direct_Cost_Flag Direct Cost Text 1

(Y) – Direct Job; (E) – Direct Equipment; or (N) – Non-Direct only; (W) – Work Order

H Cost_Type Cost Type Text 3 Required if Direct_Cost_Flag = Y

Cost Type Master

I Status Status Text 1 (A)ctive; (I)nactive; or (N)ot Used only

Spectrum Web Services| 112

G/L Account – User-Defined Field

Web Service name = UpdateGLAccount_UDF – Change GL Account UDF

Assumptions and Dependencies The General Ledger module must be set up. The General Ledger Account code must exist in the defined Company code. The General Ledger Account-UDF Web Service updates existing G/L Account’s information for the

defined fields only. 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. The G/L Account user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped, for this Web Service.




C GL_Account G/L Account Numeric 12

G/L Account Code must exist for the defined Company Code.

















































G/L Journal Entries

Web Service name = AddGLTrans – Add GL Journal Entries

Underlying File Maintenance Prior to importing G/L Journal Entries information, the following file maintenance areas must be completed:

General Ledger Installation screen General Ledger | G/L Master File Maintenance Job Cost | Jobs (if applicable) Job Cost | Job Phases (if applicable) Job Cost | Cost Type File Maintenance (if applicable) Equipment Control | Equipment (if applicable) Equipment Control | Cost Category File Maintenance (if applicable) Work Order | Site File Maintenance (if applicable) Work Order | Work Order Entry (with site equipment and components-if applicable) Service Contracts | Service Contract File Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The GL JE transactions sent will be grouped as a batch, create one journal entry, and must be in balance. The GL Journal Web Service is company-specific, therefore each group (or batch) sent must be for the

same company code. The import file has a record limitation of 900 records per batch. If the journal entry contains a significant

amount of inter-company cost center transactions, then you should create manageable journal entries so that the General Ledger Journal Entry Update can process them correctly.

The first record of the import will define the following fields for the Journal Entry header information: o Journal Entry Transaction date o Journal Entry Description o Journal Entry Remark

If the General Ledger Code is set to Direct Cost = N (Non-direct): o Any data defined in the Job Cost, Equipment, or Work Order fields will be ignored and not

populated. If the General Ledger Code is set to Direct Cost = Y (Job Cost):

o The Job_number, Phase_code, and Cost_type are mandatory and validated. o When the Job Cost Installation’s “Validate job division with G/L department?’ is:

Unchecked then the G/L code must be a direct cost code and valid for the cost type. Selected but the ‘Auto default G/L department?’ is not selected then the G/L code is

validated to the Job’s Division code and an error is received: “The Job Division does not match the G/L department’ when they do not match.

Selected AND the ‘Auto default G/L department?’ is selected then, the G/L code will be auto-switched to match the Job’s Division and G/L Department codes.

If the General Ledger Code is set to Direct Cost = E (Equipment): o The Equipment_Code and Equipment_Cost_Category are both mandatory and validated. o The Equipment_Work_Order is either required or optional based on the defined Equipment Cost

Category data entry rule. If the General Ledger Code is set to Direct Cost = W (Work Order):


o The WO_Number is required. o The WO_Equipment is required and validated when the Work Order Installation “Require

equipment code for work order transactions?” check box is selected. o The WO_Component is required and validated when the Work Order Installation “Require

component code for work order transactions?” check box is selected and the WO Equipment assigned has Components.

o The WO_Contract is not required, but if it is populated it will be validated. o The WO_Sellprice is not required, but defaults the GL debit or credit amount.

This Web Service will work the defined Workflow process in Spectrum. Cost center information will only be allowed in if the Company is set to a Yes status.

o The first record must contain the Cost Center for the Header. o The detail lines will follow standard Cost Center logic.

For a Cost center company, the following logic is used: o The Cost_Center field name is mandatory and validated for a non-direct GL_Account field name. o The Cost_Center field name is not required for a direct cost GL_Account because it will use

standard Spectrum logic based on the direct cost type defined below: For direct Job cost GL_Account fields it will attempt to use the Phase cost center; if it is

blank then it will use the Job cost center. For a direct Equipment cost GL_Account it will attempt to use the

Equipment cost category’s cost center; if it is blank then it will use the Equipment cost center.

For a direct Work Order cost GL_Account it will attempt to use the Work Order’s cost center.

Once the Expense_Cost_Center is determined for direct cost records, it is then validated against the Distribution G/L code’s cost centers.

This Web Service will work with the defined Workflow process in Spectrum. The transaction data being submitted using this web service are stored within the General Ledger Journal

Entry screen; the data must manually be updated within Spectrum.



C Transaction_Date Transaction Date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). First record is used for the header and all records will match.

Must be within current G/L Processing Date.

D Journal_Desc Journal Entry Description Text 30

First record is used for the header and all records will match.

E Journal_Remarks Journal remarks Text 100

First record is used for the header and all records will match.

F GL_Account General Ledger Code Text 12

*See Assumptions for Rules. No dashes. G/L Master File



G Line_Reference Line Item Reference Text 15

H Job_Number Job Number Text 10 Job Master File

I Phase_Code Phase Code Text 20 No dashes. Phase Master File

J Cost_Type Cost Type Text 3 Phase Master File

K Equipment_Code Equipment Code Text 10 Equipment Master File

L Equipment_Cost_Category Equipment Cost Category Text 4

Equipment Cost Categories

M Equipment_Work_Order Equipment Work Order Text 10

Equipment Work Order is required, optional or none based on Equipment Cost Category data entry rule.

Equipment Item must exist on the Equipment Work Order for required or optional settings.

N GL_Debit_Amount Debit Amount Numeric 14 Positive values only.

O GL_Credit_Amount Credit Amount Numeric 14 Positive values only.

P WO_Number Work Order # Text 10

Valid Work Order with a not complete status (e.g., not a status of C)

Q WO_Equipment WO Site Equipment Text 8

Work Order Site Master File/Equipment Tab

R WO_Component WO Component Text 2

Work Order Site Master File/Equipment Tab /Component Tab (old systems)

S WO_Contract WO Service Contract Text 10

Work Order Site Master File/Service Contract Tab

T WO_Sellprice WO Sell Price Numeric 14

U Cost_Center Journal Entry Cost Center Text 10

Required for First record to define the Header information.

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


INVENTORY

Inventory Items

Web Service name = AddInv_Req – Add Inventory Items

Underlying File Maintenance Prior to importing Inventory Items information, the following file maintenance areas must be completed:

Inventory Control Installation screen Inventory Control | Category File Maintenance Inventory Control | Warehouse File Maintenance Inventory Control | Discount File Maintenance Inventory Control | Item Location File Maintenance (if applicable) Inventory Control | Item User-Defined Fields Maintenance (if applicable) Accounts Payable | Vendors Job Cost | Cost Type File Maintenance Equipment Control | Cost Category Maintenance Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Inventory module must be set up. The Inventory Item Master cost center flag is shared. The Inventory Items import will validate that the

company has the cost center option set to Pending or Yes and will set the default for the new Inventory Items to Shared.

The Inventory Item status will default to (A)ctive if left blank. The Location field is required if the Inventory Control Installation screen is set to validate. Otherwise it is a

data entry field. Warehouse_Code hierarchy

o If populated then validate and set up the warehouse. o If the Inventory Control Installation screen option ‘One Warehouse’ is selected, the default

warehouse is defined and the field is blank then the field is required. If the default warehouse is defined then set up the item for the defined warehouse code.

o If the Inventory Control Installation screen option ‘One Warehouse’ is NOT selected and the field is blank then set up the item for ALL warehouses.



B Company_Code Company Code Text 3 Valid Company in Spectrum.

C Item_Code Item Code Text 15 Unique identifier. No dashes if using Traser.

D Item_Description Item Description Text 35

E Item_Category Category Text 4 Category File Maintenance

F ABC_Class ABC Class Text 3

G Alternate_Item_Code1 EDP Part # Text 15

H Standard_Cost Standard Cost Numeri

c 11

Format = 6.4. Enter decimals but no $ or commas.





I Unit_Of_Measure_Conversion

Purchase Conversion Factor

Numeric 9

Format = 4.4. Positive numbers only.

J Purchase_Unit_Of_Measure1

Purchase Unit of Measure Text 2

K Price_List1 Sell Price 1 Numeri

c 11

Enter decimals but no $ or commas. Positive only.

L Price_List2 Sell Price 2 Numeri

c 11


M Price_List3 Sell Price 3 Numeri

c 11


N Price_List4 Sell Price 4 Numeri

c 11


O Price_List5 Sell Price 5 Numeri

c 11


P Price_Per_Factor Price Per Factor Numeri

c 10

Defaults to 1 if left blank. Format = 4.4-

Q Sell_Unit_Of_Measure2 Sell Unit of Measure Text 2

R Vendor_Part_Number Vendor Part # Text 15

S Vendor_Code_List1 Primary Vendor Text 10 Vendor Maintenance

T Vendor_Code_List2 Alternate Vendor Text 10 Vendor Maintenance

U Markup_Price Markup % Numeri

c 7

Example: Enter 10.55% as 10.55. Defaults to 0.0% if left blank. Format = 3.2-

V Phase_Code Default Item Phase Text 20 No Dashes

W Cost_Type Default Cost Type Text 3 Cost Type Maintenance




X Default_Cost_Category Default Equip Cost Category Text 4

Equipment Cost Category Maintenance

Y Discount_Code Promotional Discount Code Text 2

Discount File Maintenance

Z Unit_Weight Weight Numeri

c 9 Format = 3.4-

AA Taxable_Flag Subject to Sales Tax? Text 1

(Y)es or (N)o only.

AB Use_Tax_Flag Subject to Use Tax? Text 1 (Y)es or (N)o only.

AC Commission_Flag Commissions? Text 1 (Y)es or (N)o only.

AD Mix_Flag Auto-create Mix? Text 1 (Y)es or (N)o only.

AE Status_Discontinue_Flag Status Text 1

(A)ctive, (D)iscontinued or (N)ot used. Defaults to Active if blank.

AF Date_Discontinued Discontinued Date Date 10

Enter as: MM/DD/CCYY (i.e., 01/05/00)

AG Warehouse_Code Default Warehouse Text 10

If Installation option 'One warehouse' is not selected and field is left blank then all warehouses will be set up. If 'One warehouse' selected and no default warehouse then field is required.


AH Location Item Location Text 10

Required if I/C Installation screen is set to Y to Validate Item Location. Otherwise this is a user-defined field.

AI Reorder_Point Item Reorder Point Numeri

c 7 No decimals. Whole numbers.

AJ Reorder_Quantity Item Suggested Quantity

Numeric 7

No decimals. Whole numbers.

AK Exclude_SI_Ticket Exclude from scale ticket quantity? Text 1

(Y)es or (N)o only.




AL Exclude_SI_Freight Exclude from freight quantity? Text 1

(Y)es or (N)o only.


Inventory Items – Sell Price

Web Service name = UpdateInv_SellPrice – Change Inventory Sell Price

Assumptions and Dependencies The Inventory module must be set up. The Inventory Item code must exist in the defined Company code. The Inventory Items-Sell Price Web Service updates existing inventory item’s information for the defined

fields only. Any field that is left blank will not be updated in Spectrum. The service does not delete values that exist in





C Item_Code Item Code Text 15

Valid Inventory Item Code must exist for the defined Company Code.

D Standard_Cost Standard Cost Numeric 12

Format = 6.4. Enter decimals but no $ or commas. Positive numbers only.

E Price_List1 Sell Price 1 Numeric 10

Format = 7.2. Enter decimals but no $ or commas. Positive only.

F Price_List2 Sell Price 2 Numeric 10


G Price_List3 Sell Price 3 Numeric 10


H Price_List4 Sell Price 4 Numeric 10


I Price_List5 Sell Price 5 Numeric 10


J Price_Per_Factor Price Per Factor Numeric 8 Format = 4.4-

K Sell_Unit_Of_Measure2 Sell Unit of Measure Text 2

L Markup_Price Markup % Numeric 7

Example: Enter 10.55% as 10.55. Format = 3.2-


Inventory Items – User-Defined Field

Web Service name = UpdateInv_UDF – Change Inventory Items UDF

Assumptions and Dependencies The Inventory module must be set up. The Inventory Item code must exist in the defined Company code. The Inventory Items-UDF Web Service updates existing inventory item’s information for the defined fields

only. 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. The Inventory Items user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.




C Item_Code Item Code Text 15

Valid Inventory Item Code must exist for the defined Company Code.













































Inventory Item Notes

Web Service name = InvItemNotes – Inventory Item Notes

Underlying File Maintenance Prior to importing Inventory Item Notes information, the following file maintenance areas must be completed:

Inventory Control Installation screen Inventory Control | Inventory Items Maintenance Inventory Control | Item Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Item_Code and Notes_Topic must exist in order to add the notes. The Item Notes web service has an option to append to the current Note Topic.





Validation



C Item_Code Item Code Text 10 Valid Inventory Item

D Notes_Topic Notes Topic Text 20 Item Note Topics Maintenance





Inventory Receipts Transactions

Web Service name = AddInv_Receipt – Add Inventory Items Receipts

Underlying File Maintenance Prior to importing Inventory Receipts Transaction information, the following file maintenance screens must be completed:

Inventory Control Installation screen Inventory Control | G/L Department File Maintenance Inventory Control | Warehouse File Maintenance General Ledger | G/L Master File Maintenance

Assumptions and Dependencies The Transaction Type will default to ‘Receipt’ only. The import has a record limit of 990 records per Transaction_Reference. The Inventory Item must exist for the defined warehouse. The Transaction_Reference must not exist in the Inventory Transaction History table. If the Transaction_Reference is blank in the web service then the following logic will apply.

o If a Transaction_Reference exists within the unposted Inventory transaction table then the web service will add additional records until it reaches the 990 record limits then create additional Transaction_Reference as needed. A numeric type Transaction_Reference will be added to first then followed by any alpha type Transaction_Reference that exists.

o If a Transaction_Reference does not exist within the unposted Inventory transaction table then the web service will follow standard Spectrum logic and create auto-assigned reference numbers.

GL_Credit_Account field defaults from the GL_Department field if left blank and must be a non-direct cost account.





If the Batch code exists then records will be added to the existing Batch code and Reference # group.

** See Assumptions and Dependencies.

D Transaction_Reference Reference # Text 7

Reference # must not be in use or been used. Limit of 990 records per Reference #.

** See Assumptions and Dependencies.

E Transaction_Date Transaction Date Date 10 MM/DD/YYYY format.

Must be within Inventory Control Processing Date Range

F From_Warehouse Warehouse Text 10 Warehouse Maintenance file




G Item_Code Item Code Text 15

Item must be a valid combination of Inventory Item & Warehouse Code.

Inventory Item Warehouse Maintenance file.

H Transaction_Quantity Quantity Numeri

c 9 Positive numbers only. Format = 6.2

I Unit_Cost Unit Cost Numeri

c 10 Positive numbers only. Format = 5.4

J GL_Department Department Text 4

Inventory G/L Department Maintenance file

K Reason Message Text 30

L GL_Credit_Account GL Credit Account Numeri

c 12

Defaults from Inventory GL Department if left blank. Must be a non-direct cost account.

GL Account Master


Inventory Job Requisitions

Web Service name = AddJob_Reqs – Add Inventory Job Requisitions

Underlying File Maintenance Prior to importing Inventory Job Requisitions information, the following file maintenance areas must be completed:

Inventory Control Installation screen Inventory Control | Inventory Item File Maintenance Inventory Control | Inventory Item Category File Maintenance Inventory Control | Warehouse File Maintenance Inventory Control | G/L Department File Maintenance General Ledger | G/L Master File Maintenance Job Cost | Jobs Job Cost | Job Phases Job Cost | Cost Type File Maintenance Job Cost | Job Classifications (if applicable) Accounts Payable | Use Tax Code Maintenance (if applicable) System Administration | Security | Operator Maintenance

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Instructions and Message fields will be truncated if they exceed the Max character length. The Status will default to O(rdered) if left blank. The import has a record limit of 990 records per Requisition and the service will prevent any additional

detail lines to be added. The Job Requisition header contains the following fields which must match in order to add detail lines.

o Company_Code o Batch_Code o Operator o Transaction_Reference o Req_Company_Code o Default_Job o Status o Transaction_Date o Ship_Date o From_Warehouse

The Inventory Item must exist for the defined warehouse. Non-stock items can be created using the combination of the Item_Category and the Item_Code using

the standard Spectrum logic. If the Non-stock item logic exceeds the character length then the defined Item_Code will be truncated.

If the Transaction_Reference is blank in the web service then the following logic will apply. o If a Transaction_Reference exists within the unposted Inventory transaction table and all header

information matches then the web service will add additional records until it reaches the 990 record limits then create additional Transaction_Reference as needed.

o If a Transaction_Reference does not exist within the unposted Inventory transaction table then the web service will follow the standard Spectrum logic and create auto-assigned reference numbers.

GL_Credit_Account field defaults from the GL_Department field if left blank and must be a non-direct cost account.

The Standard_Cost field can be defined or is defaulted from the Item_code. The Inventory Control Installation defined how and if the Standard_Cost data is updated or not.

The Inventory Control Installation defined whether or not multi_company requisitions can be done.


Job Requisitions are not created when Physical Inventory is in progress. For Intercompany Job Requisitions

o The options and set up must be completed on the company Inventory Installation screens. o The Use Tax code must exist in both companies.

The transaction data being submitted using this web service are stored within the Job Requisition Entry screen; the data must be manually updated within Spectrum.






D Operator Entered by Text 3

If blank then defaults to Operator ID.

E Transaction_Reference Requisition number Text 7

Use Auto-assign next requisition # if left blank. If defined then all Requisition Header details must match.

F Req_Company_Code Job (Requisition) company -header Text 3

Used for Multi-company requisition feature. If blank or option not selected use the Company_Code field.

Inventory Control installation option for Multi-company requisition is defined. Valid Company in Spectrum.

G Default_Job Job number - Header Text 10

If defined then each associated detail will use the same Job number.

Valid Job in defined Req_Company_Code otherwise valid for defined Company_Code

H Status Status Text 1

O(rdered) or S(hipped) only. If blank defaults to O(rdered).

I Special_Instructions Instructions Text 70

J Transaction_Date Requisition date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). Use Current Date for Inventory module if blank.




K Ship_Date Ship date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). Use Current Date for Inventory module if blank.

L Ship_Via Ship via Text 15

M From_Warehouse Default warehouse Text 10

If blank defaults from Inventory Control Installation screen.


N Item_Code Item code Text 15

If Item code is valid then it must be valid for From_Warehouse if defined. Non-stock items will be created using the Item_Category if defined and Item_Code is not valid.

Inventory Item File Maintenance

O Item_Category Item category Text 4

Used to create Non-stock items only.

Inventory Item Category Maintenance

P Warehouse Warehouse Text 10

Warehouse must be defined for Item_Code field. If blank use default warehouse or it is required.


Q Markup_Percent Markup Numeric 7

Example: Enter 10.55% as 10.55. Format = 3.2-

Defaults from Inventory Item if left blank. Not used for Non-stock items.

R Transaction_Quantity Order quantity Numeric 11

Required. Negative numbers allowed. Cannot be zero. Format = -7.2

S Ship_Quantity Ship Quantity Numeric 11

Negative numbers

Quantity cannot exceed the




allowed. Format = -7.2

Transaction_Quantity value.

T Reason Message Text 30

U GL_Department Department Text 4

Defaults from Warehouse default then Item Category default

Inventory G/L Department File Maintenance

V GL_Debit_Account G/L Account Numeric 10

Defaults from Department if not entered. Required for intercompany records. Must be a direct job cost G/L Account

G/L Account Master File

W Job_Number Job - Detail Text 10

Required if Default_Job not defined.

Job File Maintenance for defined Company.

X Phase_Code Phase Text 20

Defaults from Inventory Item if left blank.

Phase File Maintenance

Y Cost_Type Cost type Text 3

Defaults from Inventory Item if left blank. Validates to the defined GL_Debit_Account for direct job cost.

Cost Type Maintenance

Z Use_Tax_Code Use Tax Code Text 15

If blank- default from Job Tax Classification if used.


AA Standard_Cost Standard Cost Numeric 11

Positive number only. Defaults from Inventory Item if left blank. Format = 6.4


Get Inventory Items

Web Service name = GetInventoryItems – Get Inventory Items


parameter fields. Inventory Status is based on the status type defined for each status code. All parameter fields have SuperSelect logic except the following-


Parameter Fields




pItem_Category Item Category Text 4 Item Category File Maintenance

pItem_Description Item Description Text 35

pEDP_Part_Number EDP Part # Text 15

pVendor_Part_Number Vendor Part # Text 15

pPrimary_Vendor Primary Vendor Text 10 Vendor Maintenance

pStatus_Discontinue_Flag Status Text 1

Define one specific Status type of (A)ctive, (D)iscontinued or (N)ot used or leave blank to see Active and Discontinued status types only.

pCost_Center Item Cost Center Text 10



Blank = Item Code, C= Category, E= EDP part #, P= Vendor part # or V= Primary Vendor

Return Fields



Item_Code Item Code Text 15 Item Maintenance

Item_Description Item Description Text 35



Standard_Cost Standard Cost Numeric 11

Purchase_Unit_Of_Measure Purchase Unit of Measure Text 2

Displays data based on the Equipment Status type

Unit_Of_Measure_Conversion Purchase Conversion Factor Numeric 9

Price_List1 Sell Price 1 Numeric 11





Sell_Unit_Of_Measure Sell Unit of Measure Text 2

Price_Per_Factor Price Per Factor Numeric 10

Phase_Code Default Item Phase Text 20

Cost_Type Default Cost Type Text 3

Default_Cost_Category Default Equip Cost Category Text 4

Markup_Price Markup % Numeric 7

Item_Category Category Text 4

ABC_Class ABC Class Text 3

EDP_Part_Number EDP Part # Text 15

Vendor_Part_Number Vendor Part # Text 15

Primary_Vendor Primary Vendor Text 10

Alternate_Vendor Alternate Vendor Text 10

Unit_Weight Weight Numeric 9

Status_Discontinue_Flag Status Text 1 Displays data based on the Item Status

Date_Discontinued Discontinued Date Date 10





JOB COST

Jobs

Web Service name = AddJob – Add Job

Underlying File Maintenance Prior to importing Job information, the following file maintenance areas must be completed:

Job Cost Installation screen General Ledger | G/L Master File Maintenance General Ledger | G/L Department File Maintenance (if job divisions are validated to G/L departments in

the JC Installation screen) Accounts Receivable | Customers Accounts Receivable | Sales Tax Code Maintenance (if applicable) Job Cost | Tax Classification File Maintenance (if applicable) Accounts Receivable | Unit of Measure File Maintenance Payroll | Tax Table Maintenance Payroll | Worker’s Compensation Code Maintenance Work Order | Site File Maintenance (if applicable) Job Cost | Job User-Defined Fields Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Job Master cost center flag is validated against the customer cost center. The following sections in the Job Master are defined by the Job Cost Installation options:

o Payroll burden o Payroll overhead o Phase setup o Tax_Class_Code field logic o Key personnel validation logic

The contract is set up when the Customer code is defined in the layout. 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 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. If the Phase Categories is defined then define the correct Phase mask and major/minor group positions

for the Job. Master Job logic

o The Master Job tied to the Sub Job must be valid and not have a complete status o The Master Job and Sub Job must have the same Phase length. o The Sub Job will be created with the same Phase setup as the Master Job. o The Sub Job will default the Master Job’s Customer and Tax classification if left blank. o 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 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.

Cost center information will only be allowed in if the Company is set to a Pending or Yes status. This Web Service will work with the defined Workflow process in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.



C Job_Number Job Number Text 10 No duplicates

D Job_Description Job Name Text 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 Text 30

H City City Text 25

I State State Text 2 2 digit postal abbreviation

J Zip_Code Zip Code Text 10

K Phone Phone number Text 14


L Fax_Phone Fax Number Text 14


M Job_Site_Phone Job Site Phone Number Text 14


N Superintendent Superintendent Text 15

Employee Code if installation screen selected

O Estimator Estimator Text 15


P Project_Manager Project Manager Text 15


Q Customer_Code Customer Code Text 10

Customer Maintenance File

R Contract_Number Contract Number Text 30

S Job_Type Contract Type Text 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 Text 1 “Y” or “N” 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” or “N” only

Y Work_Comp_Code Worker’s Compensation Code Text 6

Worker’s 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 Date 10

Text format for import MM/DD/CCYY

AD Start_Date Actual Start Date Date 10 Text format for import MM/DD/CCYY

AE Complete_Date Actual Complete Date Date 10 Text format for import MM/DD/CCYY

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 Text 10

The Work Tax codes must be unique.


AH Work_Local_Tax_Code Work Local Tax Code Text 10 The Work Tax codes must be unique.


AI Original_Contract Original Contract Amount Numeric 14

Not validated. DOES NOT include change order amounts. Change Orders are entered manually into Spectrum.



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 Numeric 11 Format for import -XXX.XXXXXX.

AM Track_Davis_Bacon Davis-Bacon Job Text 1 “Y” or “N” only

AN Track_Prevailing_Wage Prevailing Wage Job Text 1 “Y” or “N” 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 UDF1



AQ UDF2



AR UDF3



AS UDF4



AT UDF5



AU UDF6



AV UDF7



AW UDF8



AX UDF9



AY UDF10




Excel Field Name Description Type Max Field Information Validation Service UDF defined.

AZ UDF11



BA UDF12



BB UDF13



BC UDF14



BD UDF15



BE UDF16



BF UDF17



BG UDF18



BH UDF19



BI UDF20



BJ Cost_Center Job Cost Center Text 10

Cost Center Maintenance and Customer Code Cost Center

BK Master_Job Master Job Text 10

Valid Job that does not have a complete status. Master Job must have the same


Excel Field Name Description Type Max Field Information Validation Phase length as Job.

BL 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.

BM Standard_Phase_Category Phase setup category Text 10

If defined then display the Phase information as set up for each field. **See Assumptions and Dependencies.

Validates to the Phase Category

BN Phase_Display_Code Phase setup mask Text 20

If blank defaults from Job Installation. If Sub-Job then defaults from Master Job. **See Assumptions and Dependencies.

BO Major_Group_Start Phase Major group start position Numeric 2


BP Major_Group_End Phase Major group end position Numeric 2


BQ Minor_Group_Start Phase Minor group start position Numeric 2


BR Minor_Group_End Phase Minor group end position Numeric 2


BS Status_Code Status Text 1

(A)ctive, (I)nactive or (C)omplete. Defaults to Active if blank.


Job - Update

Web Service name = UpdateJob – Update Job

Underlying File Maintenance Prior to importing Job-Update information, the following file maintenance areas must be completed:

Job Cost Installation screen General Ledger | G/L Master File Maintenance General Ledger | Departments (if job divisions are validated to G/L departments in the JC Installation

screen) Accounts Payable | Routing Code Maintenance Accounts Receivable | Customers Accounts Receivable | Sales Tax Code Maintenance (if applicable) Accounts Receivable | Unit of Measure File Maintenance Job Cost | Job Maintenance Job Cost | Phase Maintenance Job Cost | Cost Type Maintenance Job Cost | Tax Classification File Maintenance (if applicable) Job Cost | Phase Categories Maintenance (if applicable) Job Cost | Job User-Defined Fields Maintenance (if applicable) Payroll | Employee Maintenance Payroll | Tax Table Maintenance Payroll | Worker’s Compensation Code Maintenance Work Order | Site File Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

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. 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 updated if the Customer code and Original_Contract is defined. This is an

Accounts Recievable 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 o Entered_Perecent_Complete o 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

o The Master Job tied to the Sub Job must be valid and not have a complete status. o The Master Job and Sub Job must have the same Phase length. o The Sub Job will be created with the same Phase setup as the Master Job. o The Sub Job will default the Master Job’s Customer and Tax classification if left blank. o 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 set up the Default Job Address used on the Purchase Orders.


o The ‘Ship-to name’ must exist in Spectrum in order to modify the other fields such as address information and/or comments as needed.

o If the ‘PO Ship-to Name’ does not exist then the PO_Ship_Name is required. 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

o 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

o If any of the above fields are populated they will be updated if they meet the PR_OH_Type_Code current setting.

o If the PR_OH_Type_Code field is defined as (N)one then it will ignore the above four fields. 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




C Job_Number Job Number Text 10 No duplicates

D Job_Description Job Name Text 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 Text 30

H City City Text 25

I State State Text 2 2 digit postal abbreviation

J Zip_Code Zip Code Text 10

K Phone Phone number Text 14

Formatted e.g. (206) 555-1212 or 123-123-1224 or 123-1233 or 1231241235

L Fax_Phone Fax Number Text 14


M Job_Site_Phone Job Site Phone Number Text 14


N Superintendent Superintendent Text 15




O Estimator Estimator Text 15


P Project_Manager Project Manager Text 15


Q Customer_Code Customer Code Text 10 *See Assumptions and Dependencies.


R Contract_Number Contract Number Text 30

S Job_Type Contract Type Text 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 Text 1 “Y” or “N” 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” or “N” only

Y Work_Comp_Code Worker’s Compensation Code Text 6


Z Wage_Rate_Level Wage Rate Level Numeric 1 Numbers 1-9 only

AA Price_Method_Code Price Type Code Text 1


AB Est_Start_Date Estimated Start Date Date 10


AC Est_Complete_Date Estimated Complete Date Date 10


AD Start_Date Actual Start Date Date 10 Text format for import MM/DD/CCYY

AE Complete_Date Actual Complete Date Date 10


AF Work_State_Tax_Code Work State Tax Code Text 10



AG Work_County_Tax_Code Work County Tax Code Text 10



AH Work_Local_Tax_Code Work Local Tax Code Text 10





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 Numeric 11 Format for import - XXX.XXXXXX.

AM Track_Davis_Bacon Davis-Bacon Job Text 1 “Y” or “N” only

AN Track_Prevailing_Wage Prevailing Wage Job Text 1 “Y” or “N” 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 then display the Phase information as set up for each field. **See Assumptions and Dependencies.

Validates to the Phase Category

AT Phase_Display_Code Phase setup mask Text 20


AU Major_Group_Start Phase Major group start position Numeric 2




AV Major_Group_End Phase Major group end position Numeric 2


AW Minor_Group_Start Phase Minor group start position Numeric 2


AX Minor_Group_End Phase Minor group end position Numeric 2


AY Status_Code Status Text 1

(A)ctive, (I)nactive or (C)omplete. Defaults to Active if blank.

AZ Owner_Name Owner name Text 50

BA Comment Comment Text 250

BB Reports_Calc_Override

Override calculation for contract status and profitability reports? Text 1 “Y” or “N” 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 then 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 then 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 Text 30


BL PO_Ship_Address2

Override job address on PO- Ship-to address 2 Text 30


BM PO_Ship_City

Override job address on PO- Ship-to city Text 25


BN PO_Ship_State

Override job address on PO- Ship-to state Text 2

2 digit postal abbreviation. **See Assumptions and Dependencies.

BO PO_Ship_Zip_Code

Override job address on PO- Ship-to zip code Text 10


BP PO_Ship_Country

Override job address on PO- Ship-to country Text 25


BQ PO_Ship_Comment

Override job address on PO- Ship-to address comment Text 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” or “N” 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 Numeric 5


BX Auto_Ot_Flag Apply Federal rules for auto-overtime? Text 1 “Y” or “N” only

BY Certified_Project_ID Certified Payroll ID Text 50

BZ Burden_Flag Post actual burden to job? Text 1 “Y” or “N” only

CA Pre_TC_Burden_Percent Payroll burden percentage Numeric 5


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 Numeric 5

Cannot be zero. Positive number only and format = xx.xx **See Assumptions and Dependencies.

CG OH_Phase Payroll overhead phase Text 20

**See Assumptions and Dependencies. Phase

CH OH_Cost_Type Payroll overhead cost type Text 3

**See Assumptions and Dependencies. Cost type


Job – User-Defined Field

Web Service name = UpdateJob_UDF – Change Job UDF

Underlying File Maintenance Prior to importing Job User-Defined Field information, the following file maintenance areas must be completed:

Job Cost Installation screen Job Cost | Jobs Job Cost | Job User-Defined Fields Maintenance

Assumptions and Dependencies If the Company_Code is blank then use the Authorization ID default value. The Job Cost module must be set up. The Job must exist in the defined Company code. The Job-UDF Web Service updates existing Job information for the defined fields only. 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. The Job user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.





C Job_Number Job Number Text 10 Valid Job

















































Job Cost Phase

Web Service name = AddPhase – Add or Change Job Phase

Underlying File Maintenance Prior to importing Phase information, the following file maintenance areas must be completed:

Job Cost Installation screen (with unit of measure per cost category) Job Cost | Jobs Job Cost | Job Phase Job Cost | Cost Type File Maintenance Payroll | Worker’s Compensation Code Maintenance (if applicable) Accounts Receivable | Unit of Measure File Maintenance Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Phase web service will either create a new Phase or update an existing Phase. If creating a new Phase then the Description and Price_Method_Code fields are required. The Phase will default with a status of (A)ctive. The Job Cost Installation defines the phase mask and fill option which are used to create the phases. The Job number must have an Active status. The values defined for field names Original_Est_Quantity, Original_Est_Cost and Original_Est_Hours will

default the same values into the Current quantity, costs, and hours in the Phase automatically based on the Job Installation settings if the Current values are left blank.

The Job Cost Installation, ‘Current Estimate display only?’ unchecked allows the Current_Est_Hours, Current_Est_Quantity, and Current_Est_Cost fields to be updated. If it is selected then it will not be updated.

The Phase description is shared between all Phase/Cost Type combinations therefore the following logic will be applied when adding a new phase or changing the data.

o If adding a new phase/cost type combination then the first record created will be maintained in Spectrum and will ignore the remaining defined description(s) as additional combinations are added.

o If the phase/cost type combination exists within Spectrum and the record contains a different description then ALL phase/cost type combinations will be updated with the defined description.

The Bid_Item_Number field will use the first two characters as the Billing Group if the Job is a unit price Job. Cost centers will validate against the Cost Center Maintenance table. 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





C Job_Number Job Number Text 10 Jobs Maintenance

D Phase_Code Phase number Text 20 No dashes Validates to the Phase mask on



the installation screen.

E Description Description Text 25

Required if adding a new phase. *See Assumptions and Dependencies for impact of updating the Phase Description.

F Cost_Type Cost type Text 3 Cost Type

G Original_Est_Quantity Original Estimate Qty Numeric 11

H Unit_of_Measure Unit of measure Text 3 Unit of Measure

I Original_Est_Cost Original Estimate Amount Numeric 12

J Original_Est_Hours Original Estimate Hours Numeric 10

K Bid_Item_Number Billing item Text 10

The billing item is broken into Group and Item for Unit Price jobs. The first 2 characters will be defined as the Group when the Job is Unit Price. *See Assumptions and Dependencies.

L Alt_Phase_Code Alternate phase Text 20 No dashes

M Work_Comp_Code Worker's compensation Text 6

Worker’s Compensation Code

N Price_Method_Code Price type Text 1

(F)ixed Price; (T)ime & Material; (C)ost Plus; (U)nit Price or (J)ob default. Required if adding new phase.

O Phase_Cost_Center Phase Code Cost Center Text 10


P Current_Est_Hours Current Estimate Hours Numeric 10

*See Assumptions and Dependencies

Q Current_Est_Quantity Current Estimate Quantity Numeric 11


R Current_Est_Cost Current Estimate Amount Numeric 12


S Status_Code Status Code Text 1

Valid Job that does not have a complete status. Master Job must have the same Phase length as Job.


Job Cost Phase – User-Defined Field

Web Service name = UpdatePhase_UDF – Change Job Phase UDF

Underlying File Maintenance Prior to importing Phase information, the following file maintenance areas must be completed:

Job Cost Installation screen Job Cost | Jobs Job Cost | Job Phase Job Cost | Cost Type File Maintenance Job Cost | Phase User Defined Field Maintenance

Assumptions and Dependencies The Job Cost module must be set up. The Job, Phase and Cost type combination must exist in the defined Company code. The Phase Master-UDF Web Service updates existing Phase information for the defined fields only. 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. The Phase user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.




C Job_Number Job Number Text 10

Job Number must exist for the defined Company Code.

D Phase_Code Phase number Text 20

Phase Number must exist for the defined Company Code.

E Cost_Type Cost type Text 3

Cost Type must exist for the defined Company Code.












































X UDF19 User Defined Alpha/Numeric/Date 19 + 20


Y UDF20 User Defined Alpha/Numeric/Date 20 + 20



Job Notes

Web Service name = JobNotes – Job Notes

Underlying File Maintenance Prior to importing Job Notes information, the following file maintenance areas must be completed:

Job Cost Installation screen Job Cost | Job Maintenance Job Cost | Job Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Job_Number and Notes_Topic must exist in order to add the notes. The Job Notes web service has an option to append to the current Note Topic.





Validation



C Job_Number Job Number Text 10 Valid Job

D Notes_Topic Notes Topic Text 20 Job Note Topics Maintenance





Phase Notes

Web Service name = PhaseNotes – Phase Notes

Underlying File Maintenance Prior to importing Phase Notes information, the following file maintenance areas must be completed:

Job Cost Installation screen Job Cost | Jobs Job Cost | Phase

Assumptions and Dependencies The Job Cost module must be set up. The Job / Phase combination must exist in the defined Company code. The Phase Notes are updated at the Phase level and are not unique per cost type. If Company_Code is blank then use the Authorization ID default value. The Phase Notes web service has an option to append to the current Note Topic.





Validation



C Job_Number Job Text 10 Job

D Phase_Code Phase number Text 20 Phase





Job Cost Transactions

Web Service name = AddJCTrans – Add Job Cost Transactions

Underlying File Maintenance Prior to importing Job Cost Transaction information, the following file maintenance areas must be completed:

Job Cost Installation screen General Ledger | G/L Master File Maintenance Job Cost | Jobs Job Cost | Job Phases Job Cost | Cost Type File Maintenance Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Transaction Type defaults to JC for Job Cost Transactions. The combination of the Tran_Date and Batch_Code will be used to define the group of transactions to be

stored together in that batch. Each group or batch can contain a maximum number of 9000 records. The user must define the

combination of the Tran_Date and Batch_Code for each record submitted and control the number of records.

If the combination already exists within Spectrum, the records will be added to the batch until the record count reaches the maximum limit.

Once the limit is reached, an error is sent and the Web Service will stop to allow the user to review the remaining records.

If ‘Post to job cost history in detail?’ check box selected in the Cost Type File Maintenance screen, then it will post transactions in detail. If it is cleared, it will summarize the transactions by the Reference number.

The Job Cost Installation defines the phase mask and fill option which are used to validate the phases. Define unique batch codes for groups of records for easy balancing to eliminate duplicate table keys in

Spectrum. Cost center companies need to supply the credit cost center for the General Ledger code. The Debit

General Ledger cost center defaults from the Job phase or Job depending on the hierarchy for cost centers.

Cost center information will only be allowed if the Company is set to a Yes status. The transaction data being submitted using this web service are stored within the Job Cost Transaction

Entry screen; the data must manually be updated within Spectrum.



C Tran_Date Transaction Date Date 10


Within Fiscal Year Calendar and Job Cost Processing Date Range


D Batch_Code Batch Code Text 10

Recommend using a unique batch code to keep them separate while validating and updating Job Cost Transactions.

Limit the 'Batch Code/Tran Date' quantity of Record to 9000.

E Reference_1 Reference Number Text 15

Needs to be unique if detail transactions are needed. If not it will summarize the same Reference numbers into one record as defined on the Cost Type File Maintenance.


G Job_Number Job Number Text 10 Jobs

H Phase_Code Phase Code Text 20 No dashes. Job Phases

I Cost_Type Cost Type Text 3

Cost Type File Maintenance defines how transactions are posted—Detail or Summary based on the Reference Number

Cost Type File Maintenance and Job Phases

J Total_Hours Hours Numeric 10

Negative numbers are allowed. Enter (-) at the beginning of the number

K Tran_Amount Amount Numeric 12

Negative numbers are allowed. Enter (-) at the beginning of the number.

L GL_Debit_Account Debit G/L Code Text 12

G/L Account code must be a direct job cost account. No dashes.


M GL_Credit_Account Credit G/L Code Text 12

G/L Account code must be a non-direct cost account. No dashes.


N Cost_Center_Credit Credit Cost Center Text 10 Credit Cost Center only.

Cost Center Maintenance; Phase Cost Center, Job Cost Center and G/L Account Cost Center


Job Cost Projections

Web Service name = JobCostProjections – Job Cost Projections

Underlying File Maintenance Prior to importing Job Cost Projections information, the following file maintenance areas must be completed:

Job Cost Installation screen Job Cost | Jobs Job Cost | Job Phases Job Cost | Cost Type File Maintenance

Assumptions and Dependencies The Job Cost Projection Web Service will use the ‘At Completion’ logic. The standard projected cost entry

screen logic will not be created and no reporting will be created. The ‘At completion’ logic will be used for the Web Service for Dollars, Hours and Quantity values therefore the

final numbers will be defined in the service. The web service doesn’t ‘update’ existing projection entries. One of the following fields is required in order to modify the projected values. The blank fields will not be

updated and to clear a value a zero must be defined. o Amount o Projected_Hours o Projected_Quantity

The Job Cost Installation options for Projections will be used when posting the new projections. Projections that have already been posted for a subsequent date will be treated as a ‘correction’ to the

previous projection but will not affect the current projections. If the Projection value already exists in the system for the given Job/Phase/Cost type then it will be ignored. Any active Projected Cost Transaction File (i.e., Build) created will be ignored. The Phase in the record must match the current phase mask defined on the Job. The Operator code will be used to define who updated the Projections. The Web Service will ignore any projections that are in process (i.e., are built in standard Spectrum). Any field that is left blank will not be updated in Spectrum. The service does not delete values that exist in





C Job_Number Job Text 10 *See Assumptions and Dependencies. Job

D Phase_Code Phase Text 20

No dashes. *See Assumptions and Dependencies. Phase

E Cost_Type Cost type Text 3 *See Assumptions and Dependencies. Cost Type



F Transaction_Date Transaction Date Date 10

Back dated projections will be made as corrections and won't change the current projections. Enter as: MM/DD/CCYY (e.g., 01/05/2010).


G Amount Projected Dollars At Completion Numeric 14

Must be defined if Projected_Hours and Projected_Quantity are blank. Allows Negative number. Format = -10.2


H Projected_Hours Projected Hours At Completion Numeric 14

Must be defined if Amount and Projected_Quantity are blank. Allows Negative number. Format = -10.2


I Projected_Quantity Projected Quantity At Completion Numeric 14

Must be defined if Amount and Projected_Hours are blank. Allows Negative number. Format = -10.2


J Note Memo Text 80

K Operator Operator code Text 3

Define the Spectrum Operator code. If blank default Web Service code. Valid Operator Code


Get Job

Web Service name = GetJob – Get Jobs

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank. All parameter fields have SuperSelect logic except the following-

o pStatus_Code o pCost_Center o pSort_By

Parameter Fields




pDivision Division Text 5

pStatus_Code Status Text 1


pProject_Manager Project Manager Text 15

pSuperintendent Superintendent Text 15

pEstimator Estimator Text 15

pCustomer_Code Customer Code Text 10 Customer File Maintenance

pCost_Center Job Cost Center Text 10



Blank = Job number, D=Division, P=Project Manager, S=Superintendent, E=Estimator, or C=Customer Code

Return Fields



Job_Number Job Number Text 10 Job File Maintenance

Job_Description Job Description Text 25

Division Division Text 5



Address_1 Address Line 1 Text 30


City City Text 25

State State Text 2

Zip_Code Zip Code Text 10

Project_Manager Project Manager Text 15

Superintendent Superintendent Text 15

Estimator Estimator Text 15

Certified_Flag Certified Flag Text 1

Customer_Code Customer Code Text 10

Status_Code Status Text 1 (A)ctive, (I)nactive or (C )omplete

Work_State_Tax_Code Work State Tax Code Text 10

Contract_Number Contract Number Text 15

Cost_Center Job Cost Center Text 10





Get Job Main

Web Service name = GetJobMain – Get Jobs-Main



Parameter Fields















Return Fields





Division Division Text 5





City City Text 25

State State Text 2

Zip_Code Zip Code Text 10

Phone Telephone Text 14

Fax_Phone Fax Text 14

Job_Site_Phone Site phone Text 14

Customer_Code Customer Code Text 10

Customer_Name Customer Name Text 30

Original_Contract Original Contract Numeric 14

Contract_Number Contract Number Text 30

Owner_Name Owner name Text 50

WO_Site Site Text 10

Comment Comment Text 250

Price_Method_Code Price Type Code Text 1


Total_Units Job units Numeric 9

Unit_of_Measure Unit of Measure Text 5


Latitude Latitude Numeric 11

Longitude Longitude Numeric 11

Legal_Desc Legal Description Text 350


Field_1 Field 1 Text 30 Place holder for future fields











Get Job Dates

Web Service name = GetJobDates – Get Jobs Dates



Parameter Fields















Return Fields





Est_Start_Date Estimated Start Date Date 10



Est_Complete_Date Estimated Complete Date Date 10

Projected_Complete_Date Projected Complete Date Date 10

Create_Date Job Created Date Date 10

Start_Date Actual Start Date Date 10

Complete_Date Actual Complete Date Date 10










Get Job Contacts

Web Service name = GetJobContact – Get Job Contact



Parameter Fields




pJob_Number Job Number Text 10



pProject_Manager Project Manager Text 15 Defined on the Job Master


Defined on the Job Master


Defined on the Job Master

pFirst_Name Contact First Name Text 20 Contact master

pLast_Name Contact Last Name Text 30 Contact master

pPhone_Number Contact Primary Phone

Text 14 Contact master

pTitle Contact Title Text 50

Contact master




Blank = Company code, C=Contact ID, P=Project Manager, S=Superintendent, E=Estimator, or L=Last name


Return Fields


Company_Code Company Code Text 3

Job_Number Job Number Text 10 Defined on the Job Master

Job_Description Job Name Text 25 Defined on the Job Master

Status_Code Job status Text 1 Defined on the Job Master

Project_Manager Project Manager Text 15 Defined on the Job Master

Superintendent Superintendent Text 15 Defined on the Job Master

Estimator Estimator Text 15 Defined on the Job Master

Cost_Center Job Cost Center Text 10 Defined on the Job Master

Contact_ID Contact Id Number 10 Contact Master

First_Name Contact First Name Text 20 Contact Master

Last_Name Contact Last Name Text 30 Contact Master

Title Contact Title Text 50 Contact Master

Addr_1 Contact Primary Address 1 Text 30 Primary Address on Contact Master.

Addr_2 Contact Primary Address 2 Text 30

Primary Address on Contact Master.

Addr_City Contact Primary Address City Text 25 Primary Address on Contact Master.

Addr_State Contact Primary Address State Text 2 Primary Address on Contact Master.

Addr_Zip Contact Primary Address Zip Text 10 Primary Address on Contact Master.

Addr_Country Contact Primary Address Country Text 25 Primary Address on Contact Master.

Phone_Number Contact Primary Phone Text 14 Primary phone number on Contact Master.

Email1 Contact Email 1 Text 80 Contact Master



Remarks Contact Remarks Text 250 Contact Master

Status Contact Status Text 1 Contact Master

OType Organization Type Text 1

Contact Organization - V(endor), C(ustomer), E(mployee) or O(ther)

OName Organization Name Text 40 Contact Organization

OCity Organization City Text 25 Contact Organization



OState Organization State Text 2 Contact Organization

OStatus Organization Status Text 1 Contact Organization





Get Job UDF

Web Service name = GetJobUDF – Get Jobs-Main


o pStatus_Code o pCost_Center

Parameter Fields













Return Fields




UDF1 User Defined Alpha/Numeric/Date 1 + 20

























NOTES: + = the UDF (1-20) elements can be Numeric, Date or Text depending on how they are created within Spectrum. The UDF’s need to be mapped based on the Authorization ID being used.


Get Phase

Web Service name = GetPhase – Get Phases

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank. The JTD, Projected and Estimated return fields do not include contract labor hours, Pre-time card

information, committed costs or unapproved invoices. All parameter fields have SuperSelect logic except the following-


Parameter Fields




pCost_Type Cost Type Text 3 Cost Type File Maintenance

pJob_Number Job Number Text 10 Job File Maintenance



pCost_Center Phase Cost Center Text 10



Blank = Job number, Phase and Cost type or C= Cost Type, Job number and Phase

Return Fields



Job_Number Job Number Text 10

Phase_Code Phase Number Text 20

Cost_Type Cost Type Text 3

Description Description Text 25

Status_Code Status Code Text 1 (A)ctive, (I)nactive or (C )omplete




JTD_Quantity JTD Quantity Numeric 11 See Assumptions and Dependencies

JTD_Hours JTD Hours Numeric 10 See Assumptions and Dependencies

JTD_Actual_Dollars JTD Cost Numeric 12 See Assumptions and Dependencies

Projected_Quantity Projected Quantity Numeric 11 See Assumptions and Dependencies

Projected_Hours Projected Hours Numeric 10 See Assumptions and Dependencies

Projected_Dollars Projected Cost Numeric 12 See Assumptions and Dependencies

Estimated_Quantity Estimated Quantity Numeric 11 See Assumptions and Dependencies

Estimated_Hours Estimated Hours Numeric 10 See Assumptions and Dependencies

Current_Estimated_Dollars Estimated Cost Numeric 12 See Assumptions and Dependencies

Cost_Center Phase Cost Center Text 10





Get Phase - Enhanced

Web Service name = GetPhaseEnhanced – Get Phase-Enhanced

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank. The JTD, Projected and Estimated return fields do not include contract labor hours, Pre-time card

information, committed costs or unapproved invoices. All parameter fields have SuperSelect logic except the following-


Parameter Fields








pCost_Center Phase Cost Center Text 10



Blank = Job number, Phase and Cost type or C= Cost Type, Job number and Phase

Return Fields




Phase_Code Phase Number Text 20

Cost_Type Cost Type Text 3

Description Description Text 25

Status_Code Status Code Text 1 (A)ctive, (I)nactive or (C )omplete




JTD_Quantity JTD Quantity Numeric 11 See Assumptions and Dependencies

JTD_Hours JTD Hours Numeric 10 See Assumptions and Dependencies

JTD_Actual_Dollars JTD Cost Numeric 12 See Assumptions and Dependencies

Projected_Quantity Projected Quantity Numeric 11 See Assumptions and Dependencies

Projected_Hours Projected Hours Numeric 10 See Assumptions and Dependencies

Projected_Dollars Projected Cost Numeric 12 See Assumptions and Dependencies

Estimated_Quantity Estimated Quantity Numeric 11 See Assumptions and Dependencies

Estimated_Hours Estimated Hours Numeric 10 See Assumptions and Dependencies

Current_Estimated_Dollars Estimated Cost Numeric 12 See Assumptions and Dependencies

Cost_Center Phase Cost Center Text 10

Price_Method_Code Price Type Code Text 1

(F)ixed Price; (T)ime & Material; (C)ost Plus; (U)nit Price OR (J)ob default.

Complete_Date Complete Date Date 8

Start _Date Estimated Start Date Date 8

End_Date Estimated End Date Date 8

Comment Comment Text 250





PAYROLL

Employee – Required

Web Service name = AddEmp_Req – Add Employee (Required Fields)

Underlying File Maintenance Prior to importing Employee information, the following file maintenance areas must be completed:

Payroll Installation screen General Ledger | G/L Master File Maintenance Payroll | Tax Table Maintenance Payroll | Department Expense Maintenance Payroll | Employee Status Code Maintenance Payroll | Supervisor Code Maintenance (if applicable) Payroll | Worker’s Compensation Code Maintenance Payroll | Hours Bank Code Maintenance (if applicable) Payroll | Union File Maintenance (if applicable) Payroll | Wage Code File Maintenance (if applicable) Payroll | EEO Classification Maintenance (if applicable) Payroll | Employee User-Defined Fields Maintenance (if applicable) Time + Material | Labor Billing Rates Maintenance (if applicable) Human Resources | Locations Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Payroll module must be set up. The combination of the First_Name, Middle_Name and Last_Name is used to create the displayed name

within Spectrum which cannot exceed 30 characters including spaces. An error will occur if the combined value of these three individual fields exceeds the 30 character limit.

Non-US Payroll Processing o Payroll Installation option on the Default Tab.

If selected then the Federal Tax code on the Employee master can be defined as any Tax code.

The option allows for a Federal tax code can be defined on the Payroll Installation and used as a default when adding new Employees.

o Field can be defined in the service and must be unique for each tax code on the Employee master.

Cost center information will only be allowed if the Company is set to a Pending or Yes status. The Employee-required Web Service creates new records only. The Employee contact is created.







C Employee_Code Employee Code Text 11 Unique Identifier / No commas or symbols No duplicates

D Alpha_Sort Alpha Reference Text 8 Recommend unique identifier.

E First_Name Employee First Name Text 20 No commas

The combination of the First_Name, Middle_Name and Last_Name is used to create the displayed name within Spectrum which cannot exceed 30 characters including spaces.

F Middle_Name Employee Middle Name Text 20 No commas


G Last_Name Employee Last Name Text 30 No commas


H Employee_Suffix Employee name Suffix Text 3 No commas

I Worker_Comp_Code Worker’s Comp Code Text 6

Worker's Compensation Code Maintenance

J Department_Code Department Code Text 6 Department Expense Maintenance

K Employment_Status Employee Status Text 1 Employee Status Code Maintenance

L Termination_Date_List3 Latest Termination Date Date 10


Required if Employee Status = “T” or “D”

M Pay_Type Pay Type Text 1

(C)ommission; (H)ourly; (O)vertime or (S)alary only

If (H)ourly selected then Salary_Amount is ignored and Hourly_Rate is required. If (S)alary is selected then Salary_Amount is




required and Hourly_ Rate is ignored.

N Pay_Frequency_Flag Frequency Text 1

(D)aily; (W)eekly; (B)I-weekly; (M)onthly; (S)emi-monthly; (Q)uarterly or (A)nnual only

O Hourly_Rate Hourly Rate Numeric 8 Positive number only. Format = 3.4

Required if Pay_Type = H

P Salary_Amount

Salary Amount for ONE PAY PERIOD ONLY Numeric 13

Enter Amount for ONE PAY PERIOD ONLY! Required if Pay_Type = S , O or C

Q Standard_Work_Hours Standard Hours per Pay Period Numeric 8

Positive number only. Format = 4.2

Required if Pay_Frequency_Flag = D, otherwise calculated by Spectrum if blank.

R Emp_Foreign Foreign Employee? Text 1 (Y)es or (N)o only

If Payroll Installation option is selected to allow non-US payroll processing then ignore this field which is hidden.

S Fed_Tax_Code Federal Tax Table Code Text 10

Default to US if Payroll Installation option is not selected. Use default if defined and valid. Can be overriden. If Emp_Foriegn = N then Spectrum defaults this field to US.

Payroll Tax Table Maintenance

T Subject_to_Fed_Tax Subject to Federal Income Tax Text 1

(E)xempt or (T)axable only. If Emp_Foriegn = N then Spectrum default this field to T(axable).

U Subject_to_FICA_Fed Subject to FICA Text 1


V Subject_to_FUTA_Fed Subject to Federal Unemployment Text 1

(E)xempt or (T)axable only. If Emp_Foriegn




= N then Spectrum default this field to T(axable).

W Fed_Filing_Status Federal Filing Status Text 20

If Subject_to_Fed_Tax = T then this field is required.


X Fed_Exemptions # Exemptions for Federal Income Tax Numeric 5

Y Fed_Tax_Override Amount of Federal Income Tax Override Numeric 7 Positive number only.

Z Fed_Tax_Override_Cont

Federal Income Tax Override Control Text 1

(F)ixed; (P)ercent; (A)dd-on only

AA State_Tax_Code Resident State Tax Table Code Text 10

The Tax code must be unique between the Federal, Resident State, Perm Work State, Resident County and Resident Local.


AB Subject_to_State_Tax Subject to State Income Tax Text 1

(E)xempt or (T)axable only. Required if field name State_Tax_Code is not blank.

AC Subject_to_SDI_State Subject to State SDI Text 1


AD Subject_to_SUTA_State

Subject to State Unemployment Text 1


AE State_Filing_Status State Filing Status Text 20

If Subject_to_State_Tax = T then this field is required.


AF State_Exemptions # Exemptions for State Income Tax Numeric 5

AG State_Tax_Override Amount of State Income Tax Override Numeric 7 Positive number only.

AH State_Tax_Override_Cont

State Income Tax Override Text 1


AI Cost_Center Employee Cost Center Text 10


AJ Employee_Termination_Reason Termination Reason Text 30

AK Employee_Rehire_Rating Rehire rating (0-10) Numeric 2

0-10 only. Required if Employee has an




Employment status of Terminated.


Employee – Required Update

Web Service name = UpdateEmp_Req – Update Employee (Required Fields)

Underlying File Maintenance Prior to importing Employee-Required Update information, the following file maintenance areas must be completed:

Payroll Installation screen General Ledger | G/L Master File Maintenance Payroll | Employee Maintenance Payroll | Tax Table Maintenance Payroll | Department Expense Maintenance Payroll | Employee Status Code Maintenance Payroll | Supervisor Code Maintenance (if applicable) Payroll | Worker’s Compensation Code Maintenance Payroll | Hours Bank Code Maintenance (if applicable) Payroll | Union File Maintenance (if applicable) Payroll | Wage Code File Maintenance (if applicable) Payroll | EEO Classification Maintenance (if applicable) Payroll | Occupation Maintenance (if applicable) Payroll | Trade Maintenance (if applicable) Payroll | Employee User-Defined Fields Maintenance (if applicable) Time + Material | Labor Billing Rates Maintenance (if applicable) Human Resources | Locations Maintenance (if applicable) Human Resources | License Class Maintenance (if applicable) Job Cost | Job Maintenance (if applicable) Equipment Control | Equipment Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Payroll module must be set up. The Employee code must exist in the defined Company code. To change an Employee’s pay rate the following fields are dependent on each other.

o The following fields are required to update the Employee’s pay rate information- Pay_Type Pay_Frequency_Flag Standard_Work_Hours Effective_Date

o The following two fields are necessary as well to change the pay rate information but are subject to the defined Pay_Type. Therefore based on the defined Pay_Type, it will then make one of these fields required-

Hourly_Rate Salary_Amount

If the Fed_Tax_Code field is defined then the following fields are required. o Subject_to_Fed_Tax o Subject_to_FICA_Fed o Subject_to_FUTA_Fed o Fed_Filling_Status

If the State_Tax_Code field is defined then the following fields are required. o Subject_to_State_Tax o Subject_to_SID_State


o Subject_to_SUTA_State o State _Filling_Status

The Employee status can be modified using this web service therefore we recommend the user defines the appropriate hire, rehire and termination dates.

The Employee-Required Update Web Service updates an existing employee’s information for the defined fields only.


The Employee contact is updated based on the fields associated with the Employee Contact record.

Cost center information will only be allowed if the Company is set to a Pending or Yes status.




C Employee_Code Employee Code Text 11 Unique Identifier / No commas


D Alpha_Sort Alpha Reference Text 8 Recommend unique identifier.

E First_Name Employee First Name Text 20 No commas


F Middle_Name Employee Middle Name Text 20 No commas


G Last_Name Employee Last Name Text 30 No commas

The combination of the First_Name, Middle_Name and Last_Name is used to create the displayed name within Spectrum


Excel Field Name Description Type Max Field Information Validation which cannot exceed 30 characters including spaces.

H Employee_Suffix Employee name Suffix Text 3 No commas

I Worker_Comp_Code Worker’s Comp Code Text 6

Worker's Compensation Code Maintenance

J Department_Code Department Code Text 6

Department Expense Maintenance

K Employment_Status Employee Status Text 1 Employee Status Code Maintenance

L Termination_Date_List3 Latest Termination Date Date 10



M Pay_Type Pay Type Text 1

(C)ommission; (H)ourly; (O)vertime or (S)alary only

If (H)ourly selected then Salary_Amount is ignored and Hourly_Rate is required. If (S)alary is selected then Salary_Amount is required and Hourly_ Rate is ignored.

N Pay_Frequency_Flag Frequency Text 1

(D)aily; (W)eekly; (B)I-weekly; (M)onthly; (S)emi-monthly; (Q)uarterly or (A)nnual only

O Hourly_Rate Hourly Rate Numeric 6 Positive number only. Format = 3.4

Required if Pay_Type = H

P Salary_Amount

Salary Amount for ONE PAY PERIOD ONLY Numeric 13

Enter Amount for ONE PAY PERIOD ONLY! Required if Pay_Type = S , O or C

Q Standard_Work_Hours Standard Hours per Pay Period Numeric 8

Positive number only. Format = 4.2

Required if Pay_Frequency_Flag = D, otherwise calculated by Spectrum if blank.

R Emp_Foreign Foreign Employee? Text 1 (Y)es or (N)o only

If Payroll Installation option is selected to allow non-US payroll processing then


Excel Field Name Description Type Max Field Information Validation ignore this field which is hidden.

S Fed_Tax_Code Federal Tax Table Code Text 10

Default to US if Payroll Installation option is not selected. Use default if defined and valid. Can be overriden. If Emp_Foriegn = N then Spectrum defaults this field to US.


T Subject_to_Fed_Tax

Subject to Federal Income Tax Text 1


U Subject_to_FICA_Fed Subject to FICA Text 1


V Subject_to_FUTA_Fed

Subject to Federal Unemployment Text 1


W Fed_Filing_Status Federal Filing Status Text 20

If Subject_to_Fed_Tax = T then this field is required.


X Fed_Exemptions

# Exemptions for Federal Income Tax Numeric 5

Y Fed_Tax_Override

Amount of Federal Income Tax Override Numeric 7 Positive number only.

Z Fed_Tax_Override_Cont

Federal Income Tax Override Control Text 1


AA State_Tax_Code Resident State Tax Table Code Text 10

The Tax code must be unique between the Federal, Resident State, Perm Work State, Resident County and Resident Local.


AB Subject_to_State_Tax Subject to State Income Tax Text 1


AC Subject_to_SDI_State Subject to State SDI Text 1


AD Subject_to_SUTA_State

Subject to State Unemployment Text 1




AE State_Filing_Status State Filing Status Text 20

If Subject_to_State_Tax = T then this field is required.


AF State_Exemptions # Exemptions for State Income Tax Numeric 5

AG State_Tax_Override

Amount of State Income Tax Override Numeric 7 Positive number only.

AH State_Tax_Override_Cont

State Income Tax Override Text 1


AI Cost_Center Employee Cost Center Text 10


AJ Employee_Termination_Reason

Termination Reason Text 30

AK Employee_Rehire_Rating

Rehire rating (0-10) Numeric 2

0-10 only. Required if Employee has an Employment status of Terminated.

AL Occupation Occupation Text 50 Occupation File Maintenance

AM Trade Trade Text 50 Trade File Maintenance

AN Perm_Work_Comp

Always use this worker's compensation code on time card? Text 1 (Y)es or (N)o only

AO Pref_Status Health Coverage status Text 3

(HCF)=Full Time, (HCP)=Part time or (VAR)=Variable Hours. Defaults to Unassigned if left blank.

AP Employee_Telephone_Memo Telephone Memo Text 30

AQ Employee_Driver_License_State

Driver's License State Text 2


AR Employee_Driver_License_Class

Driver's License Class Text 9

Data entry field if HR module not installed.

Human Resources License Class if HR Module installed.

AS Employee_Citizenship Citizenship Text 30

AT Employee_Security_Stat Security Status Text 30

AU Employee_Veteran_Stat Veteran Status Text 1

(S)=Disabled Veteran, (V)=Armed Forces Service Medal Veteran, (D)= Disabled Armed Forces, (O)=Other Protected Veteran and (N)=Non-Veteran.

AV Employee_New_Vet

Recently Separated Veteran? Text 1 (Y)es or (N)o only


Excel Field Name Description Type Max Field Information Validation AW Employee_Disabled Disabled? Text 1 (Y)es or (N)o only

AX Employee_Disabled_Note

Disabled Description Text 30

Available when Disabled? Is yes. Otherwise ignore.

AY Employee_Place_Birth Place of Birth Text 30

AZ Effective_Date Pay Effective Date Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). No duplicate dates may exist. Required if Hourly_Rate or Salary_Amount is defined.

Used to define the effective date for a Pay Rate change on the Employee Master. **See Assumption and Dependency's for Rules.

BA Comments

Pay Rate Revision Comment Text 40

For Pay Rate Changes only. Ignore date if Effective_Date is not defined.

BB Last_Job_Company

Company code for Last Job worked on Text 3

If left blank and Last_Job_Number is defined then use Company_Code.


BC Last_Job_Number Last Job worked on Text 10

Valid Job in Company defined

BD Last_Equipment_Company

Company code for Last Equipment worked on Text 3

If left blank and Last_Equipment_Code is defined then use Company_Code.


BE Last_Equipment_Code Last Equipment worked on Text 10

Valid Equipment code in Company defined

BF Hire_Date_List1 Original hire date Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2010)

BG Rehire_Date_List2 Latest rehire date Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2010)


Employee – Personal

Web Service name = UpdateEmp_Personal – Change Employee – Personal Info

Assumptions and Dependencies The Payroll module must be set up. The Employee code must exist in the defined Company code. The Employee-Personal Information Web Service updates an existing employee’s information for

the defined fields only. 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. Any changes made to the Employee for the following fields will update the Employee Contact

record. o Title o Email o Mobile Phone o Work Extension o Status

Exce

l Field Name Description Type Max

Field Information

Validation



Employee Code must exist in the defined Company Code

D Employment_Status Employee Status Text 1

Employee Status Code Maintenance

E Termination_Date_List3 Latest Termination Date Date 10



F Street_Address Mailing Address Text 25

G Street_Address2 Mailing Address Line 2 Text 25

H City_Address Mailing City Text 25

I State Mailing State Text 2 2 character postal abbreviation

J Zip_Code Mailing Zip Code Text 10

K Domicile_Address Domicile Street Address Text 25

L Domicile_Address2 Domicile Street Address Line 2 Text 25

M Domicile_City Domicile City Text 25

N Domicile_State Domicile State Text 2 2 character postal abbreviation


Excel

Field Name Description Type MaxField


O Domicile_Zip_Code Domicile Zip Code Text 10

P Phone Personal telephone Text 14


Q Employee_Fax Employee Fax Text 14

Formatted e.g., (206) 555-1212 or 123-123-1224 or 123-12324

R Employee_Email Work E-mail Address Text 80

Structure = [email protected]. Use a semi-colon between multiple addresses

S Emergency_Contact Emergency Contact Text 25

T Emergency_Phone Emergency Phone Text 14


U Emergency_Relationship

Relationship of Emergency Contact Text 15

V Supervisor_Code Supervisor Code Text 2

Supervisor Code Maintenance

W Employee_Location Employee Location Code Text 10

Text field if HR module is not installed.

Human Resources Location Codes if installed

X Union_Code Union Code Text 10 Union File Maintenance

Y Wage_Class Wage Code Text 10

Validated in combination with union code

Union & Wage Code combination in Wage Code File Maintenance

Z Employee_Work_Class Work Class Text 1

(J)ourneyman; (A)pprentice or (T)rainee only

AA Pay_Rate_Code Pay Level Text 1 1 - 9 only

AB EEO_Class_Code EEO Class Code Text 3

EEO Classification Maintenance


Excel



AC Social_Security Social Security # Text 9 Format = 123456789

No duplicates allowed

AD Title Employee Title Text 50

Text field if HR module is not installed.

Human Resources Job Title if installed and selected.

AE Sex Employee Sex Text 1 (M)ale or (F)emale only

AF Race Employee Race Text 1

(A)- Asian; (B) - Black; (C)- White; (H) -Hispanic; (N)- American Indian; (O) -Other only;(P)- Pacific Islander

AG Number_Of_Dependents Dependents Numeric 3 AH Certified_Flag Certified Report Text 1 (Y)es or (N)o only

AI Marital_Status Marital Status Text 1

(D)ivorced; (M)arried; (S)ingle; (W)idowed or (U)nknown only

AJ Delete Flag Purge at Year End? Text 1 (Y)es or (N)o only

Only allowed with a status type of T(erminated) or D(ecreased)

AK Months_To_Next_Review

Months To Next Review Numeric 3

AL Hire_Date_List1 Original Hire Date Date 10


AM Birth_Date_List4 Date of Birth Date 10


AN Rehire_Date_List2 Latest Rehire Date Date 10


AO Last_Review_Date_List7 Date of Last Review Date 10


AP Spouse_Birth_Date_List6 Spouse Birth Date Date 10


AQ Spouse_Name Spouse Name Text 15

AR Driver_License Driver’s License # Text 25

AS Employee_Driver_License_Expire

Driver’s License Expiration Date Date 10



Excel



AT Vacation_Hours_Balance Vacation Hours Balance Numeric 7

Format = -3.2. Allows negatives.

AU Vacation_Hours_YTD Vacation Hours YTD Numeric 7


AV Vacation_Control_Code Vacation Control Code Text 2

Hours Bank Code Maintenance with a Type of Vacation.

AW Holiday_Hours_Balance Holiday Hours Balance Numeric 7


AX Holiday_Hours_YTD Holiday Hours YTD Numeric 7


AY Holiday_Control_Code Holiday Control Code Text 2

Hours Bank Code Maintenance with a Type of Holiday.

AZ Sick_Hours_Balance Sick Hours Balance Numeric 7


BA Sick_Hours_YTD Sick Hours YTD Numeric 7 Format = -3.2. Allows negatives.

BB Sick_Control_Code Sick Control Code Text 2

Hours Bank Code Maintenance with a Type of Sick.

BC I9_Flag I9 Status Text 1 (A)lien or (P)ermanent only

BD I9_Expire_Date I9 Expiration Date Date 10


BE Employee_Mobile_Phone Work mobile Phone Text 14


BF Employee_Extension Work extension Text 15

BG Employee_Termination_Reason

Termination Reason Text 30

BH Employee_Rehire_Rating Rehire rating (0-10) Numeric 2

0-10 only. Required if Employee has an Employment status of Terminated.


Employee – Payroll Tax

Web Service name = UpdateEmp_PR_Tax – Change Employee – Payroll/Tax

Assumptions and Dependencies The Payroll module must be set up. The Employee code must exist in the defined Company code. The Employee–Payroll Tax Information Web Service updates an existing employee’s information

for the defined fields only. 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. The Auto deposit rates must equal 100% if the Auto Deposit Allocation Method is defined as

Percent. Therefore if any changes are made, all accounts must be defined in the Employee-Payroll Tax Information Web Service.

The Primary Account must be active (Y) if any other accounts have an active status. Therefore the Auto_Deposit_Flag field must be defined as Y in order for the other accounts to be updated.

The Tax code must be unique between the Resident state, Perm work state, Resident county, and Resident local.

The Permanant_Unemployment_State defined tax code is the permanent override for the Resident and Work State unemployment calculation.

o The defined tax code can be the same as the Resident state, Perm work state, Resident county, or Resident local.

o If it is defined then the “Permanently override resident and work state unemployment?” check box will be selected.

Excel Field Name Descripti

on Type Max

Field Information

Validation



C Employee_Code Employee Code Text 11

Unique Identifier / No commas.

Employee Code must exist in the defined Company Code

D Auto_Deposit_Allocation

Auto-Deposit Allocation Method Text 1

(P)ercent or (F)ixed amount only

If Percent is defined then all Account Rates must total 100%.

E Bank_Account_Number

Primary Auto-Deposit Acct # Text 17

F Bank_Account_Type

Primary Auto-Deposit Acct Type Text 1

(C)hecking or (S)avings only

G ABA_Number

Primary Auto-Deposit Acct ABA # Text 9



on Type Max

Field Information

Validation

H Auto_Deposit_Flag

Primary Auto-Deposit Acct Status Text 1

(Y)es; (N)o or (P)re-notification only

The Primary Account must be active if any other accounts have an active status.

I Auto_Deposit_Rate1

Primary Auto-Deposit Acct Rate Numeric 8

If multiple Accounts exist then all Accounts must be defined to make changes.

If Percent is defined in field name Auto_Deposit_Allocation then all Account Rates must total 100%.

J Bank_Account_Number_2

Second Auto-Deposit Acct Text 17

K Bank_Account_Type_2

Second Auto-Deposit Acct Type Text 1


L ABA_Number_2

Second Auto-Deposit Acct ABA # Text 9

M Auto_Deposit_Flag_2

Second Auto-Deposit Acct Status Text 1



N Auto_Deposit_Rate2

Second Auto-Deposit Acct Rate Numeric 8



O Bank_Account_Number_3

Third Auto-Deposit Acct Text 17

P Bank_Account_Type_3

Third Auto-Deposit Acct Type Text 1


Q ABA_Number_3

Third Auto-Deposit Acct ABA # Text 9

R Auto_Deposit_Flag_3

Third Auto-Deposit Acct Status Text 1





on Type Max

Field Information

Validation

S Auto_Deposit_Rate3

Third Auto-Deposit Acct Rate Numeric 8



T Bank_Account_Number_4

Fourth Auto-Deposit Acct Text 17

U Bank_Account_Type_4

Fourth Auto-Deposit Acct Type Text 1


V ABA_Number_4

Fourth Auto-Deposit Acct ABA # Text 9

W Auto_Deposit_Flag_4

Fourth Auto-Deposit Acct Status Text 1



X Auto_Deposit_Rate4

Fourth Auto-Deposit Acct Rate Numeric 8



Y Bank_Account_Number_5

Fifth Auto-Deposit Acct Text 17

Z Bank_Account_Type_5

Fifth Auto-Deposit Acct Type Text 1


AA ABA_Number_5

Fifth Auto-Deposit Acct ABA # Text 9

AB Auto_Deposit_Flag_5

Fifth Auto-Deposit Acct Status Text 1



AC Auto_Deposit_Rate5

Fifth Auto-Deposit Acct Rate Numeric 8





on Type Max

Field Information

Validation

AD Part_time_Casual_Flag Part-Time? Text 1

(Y)es or (N)o only (if left blank; this flag will default to “no” in Spectrum). This is an option to exclude the Employee from Automatic Pay Cycle.

AE Billing_Code T&M Billing Code Text 10

T&M Billing Code Maintenance

AF Special_Pay_Rate Special Pay Rate Numeric 7


AG Special_Pay_Amount Special Pay Amount Numeric 7


AH Misc_Allowance_Rate Misc Allow Amount Numeric 7


AI Prevail_Wage_Fringe_Rate

Prevailing Wage Fringe Employer Benefit Numeric 7


AJ Perm_wk_State_Tax_Code

Perm Work State Tax Table Code Text 10

The Tax code must be unique between the Resident State, Perm Work State, Resident County and Resident Local.


AK Subject_to_Perm_wk_State_Tax

Subject to Perm Work State Income Tax Text 1

(E)xempt or (T)axable only. Required if field name Perm_wk_State_Tax_Code is not blank.

AL Subject_to_SDI_Perm_wk

Subject to Perm Work State SDI Text 1

(E)xempt or (T)axable only. Required if field name Perm_wk_State_Tax_Code is not blank.

AM Subject_to_SUTA_Perm_wk

Subject to Perm Work State Unemployment Text 1

(E)xempt or (T)axable only. Required if field name Perm_wk_State_



on Type Max

Field Information

Validation

Tax_Code is not blank.

AN Perm_wk_State_Filing_Status

Perm Work State Filing Status Text 20

If Subject_to_Perm_wk_State_Tax = T then this field is required.


AO Perm_wk_State_Exemptions

# Exemptions for Perm Work State Income Tax Numeric 5

AP Perm_wk_State_Tax_Override

Amount of Perm Work State Income Tax Override Numeric 7

AQ Perm_wk_State_Tax_Override_Cont

Perm Work State Income Tax Override Text 1


AR Res_County_Tax_Code

Resident County Tax Table Code Text 10



AS Subject_to_Res_County_Tax

Subject to Resident County Income Tax Text 1

(E)xempt or (T)axable only. Required if field name Res_County_Tax_Code is not blank.

AT Subject_to_FICA_Res_County

Subject to Resident County FICA Text 1


AU Subject_to_FUTA_Res_County

Subject to Resident County Unemployment Text 1




on Type Max

Field Information

Validation

AV Res_County_Filing_Status

Resident County Filing Status Text 20

If Subject_to_Res_County_Tax = T then this field is required.


AW Res_County_Exemptions

# Exemptions for Resident County Income Tax Numeric 5

AX Res_County_Tax_Override

Amount of Resident County Income Tax Override Numeric 7

AY Res_County_Tax_Override_Cont

Resident County Income Tax Override Control Text 1


AZ Res_Local_Tax_Code

Resident Local Tax Table Code Text 10



BA Subject_to_Res_Local_Tax

Subject to Resident Local Income Tax Text 1

(E)xempt or (T)axable only. Required if field name Res_Local_Tax_Code is not blank.

BB Subject_to_FICA_Res_Local

Subject to Resident Local FICA Text 1


BC Subject_to_FUTA_Res_Local

Subject to Resident Local Unemployment Text 1




on Type Max

Field Information

Validation

BD Res_Local_Filing_Status

Resident Local Filing Status Text 20

If Subject_to_Res_Local_Tax = T then this field is required.


BE Res_Local_Exemptions

# Exemptions for Resident Local Income Tax Numeric 5

BF Res_Local_Tax_Override

Amount of Resident Local Income Tax Override Numeric 7

BG Res_Local_Tax_Override_Cont

Resident Local Income Tax Override Control Text 1

(F)ixed; (P)ercent; or (A)dd-on only

BH Permanent_Unemployment_State

Unemployment state (Permanent Override for resident and work state) Text 10

This Tax code can be the same as a Resident State, Perm Work State, Resident County or the Resident Local.


BI Apprentice_ID

Apprentice program ID # Text 20

BJ Apprentice_Wage_Percent Wage % Numeric 6

Format = xxx.xx Positive numbers only and cannot exceed 100. If defined then Apprenctice_ID is required.

BK Summary_Post_Flag

Post in summary to job and equipment history (confidential employee)? Text 1

(Y)es or (N)o only. If left blank then defaults to N. Field is not available in a Confidential Payroll Company.

BL Suppress_Post_Flag

Also suppress employee's hours in job and Text 1

Summary_Post_Flag must = Y in order to define. (Y)es or (N)o



on Type Max

Field Information

Validation

equipment history?

only. If left blank then defaults to N. Field is not available in a Confidential Payroll Company.


Employee – User-Defined Field

Web Service name = UpdateEmp_UDF – Change Employee - UDF

Assumptions and Dependencies The Payroll module must be set up. The Employee code must exist in the defined Company code. The Employee User-Defined Field Information Web Service updates an existing employee’s

information for the defined fields only. 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. The Employee user-defined fields need to be defined in Spectrum. The Authorized ID must have the user-defined fields defined, or mapped, for this Web Service.

Excel Field Name Description Type MaxField




Employee Code must exist for the defined Company Code.

D UDF1



E UDF2



F UDF3



G UDF4



H UDF5



I UDF6



J UDF7



K UDF8



L UDF9






M UDF10



N UDF11



O UDF12



P UDF13



Q UDF14



R UDF15



S UDF16



T UDF17



U UDF18



V UDF19



W UDF20




Employee – Deduction/Add-ons

Web Service name = Update_Empl_Vol_Ded – Add_Change Employee Deduction/Add-ons

Underlying File Maintenance Prior to importing Employee – Deduction/Add-ons information, the following file maintenance areas must be completed:

Payroll Installation screen Payroll | Employee Maintenance Payroll | Deduction/Add-on Code Maintenance Payroll | Formula File Maintenance Accounts Payable | Vendors Human Resource | Recurring Benefits Code Maintenance (if applicable)

Assumptions and Dependencies The Payroll Module must be set up. The Employee code must exist in the defined Company code. The Employee-Deduction Add-on Web Service updates an existing employee’s information for

the defined fields only. o If the Deduction/Add-on does not exist then it will be added to the Employee. o Does not change the following fields (changes all other fields if Vol_Deduct_Code exists

for the Employee) Company_Code Employee_Code VoL_Deduct_Code


If Human Resources module is active then it will update the Employees Benefits Master. Deduction/Add-on codes have specific rules regarding the status code option allowed and will

follow the standard Spectrum rules.




C Employee_Code Employee Code Text 11 Valid Employee Code in Spectrum

D Vol_Deduct_Code Code Text 10 Deduction/Add- on Maintenance Table

E Vol_Deduct_Status Status Text 1

(R)ecurring, (O)ne Time, (I)nactive or (S)kip one

Required if Vol_Deduct_Code is being added to the defined Employee_Code

F Formula_Code Formula Text 5

Dependent on Status & Code defined. If blank defaults from defined code. Valid Formula code




G Vol_Deduct_Amount Amount Numeric 9

Dependent on Status & Code defined. Format = -5.2

H Vol_Deduct_Percent Percent Numeric 6

Dependent on Status & Code defined. Positive numbers only. Format = 3.3

I Vol_Deduct_Limit Annual Limit Numeric 8


J Monthly_Limit Monthly Limit Numeric 8


K Cycle_Amount_Limit Cycle Limit Numeric 8 Positive numbers only.

L Cycle_Percent_Limit Cycle Limit % Numeric 6 Positive numbers only. Format = 2.3

M Formula_Value_1 Variable 1 Numeric 9 Format = -4.3

Defaults to zero- Tied to Formula_Code field.

N Formula_Value_2 Variable 2 Numeric 9 Format = -4.3


O Formula_Value_3 Variable 3 Numeric 9 Format = -4.3


P Vendor_Code Vendor Text 10

Required if Vol_Deduct_Code requires it.

Valid Vendor Code in Spectrum

Q AP_Remark AP Invoice Remarks Text 30

Required if Pay_Frequency_Flag = D, otherwise calculated by Spectrum.


Employee Notes

Web Service name = EmployeeNotes – Employee Notes

Underlying File Maintenance Prior to importing Employee Notes information, the following file maintenance areas must be completed:

Payroll Installation screen Payroll | Employee File Maintenance Payroll | Employee Note Topics Maintenance

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Employee_Code and Notes_Topic must exist in order to add the notes. The Employee Notes web service has an option to append to the current Note Topic.





Validation



C Employee_Code Employee Code Text 11 Valid Employee

D Notes_Topic Notes Topic Text 20 Employee Note Topics Maintenance





Employee Entity

Web Service name = UpdateEmp_Entity – Add or Change Employee Entity

Underlying File Maintenance Prior to importing Employee Entity information, the following file maintenance areas must be completed:

Payroll Installation screen Enterprise Management | Entities Enterprise Management | Cost Center Maintenance Payroll | Employee Maintenance

Assumptions and Dependencies The Payroll Module must be set up. The Employee code must exist in the defined Company code. The Employee-Entity Web service adds or updates an existing employee’s entity information for

the defined fields only. 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.




C Employee_Code Employee Code Text 11 Valid Employee Code in Spectrum

D Main_Comp_Status

Main Company: Authorized for payment from this entity? Text 1

(A)uthorized or (I)nactive. Defaults to (A)uthorized if blank.

E Main_Comp_OverrideCC

Main Company Override Cost Center Text 10


F Entity_Code Entity Text 10

Define the specific Entity for the Employee.

Valid Entity in Spectrum

G Status

Entity Specific: Authorized for payment from this entity? Text 1

Must have a defined Entity_Code if defined. (A)uthorized or (I)nactive. Defaults to (A)uthorized if blank.

H Override_CC

Entity Specific Deductions/Add-ons Override Cost Center Text 10

Must have a defined Entity_Code.



Employee Entity Ded/Add-on Code

Web Service name = UpdateEmp_Entity_DedAddon – Add or Change Employee Entity Ded/Add-on

Underlying File Maintenance Prior to importing Employee Entity Ded/Add-on information, the following file maintenance areas must be completed:

Payroll Installation screen Enterprise Management | Entities Enterprise Management | Cost Center Maintenance Payroll | Employee Maintenance Payroll | Deduction/Add-on Code Maintenance Payroll | Formula File Maintenance Accounts Payable | Vendors Human Resource | Recurring Benefits Code Maintenance (if applicable)

Assumptions and Dependencies The Payroll Module must be set up. The Employee code must exist in the defined Company code. The Employee-Entities Web service adds or updates an existing employee’s entity information for

the defined fields only. o The Vol_Deduct_Code fields require that the Entity_Code field be populated. o If the Vol_Deduct_Code does not exist on the Employee’s Entity then it will be added. If it

does exist on the Employee’s Entity then the details of the code will be updated. 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. If Human Resources module is active then it will update the Employee’s Entity Benefits Master. Deduction/Add-on codes have specific rules regarding the status code option allowed and will

follow the standard Spectrum rules.


Validation



C Employee_Code Employee Code Text 11 Employee Code

D Entity_Code Entity Text 10

Define the specific Entity for the Employee. Entity

E Override_CC

Entity Specific Deductions/Add-ons Override Cost Center Text 10

Must have a defined Entity_Code.




Validation

F Vol_Deduct_Code Code Text 10

Must have a defined Entity_Code if defined. If code is blank and detail lines are populated they will be ignored.

Deduction/Add- on Maintenance Table

G Vol_Deduct_Status Status Text 1

(R)ecurring, (O)ne Time, (I)nactive or (S)kip one

Required if Vol_Deduct_Code is being added to the defined Employee_Code

H Formula_Code Formula Text 5

Dependent on Status & Code defined. If blank defaults from defined code. Formula code

I Vol_Deduct_Amount Amount Numeric 9

Dependent on Status & Code defined. Format = -5.2

J Vol_Deduct_Percent Percent Numeric 7


K Vol_Deduct_Limit Annual Limit Numeric 8


L Monthly_Limit Monthly Limit Numeric 8


M Cycle_Amount_Limit Cycle Limit Numeric 8

Positive numbers only. Format = 5.2

N Cycle_Percent_Limit Cycle Limit % Numeric 6


O Formula_Value_1 Variable 1 Numeric 9 Format = -4.3


P Formula_Value_2 Variable 2 Numeric 9 Format = -4.3


Q Formula_Value_3 Variable 3 Numeric 9 Format = -4.3


R Vendor_Code Vendor Text 10

Required if Vol_Deduct_Code requires it Vendor Code



Validation

S AP_Remark AP Invoice Remarks Text 30


Employee Entity Time Bank

Web Service name = UpdateEmp_Entity_TimeBank – Add or Change Employee Entity Time Bank

Underlying File Maintenance Prior to importing Employee Entity Time Bank information, the following file maintenance areas must be completed:

Payroll Installation screen Enterprise Management | Entities Enterprise Management | Cost Center Maintenance Payroll | Employee Maintenance Payroll | Hours Bank Code Maintenance (if applicable)

Assumptions and Dependencies The Payroll Module must be set up. The Employee code must exist in the defined Company code. The Employee-Entity Time Off Bank Web service adds or updates an existing employee’s entity

time off bank information for the defined fields only. o If the Time Off Bank codes do not exist then they will be added to the employee’s entity. o If the Time Off Bank codes do exist then the details for the code will be updated.

The Time Off Bank codes are not required to populate the Year to Date or Balance fields. This is standard Spectrum entry logic. If a code is not defined then the default display on the main Entity screen will not be marked to indicate that data exists.



Validation



C Employee_Code Employee Code Text 11 Valid Employee Code

D Entity_Code Entity Text 10

Define the specific Entity for the Employee. Valid Entity

E Vacation_Hours_Balance

Vacation Hours Balance Numeric 7

Allows negative numbers. Format = -3.2

F Vacation_Hours_YTD

Vacation Hours YTD Numeric 7


G Vacation_Control_Code

Vacation Control Code Text 2

Hours Bank Code Maintenance with a Type of Vacation

H Holiday_Hours_Balance

Holiday Hours Balance Numeric 7




Validation

I Holiday_Hours_YTD

Holiday Hours YTD Numeric 7


J Holiday_Control_Code

Holiday Control Code Text 2

Hours Bank Code Maintenance with a Type of Holiday

K Sick_Hours_Balance

Sick Hours Balance Numeric 7


L Sick_Hours_YTD Sick Hours YTD Numeric 7


M Sick_Control_Code Sick Control Code Text 2

Hours Bank Code Maintenance with a Type of Sick


Pre-Time Card Transactions

Web Service name = PreTimeCard – Pre-Time Card

Underlying File Maintenance Prior to importing Pre-Time Card Transaction information, the following file maintenance screens must be completed:

Payroll Installation o Payroll | Tax Table Maintenance o Payroll | Deduction/Add-on Code Maintenance (if applicable) o Payroll | Department Expense Maintenance o Payroll | Worker’s Comp Base Code o Payroll | Worker’s Compensation Code Maintenance o Payroll | Union File Maintenance (if applicable) o Payroll | Non-Union Pay Group Maintenance (if applicable) o Payroll | Wage Code File Maintenance (if applicable) o Payroll | Crew Maintenance (if applicable) o Payroll | Employee Status Code Maintenance o Payroll | Employees Maintenance

General Ledger Installation o General Ledger | G/L Department File Maintenance o General Ledger | G/L Master File Maintenance

Human Resources | Installation (if applicable) o Human Resources | Triggers Maintenance

Job Installation (if applicable) o Job Cost | Jobs Maintenance (if applicable) o Job Cost | Cost Type Maintenance (if applicable) o Job Cost | Phases Maintenance (if applicable)

Equipment Control Installation (if applicable) o Equipment Control | Equipment Status File Maintenance (if applicable) o Equipment Control | Equipment Maintenance (if applicable) o Equipment Control | Equipment Components File Maintenance (if applicable) o Equipment Control | Cost Category Maintenance (if applicable) o Equipment Control | Job Specific Equipment Charge Rates (if applicable)

Preventive Maintenance Installation (if applicable) o Preventive Maintenance | Equipment Work Order Entry(if applicable)

Work Order Installation (if applicable) o Work Order | Site File Maintenance (if applicable) o Work Order | G/L Department File Maintenance (if applicable) o Work Order | Work Order Type File Maintenance (if applicable) o Work Order | Labor Category File Maintenance (if applicable) o Work Order | Labor Billing Rates Maintenance (if applicable) o Work Order | Work Order Standard Phase (if applicable) o Work Order | Work Order Entry (if applicable)

Service Contract Installation (if applicable) o Service Contract | Contract Type File Maintenance (if applicable) o Service Contracts | Service Contract File Maintenance (if applicable)

Time & Material Installation (if applicable) o Time & Material | Job Billing Maintenance (if applicable) o Time & Material | Labor Billing Rates (if applicable) o Time & Material | Job Labor Billing Rates Maintenance (if applicable)


o Time & Material | Equipment Billing Rates (if applicable) o Time & Material | Job Equipment Billing Rates Maintenance (if applicable)

Enterprise | Cost Center Maintenance (if applicable)

Assumptions and Dependencies General Guidelines

The transaction data being submitted using this web service are stored within the Payroll Approve Pre-Time Import screen by Employee or by Quantity and requires the data to be manually approved within Spectrum using the Approval buttons on the screen.

The Pre-time card Web Service submits one record at a time and creates ‘R’egular Check types for the next available sequence number. If a ‘R’egular Check types exist then it adds the details to the first existing sequence number.

The Pre-time card Web Service does not support the Salary redistribution logic used in standard Pre-time card entry.

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 set up. 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 Company_Code, Work_Date and Pay_Type. Cost center information will only be allowed if the Company is set to a Yes status. This Web Service is not impacted by the Workflow process in Spectrum.

Employee Record Guidelines

Any Pay_Type other than Q(uantity) will be sent to the Pre-Time Card Import Errors screen located within the Pre-Time Card Import logic.

The Department_Code defined controls what information appears in the record. o If excess data is sent within the record, the Department_Code will control what data

remains in the record for review. o 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 Company_Code. 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.

Excel Field Name Description Type Max

Field Information Validation

B Company_Code Company Code Text 3 Company where the records will be created.


C Batch_Code Batch Code Text 8 New or existing batch code




D Employee_Code Employee Text 11

Must exist in company per the Company_Code entry. Not required for quantity records.

E Department_Code Department Text 6

Not required for quantity records. **See Assumptions and Dependencies.

F Pay_Type Pay type 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 Company_Code 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.

G Hours_Employee Employee Hours Numeric 8

Enter decimals but no $ signs or commas. Can be positive or negative; Not required for quantity records.

H Job_Number Job Text 10 Required for Quantity records.

I Phase_Code Phase Text 20 No dashes. Required for Quantity records.

J Cost_Type Cost type Text 3 Required for Quantity records.

K Work_Date Date Text 10 Enter as: MM/DD/CCYY (i.e., 01/05/2010).

Within P/R processing date range

L Message Message Text 30 Cannot contain SuperSelect characters.

M Pay_Rate_Code Rate level Text 1 1 thru 9 only

N Wage_Code Wage code Text 10

O Union_Code Union code OR Pay group Text 10

P Worker_Comp_Code Work Comp Text 6

Q State Work state Text 10




R Work_County Work county Text 10

S Work_Locality Work local Text 10

T Equipment_Code Equipment Text 10

U Equipment_Hours

Equipment Hours Numeric 8

Enter decimals but no $ signs or commas. Can be positive or negative

V Additional_JTD_Quantity Add'l JTD Qty Numeric 14

Enter decimals but no $ signs or commas. Can be positive or negative

W Inter_Company_Code

Inter-Company code Text 3

For Employee records- the data will be shown for this company code. For Quantity records – the data will need to be reviewed and the company code changed on the error screen.

Define the valid Company code here if the Job, Work Order or Equipment is from a different company.

X Pay_Rate Pay Rate Numeric 12

Enter decimals but no $ signs or commas. Can be positive or negative. Allows up to a 3 decimal rate.

Y Cost_Category_Code Cost Category Text 4

Z Crew_Number Crew Text 10

AA WO_Number Work Order Text 10

AB WO_Equipment WO Site Equipment Text 8

AC WO_Component WO Component Text 2

AD SC_Contract WO Contract Text 10

AE PM_Work_Order Equipment Work Order Text 10

AF Cost_Center 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


Get Deduction/Add-on Codes

Web Service name = GetDedAddon – Get Deduction Add-on Codes


o pDeduct_Type o pCost_Center o pSort_By

Parameter Fields




pVol_Deduct_Code Deduction/Add-on Code Text 10 Deduction/Add-on Code Maintenance

pDeduct_Type Type Text 1

Define one specific type or leave blank to see all

pCost_Center Cost Center Text 10



Blank = Deduction/Add-on Code or T= Deduction Type then Deduction/Add-on Code

Return Fields



Vol_Deduct_Code Deduction/Add-on Code Text 10

Deduction/Add-on Code Maintenance

Vol_Deduct_Description Description Text 15

Deduct_Type Type Text 1 (A)dd-on or( D)eduction

Calc_Method Calculation Method Text 1

(F)ixed Amount; (G) Percent of Gross Amount; (N) Percent of Net Amount; (S) Percent of Straight Time Equivalent; (R ) Regular Equivalent



Hours; (O)vertime Equivalent Hours; (A)ll Hours; (U)ser Defined Formula; (P)ercent of Related Code; (C ) Prevailing Wage Adjustment or (H) Employer Health & Welfare Benefits only.





Get Employee

Web Service name = GetEmployee – Get Employees



Parameter Fields




pWage_Class Wage Code Text 10

pUnion_Code Union Code Text 10

pOccupation Occupation Text 50

pTrade Trade Text 50

pStatus_Type Status Text 1


pCost_Center Employee Cost Center Text 10



Blank = Employee Code, A= Alphabetical by Employee_Name, F= First Name, L= Last name or D= Department code

Return Fields



Employee_Code Employee Code Text 11 Employee File Maintenance

Employee_Name Employee Name Text 30

Supervisor_Code Supervisor Code Text 2

Employment_Status Employee Status Text 1

Department_Code Department Code Text 6



Union_Code Union Code Text 10

Wage_Class Wage Code Text 10

Worker_Comp_Code Worker’s Comp Code Text 6

First_Name Employee First Name Text 20

Middle_Name Employee Middle Name Text 20

Last_Name Employee Last Name Text 20

Occupation Occupation Text 50

Trade Trade Text 50

Title Employee Title Text 50

Employee_Mobile_Phone Work Mobile Phone Text 14

Employee_Extension Work Extension Text 15

Cost_Center Employee Cost Center Text 10





Get Pay Types

Web Service name = GetPayType – Get Pay Types

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank. Pay Types within Spectrum are hard coded within the software. The Incentive (*I) is not supported for this web service. All parameter fields have SuperSelect logic except the following-

o pPay_Type o pSort_By

Parameter Fields




pPay_Type Pay Type Text 2


Blank = Company Code and Pay Type or T= Pay Type

Return Fields



Pay_Type Pay Type Text 4

Pay_Type_Desc Pay Type Description Text 30





Get Wage Codes

Web Service name = GetWageCode – Get Wage Codes


o pSort_By Wage Codes can be defined globally for Unions, be Job specific or be Phase/Cost type specific

within Spectrum. o To see global Wage Codes leave the pJob_Number parameter blank. o To see Job specific Wage Codes define pJob_Number parameter with ALL. o To see Phase/Cost type specific Wage Codes leave the pJob_Number parameter blank

and define the specific pPhase_Code and/or pCost_Type parameters.

Parameter Fields




pWage_Code Wage Code Text 10 Wage Code File Maintenance

pUnion_Code Union Code Text 10 Union Code File Maintenance


pPhase_Code Phase Code Text 20 Phase File Maintenance


pSort_By Sort By Options Text 1 Blank = Wage Code, J= Job number or U= Union Code

Return Fields

Return Field Name




Wage_Code Wage Code Text 10

Union_Code Union Code Text 10

Short_Description Short Description Text 10

Full_Description Full Wage Description Text 30

Worker_Comp_Code Worker’s Compensation Code Text 6

Effective_Date Effective Date Date 8




Return Field Name




PROJECT MANAGEMENT

Project Log

Web Service name = ProjectLog – Project Log

Underlying File Maintenance Prior to importing Project Log information, the following file maintenance screens must be completed:

Job Cost Installation screen Project Management | Building / Area Maintenance Project Management | Category Maintenance Project Management | Classification Maintenance Project Management | Project Note Topics Maintenance Job Cost | Job Phases

Assumptions and Dependencies If Company_Code and Category field names are blank then use the Authorization ID default

value. Both fields are required in order to process the web service. The TransactionId and Reference_Num field name can be defined or not.

o If they are both blank then a new entry is created using the auto sequencing logic. o If the TransactionId is defined and valid then it will update the pre-existing record.

Any field that are left blank they will not be updated in Spectrum. The service does not delete values that exist in Spectrum; it only changes data

defined in the layout. o If the Reference_Num is defined along with the Company_Code, Job_Number, and

Category and the unique combination of those fields are valid then it will update the pre-existing record.

Any field that are left blank they will not be updated in Spectrum. The service does not delete values that exist in Spectrum; it only changes data

defined in the layout. o If the Reference_Num is defined along with the Company_Code, Job_Number, and

Category and the unique combination of those fields does not exist then a new entry is created using the defined Reference_Num.

If the defined ‘Category’ in the record has a default value defined and the information is not valid then the default value will be used.

o If there is no default value defined then the field will be left blank. o No error will be returned to the user.

The following fields are validated against the defined Spectrum Project Management Tables. o Classification o Phase o Building o Area

Once the Record is entered into Spectrum the user will receive a Response message defining the following:

o TransactionId for their records that is stored in their system and is used as a selection criteria if known.

If duplicate records exist to be updated, then they will all be updated as they are processed. External_Link and External_Id field logic

o These fields are used to define if a third party web connection is being used. External_Link = states if a web address is defined in the field. This is a yes or no

field.


External_Id = stores the complete web address such as http://www.msn.com o The defined Web URL (External_Id) controls how the information is opened in Spectrum.

If it is defined then it uses the Spectrum Web link logic. o If the External_Id is defined then External_Link will be Y(es). o External_Id and External_Link fields DO NOT display on the Project Log detail tab

screen. o Project Logs tied to an External_Id URL will be opened using the defined URL and can’t

be viewed within Spectrum. Issued_Date and Resp_Req_Date field logic

o If the Job has a defined Default Project Log for the Days to Respond then this field will be calculated when the new entry is made.

o The Resp_Req_Date is only calculated if the default exists for the Job and Category. o If the Issue_Date is blank, it uses the system date and will calculate the Resp_Req_Date

as well if the Job has defaults defined. o The Resp_Req_Date is not calculated if the Entry is being changed.

This Web Service will work with the defined Workflow process in Spectrum.


on Type

Max Field Information Validation



C Job_Number Job code Text 10 Valid Job in Spectrum

D TransactionId Project Log ID Text 36

TransactionId is created within Spectrum when the project log is added. If defined then the record will be updated.

Validates to the Project Log entry.

E Category Category Text 30

Validates to the Project Management Category Maintenance

F Reference_Num Number Text 10

Reference_Num is created within Spectrum when the project log is added. ** If defined and the Company_Code, Job_Number and Category is unique the record will be updated otherwise creates a new entry.


G Topic Topic Text 250

H Issued_Date Issued date Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2010) If left



on Type


blank it will use the current date.

I Resp_Req_Date Respond by Date 10

Enter as: MM/DD/CCYY (e.g., 01/05/2010). If Job has default set then the date will be calculated only when created.


J Answered_Date Answered Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2010)

K Cost_Impact Cost impact? Text 1

(Y)es or (N)o or blank field

L Schedule_Impact Schedule impact? Text 1


M Status Closed? Text 1 (O)pen or (C )losed

N Activity Activity flag? Text 1

(A)cton needed, (I)nformation or (T)racking

O Priority Priority flag? Text 1 (H)igh, (M)edium or (L)ow

P Classification Discipline Text 50

Validates to the Project Management Discipline Maintenance

Q Spec_Section Spec Section Text 30

R Phase Phase Text 20 No dashes Validates to the Job Phase

S Building Building Text 10

Validates to the Project Management Building / Area Maintenance

T Area Area Text 10

Validates to the Project Management Building / Area Maintenance

U Responsibility Responsibility Text 250

V Reference Reference Text 250

W Sent_via Sent via Text 50

X Direction Direction Text 1 (I)nbound or (O)utbound or blank

Y Email_Date E-mail date Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2010)



on Type


Z Weather Weather Text 250

AA AM_Temperature

AM Temperature Text 6

AB PM_Temperature

PM Temperature Text 6

AC Precipitation_Amount Precipitation Amount

Numeric 6

Positive number only. Enter as: xx.xxx

AD Wind Wind Text 15

AE External_Ref1 External ID Text 30

AF External_Ref2 Owner number Text 30

AG External_Link

Access to External Program? Text 1



AH External_Id

External Program’s Web URL Text 250

Used to open details using the web link logic in Spectrum.

**See Assumptions and Dependencies. If defined then the External_Link = Y

AI Authored_By Authored by Text 250

AJ Cost_Impact_Amount Cost impact amount

Numeric 14

Allows negative. Decimals OK

AK Sent_To_Submitter Sent to submitter Date 10


AL Required_From_Submitter

Required from submitter Date 10


AM Received_From_Submitter

Received from submitter Date 10


AN Sent_To_Approver Sent to approver Date 10


AO Required_From_Approver

Required from approver Date 10


AP Received_From_Approver

Received from approver Date 10




on Type


AQ Returned_To_Submitter Returned to submitter Date 10


AR Scheduled_Delivery Scheduled delivery Date 10


AS Actual_Delivery Actual delivery Date 10


AT Inspection Inspection Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2014)

AU Re_Inspection Reinspection Date 10


AV Scheduled_Complete Scheduled complete Date 10


AW Signed_Off Signed off Date 10 Enter as: MM/DD/CCYY (e.g., 01/05/2014)

AX Schedule_Impact_Days Schedule Impact days

Numeric 4

Allows negative. Format = -xxx

AY Log_Status Log status Text 30

AZ Subsection Subsection Text 10


Project Log Notes

Web Service name = ProjectLogNotes – Project Log Notes

Assumptions and Dependencies If Company_Code and Category field names are blank then use the Authorization ID default

value. Both fields are required in order to process the web service. The Project Log entry must exist in order to add the notes. Either the TransactionId or the Reference_Num field must be defined to add the notes to the

Project Log entry. o If the TransactionId is defined and valid then it will update the pre-existing record with the

defined notes. o If the Reference_Num is defined along with the Company_Code, Job_Number, and

Category and the unique combination of those fields is valid then it will update the pre-existing record with the defined notes.

o The following hierarchy will be used if the TransactionId, Category and Reference_Num are all populated in this order:

TransactionId Category and Reference_Num

The Project Log Notes Web Service has an option to append to the current Note Topic. If not defined then the Notes will be replaced. The formatting options available within the Notes on the Project Log are not supported.






C Job_Number Job code Text 10 Valid Job in Spectrum

D TransactionId Project Log ID Text 36

TransactionId is created within Spectrum when the project log is added. If defined then the record will be added.



Validates to the Project Management Category Maintenance



F Reference_Num Reference number Text 10

Reference_Num is created within Spectrum when the project log is added. ** If defined and the Company_Code, Job_Number and Category is unique the record will be updated.


G Notes_Topic Project Note Topic Text 20

Validates to the Project Note Topics Maintenance

H Notes_Text Notes Text 1000

I Append_Note Append Notes? Text 1 (Y) to append. Blank = Replace all notes


Job Spec Section

Web Service name = UpdateJobSpecSection – Add Change Job Spec Section

Underlying File Maintenance Prior to importing Job Spec Section information, the following file maintenance screens must be completed:

Project Management Installation screen Project Management | Job Spec Sections

Assumptions and Dependencies The Project Management module must be set up. The Job must exist in the defined Company code. The Job Spec Section Web Service updates existing Project Management Job Spec Section

information for the defined fields only. The Spec_Section must exist in order to change the Description information. Any field that is left blank will not be updated in Spectrum. The service does not delete values





C Job_Number Job Number Text 10 Valid Job in

Spectrum

D Spec_Section Section Text 30

E Spec_Section_Desc

Section Description Text 50


Project Log Recipient

Web Service name = UpdatePJRecipient – Add Project Log Recipient

Underlying File Maintenance Prior to importing Project Log Recipient information, the following file maintenance screens must be completed:

Job Cost Installation screen Project Management | Project Log Project Management | Category Maintenance Job Cost | Job Contacts Systems Administration | Contacts

Assumptions and Dependencies The Project Log must exist in order to add the Project Log Recipients. The Project Log Recipients web service will create a new Recipient entry. If Company_Code field is blank then use the Authorization ID default value. To update the Project Log Recipients on a specific Project Log the TransactionId must be defined OR the

Job_Number, Category and Reference_Num must be defined. Once it is a validated then the Project Log Recipients will be added.

Contact_ID field o The Contact_ID is an internally created Id number that does not appear on a screen in Spectrum

but controls the Contact Name shown on the Project Log Recipients List. o The following hierarchy logic will be used to define the correct Recipients based on the fields define

in the Web Service. If the information is not valid then each component will be processed to find the correct Recipient. If the Recipient is not found then it will provided an error.

If a Contact_ID is provided then it will be used to define the Recipient information. If the Contact_ID is blank then the Recipient_Email is required and will be used to define

the Recipient information. If the Recipient_Email doesn’t exist then the Last_Name and First_Name fields will be

used to define the Recipient information. o The first created Contact ID found in Spectrum with and ACTIVE status will be used to populate the

Recipient information if the Recipient_Email or the combination of the Last_Name and First_Name fields is used.

If duplicate records exist, then they will all be added as they are processed.

Any field that is left blank will not be updated in Spectrum.




C Job_Number Job Number Text 10 Valid Job in

Spectrum

D TransactionId Internally created Project Log ID Text 36

Not found in Spectrum. Leave blank if using Template.

Valid Project Log ID. *See Assumptions and Dependencies





F Reference_Num Number Text 10

If TransactionId is blank then Category and Reference_Num must be defined.


G Recipient_Type Type Text 1

T=To ; F=From ; C=Courtesy copy or B=Blind copy

H Contact_ID Internally created Contact ID Text 10

Not found in Spectrum. Leave blank if using Template.

Valid Contact. *See Assumptions and Dependencies

I Recipient_Email Recipient Email Text 80

If Contact_ID not defined then Recipient_Email is required. Format = [email protected].


J Last_Name Recipient Last Name Text 30

If Recipient_Email is not defined then the Last_Name and First_Name are required.


K First_Name Recipient First Name Text 20

If Recipient_Email is not defined then the Last_Name and First_Name are required.



Get Discipline

Web Service name = GetDiscipline – Get Discipline

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank in

the parameter fields. All parameter fields have SuperSelect logic except the pSort_By

Parameter Fields




pLog_Class Discipline Text 50 Defaults to All

pSort_By Sort By Options Text 1 Blank = Company Code or D=Log Class

Return Fields



Log_Class Discipline Text 50 Project Log Discipline





Get Project Log Jobs

Web Service name = GetPJJobs – Get PJ Jobs

Assumptions and Dependencies The Authorization ID controls the security and defaults the pCompany_Code field if left blank in

the parameter fields. All parameter fields have SuperSelect logic except the pSort_By

Parameter Fields




pJob_Number Text 10 Valid Job

pStatus_Code if left blank then active and inactive only Text 1

(A)ctive, (I)nactive or (C )omplete

pLog_Class Discipline Text 50 Defaults to All

pSort_By Sort By Options Text 1 Blank = Company Code or D=Log Class

Return Fields




Job_Description Job Name Text 25


Category Project Log Category Text 30

PJ_Reference_Num Last Project Log Reference Number per Category Text 10

Display the Reference Number from the Project Log table per Category






WORK ORDER

Work Order Site Address

Web Service name = AddWOSiteAddress – Add Work Order Site Address

Underlying File Maintenance Prior to importing Work Order Site information, the following file maintenance areas must be completed:

Work Order Installation screen Accounts Receivable Installation screen Payroll Installation screen Work Order | Lead Source Maintenance Work Order | Technician Maintenance Work Order | Type Maintenance Work Order | Zone Maintenance Work Order | Site Maintenance (if applicable) Work Order | Make Maintenance (if applicable) Work Order | Model Maintenance (if applicable) Work Order | Equipment Type Maintenance (if applicable) Accounts Receivable | Customer Maintenance Accounts Receivable | Sales Tax Code Maintenance (if applicable) Accounts Receivable | Bill-to Code Maintenance (if applicable) Payroll | Tax Tables Maintenance (if applicable) Payroll | Worker’s Compensation Code Maintenance (if applicable) Work Order | Site User-Defined Fields (if applicable) Work Order | Site Note Topics Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies All work order sites are created with an ‘Active’ Status. Billing Address defaults from the Customer Code unless defined within the service. The Site_Contact_Person, Site_Phone1 and the Work_Site_Email fields will be used to define the

Contact on the Work Order site and marked as the Primary Contact. Cost centers will validate against the Cost Center Maintenance Table and Customer Cost Center. Cost Center information will only be allowed in if Company is set to Pending or Yes status.




C Site_ID Site code Text 10

No duplicates-not auto created.

D Site_Name Site Name Text 30

E Site_Address1 Address Line 1 Text 30

F Site_Address2 Address Line 2 Text 30

G Site_City City Text 25




H Site_State State Text 2 2 digit postal code

I Site_Zip_Code Zip Text 10

J Site_Phone1 Site Phone Text 14


K Telephone_Ext_1 Site Phone Ext Text 4

L Site_Phone2 Other Phone Text 14


M Telephone_Ext_2 Other Phone Ext Text 4

N Site_Contact_Person Site Contact Text 20 No commas

O Site_Customer_Code Customer Code Text 10


P Lead_Source Lead Source Code Text 15 Lead Source Maintenance

Q Requested_Tech Requested Tech Text 11 Technician Maintenance

R WO_Type Work Order Type Text 5

Work Order Type Maintenance

S Zone Zone Text 3

Work Order Zone Maintenance File

T Special_Instructions Alert Notes Text 70

U Show_Notes

Display Alert Notes in WO main properties? Text 1

(Y)es or (N)o only. Blank = No

V Sales_Tax_Code Sales Tax Code Text 15

Defaults from the Customer Code if blank.

A/R Sales Tax Code Maintenance File.

W Taxable_Flag Default site to Taxable? Text 1


X Labor_Taxable Labor Taxable? Text 1





Y Material_Taxable Material Taxable? Text 1


Z Work_Comp_Code

Worker’s Compensation Code Text 6


AA Wage_Rate_Level Wage Rate Level Numeric 1 numbers 1-9

AB Work_State_Tax_Code Work State Code Text 10



AC Work_County_Tax_Code

Work County Code Text 10



AD Work_Local_Tax_Code Work Local Code Text 10



AE Work_Site_Email WO Contact Email Text 80

Must be the basic layout for an email address. Example:[email protected]

AF Site_Case_Type Case Type Text 10 Case Type Maintenance

AG Customer_Job Customer Job Text 10 No validation

AH Latitude Latitude Numeric 11 Format = -XXX.XXXXXX.

AI Longitude Longitude Numeric 11 Format = -XXX.XXXXXX.

AJ Markup_Code Non-Stock Markup Code Text 10

Non-stock Markup File Maintenance

AK Alternate_Address

Print alternate address on work order/invoice? Text 1


AL Billto_Code Bill-to code Text 4

Required if Alternate_Address is Y. Tied to defined Customer code.

Customer Bill-to Address Maintenance

AM Cost_Center Site Cost Center Text 10

Cost Center Maintenance and Customer Cost Center


Work Order Site Equipment

Web Service name = AddWOSite_Equip – Add Work Order Site Equipment

Assumptions and Dependencies The Work Order Site Equipment Web Service adds equipment information to an existing Work

Order Site. The Work Order site must have an Active Status. The Equip_ID field does not tie to the Equipment Control module. Duplicate Equipment codes cannot exist on the same Work Order Site.




C Site_ID Site code Text 10 Must have an active status

Work Order Site File Maintenance

D Equip_ID Equipment code Text 10 No duplicates within WO Site

E Equip_Description Description Text 30

F Equip_Type Equipment type Text 4 Equipment Type Maintenance

G Year_Installed Year installed Numeri

c 4 Format = CCYY

H Make Make Text 20

Validated if WO Installation option is selected.

I Model Model Text 20

Validated if WO Installation option is selected.

J Serial Serial number Text 15

K Location Location Text 20

L Status Equipment status Text 1 A(ctive) or I(nactive) only


Work Order Site Address – User-Defined Field

Web Service name = UpdateWOSite_UDF – Change Work Order Site - UDF

Assumptions and Dependencies The Work Order Site-UDF Web Service adds user-defined fields (UDF) information to an existing

Work Order Site. The Work Order site must have an Active Status. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service.




Valid Company in Spectrum.

C Site _ID Site code Text 15

Valid Work Order Site Address Code must exist for the defined Company Code.






















M UDF10



N UDF11



O UDF12



P UDF13



Q UDF14



R UDF15



S UDF16



T UDF17



U UDF18



V UDF19



W UDF20




Work Order Site Notes

Web Service name = WOSiteNotes – Work Order Site Notes

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The Site_ID and Notes_Topic must exist in order to add the notes. The Work Order Site Notes web service has an option to append to the current Note Topic.







C Site _ID Site code Text 10

Valid Work Order Site Address Code must exist for the defined Company Code.

D Notes_Topic Notes Topic Text 20 Site Note Topics Maintenance





Work Order Header

Web Service name = WorkOrderHeader – Add or Change Work Order Header

Underlying File Maintenance Prior to importing Work Orders information, the following file maintenance areas must be completed:

Work Order Installation screen Accounts Receivable Installation screen Service Contract Installation screen Job Cost Installation screen Work Order | Lead Source Maintenance Work Order | Technician Maintenance Work Order | Work Order Type Maintenance Work Order | Case Type Maintenance Work Order | Dispatch Status Maintenance Work Order | Non-stock Markup File Maintenance Work Order | Zone Maintenance Work Order | Priority Maintenance (if applicable) Work Order | G/L Department (if applicable) Work Order | Site Maintenance (if applicable) Job Cost | Jobs (if applicable) Accounts Receivable | Customer Maintenance Accounts Receivable | Sales Tax Code Maintenance (if applicable) Accounts Receivable | Salesperson Code Maintenance (if applicable) Accounts Receivable | Terms Code Maintenance (if applicable) Accounts Receivable | Bill-to Code Maintenance (if applicable) Service Contract | Service Contract Maintenance (if applicable) Work Order | Work Order User-Defined Fields (if applicable) Work Order | Work Order Note Topics Maintenance (if applicable) Enterprise Management | Cost Center Maintenance (if applicable)

Assumptions and Dependencies The Work Order Web Service will create new Work Orders within Spectrum or update an existing

Work Order. Any Field that is left blank for an existing Work Order will not be updated in Spectrum. The service does not delete values that exist in Spectrum; it only changes the data with the defined data in the field name.

The defined WO_Reference_Code defines the hierarchy used for the defaults for the following fields. The WO_Reference_Code is either for a Job or a Site within Spectrum.

o AR_Terms_Code o Sales_Tax_Code o Taxable_Flag o GL_Department – site specific only. See help files for logic. o Cost_Center o Material_Price_Level o Price_Level o Markup_Code – site specific only. See help files for logic. o Sales_Person – see help files for logic.

The Dispatch_Status_Code status type controls the multiple dates that can be defined. Cost centers will validate against the Cost Center Maintenance Table and follow the standard

WO_Reference_Code hierarchy (i.e., Job vs. Site work order). Cost Center information will only be allowed in if Company is set to Pending or Yes status.





If blank defaults from Authorization ID.


C WO_Number Work Order number Text 10

If left blank then uses next number on Work Order Installation. If defined and exists change data.

D WO_Reference_Code For Site or Job? Text 1 S(ite) or J(ob)

E WO_Job_Number Site code / Job number Text 10

Validates based on WO_Reference_Code

Work Order Site File Maintenance or Job File Maintenance

F WO_Job_Division Work Order Type Text 5

Required if creating new Work Order Header unless default exists for Site specific work orders. Type must contain a non-direct cost flag for Site specific and a direct cost flag for Job specific Work Orders. Field will update if WO_Number exists.

Work Order Type Maintenance

G Bill_Customer_Code Customer Text 10

Required if creating new Work Order Header. Field will update if WO_Number exists.


H Contract_Number Service contract Text 10

For Site specific Work Orders

Service Contract Maintenance

I Customer_PO_Number Customer P.O. Text 25

J Customer_Job Customer's job Text 10

For Site specific Work Orders. Defaults from Site if defined. No validation

K WO_Phone1 Phone 1 Text 14

Formatted e.g., (206) 555-1212 or 123-123-1224 or 123-1233 or 1231231235.Defaults from Site/Job or Customer if left blank.

L WO_Phone2 Phone 2 Text 14

Formatted e.g., (206) 555-1212 or 123-123-1224 or 123-1233 or 1231231235.Defaults




from Site/Job or Customer if left blank.

M Bill_Contract Contact note Text 20

N Zone Zone Text 3 Defaults from Site if defined.

Work Order Zone Maintenance File

O Priority_Code Priority Text 2

Work Order Priority Maintenance

P WO_Case_Type Case type Text 10 Defaults from Site if defined.

Case Type Maintenance

Q Price_Type Price method Text 1

F(lat Rate) or T(+M). If blank use Work Order Installation default.

R Total_Quote_Amount Quote Numeric 10 Positive numbers only.

S Projected_Hours Quote Hours Numeric 8 Positive numbers only.

T Est_Arrival Est. arrival Text 15

U Dispatch_Status_Code Dispatch code status Text 1

Dispatch Status Codes

V Summary_Description

Work summary (customer request) Text 250

W Ordered_Date Ordered date Date 10 Text format for import MM/DD/CCYY.

X Time_Entered Ordered time Numeric 6

Format HHMMSS. Hours cannot exceed 24, minutes and seconds cannot exceed 59.

Y Requested_Date Requested date Date 10


Z Estimated_Complete_Time

Requested time Numeric 6


AA Scheduled_Start_Date Scheduled date Date 10


AB Scheduled_Start_Time Scheduled time Numeric 6





AC Date_Assigned Assigned date Date 10 Text format for import MM/DD/CCYY

AD Time_Assigned Assigned time Numeric 6


AE Arrival_Date Arrived date Date 10 Text format for import MM/DD/CCYY

AF Arrival_Time Arrived time Numeric 6


AG Complete_Date Finished date Date 10 Text format for import MM/DD/CCYY

Must have a Dispatch code status type of Finished to be populated

AH Complete_Time Finished time Numeric 8


Must have a Dispatch code status type of Finished to be populated

AI Lead_Source Lead source Text 15

Required if the Work Order Installation option is selected. Defaults from Site if defined.

Lead Source Maintenance

AJ Sales_Person Salesperson Text 3

Defaults from Service Contract then Customer if left blank based on the WO_Reference_Code defined.

Salesperson Code Maintenance

AK Taken_By Taken by Text 3

If blank then default the services operator code.

AL AR_Terms_Code Terms code Text 1

If blank then default from WO_Reference_Code defined hierarchy.

Customer Term Code Maintenance

AM Sales_Tax_Code Sales tax code Text 15

If blank then default from WO_Reference_Code defined hierarchy. Defaults from Site if defined.

A/R Sales Tax Code Maintenance




AN Taxable_Flag Taxable? Text 1

(Y)es or (N)o only. If blank then default from WO_Reference_Code defined hierarchy.

AO GL_Department G/L department Text 5

Site work order specific field. Defaults from Work Order Type File Maintenance. Required if Work Order Type is not defined.

WO GL Department Maintenance and Work Order Type definitions.

AP Cost_Center Cost center Text 10

Hierarchy defined based on the WO_Reference_Code field.

Cost Center Maintenance. Job and Customer Cost Center. Service Contract, WO Site and Customer Cost Center.

AQ Billto_Code Alternate Bill-to code Text 4

Defaults from Site if blank. Must be valid for the defined Customer Code.

Customer Bill-to Address Maintenance

AR Override_ERO_Markup Override markup % Numeric 6

Positive numbers only. Format XXX.XX%

AS Material_Price_Level Material level Numeric 1

1 - 5 only. If blank then default from WO_Reference_Code defined hierarchy.

AT Price_Level Labor level Numeric 1

1 - 5 only. If blank then default from WO_Reference_Code defined hierarchy.

AU Markup_Code Non-stock markup Text 10

Site work order specific field. If blank then follows standard spectrum hierarchy.

Non-stock Markup File Maintenance


Work Order Header – User-Defined Field

Web Service name = UpdateWOHeader_UDF – Change Work Order Header - UDF

Assumptions and Dependencies The Work Order module must be set up. The Work Order number must exist in the defined Company code. The Work Order user-defined fields need to be defined in Spectrum. The Work Order Header-UDF Web Service adds user-defined fields (UDF) information to an

existing Work Order. The Authorized ID must have the user-defined fields defined, or mapped for this Web Service. Any field that is left blank will not be updated in Spectrum. The service does not delete values





Valid Company in Spectrum.


Valid Work Order number must exist for the defined Company Code.






















M UDF10



N UDF11



O UDF12



P UDF13



Q UDF14



R UDF15



S UDF16



T UDF17



U UDF18



V UDF19



W UDF20




Work Order Header Notes

Web Service name = WOHeaderNotes – Work Order Header Notes

Assumptions and Dependencies If Company_Code is blank then use the Authorization ID default value. The WO_Number and Notes_Topic must exist in order to add the notes. The Work Order Header Notes web service has an option to append to the current Note Topic.








Valid Work Order number must exist for the defined Company Code.

D Notes_Topic Notes Topic Text 20 Work Order Note Topics Maintenance





Work Order Labor Cost

Web Service name = AddWOLaborCost – Add Work Order Labor Cost

Underlying File Maintenance Prior to importing Work Order Labor Cost information, the following file maintenance areas must be completed:

Work Order Installation screen Payroll Installation screen Job Cost | Jobs Job Cost | Job Phase Job Cost | Cost Type File Maintenance Payroll | Employee Maintenance Payroll | Union File Maintenance (if applicable) Payroll | Wage Code File Maintenance (if applicable) Payroll | Worker’s Compensation Code Maintenance Payroll | Tax Table Maintenance Equipment Control | Equipment Maintenance (if applicable) Service Contract | Service Contract (if applicable) Work Order | Work Order Work Order | G/L Department Work Order | Site File Maintenance (if applicable) Work Order | Site Equipment (if applicable) Work Order | Site Equipment Component (if applicable) Work Order | Tasks (if applicable) Work Order | Technicians Work Order | Manufacturer

Assumptions and Dependencies The WO Labor Cost service adds Work Order Labor Cost transaction. If the Company_Code is blank then use the Authorization ID default value. The Web Service will not create new Phase or Site Equipment/Components automatically; therefore

the codes defined in the web services must exist to add the transaction. To add multiple transactions to a Work Order the Company Code, Work Order and Technician must

be defined for each record along with the new data. The defined Work Order will dictate what fields will be used based on the type of the Work Order (Site

or Job). The Pay type used allows access to the various fields. Equipment pay types allow access to the

Equipment fields for both Site and Job Work Orders. The EU (Equipment Usage) pay type makes the following fields unavailable for a Site Work Order:

o Bill_Rate o Bill_Manufacturer o Mfg_Code o Mfg_Hours_Billed

The Job_Number, Phase and Cost_Type combination must exist and not have a completed status for a Job Work Order.

The Technician field validates to an existing Employee setup in the Payroll module or as a Work Order Technician in the Work Order module.

The Payroll fields will follow standard Spectrum default logic based on type of Work Order. See standard Spectrum Help files for logic.

This Web Service will ignore the defined Workflow process in Spectrum.







C WO_Number Work Order Text 10 Work Order Entry

D Employee_Code Technician Text 11 Active status only

Technician Maintenance or Employee Maintenance

E Pay_Type Pay Type Text 2

(R)egular; (O)vertime; (D)ouble time;(SR)-Special rate; (ER)-Equipment-Regular; (EO)-Equipment-Overtime; (ED)-Equipment-Double time and (EU)-Equipment usage.

F Time_Card_Date Work date Date 10

Enter as: MM/DD/CCYY (i.e. 01/05/2010).

Within P/R processing date range

G Time_In Time in Text 5

Military time. Format = HHMM or HH:MM Example = 1602 or 16:02

H Time_Out Time out Text 5

Military time. Format = HHMM or HH:MM Example = 1602 or 16:02

I Hours Hours Numeri

c 8

Calculated if Time_In and Time_Out is defined and required if are blank. Allows negatives. Format = -4.2

J GL_Department G/L department Text 5 Defaults from Work Order Header.

Work Order G/L Department File Maintenance

K Work_Task Task Text 15 Work Order Task

L Task_Complete Task completed? Text 1

Y(es) or N(o). If blank then defaults to N.




M WO_Site_Equipment Work Order Site Equipment Text 8

Required if Work Order Installation option is selected for Site WO.


N Component_Number

Work Order Site Equipment Component Text 2


Work Order Site Equipment Component

O Contract_Number Contract Text 10

Service Contract File Maintenance

P Bill_Customer Bill customer for this entry? Text 1


For EU transactions on a Site WO defaults to Y and cannot be changed.

Q Tax_Flag

Taxable on customer invoice? / Taxable? Text 1

Y(es) or N(o). If blank then defaults to N. Ignore if Bill_Customer = N on Site WO.

R Hours_Billed

Customer Billing hours hours / Bill hours

Numeric 8

Negative numbers allowed. Format = -4.2

S Labor_Billing_Code Bill code Text 10 Labor Billing Code

T Bill_Rate Customer Billing rate

Numeric 9

Positive numbers only. Format = 4.3 Ignore if Pay_Type = EU on Site WO.

U Bill_Manufacturer

Warranty: bill manufacturer for this labor? Text 1

Y(es) or N(o). If blank then defaults to N. **See Assumption and Dependencies.

V Mfg_Tax_Flag

Warranty: taxable on manufacturer invoice? Text 1


W Mfg_Code Warranty Manufacturer Text 10

Required when Bill_Manufacturer is Y(es).

Work Order Manufacturer

X Mfg_Hours_Billed Warranty Billing hours

Numeric 8


Y Mfg_Bill_Rate Warranty Billing rate

Numeric 8


Z Work_State State / Province Text 10 Required for a Job Work Order. **See





Assumptions and Dependencies

AA Work_County County Text 10 **See Assumptions and Dependencies


AB Work_Locality Local Text 10 **See Assumptions and Dependencies


AC Worker_Comp_Code Worker's comp Text 6 **See Assumptions and Dependencies

Worker's Compensation Code Maintenance File

AD Pay_Group_Code Pay group Text 6 **See Assumptions and Dependencies Pay Groups

AE Wage_Code Wage Code Text 10 **See Assumptions and Dependencies

Union / Wage code combination

AF Union_Code Union Text 10 **See Assumptions and Dependencies Union Code

AG Pay_Rate_Code Level Text 1 1 - 9 only.

AH Phase_Code Phase Text 20

Required for Job Work Order. Must exist on the Job. Phase

AI Cost_Type Cost type Text 3

Required for Job Work Order. Phase/Cost type combination must exist on the Job. Cost Type

AJ Equipment_Code Co. Equipment / Equipment Text 10

Required for Equipment Pay types. **See Assumptions and Dependencies

Equipment Maintenance

AK Equipment_Rate_Type

Equipment rate type Text 1

(H)ourly, (D)aily, (W)eekly, or (M)onthly **See Assumptions and Dependencies

AL Equipment_Hours Equipment hours Numeri

c 8

Negative numbers allowed. Format = -4.2 **See Assumptions and Dependencies

AM Equipment_Bill_Hours

Equipment Bill hours

Numeric 8

Negative numbers allowed. Format = -4.2 **See Assumptions and Dependencies

AN Equipment_Bill_Rate Equipment Bill rate

Numeric 8







Work Order Material Cost

Web Service name = AddWOMaterialCost – Add Work Order Material Cost

Underlying File Maintenance Prior to importing Work Order Material Cost information, the following file maintenance areas must be completed:

Work Order Installation screen Job Cost | Jobs Job Cost | Job Phase Job Cost | Cost Type File Maintenance Inventory Control | Inventory Items Maintenance Inventory Control | Warehouse Service Contract | Service Contract (if applicable) Work Order | Work Order Work Order | G/L Department Work Order | Site File Maintenance (if applicable) Work Order | Site Equipment (if applicable) Work Order | Site Equipment Component (if applicable) Work Order | Task (if applicable) Work Order | Manufacturer

Assumptions and Dependencies The WO Material Cost service adds Work Order Material Cost transaction. If the Company_Code is blank then use the Authorization ID default value. The Web Service will not create new Item, Phase or Site Equipment/Components automatically;

therefore the codes defined in the web services must exist to add the transaction. To add multiple transactions to a Work Order the Company Code, Work Order and Item Code

must be defined for each record along with the new data. The defined Work Order will dictate what fields will be used based on the type of the Work Order

(Site or Job). Warranty Manufacturer fields

o The Component field must be defined in order to allow access to the Warranty information for a Site Work Order.

o If the Bill_Manufacturer field is N then ignore all other Warranty Manufacturer data defined.

If Spectrum Tasks are used then their defined logic will be applied. A non-stock item can be created using the standard Spectrum logic (type a ! before entering an

item code). See the standard Spectrum Help files for assistance. The Job_Number, Phase and Cost_Type combination must exist and not have a completed

status for a Job Work Order. If the Extension field is defined, then the Unit_Price value will be recalculated and ignores any

value defined for the Unit_Price field. The SC_Contract field will default if defined on the Work Order. If no Service Contract is defined

on the Site Work Order then a valid Contract defined on the Site will be allowed. The Web Service follows standard Cost Center logic. See the standard Spectrum Help files for

logic. This Web Service will ignore the defined Workflow process in Spectrum. Any field that is left blank will not be updated in Spectrum. The service does not delete values








D Item_Code Item Code Text 15

**See Assumptions and Dependencies for Non-Stock Items Item Maintenance

E Item_Description Item Description Text 35

Used for non-stock items. Defaults from Item_Code if valid. Can overwrite on Job Work Order.

F Warehouse_Code Warehouse Text 10 Ignore if non-stock item.


G Quantity_Used Quantity Numeri

c 11


H Unit_Of_Measure Unit of Measure Text 2

Defaults from Item_Code if valid. **See Assumptions and Dependencies.

I GL_Department G/L department Text 5 Defaults from Work Order Header.


J Work_Task Task Text 15 Work Order Task

K Task_Complete Task completed? Text 1


L WO_Site_Equipment Work Order Site Equipment Text 8



M Component_Number


Required if Work Order Installation option is selected for Site WO. **See Assumptions and Dependencies.


N SC_Contract Contract Text 10

If defined on the Work Order then only allows the defined SC_Contract. Otherwise is valid





if defined on the Site.

O Bill_Customer Bill customer for this material? Text 1

Y(es) or N(o). Defined Work_Task impacts this option. If Y then Extension field is created.

P Tax_Flag Taxable on customer invoice? / Taxable? Text 1


Q Show_Invoice_Detail Show this item on A/R invoice in detail? Text 1


R Unit_Cost Standard Cost/Unit Cost

Numeric 12

Negative numbers allowed. Format = -8.2 Used for non-stock items only. **See Assumptions and Dependencies.

S Unit_Price Unit Price/Price Numeri

c 13

Negative numbers allowed. Format = -9.2 Field defaults for Site type WO within Spectrum with the best price but can be overwritten.

T Extension Invoice extension Numeri

c 13

Negative numbers allowed. Format = -9.2 If defined then Unit_Price will be recalculated. If left blank then will be calculated.

U Bill_Manufacturer

Warranty: bill manufacturer for this material? Text 1


V Mfg_Tax_Flag Warranty: taxable on manufacturer invoice? Text 1





W Mfg_Code Warranty Manufacturer Text 10

**See Assumption and Dependencies.

Work Order Manufacturer

X Mfg_Unit_Price Warranty Billing rate Numeri

c 13

Negative numbers allowed. Format = -9.2 **See Assumption and Dependencies.

Y Phase_Code Phase Text 20


Z Cost_Type Cost type Text 3



Work Order Other Charges

Web Service name = AddWOOtherCharges – Add Work Order Other Charges

Underlying File Maintenance Prior to importing Work Order Other Charges information, the following file maintenance areas must be completed:

Work Order Installation screen Job Cost | Jobs Job Cost | Job Phase Job Cost | Cost Type File Maintenance Service Contract | Service Contract (if applicable) Work Order | Work Order Work Order | Other Charges Work Order | G/L Department Work Order | Site File Maintenance (if applicable) Work Order | Site Equipment (if applicable) Work Order | Site Equipment Component (if applicable) Work Order | Task (if applicable)

Assumptions and Dependencies The WO Other Charges Cost service adds Work Order Charges Cost transaction. If the Company_Code is blank then use the Authorization ID default value. The Web Service will not create new phase or Site Equipment/Components automatically; therefore the

codes defined in the web services must exist to add the transaction. To add multiple transactions to a Work Order the Company Code, Work Order and Other Charge Item

must be defined for each record along with the new data. The defined Work Order will dictate what fields will be used based on the type of the Work Order (Site or

Job). The Other_Cost_Item field

o The Taxable flag defaults from the Other Charge Item setup if left blank. o The rate type controls what fields are allowed to be updated or allowed access to. o The rate type ‘Percent of Cost’ uses the labor hours defined for the Work Order to do it’s

calculations. Therefore a ‘locking’ error will appear if someone is reviewing or is sitting in the screen that could prevent the creation of the current record.

o The rate type defined on the Other Charges Item controls if the Cost_Of_Sales_Amount and Sell_Price fields are defined or calculated. The web service allows these fields to be defined.

o The Work Order’s defined Price Method (Flat Rate or TM) impacts what information is allowed based on the Other Item code.

Impacts the default logic. Impacts what fields can be modified

The Contract_Number will default from the Work Order Header if defined. However the standard Spectrum logic for the defined Equipment will control it if the field will be used.

If Spectrum Tasks are used then their defined logic will be applied and included in the Cost_Of_Sales_Amount and Sell_Price fields.

The Job_Number, Phase and Cost_Type combination must exist and not have a completed status for a Job Work Order.

The Web Service follows standard Cost Center logic. See the standard Spectrum Help files for logic. This Web Service will ignore the defined Workflow process in Spectrum. Any field that is left blank will not be updated in Spectrum. The service does not delete values that exist in








D Other_Cost_Item Item Code/Other Charge Code Text 15


Work Order Other Charges Maintenance

E Description Description Text 35

F GL_Department G/L department Text 5

Defaults from Work Order Header if defined.


G Work_Task Task Text 15 Work Order Task

H Task_Complete Task completed? Text 1


I WO_Site_Equipment Work Order Site Equipment Text 10



J Component_Number




K Contract_Number Contract Text 10

Defaults from Work Order Header if defined. **See Assumptions and Dependencies.


L Taxable_Flag Taxable on customer invoice? / Taxable? Text 1

Y(es) or N(o). Defaults based on the Other_Cost_Item setup.

M Cost_Of_Sales_Amount Cost Amount/Sell Price

Numeric 13

Negative numbers allowed. Format = -9.2 **See Assumptions and Dependencies.

N Sell_Price Invoice extension/ Sell price

Numeric 13

Negative numbers allowed. Format = -9.2 **See Assumptions and Dependencies.




O Phase_Code Phase Text 20


P Cost_Type Cost type Text 3


Data Exchange Module Web Services Manual - cdp-inc.com · PDF filethem prior to updating to Spectrum. User-Defined Fields User-defined fields (UDF) allow the importing of additional

Documents