Skip to content

Commit

Permalink
docs: edit config information
Browse files Browse the repository at this point in the history
  • Loading branch information
HKuz authored and agritheory committed Aug 26, 2022
1 parent c56f917 commit eabf6d0
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Configuration

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

## Banks and Bank Accounts

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.
Expand All @@ -12,42 +10,42 @@ For parties receiving payment via an electronic bank transfer, their `Bank` and

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:
For any existing or new `Mode of Payment` document, you can specify one of the following `type` options in the table below. The "Bank" and "Electronic" options are special, and will change the behavior of a check run. Usage suggestions are included with each option.

- Cash
- Bank
- General
- Phone
- Electronic
| Type | Suggested Usage |
|---|---|
| Bank | Payments requiring a physical check |
| Cash | Cash payments |
| Electronic | ACH electronic fund transfers, direct deposit |
| General | Bank drafts, wire transfers, credit cards |
| Phone | Phone payments |

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.
Only Modes of Payment marked as "Electronic" will be included in an 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.
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.

![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)
![Screen shot of details from 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.
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.

![Supplier doctype detail showing the Credit Limit section expanded with new fields for "Supplier Default Mode of Payment", "Bank", and "Bank Account".](./assets/ConfigSupplier.png)
![Supplier doctype detail showing the Credit Limit section expanded with new fields for Supplier Default Mode of Payment, Bank, and Bank Account.](./assets/ConfigSupplier.png)

The "Bank" and "Bank Account" fields are retrieved by the system to facilitate payments when the mode of payment is an electronic type.
The `Bank` and `Bank Account` fields are retrieved by the system to facilitate payments when the mode of payment is an electronic type.

## Employee Configuration

Similarly, the `Employee` doctype includes new "Mode of Payment", "Bank", and "Bank Account" fields in the "Salary Details" section. The "Mode of Payment" value will show in a check run, and the system uses the "Bank" and "Bank Account" values for electronic payments.

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

Similarly, the `Employee` doctype includes new `Mode of Payment`, `Bank`, and `Bank Account` fields in the "Salary Details" section. The `Mode of Payment` value will show in a check run, and the system uses the `Bank` and `Bank Account` values for electronic payments.

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

0 comments on commit eabf6d0

Please sign in to comment.