Skip to content

Commit

Permalink
docs: flatten directory structure
Browse files Browse the repository at this point in the history
  • Loading branch information
HKuz authored and agritheory committed Aug 26, 2022
1 parent 8e26dc9 commit 900fd2f
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 12 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/exampleprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Example Print Format: Voucher Check

[TODO: add print format to Check Run]

To take advantage of Check Run's check printing functionality, you'll want to set up a print format in ERPNext. Print formats are as unique as the organizations using ERPNext, so this voucher check print format serves as an example template. It can be a starting point from which to customize to suit your needs.
14 changes: 8 additions & 6 deletions docs/version-13/index.md → docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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 chosen 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 a specified bank account, and gives the user the option to print checks.

## Installation, Settings, and Configuration

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

Note that a user must have a permission level in ERPNext to create payment entries in order to perform a check run.

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

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

![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.](./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.]

## Additional Check Run Features

Follow the links below for more information about Check Run's features:

- [ACH generation](./achgeneration.md)
- [Render PDF sequence](./renderpdfsequence.md)
- [ACH Generation](./achgeneration.md)
- [Render PDF Sequence](./renderpdfsequence.md)
- [Positive Pay Report](./postivepay.md)
- [Example Print Format: Voucher Check](./exampleprint.md)
- [Example Data: Experimenting with Check Run Using Demo Data](./exampledata.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Launch your bench
bench start
```

Optional: install a demo Company and its data to test the Check Run module's functionality
Optional: install a [demo Company and its data](./exampledata.md) to test the Check Run module's functionality
```shell
bench execute 'check_run.test_setup.before_test'
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 0 additions & 5 deletions docs/version-13/exampleprint.md

This file was deleted.

0 comments on commit 900fd2f

Please sign in to comment.