Skip to content

Commit

Permalink
docs: add and re-order config section
Browse files Browse the repository at this point in the history
  • Loading branch information
HKuz authored and agritheory committed Aug 26, 2022
1 parent bbc0a0e commit c0ac8e5
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 22 deletions.
42 changes: 26 additions & 16 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
# Configuring Mode of Payment for Employees and Suppliers
# Configuration

[TODO: any additional configuration needed for a payment method to work (like credit card)?] - yes "electronic caveat

The options that show in the dropdown for `Mode of Payment` in a check run are determined by the `Mode of Payment` documents you have created in your ERPNext site. The Check Run application includes new fields in the `Supplier` and `Employee` doctypes to specify a default `Mode of Payment`. If populated, this option will automatically show in a check run for any payables owed to that party, as demonstrated in the images below.
## Banks and Bank Accounts

![Detail of a supplier document for HIJ Telecom that shows the field for Supplier Default Mode of Payment filled in with "Check".](./assets/SupplierDefaultMoPDetail.png)
The check run feature requires at least one `Bank` and `Bank Account` defined for the Company. These can be set up under `Accounting > Bank` and `Accounting > Bank Account`, respectively.

![Detail of a check run including an invoice for HIJ Telecom where the Mode of Payment column automatically shows "Check".](./assets/CheckRunDetailBoxAroundMoP.png)
For parties receiving payment via an electronic bank transfer, their `Bank` and `Bank Account` must be in the system as well. See the sections below for configuration details for Suppliers and Employees.

## Mode of Payment

The Check Run application adds a new `type` field into the `Mode of Payment` doctype. The field helps the application properly process different types of payment methods.

For any existing or new `Mode of Payment` document, you can specify one of the following options:

- Cash
- Bank
- General
- Phone
- Electronic

Only Modes of Payment marked as "Electronic" will be included in ACH file generation. This should be reserved for methods like "ACH/EFT" or "Employee Direct Deposit". ACH files are intended to represent electronic inter-bank transactions.

<div style="font-weight: bold; font-size 140%; background-color: red; border: 1px solid red; padding-left: 0.5em;">Warning</div>
<aside style="padding: 1em; border: 1px solid red">
Only Modes of Payment marked as "Bank" will be included in the Check Print and Reprint features. Bank Drafts and Wire Transfers should not be configured as "Bank" but "General" instead.<br><br>
Only modes of Payment marked as "Electronic" will be included in ACH file. Credit Cards should not be configured as "Electronic" but should use "General" instead.
</aside>

## Default Mode of Payment

The options that show in the dropdown for `Mode of Payment` in a check run are determined by the `Mode of Payment` documents defined in an ERPNext site. The Check Run application includes new fields in the `Supplier` and `Employee` doctypes to specify a default `Mode of Payment`. If populated, this option will automatically show in a check run for any payables owed to that party, as demonstrated in the images below.

![Detail of a supplier document for HIJ Telecom that shows the field for Supplier Default Mode of Payment filled in with "Check".](./assets/SupplierDefaultMoPDetail.png)

![Detail of a check run including an invoice for HIJ Telecom where the Mode of Payment column automatically shows "Check".](./assets/CheckRunDetailBoxAroundMoP.png)

## Supplier Configuration

The `Supplier` doctype has three new fields under the "Credit Limit" section to specify the "Default Supplier Mode of Payment", "Bank", and "Bank Account". As noted above, if there is a value for the "Supplier Default Mode of Payment", it will automatically show in the check run for any invoices for that supplier.
Expand All @@ -28,16 +50,4 @@ Similarly, the `Employee` doctype includes new "Mode of Payment", "Bank", and "B

![Employee doctype detail showing the expanded Salary Details section with new fields for "Mode of Payment", "Bank", and "Bank Account".](./assets/ConfigEmployee.png)

## Mode of Payment

The Check Run application adds a new `type` field into the `Mode of Payment` doctype. The field helps the application properly process different types of payment methods.

For any existing or new `Mode of Payment` document, you can specify one of the following options:

- Cash
- Bank
- General
- Phone
- Electronic

Only Modes pf Payment marked as "Electronic" will be included in ACH file generation. This should be reserved for methods like "ACH/EFT" or "Employee Direct Deposit". ACH files are intended to represent electronic inter-bank transactions.
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The check run feature collects all outstanding payables for a given company and
See the following pages for details on installation, settings, and configuration for the Check Run application:

- [Installation Guide](./installationguide.md)
- [Configuring Mode of Payment for Employees and Suppliers](./configuration.md)
- [Configuration: Bank Accounts, Mode of Payment for Employees and Suppliers](./configuration.md)
- [Default Permissions and Workflows](./permissions.md)
- [Check Run Settings](./settings.md)

Expand All @@ -19,7 +19,7 @@ To initiate a check run, search for "Check Run List" in the AwesomeBar, and clic

<div style="font-weight: bold; font-size 140%; background-color: red; border: 1px solid red; padding-left: 0.5em;">Tip</div>
<aside style="padding: 1em; border: 1px solid red">
You can add a shortcut to the Check Run list by customizing the Accounts workspace. Instructions are hosted in the ERPNext documentation here: [Desk > Workspace > Customization](https://frappeframework.com/docs/v14/user/en/desk/workspace/customization)
You can add a shortcut to the Check Run list by customizing the Accounts workspace. Instructions are hosted in the ERPNext documentation here: <a href="https://frappeframework.com/docs/v14/user/en/desk/workspace/customization">Desk > Workspace > Customization</a>
</aside><br>

![New Check Run dialogue box showing the mandatory fields the user must fill in for Company, Paid From (Bank Account), and Accounts Payable.](./assets/InitiatingCheckRunDialogue.png)
Expand All @@ -31,17 +31,17 @@ The check run then returns a list of all outstanding payables for the given acco
The user checks which payables to pay and the mode of payment for each one. The mode of payment dropdown options will correspond to the `Mode of Payment` documents you have set up in your system. You can configure a default mode of payment for each supplier and employee that will then automatically show as the selection in a check run.

<div style="font-weight: bold; font-size 140%; background-color: red; border: 1px solid red; padding-left: 0.5em;">Tip</div>
// make this an aside component also
<aside style="padding: 1em; border: 1px solid red">

This view supports the same keyboard shortcuts as the listview in Frappe.

- The up and down arrows navigate rows
- The space bar will select or de-select a row to pay
- Once a row is focused it, typing any letter key will auto complete the Mode of Payment
- Once a row has focus, typing any letter key will auto-complete the Mode of Payment

<br>
</aside><br>

![Detail view of the dropdown menu for the mode of payment. Options include ACH/EFT, Bank Draft, Cash, Check, Credit Card, and Wire Transfer.](./assets/ModeOfPayment.png)
![Detail view of the dropdown menu for the mode of payment. Options include ACH/EFT, Bank Draft, Cash, Check, Credit Card, and Wire Transfer. The options will depend on what Mode of Payment documents are defined in the ERPNext site.](./assets/ModeOfPayment.png)

When the user submits the check run, payment entries are automatically generated for each party. The user is also given the choice to print checks [(a print format must be in the system)] and save a PDF. [Files are automatically deleted after they have been downloaded.]

Expand Down

0 comments on commit c0ac8e5

Please sign in to comment.