Repository navigation
Deposit plugin documentation - #720
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved tutorial inaccuracies can leave PostgreSQL tables missing and mislead readers about minimum-payment enforcement, request-level activation, and supported credit operations.
4 open issues
What changed in this PR
Adds documentation for recording offline invoice payments with the Deposit plugin, covering both API usage and Kaui workflows.
Changes:
- Documents installation, database setup, configuration, payment behavior, and testing.
- Adds a Kaui guide for recording deposits against account invoices.
- Links the new documentation from the Kaui guide and main navigation.
| File | Description |
|---|---|
userguide/tutorials/deposit-plugin.adoc |
Adds the Deposit plugin setup and API tutorial. |
userguide/kaui/userguide_kaui.adoc |
Includes the new Deposit section. |
userguide/kaui/includes/deposit.adoc |
Documents the Kaui deposit workflow with screenshots. |
html5/_main_toc.html.slim |
Adds the Deposit plugin navigation link. |
Review effort: Balanced
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
🟡 Changes recommended
The PostgreSQL setup instructions omit running the common table DDL after the domain definitions, leaving required deposit tables missing and causing deposit recording to fail.
2 open issues
3 resolved since last review
Review effort: Balanced
|
|
||
| NOTE: Entries with a missing or zero `paymentAmount` are skipped. Invoices are processed in the order specified in the request, and processing stops at the first error. Payments recorded for the invoices before the failing invoice are not rolled back. | ||
|
|
||
| == Partial Payments and Overpayments |
There was a problem hiding this comment.
Partial Payments, Overpayments and Refunds
|
|
||
| . https://apidocs.killbill.io/account#create-an-account[Create] a Kill Bill account. Save the **accountId** for further use. | ||
|
|
||
| . Create an https://apidocs.killbill.io/invoice#create-external-charge-s[external charge] of `500` USD on the account. Save the **invoiceNumber** of the generated invoice for further use. |
There was a problem hiding this comment.
. Create an https://apidocs.killbill.io/invoice#create-external-charge-s[external charge] of 500 USD on the account with autoCommit=true, so that the invoice is committed. Save the invoiceNumber of the generated invoice for further use.
|
|
||
| 1. Open the Deposit UI as explained above. The "Account ID" field is pre-populated with the current account, and the "Invoices" section lists the account invoices along with their balance. | ||
| 2. Enter the following details: | ||
| * **Amount Received:** The total amount received. The currency of the account is displayed below this field. |
There was a problem hiding this comment.
- Amount Received: The total amount received. It should be equal to the sum of the amounts entered in the "Payment" column, otherwise Kaui displays a warning. Only the amounts entered in the "Payment" column are recorded. The currency of the account is displayed below this field.
| * **Amount Received:** The total amount received. The currency of the account is displayed below this field. | ||
| * **Payment Date:** The date on which the payment was received. | ||
| * **Payment Ref. #:** The reference of the payment, for example the wire or check number. | ||
| * **Payment Mode:** The mode of the payment, for example `Wire`. |
There was a problem hiding this comment.
- Payment Mode: The mode of the payment. Select one of
Wire,Check,CashorOTHER.
There was a problem hiding this comment.
🔵 Needs a closer look
The PostgreSQL setup instructions omit the shared table DDL and required ordering, leaving deposit tables missing unless compatibility domains are created first and the shared DDL is then run.
No open issues 🎉
2 resolved since last review
Review effort: Balanced
No description provided.