This commit is contained in:
2022-01-08 20:24:34 +00:00
parent d79b8b176e
commit 0eafc1cd33
3 changed files with 143 additions and 19 deletions

View File

@@ -31,11 +31,21 @@ Service rates are accessed in the following ways:
## How service rates work
### Selecting
Service rates are selected on [Work orders](svc-workorders.md), [Quotes](svc-quotes.md) and [Preventive Maintenance](svc-pms.md) orders to indicate a charge for service provided.
Service rates Cost and Price fields are **locked** to prevent editing once they are used on another object in order to protect the historical record. This means that you must make a new service rate if the price or cost needs to be changed.
### Locked when used
When a rate is retired it should be set to inactive by un-checking it's Active checkbox and a new rate created to take it's place. Rate names must be unique so for example if a rate changes yearly then the old rate might be called "In-shop service 2022" and the new rate called "In shop service 2023" to ensure names are unique and recognized by users.
Service rates Cost and Price fields are **locked** to prevent editing once they are used on another object in order to protect the historical record. This means that you must make a new service rate if the price or cost needs to be changed.
### Retiring
When a rate is retired it should be set to inactive by un-checking it's Active checkbox and a new rate created to take it's place. Rate names must be unique so for example if a rate changes yearly then the old rate might be called "In-shop service 2022" and the new rate called "In shop service 2023" to ensure names are unique and recognized by users.
### Contract service rates
Service rates can be created that are only available to specific [Contracts](svc-contracts.md).
## Service rate data table
@@ -47,7 +57,7 @@ The Service Rate edit form contains all the [standard edit form](ay-start-edit-f
#### Name
This is the name of the rate as it's displayed in forms and reports. A rate name must be unique from all other service rates entered. Remember this is the Name that Customers will see on reports if provided to them.
This is the name of the rate as it's displayed in forms and reports. A rate name must be unique from all other service rates entered. Remember this is the Name that Customers will see on reports if provided to them.
#### Account number
@@ -59,7 +69,7 @@ Charge to customer per unit for this service. [Currency](ay-start-data-types.md#
#### Cost
Internal cost per unit to provide this service. [Currency](ay-start-data-types.md#currency) field. This field is **locked** once the rate is used in AyaNova to preserve historical data.
Internal cost per unit to provide this service. [Currency](ay-start-data-types.md#currency) field. This field is **locked** once the rate is used in AyaNova to preserve historical data.
#### Unit charge description

View File

@@ -25,7 +25,6 @@ Read only access
- Sales
- Sales - restricted
## How to access Tax codes
Tax codes are accessed in the following ways:
@@ -36,16 +35,33 @@ Tax codes are accessed in the following ways:
## How Tax codes work
### Selecting
Tax codes are selected on [Purchase orders](inv-purchase-orders.md), [Work orders](svc-workorders.md), [Quotes](svc-quotes.md) and [Preventive Maintenance](svc-pms.md) orders to indicate and calculate taxes for both purchase and sales events.
### Locked when used
Tax code Percentages and Tax on Tax fields are **locked** to prevent editing once they are used on another object in order to protect the historical record. Other fields remain editable as they would not affect past record tax calculations.
After an edit and save that affects any of the calculation affecting fields the AyaNova server will check if any objects are using this Tax code and if any are found will prevent the change and report back all object types involved. Options are to remove or switch the Tax code from the existing in-use objects to be able to edit those fields or simply make a new Tax code.
When a tax code is retired it should be set to inactive by un-checking it's Active checkbox and a new active tax code created to take it's place.
### Retiring
If a tax has been selected in [Global Settings](adm-global-settings.md#default-parts-purchase-tax) as a default it can not be deleted.
When a tax rate changes a new tax code must be made to replace the previously used tax code with the now outdated rate in order to preserve historical data. The old rate must be "retired" to prevent it from being used in future.
When a tax code is retired it should be set to inactive by un-checking it's Active checkbox and a new active tax code created to take it's place. Setting to inactive prevents it from being selected on new records but still shows it on historical records.
Due to the need to replace tax codes from time to time and the requirement that Names be unique we recommend tax codes be named uniquely by appending the year they go into effect or some other system that makes sense for your needs.
### Automatic default
Tax codes can be set to default automatically (you can still change the default when necessary) in [Global Settings](adm-global-settings.md#default-parts-purchase-tax).
A default tax code can not be deleted unless it is removed as a default first.
### Not required
Tax codes are optional and not required to be used if they are not appropriate for your situation.
## Tax codes data table
@@ -65,15 +81,20 @@ This is the primary tax field and should be entered as a [percentage](ay-start-d
#### Tax B
The "B" tax is a secondary tax that can also be applied in tax calculations for situations where more than one tax is required to be used.
#### Tax on Tax
Charge to customer per unit for this service. [Currency](ay-start-data-types.md#currency) field. This field is **locked** once the rate is used in AyaNova to preserve historical data.
Tax On Tax set to checked / true indicates that when totals are calculated, Tax B is applied to the total of the item including the increase due to Tax A.
For example, if you had a tax code that was 5% for Tax A and 6% for Tax B, and the product the tax was applied to was priced at $10.00, Tax A would be $0.50 ($10.00 _ 5%) and Tax B would be $0.63 (($10.00 + $0.50 Tax A) _ 6% Tax B)
If Tax on Tax is not checked / false then each tax is calculated separately and then added to the total.
#### Active
Rates that are set to Active can be selected on new Work orders and other objects that user Tax codes.
Rates not set to Active will still show in older records but can not be selected for new records; this is how you retire a rate from use.
Taxes that are set to Active can be selected on new Work orders and other objects that user Tax codes.
Taxes not set to Active will still show in older records but can not be selected for new records; this is how you retire a rate from use.
#### Notes
@@ -94,8 +115,3 @@ Standard AyaNova object [wiki control](ay-start-form-wiki.md).
#### Attached files
Standard AyaNova object [attachments control](ay-start-form-attachments.md).
000000000000000000000000000000000000000000000000000
Notes to include in docs:
Data integrity - Tax code values are stored only in the Tax Code object and linked to by objects affected by that Tax code (e.g. Work order item labor record).

View File

@@ -1,7 +1,105 @@
# TRAVEL RATES Placeholder
# Travel rates
[UNDER CONSTRUCTION]
The Travel rates [form](ay-start-form-overview.md) is used to edit travel rates.
Notes to include in docs:
Travel rates are used to indicate charges for travel required to provide service on [Work orders](svc-workorders.md).
Data integrity - Travel rate values are stored only in the Travel rate object and linked to by objects affected by that Travel rate (e.g. Work order item travel record). If a Travel rate has been selected on another object the fields affecting price calculations are not editable (Cost, Charge etc). Other fields remain editable as they would not affect past price calculations. when saving a Travel rate with price affecting changes, the AyaNova server will check if any objects are found to be using this Travel rate and if they are it will not save but instead report back an error with all object types using this rate. Options are to remove or switch the Travel rate from the existing in-use objects to be able to edit those fields or simply make a new Travel rate.
## Authorization Roles required
This form is available to User's with the following [roles](ay-biz-admin-roles.md):
Full access
- Accounting
- Business administration
- Travel manager
Read only access
- Business administration - restricted
- Travel manager - restricted
- Travel technician
- Sales
## How to access travel rates
Travel rates are accessed in the following ways:
- From the `Accounting` navigation pane `Travel rates` item
- By clicking on the [open record icon](ay-start-form-select-list.md#opening-selected-record) any travel rate selection list on any other form where travel rates can be selected such as the Work order, Quote and Preventive Maintenance forms
- From any [data table](ay-start-form-data-tables.md) column showing travel rates such as the [Work order list](svc-workorders.md)
## How travel rates work
### Selecting
Travel rates are selected on [Work orders](svc-workorders.md), [Quotes](svc-quotes.md) and [Preventive Maintenance](svc-pms.md) orders to indicate charges for travel required to provide service.
### Locked when used
Travel rates Cost and Price fields are **locked** to prevent editing once they are used on another object in order to protect the historical record. This means that you must make a new travel rate if the price or cost needs to be changed.
### Retiring
When a rate is retired it should be set to inactive by un-checking it's Active checkbox and a new rate created to take it's place. Rate names must be unique so for example if a rate changes yearly then the old rate might be called "In-shop travel 2022" and the new rate called "In shop travel 2023" to ensure names are unique and recognized by users.
### Contract travel rates
Travel rates can be created that are only available to specific [Contracts](svc-contracts.md).
## Travel rate data table
The Travel rates [data table](ay-start-form-data-tables.md) lists all the travel rates available and data table [common menu options](ay-start-form-data-tables.md#common-menu-options).
## Travel rate edit form
The travel Rate edit form contains all the [standard edit form](ay-start-edit-forms.md) functionality and contains the following fields:
#### Name
This is the name of the rate as it's displayed in forms and reports. A rate name must be unique from all other travel rates entered. Remember this is the Name that Customers will see on reports if provided to them.
#### Account number
Optional convenience field not used by AyaNova itself.
#### Retail charge
Charge to customer per unit for this travel. [Currency](ay-start-data-types.md#currency) field. This field is **locked** once the rate is used in AyaNova to preserve historical data.
#### Cost
Internal cost per unit to provide this travel. [Currency](ay-start-data-types.md#currency) field. This field is **locked** once the rate is used in AyaNova to preserve historical data.
#### Unit charge description
This is the unit the rate is billed in for example "Miles", "Kilometers", "Hours" and will be displayed on reports as well as in the user interface.
#### Contract rate
If checked this rate will only be availble to select on Work orders with a [Contract](svc-contracts.md) with matching rates selected.
#### Active
Rates that are set to Active can be selected on new Work orders and other objects that user travel rates.
Rates not set to Active will still show in older records but can not be selected for new records; this is how you retire a rate from use.
#### Notes
Notes about this record for internal use. Notes can also be reported on if desired.
#### Custom fields
If the form has been [customized](ay-customize.md) and [custom fields](ay-start-form-custom-fields.md) enabled for this object they will display here.
#### Tags
Standard AyaNova object [tags control](ay-start-form-tags.md).
#### Wiki
Standard AyaNova object [wiki control](ay-start-form-wiki.md).
#### Attached files
Standard AyaNova object [attachments control](ay-start-form-attachments.md).