-
Notifications
You must be signed in to change notification settings - Fork 5
loan_reporting
The loan reporting system allows alliances and player banks to share and access information about active or defaulted loans. Loan information can be useful to avoid loaning to over burdened players with active loan obligations or a history of fraud
Anyone with the INTERNAL_AFFAIRS role can create loans.
All loan information is publicly viewable.
Loans are tied to the server/alliance creating them.
Only those with the INTERNAL_AFFAIRS role can update or remove a loan.
- OPEN
- CLOSED
- EXTENDED
- MISSED_PAYMENT
- DEFAULTED
| 📚 Add a loan for a nation or alliance |
|---|
/report loan add
Add a loan for a nation or alliance
Arguments:
<receiver> - NationOrAlliance
A nation or alliance name, url or id. Prefix with `AA:` or `nation:` to avoid ambiguity if there exists both by the same name or id
[status] - Status
The status of a nation's loan
[-o overwriteLoan] - DBLoan[GuildLoan]
[-p principal] - Map
A comma separated list of resources and their amounts
[-r remaining] - Map
[-c amountPaid] - Map
[-d dueDate] - Long[Timestamp]
A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date
[-a allianceLending] - DBAlliance
An alliance name id or url
[-f force] - boolean
| 📚 Update a loan for a nation or alliance... |
|---|
/report loan update
Update a loan for a nation or alliance
If no other arguments are provided, only the last updated date will be set
Arguments:
<loan> - DBLoan[GuildLoan]
[-p principal] - Map
A comma separated list of resources and their amounts
[-r remaining] - Map
[-c amountPaid] - Map
[-d dueDate] - Long[Timestamp]
A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date
[-f force] - boolean
| 📚 Delete a loan for a nation or alliance... |
|---|
/report loan remove
Delete a loan for a nation or alliance
Note: To delete all loans use the loan purge command
Arguments:
<loan> - DBLoan[GuildLoan]
[-f force] - boolean
| 📚 Generate a google sheet of all loan information banks and alliances have submitted... |
|---|
/report loan sheet
Generate a google sheet of all loan information banks and alliances have submitted
If no nations are provided, only the loans for this server are returned
If no loan status is provided, all loans are returned
Arguments:
[nations] - Set
A comma separated list of nations, alliances and filters
[-s sheet] - SpreadSheet
A google spreadsheet id or url
[-l loanStatus] - Set
A comma separated list of the status of a nation's loan
| 📚 Import loan report data from a google sheet... |
|---|
/report loan upload
Import loan report data from a google sheet
Expects the columns: Receiver, Principal, Remaining, Status, Due Date, Loan Date, Paid, Interest
This is not affect member balances and is solely for sharing information with the public
Arguments:
<sheet> - SpreadSheet
A google spreadsheet id or url
[defaultStatus] - Status
The status of a nation's loan
[-o overwriteLoans] - boolean
[-m overwriteSameNation] - boolean
[-a addLoans] - boolean
| 📚 Delete all loan information |
|---|
/report loan purge
Delete all loan information
Arguments:
[guildOrAllianceId] - Long
Purge all loans created by this guild or alliance id
(A whole number)
[-f force] - boolean
Active loans which have been reported will be flagged as outdated if they have not been updated in over 7 days
To mark all loans as updated, use the following command
| 📚 Mark all active loans by this guild as up to date... |
|---|
/report loan update_all
Mark all active loans by this guild as up to date
It is useful for loan reporting to remain accurate
Arguments:
[loanStatus] - Set
A comma separated list of the status of a nation's loan
[-f force] - boolean
| 📚 The channel to receive alerts when any nation or user is reported to the bot... |
|---|
/settings_orbis_alerts report_alert_channel
The channel to receive alerts when any nation or user is reported to the bot
See
Arguments:
<channel> - MessageChannel
A discord channel name or mention
Orbis Business & Innovation Forum is a player run discord server for fostering communication between banks