Field Definitions: SM Agreements Form
The following is a list of field descriptions for the SM Agreements form. Many of the descriptions include links to other topics that provide additional information about or related to the topic.
Agreement
Enter a number to represent this agreement or enter N, New, or + to have the system automatically assign the next sequential number available (based on highest existing agreement numbers).
Revision
Displays the current agreement revision, showing the term and revision status. The revision represents changes to the agreement as a whole (i.e. original agreement, amendments, renewals). You can select different revisions to view, but you cannot edit the revision term or status.
When you add a new agreement, this field automatically defaults a status of Quote. Other statuses are applied by the system based on the agreement activity. The statuses applied are as follows:
Quote - Not activated. In addition to the original quote, this status will also be applied to amendments and renewals when they are first initiated, as well as to agreements or renewals that have been deactivated (see Deactivating an Agreement for more information).
Active - This status is applied to any revision (agreement, amendment, or renewal) that has been activated.
Terminated - This status is applied to any revision that is manually terminated or terminated by activation of an amendment.
Expired - This status is assigned to all agreements that have expired (i.e. passed their expiration date).
Description
Enter a description for this agreement, up to 60 characters.
Alt Agreement
Enter an alternate agreement identification number for this agreement, up to 30 characters. This will typically be the number used by your customer to track this agreement. The field is information only, and can be used for reporting purposes.
Agreement Type
Enter the agreement type for this agreement. Must be an active agreement type. Press F4 for a list of valid agreement types.
The agreement type specified here will determine the department to which costs and revenue are posted.
Entry in this field is not required when first setting up the agreement. However, you must assign an agreement type before you can activate the agreement.
Customer
Enter the SM customer to which this agreement applies. Must be an active customer. Press F4 for a list of valid SM customers.
Customer PO
Enter the PO number (provided by the customer) for this agreement. Up to 30 characters allowed.
The purchase order number specified here will default automatically on all preventative maintenance work orders generated for this agreement. May be overridden at the work order scope level (in SM Work Orders).
Effective Date
Enter the date on which this agreement became or will become effective.
Start Date
Start Date field of the Info tab on the SM Agreements form.
Enter the start date for an agreement version beginning at a time later than the effective date and prior to the expiration date.
The field is disabled for any agreement that is not Revision 1 and is still in quote form; this field is completely hidden starting with Version 2 and greater.
Expiration Date
This field is enabled for expiring agreements only (i.e. Non-Expiring Agreements box is unchecked).
Required.
Enter the expiration date for this agreement. Must be at least one day after the specified effective date.
If you checked the Auto Renew box for this agreement, the system will use this date to determine renewal eligibility when running the agreement renewal process.
Renew Through
This field is only enabled if the agreement specifies an agreement type with the Auto Renew checkbox selected (in SM Agreement Types).
Enter the date through which to renew the agreement. Date must be greater than the expiration date specified for the agreement.
Renew Markup
This field is only enabled if the agreement specifies an agreement type with the Auto Renew checkbox selected (in SM Agreement Types).
Enter the markup percent to apply when renewing the agreement. Entry is required if you entered a Renew Through date for the agreement.
Rate Template
Enter the rate template to use for work performed on a work order that is not covered by agreement pricing (typically "add-on" work). Must be an active rate template.
Budget Total
For use with Agreement Budgets.
Display only, the total budget amount for this agreement. This field is populated automatically based on the total budget amounts entered by call type/cost type category on the Budget tab.
Est. Profit Margin
For use with Agreement Budgets.
Display only, the estimated profit margin for this agreement. This field is populated automatically based on the following:
(Agreement Price + Est. Service Revenue) – Budget Total / (Agreement Price + Est. Service Revenue)
Est. Percent Markup
For use with Agreement Budgets.
Display only, the estimated percent of markup for this agreement. This field is populated automatically based on the following calculation:
(Agreement Price + Service Revenue – Budget) / Budget
Agreement Price
Enter the price for this agreement. All services listed for this agreement (on the Work Schedule tab) with a pricing type of I-Included in Agreement will be covered by this price.
The agreement price is based on the term of the agreement. For example, if you enter an agreement price of $15,000 and the agreement covers a 2-year period, the customer will be charged a total of $15,000 for the entire 2-year period.
Billing Reduction
Enter the amount by which to reduce the remaining amount to bill. Do not enter as a negative number, as this number is already assumed negative.
The system automatically adjusts the Total Remaining accordingly based on the value entered here. For example, if the Total Remaining is 2,500.00 and you enter 500.00 in this field, the new Total Remaining will be 2,000.00.
If the Total Remaining is 0.00 (e.g. this is an amendment that did not add additional pricing to the agreement service), but you want to reduce the remaining amount to bill by 500.00, entering 500.00 in this field will update the Total Remaining to -500.00.
Est. Service Revenue
Display only, the total estimated revenue for agreement services that are not included in the agreement price (i.e. have a price method other than Included in Agreement).
Matl Tax Override
Matl Tax Override drop-down list on the Info tab of the SM Agreements form.
Use this drop-down list to select the material tax default for an entire agreement.
The option selected here is used to determine the Tax Type default when entering material-related work completed for a work order (i.e. inventory lines, purchase lines for a material, and miscellaneous lines referencing an SM cost type with a Material cost type category). It is also used to determine the Tax Type default when entering material requirements and miscellaneous requirements referencing an SM cost type with a Material cost type category for agreement services, quote scopes, and work order scopes.
Blank – Select this option to use the standard tax type defaulting behavior. For taxable, billable material-related requirements or work completed, the tax type will default as Sales. For taxable, non-billable material-related requirements or work completed, the tax type will default as Use. Defaults may be overridden.
N - No Tax – Select this option to default the tax type as "blank" for material-related requirements or work completed.
S - Sales Tax Only – Select this option to default the tax type as Sales for material-related requirements or work completed. You may override the tax type, but only Sales and None options are allowed.
For Australian and Canadian companies, select this option to default the Tax Type as VAT. You may override the tax type, but only Sales and None options are allowed.
U - Use Tax Only (US companies only) – Select to default the tax type as Use for material-related requirements or work completed. You may override the tax type, but only Use and None options are allowed.
Revenue Recognition
The Revenue Recognition field on the SM Agreements form, Info tab.
If you selected the Recognize Revenue as Costs Incurred check box in SM Company Parameters, this field defaults to C - As Costs Incurred and is disabled.
If you did not select the Recognize Revenue as Costs Incurred check box in SM Company Parameters, select which option to use for recognizing revenue for this agreement:
B - As Billed - Select this option to recognize revenue once it is billed.
S - Amortize - Select this option to amortize revenue recognition for an agreement. When you select this option, the system allows you to set up an amortization schedule on the Amortization Schedule tab. For more information, see Set up an Agreement Amortization Schedule Manually.
- C - As Cost Incurred - Select this option to recognize revenue as costs are incurred when posting work orders for this agreement.
Margin
Margin field on the Info tab of the SM Agreements form.
This field is required when the Revenue Recognition type is As Costs Incurred.
Enter a mark-up percentage to apply when recognizing revenue for this agreement. During the revenue recognition process (in SM Revenue Recognize), the system will determine the revenue to recognize by applying the margin to the sum of all associated costs (that is, work completed lines posted to the agreement work order).
Invoice Format
Enter the custom report to use for printing Agreement Billing invoices for this customer. Press F4 for a list of valid custom reports.
Leave blank to use the Def. Agreement Inv. Report specified in SM Company Parameters.
Auto Schedule Trips
Auto Schedule Trips check box on the SM Agreements form.
Select this check box to have a service automatically scheduled on the Dispatch Board.
Call Type
Required.
Enter the call type for which to define a budget amount or press F4 to select from a list of valid call types.
Cost Type Category
Required.
Enter L, E, M, O, or S to specify the cost type category for which to define the budget amount or select the cost type category using the drop-down menu (accessed by clicking the down arrow). Cost type categories are as follows:
L-Labor
E-Equipment
M-Material
O-Other
S-Subcontracts
Budget Amount
Enter the budget amount for the specified call type/cost type category.
Service Budget
Display only, the total of all agreement service cost estimates for this call type / cost type category.
Total Remaining
The system displays an amount in this field based on the total price of the agreement (including periodic agreement services that are not being billed separately). If a billing schedule exists, this amount should be 0.00.
The Billing Reduction field (below) allows you to reduce the amount remaining to bill for the agreement; however, you can also reduce the amount to bill by entering the total amount to bill in this field.
For example, if the defaulted Total Remaining is 2500.00 and you want to reduce that amount by $500, enter 2,000.00 in this field and the system will automatically update the Billing Reduction field by the reduction amount (in this case, $500).
If the defaulted Total Remaining is 0.00 (e.g. this is an amendment that did not add additional pricing to the agreement), but you want to reduce the remaining amount to bill by 500.00, enter -500.00 in this field. The system will update the Billing Reduction field to $500.
Service Site
Service Site field in SM Agreements, Spot Coverage tab.
Enter the service site to cover under this agreement for spot work. Must be a valid service site for the customer specified on the agreement.
Coverage Level
Coverage Level field in SM Agreements, Spot Coverage tab.
Display only, the coverage level for the selected service site. Initially defaults as None. Once you enter coverage details in the SM Agreement Site Coverage Dtl form, the system updates this field to Coverage.
Service
Service field on the Posted Detail tab of the SM Agreements form.
This field indicates the number associated with the service that was performed for the posted revenue.
Source Co
Source Co field on the Posted Detail tab of the SM Agreements form.
This field indicates the source company for the posted revenue.
Post Month
Post Month field on the Posted Detail tab of the SM Agreements form.
This field indicates the month the revenue for this particular service was posted.
Batch Id
Batch ID field on the Posted Detail tab of the SM Agreements form.
This field indicates the batch ID for the posted revenue.
Source
Source field on the Posted Detail tab of the SM Agreements form.
This field indicates the source of the posted revenue (SM Invoice or SM Amortize).
Transaction Type
Transaction Type field on the Posted Detail tab of the SM Agreements form.
This field indicates the transaction type for the posted revenue.
GLCo
GLCo field on the Posted Detail tab of the SM Agreements form.
This field indicates the general ledger company for the posted revenue.
GL Account
GL Account field on the Posted Detail tab of the SM Agreements form.
This field indicates the general ledger account for the posted revenue.
Deferred
Deferred flag on the Posted Detail tab of the SM Agreements form.
This flag is checked when the account is the deferred revenue account from the Deferred Revenue field of the SM Departments form.
Debit
Debit field on the Posted Detail tab of the SM Agreements form.
A debit amount appears in this field if the posted revenue detail is a debit for this particular service.
Credit
Credit field on the Posted Detail tab of the SM Agreements form.
A debit amount appears in this field if the posted revenue detail is a credit for this particular service.
Revision Notes
The Revision Notes tab on the SM Agreements form.
Use this tab to enter miscellaneous notes about the selected agreement revision. The space allowance is virtually unlimited.
Notes added for a revision are specific to that revision only, meaning you can only see them when you have selected that revision. However, if notes exist for an active revision and you create an amendment, the notes are copied to the new (amendment) revision. Any further updates to notes for either revision are specific to that revision.
Add a Standard Note
Standard notes allow you to insert frequently used text into some fields in the application. This text is created and maintained using the HQ Standard Note form.
To insert a standard note into this field, right click the mouse while focus is in the field and select Standard Notes from the shortcut menu, which opens the Standard Note Copy window. Then enter the standard note to copy (or select from F4 lookup) and click OK. The system inserts the selected note into the field.
Spelling Check
You can run a spell check on any text in a form. To run a spelling check on the text in this field, click the Spelling icon on the toolbar or select
.Attachments
You can add attachments for an agreement revision via the Revision Notes tab or the Info tab. Attachments added for a revision are specific to that revision and are not accessible from any other revision of the agreement. In addition, attachments are not copied to new revisions when creating amendments or renewals.
To add attachments for a revision, place focus in the Revision Notes tab or the Info tab and right-click on the Attachments button () and select Add Attachments. Then add your attachment and save.