Skip to content

Commit

Permalink
chore: conform capitalization
Browse files Browse the repository at this point in the history
  • Loading branch information
HKuz authored and agritheory committed Nov 16, 2022
1 parent 94551f7 commit b66019f
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/achgeneration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

For electronic bank transfers, banking institutions require specifically-formatted plain-text files to encode all necessary information. This includes data about the type of payment, the parties, their bank accounts, and payment amounts. These files conform to Automated Clearing House (ACH) standards, which is an electronic-funds transfer system run by the National Automated Clearing House Association (NACHA). ACH files are intended to represent electronic inter-bank transactions.

After submission, a check run will automatically generate this file, but only if the run includes payments using an "Electronic" Mode of Payment. See the [configuration page](./configuration.md) for details on how to set the `Mode of Payment` `type` field to mark it as an electronic bank transfer.
After submission, a Check Run will automatically generate this file, but only if the run includes payments using an "Electronic" Mode of Payment. See the [configuration page](./configuration.md) for details on how to set the `Mode of Payment` `type` field to mark it as an electronic bank transfer.

The system defaults to using the "ach" file extension, but you can change this as needed in [Check Run Settings](./settings.md). The settings page also includes options to set two other mandatory fields in an ACH file:

Expand Down
12 changes: 6 additions & 6 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## 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.
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.

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 `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.
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.

| Type | Suggested Usage |
|---|---|
Expand All @@ -29,22 +29,22 @@ Only Modes of Payment marked as "Electronic" will be included in an ACH file. Cr

## 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.
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.

![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)
![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)

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.
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)
16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Check Run Documentation

The Check Run application extends ERPNext[^1] with several payables-related utilities. These include check run (a single-page payment mechanism), check printing, and a bank-friendly report.
The Check Run application extends ERPNext[^1] with several payables-related utilities. These include Check Run (a single-page payment mechanism), check printing, and a bank-friendly report.

The check run feature collects all outstanding payables for a given company and account head. It defaults to returning payables up to the current date, but this can be adjusted as needed. The user then selects the invoices to pay and the payment method. On submission, the form creates payment entries that post against the specified bank account, and gives the user the option to print checks.
The Check Run feature collects all outstanding payables for a given company and account head. It defaults to returning payables up to the current date, but this can be adjusted as needed. The user then selects the invoices to pay and the payment method. On submission, the form creates payment entries that post against the specified bank account, and gives the user the option to print checks.

## Installation, Configuration, Settings, and Permissions

Expand All @@ -15,19 +15,19 @@ There is some required prerequisite setup to get the Check Run application up an

## Check Run Quick Start

To initiate a check run, search for "Check Run List" in the AwesomeBar, and click the `Add Check Run` button. This opens a dialogue box where the user must select the company, the bank account from which to make the payments, and the payables account head.
To initiate a Check Run, search for "Check Run List" in the AwesomeBar, and click the `Add Check Run` button. This opens a dialogue box where the user must select the company, the bank account from which to make the payments, and the payables account head.

<markdown-tip>
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>
</markdown-tip>

![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)

The check run then returns a list of all outstanding payables for the given account. The report shows the party, the invoice document name, the outstanding amount, and the due date. This screen also allows the user to edit the parameters of the run as needed, including the end date, the posting date, and the initial check number.
The Check Run then returns a list of all outstanding payables for the given account. The report shows the party, the invoice document name, the outstanding amount, and the due date. This screen also allows the user to edit the parameters of the run as needed, including the end date, the posting date, and the initial check number.

![Check run parameters and results. The user can edit the Check Run End Date, Posting Date, Initial Check Number, Company, Paid From (Bank Account), and Accounts Payable fields. The Beginning Bank Account Balance, Final Check Number, and Amount in Check Run are calculated. The table shows a list of outstanding payables, with columns for Party, Document, Document Date, Mode of Payment, Outstanding Amount, Due Date, and a check box to Pay.](./assets/CheckRunScreen.png)
![Check Run parameters and results. The user can edit the Check Run End Date, Posting Date, Initial Check Number, Company, Paid From (Bank Account), and Accounts Payable fields. The Beginning Bank Account Balance, Final Check Number, and Amount in Check Run are calculated. The table shows a list of outstanding payables, with columns for Party, Document, Document Date, Mode of Payment, Outstanding Amount, Due Date, and a check box to Pay.](./assets/CheckRunScreen.png)

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.
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.

<markdown-tip>

Expand All @@ -41,9 +41,9 @@ This view supports the same keyboard shortcuts as the listview in Frappe.

![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 for this to work properly) and save a PDF.
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 for this to work properly) and save a PDF.

![Screen shot showing buttons with available actions after the check run successfully submits. The status shows "Ready to Print", and there are buttons to "Download Checks" and "Download NACHA File".](./assets/PostSubmissionOptions.png)
![Screen shot showing buttons with available actions after the Check Run successfully submits. The status shows "Ready to Print", and there are buttons to "Download Checks" and "Download NACHA File".](./assets/PostSubmissionOptions.png)

Individual payment entries are linked with a Check Run. You can set the number of invoices paid per voucher to a party in [Check Run Settings](./settings.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/permissions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Default Permissions and Workflow

It's strongly recommended that you set system permissions to limit which users can see and execute a check run. The only permission the application enforces is that a user must have a permission level in ERPNext to create payment entries in order to perform a check run. Additionally, only the first user to access a draft check run doctype can edit it.
It's strongly recommended that you set system permissions to limit which users can see and execute a Check Run. The only permission the application enforces is that a user must have a permission level in ERPNext to create payment entries in order to perform a Check Run. Additionally, only the first user to access a draft Check Run doctype can edit it.

See the [ERPNext documentation page](https://docs.erpnext.com/docs/v13/user/manual/en/setting-up/users-and-permissions) for more information about user and role permissions.

Expand Down
2 changes: 1 addition & 1 deletion docs/positivepay.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Positive Pay Report

The check run application includes a new Positive Pay report. This report generates a bank-friendly summary of check payments for a given bank account and period.
The Check Run application includes a new Positive Pay report. This report generates a bank-friendly summary of check payments for a given bank account and period.

To access the report, type "Report Positive Pay" into the AwesomeBar. Enter the bank account, start date, and end date. The report will display a table showing the check date, check number, and party name for all checks against the bank account within the specified time period.

Expand Down
2 changes: 1 addition & 1 deletion docs/renderpdfsequence.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Render PDF Sequence

After a check run has been submitted, it will begin rendering the Checks it needs to print. Even on powerful systems it can take several minutes to render checks. The check run creates a new Folder in the File Manager for PDFs. These will be linked to the check run but removed when the user confirms they have printed correctly.
After a Check Run has been submitted, it will begin rendering the Checks it needs to print. Even on powerful systems it can take several minutes to render checks. The Check Run creates a new Folder in the File Manager for PDFs. These will be linked to the Check Run but removed when the user confirms they have printed correctly.

![Screen shot showing options to "Confirm Print" if the Checks printed properly, or "Re-Print Checks" if not.](./assets/PrintConfirmation.png)
Loading

0 comments on commit b66019f

Please sign in to comment.