Skip to content

Commit

Permalink
docs: add settings docs and screen shots
Browse files Browse the repository at this point in the history
  • Loading branch information
HKuz authored and agritheory committed Aug 26, 2022
1 parent 0b9ee06 commit c56f917
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 1 deletion.
Binary file added docs/assets/SettingsDefaultScreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/SettingsList.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/VoucherGroup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 47 additions & 1 deletion docs/settings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
# Check Run Settings

[TODO]
A `Check Run Setting` entry determines the behavior in a check run for a specific bank account/payable account combination. You will need to confirm separate settings for every bank account-payable account combination that you plan to use in a check run.

![Screen shot of the Check Run Settings listview with two entries - one for the Local Bank and Payroll Payable combination and the other for the Local Bank and Accounts Payable combination.](./assets/SettingsList.png)

If the system doesn't find settings for the account combination you're using in an initiated check run, it will automatically take you to the settings page to confirm the options. Alternatively, you can access the setting list directly by searching for "Check Run Settings List" in the AwesomeBar and clicking the `Add Check Run Settings` button.

![Screen shot showing the default settings for one Bank Account and Payable Account combination. A description of each setting and its default value is listed below.](./assets/SettingsDefaultScreen.png)

- **Include Purchase Invoices:**
- Selected by default
- Indicates whether or not purchase invoices are included in a check run
- **Include Journal Entries:**
- Selected by default
- Indicates whether or not journal entries are included in a check run. For example, the demo data has a journal entry for payroll taxes owed to the local tax authority - this will only show in a check run if this setting is selected
- **Include Expense Claims:**
- Selected by default
- Indicates whether or not expense claims are included in a check run
- See the [configuration page](./configuration.md) for instructions on how to set up a default mode of payment, bank, and bank account for an `Employee`
- **Pre-Check Overdue Items:**
- Unselected by default
- Indicates whether the "Pay" checkbox is pre-selected for any items whose Due Date falls before the check run's Posting Date
- **Allow Cancellation:**
- Unselected by default
- Indicates whether or not a user can cancel a check run. If selected and a user cancels a check run, the system will remove the reference to the check run document name in all payment entries that were made via the run, but it will not cancel the payment entries themselves
- **Cascade Cancellation:**
- Unselected by default (it is not recommended to select this option!)
- Indicates whether or not the system will cancel all payment entries associated with a check run if the check run is cancelled
- **Number of Invoices per Voucher:**
- Default value shows 0, which tells the system this setting is unmodified and it will use 5 invoices per voucher
- This setting is an upper limit for the number of invoices per party to group into each voucher to that party
- The screen shot below shows the output of a submitted check run where the Number of Invoices per Voucher setting was set to 2. Out of the four invoices paid to Exceptional Grid, they are grouped so two are paid under one voucher, then the other two are paid under a different voucher

![Check run output table showing a row for eight invoices paid (two for AgriTheory, two for Cooperative Ag Finance, and four for Exception Grid). The first two Exceptional Grid invoices have Check Reference Number ACC-PAY-2022-00003 and the next set of two invoices have Check Reference Number ACC-PAY-2022-00004. They were split into different vouchers because the setting limited two invoices per voucher.](./assets/VoucherGroup.png)

- **ACH File Extension:**
- Default value is "ach"
- A check run automatically generates an ACH file if any Mode of Payment options used had a type of "Electronic". This setting is a text field to indicate the file extension the system will use when it creates these files. Your banking institution may require a certain extension
- See the [configuration page](./configuration.md) for instructions on how to indicate a `Mode of Payment` is an electronic bank transfer
- **ACH Service Class Code:**
- Default is 200
- Options include 200 (mixed debits and credits), 220 (credits only), and 225 (debits only). This is a mandatory value for fields in the ACH file and should reflect the nature of your electronic bank transfer payments
- **ACH Standard Class Code:**
- Default is PPD (Prearranged Payment and Deposit Entry)
- PPD is the only supported standard entry class code at this time
- **ACH Description:**
- Default is blank
- Optional field to add a description to ACH files

0 comments on commit c56f917

Please sign in to comment.