-
Notifications
You must be signed in to change notification settings - Fork 5
deposits
Member balances are determined by what they deposit into the bank, as well as funds they receive from the alliance. Offshores/Training alliances etc.
The deposits check command can be used to view the account balance of nations, tax brackets as well as the alliance or guild offshore account
- Nation e.g.
Borg- Net funds a nation has deposited/received with the alliance bank - Tax bracket e.g.
#tax_id=1234- Net funds a from tax records - Alliance e.g.
AA:Rose- Net funds the alliance has deposited/received with the offshore - Guild ID e.g.
647252780817448972- Net funds the#guildhas deposited/received with the offshore
Nation and Tax Bracket deposits can be adjusted by econ or admin, however alliance/guild accounts can only be set in the offshore server
| 📚 Displays the account balance for a nation, alliance or guild... |
|---|
/deposits check
Displays the account balance for a nation, alliance or guild
Balance info includes deposits, loans, grants, taxes and escrow
Arguments:
<nationOrAllianceOrGuild> - [NationOrAllianceOrGuildOrTaxid](arguments#nationorallianceorguildortaxid)
Account to check holdings for
(A nation or alliance name, url or id, or a guild id, or a tax id or url)
[-a offshores] - [Set](arguments#setdballiance)
The alliances to check transfers from
Otherwise the guild configured ones will be used
(A comma separated list of alliances)
[-c timeCutoff] - [Long[Timestamp]](arguments#longtimestamp)
Only include transfers after this time
(A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date)
[-b includeBaseTaxes] - [boolean](arguments#boolean)
Include all taxes in account balance
[-o ignoreInternalOffsets] - [boolean](arguments#boolean)
Do NOT include manual offsets in account balance
[-t showCategories] - [Boolean](arguments#boolean)
Show separate sections for taxes and deposits
[-d replyInDMs] - [boolean](arguments#boolean)
[-e includeExpired] - [boolean](arguments#boolean)
Include expired transfers
[-i includeIgnored] - [boolean](arguments#boolean)
Include transfers marked as ignore
[-z allowCheckDeleted] - [boolean](arguments#boolean)
[-h hideEscrowed] - [boolean](arguments#boolean)
Hide the escrow balance
| 📚 Get a sheet with member nations and their deposits... |
|---|
/deposits sheet
Get a sheet with member nations and their deposits
Each nation's safekeep should match the total balance given by deposits commandAdd -b to
Add -o to not include any manual deposit offsets
Add -d to not include deposits
Add -t to not include taxes
Add -l to not include loans
Add -g to not include grants
Add to include past depositors-f
Add to force an update[nations]
**Arguments:** - [Set<DBNation>](arguments#setdbnation)[offshores]
> A comma separated list of nations, alliances and filters - [Set<DBAlliance>](arguments#setdballiance)[-b ignoreTaxBase]
> The alliances to track transfers from
> (A comma separated list of alliances) - [boolean](arguments#boolean)[-o ignoreOffsets]
> use 0/0 as the tax base - [boolean](arguments#boolean)[-t noTaxes]
> Do NOT include any manual deposit offesets - [boolean](arguments#boolean)[-l noLoans]
> Do NOT include taxes - [boolean](arguments#boolean)[-g noGrants]
> Do NOT include loans - [boolean](arguments#boolean)[-d noDeposits]
> Do NOT include grants - [boolean](arguments#boolean)[-p includePastDepositors]
> Do NOT include deposits - [Set<Integer>](arguments#setinteger)[-e noEscrowSheet]
> Include past depositors - [boolean](arguments#boolean)[-n useFlowNote]
> Do NOT include escrow sheet - [DepositType](arguments#deposittype)[-f force]` - [boolean](arguments#boolean)
> Only show the flow for this note
> i.e. To only see funds marked as #TRADE
> This is for transfer flow breakdown internal, withdrawal, and deposit
> (A note to use for a bank transfer)
See also:Locutus/Wiki/bank_flows
Use the argument in the deposits command, or set the following
| 📚 Display deposits in a condensed format |
|---|
/settings_bank_info display_condensed_deposits
Display deposits in a condensed format
Arguments:
<enabled> - [boolean](arguments#boolean)
| 📚 Whether members's deposits are displayed by default with a breakdown of each category (true/false) |
|---|
/settings_bank_info display_itemized_deposits
Whether members's deposits are displayed by default with a breakdown of each category (true/false)
Arguments:
<enabled> - [boolean](arguments#boolean)
| 📚 Get a sheet of a nation or alliances transactions (excluding taxes) |
|---|
/bank records
Get a sheet of a nation or alliances transactions (excluding taxes)
Arguments:
<nationOrAllianceOrGuild> - [NationOrAllianceOrGuild](arguments#nationorallianceorguild)
A nation or alliance name, url or id, or a guild id
[timeframe=%epoch%] - [long[Timestamp]](arguments#longtimestamp)
A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date
[useTaxBase=false] - [boolean](arguments#boolean)
[useOffset=true] - [boolean](arguments#boolean)
[-s sheet] - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. `sheet:ID,TAB_NAME`For a url, append `#gid=1234` or `#tab=tabName` to specify the id of the tab to use
[-o onlyOffshoreTransfers] - [boolean](arguments#boolean)
| 📚 Get a sheet of a nation tax deposits over a period... |
|---|
/tax deposits
Get a sheet of a nation tax deposits over a period
If a tax base is set for the nation or alliance then only the portion within member holdings are included by default
Arguments:
<nations> - [Set](arguments#setdbnation)
A comma separated list of nations, alliances and filters
[baseTaxRate] - [TaxRate](arguments#taxrate)
Set to 0/0 to include all taxes
(A tax rate in the form of `money/rss`)
[startDate] - [Long[Timestamp]](arguments#longtimestamp)
A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date
[endDate] - [Long[Timestamp]](arguments#longtimestamp)
[-s sheet] - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. `sheet:ID,TAB_NAME`For a url, append `#gid=1234` or `#tab=tabName` to specify the id of the tab to use
| 📚 Get a sheet of a nation tax deposits over a period |
|---|
/tax records
Get a sheet of a nation tax deposits over a period
Arguments:
<nation> - [DBNation](arguments#dbnation)
nation id, name or url
[startDate] - [Long[Timestamp]](arguments#longtimestamp)
A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date
[endDate] - [Long[Timestamp]](arguments#longtimestamp)
[-s sheet] - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. `sheet:ID,TAB_NAME`For a url, append `#gid=1234` or `#tab=tabName` to specify the id of the tab to use
Notes can be used in the transfer commands, as well as when sending in-game
Multiple notes can be used at a time
Notes with values go in the form #expire=60d
-
#deposit: For funds directly deposited or withdrawn -
#tax: For city raw consumption or taxes -
#loan: For funds members are expected to repay at some date in the future -
#grant: Can be excluded from withdrawal limit, considered a loan if no time is specified e.g.#expire=60d -
#ignore: Excluded from deposits -
#trade: Sub type of deposits, earmarked as trading funds
These notes are used in addition to a primary note, and usually have a value
-
#grant #city: Go to https://politicsandwar.com/city/create/ and purchase a new city -
#grant #project: Go to https://politicsandwar.com/nation/projects/ and purchase the desired project -
#grant #infra: Go to your city https://politicsandwar.com/cities/ and purchase the desired infrastructure -
#grant #land: Go to your city https://politicsandwar.com/cities/ and purchase the desired land -
#grant #build: Go to https://politicsandwar.com/city/improvements/bulk-import/ and import the desired build -
#grant #warchest: Go to https://politicsandwar.com/nation/military/ and purchase the desired units -
#grant #raws: Raw resources for city consumption -
#grant #expire: Will be excluded from deposits after the specified time e.g.#expire=60d
This applies for guilds with a registed alliance
| 📚 Your alliance id |
|---|
/settings_default registeralliance
Your alliance id
Arguments:
<alliances> - [Set](arguments#setdballiance)
A comma separated list of alliances
By default, any alliance alliance registered to the guild is tracked for member deposits.
Removing an alliance from being tracked will remove all those transfers from a member's balance
The following coalitions are also tracked:
- TRACK_DEPOSITS
- OFFSHORE
See: Locutus/Wiki/tax_automation
Use negative amounts to subtract
Nation or tax brackets can be adjusted for a server
Offshore balances for alliances or guilds are managed in the offshore's server
| 📚 Add or subtract from a nation, alliance, guild or tax bracket's account balance... |
|---|
/deposits add
Add or subtract from a nation, alliance, guild or tax bracket's account balance
note: Mutated alliance deposits are only valid if your server is a bank/offshore
Use #expire=30d to have the amount expire after X days
Arguments:
<accounts> - [Set](arguments#setnationorallianceorguildortaxid)
A comma separated list of nations, alliances, guild ids and tax ids or urls
<amount> - [Map](arguments#mapresourcetype-double)
A comma separated list of resources and their amounts
<note> - [String](arguments#string)
A single line of text
[-f force] - [boolean](arguments#boolean)
Specify multiple nations for the command above, or use add balance sheet
| 📚 Add account balance using a google sheet of nation's and resource amounts... |
|---|
/deposits addsheet
Add account balance using a google sheet of nation's and resource amounts
The google sheet must have a column for nation (name, id or url) and a column named for each in-game resource
Arguments:
<sheet> - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. `sheet:ID,TAB_NAME`For a url, append `#gid=1234` or `#tab=tabName` to specify the id of the tab to use
<note> - [String](arguments#string)
The transaction note to use
(A single line of text)
[-f force] - [boolean](arguments#boolean)
[-n negative] - [boolean](arguments#boolean)
Subtract the amounts instead of add
For example, moving #loan to #deposit
| 📚 Bulk shift resources in a nations holdings to another note category |
|---|
/deposits shift
Bulk shift resources in a nations holdings to another note category
Arguments:
<nation> - [DBNation](arguments#dbnation)
nation id, name or url
<from> - [DepositType](arguments#deposittype)
The note to change FROM
(A note to use for a bank transfer)
<to> - [DepositType](arguments#deposittype)
The new note to use
(A note to use for a bank transfer)
[timediff] - [Long[Timestamp]](arguments#longtimestamp)
Only transfers after this timeframe
(A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date)
| 📚 Adjust nation's holdings by converting negative resource values of a specific note to a different resource or money |
|---|
/deposits convertnegative
Adjust nation's holdings by converting negative resource values of a specific note to a different resource or money
Arguments:
<nations> - [Set](arguments#setdbnation)
A comma separated list of nations, alliances and filters
[negativeResources=manu,raws,food] - [List](arguments#listresourcetype)
A comma separated list of resource types
[convertTo=money] - [ResourceType](arguments#resourcetype)
The name of a resource
[-g includeGrants] - [boolean](arguments#boolean)
[-t depositType] - [DepositTypeInfo](arguments#deposittypeinfo)
Convert transfers of this note category
(A DepositType optionally with a value and a city tag)
[-f conversionFactor] - [Double](arguments#double)
What factor to multiple the converted resources by
e.g. Use a value below 1.0 to incur a fee
(A decimal number)
[-s sheet] - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. `sheet:ID,TAB_NAME`For a url, append `#gid=1234` or `#tab=tabName` to specify the id of the tab to use
[-n note] - [String](arguments#string)
The transfer note to use for the adjustment
(A single line of text)
Set the arguments for the categories you do not wish to reset to false
/deposits reset nations: ignoregrants: true ignoreloans: true ignoretaxes: true ignorebankdeposits: true ignoreescrow: true
| 📚 Resets a nations deposits to net zero (of the specific note categories) |
|---|
/deposits reset
Resets a nations deposits to net zero (of the specific note categories)
Arguments:
<nations> - [NationList](arguments#nationlist)
A comma separated list of nations, alliances and filters
[-g ignoreGrants] - [boolean](arguments#boolean)
Do NOT reset grants
[-l ignoreLoans] - [boolean](arguments#boolean)
Do NOT reset loans
[-t ignoreTaxes] - [boolean](arguments#boolean)
Do NOT reset taxes
[-d ignoreBankDeposits] - [boolean](arguments#boolean)
Do NOT reset deposits
[-e ignoreEscrow] - [boolean](arguments#boolean)
Do NOT reset escrow
[-f force] - [boolean](arguments#boolean)
See: Locutus/Wiki/banking
Allow members to withdraw any resource as long as their balance has a positive market value
| 📚 If members can convert resources to cash.... |
|---|
/settings_bank_access resource_conversion
If members can convert resources to cash.
This is done virtually in Resources are converted using market average
Use #cash as the note when depositing or transferring funds
Arguments:
<enabled> - [boolean](arguments#boolean)
| 📚 The #channel to receive alerts when there is a large tranfer in the game or a nation VMs with resources |
|---|
/settings_bank_info addbalance_alert_channel
The #channel to receive alerts when there is a large tranfer in the game or a nation VMs with resources
Arguments:
<channel> - [MessageChannel](arguments#messagechannel)
A discord channel name or mention
/role setalias locutusrole: ECON_WITHDRAW_ALERTS discordrole: @Econ Withdraw Alerts
| 📚 The #channel to receive alerts when a nation requests a transfer |
|---|
/settings_bank_info withdraw_alert_channel
The #channel to receive alerts when a nation requests a transfer
Arguments:
<channel> - [MessageChannel](arguments#messagechannel)
A discord channel name or mention
/role setalias locutusrole: ECON_DEPOSIT_ALERTS discordrole: @Econ Deposit Alerts
| 📚 The #channel to receive alerts when a nation makes a deposit (this will no longer reliably alert) |
|---|
/settings_bank_info deposit_alert_channel
The #channel to receive alerts when a nation makes a deposit (this will no longer reliably alert)
Arguments:
<channel> - [MessageChannel](arguments#messagechannel)
A discord channel name or mention
📚 The #channel to receive alerts e.g. for custom !BankAlerts
|
|---|
/settings_bank_info bank_alert_channel
The #channel to receive alerts e.g. for custom !BankAlerts
Arguments:
<channel> - [MessageChannel](arguments#messagechannel)
A discord channel name or mention
Transfer from the alliance bank (alliance deposits)
Arguments:
<receiver> - NationOrAlliance
A nation or alliance name, url or id. Prefix with
AA:ornation:to avoid ambiguity if there exists both by the same name or id
<transfer> - Map<ResourceType, Double>[AllianceDepositLimit]
A comma separated list of resources and their amounts, which will be restricted by an alliance's account balance
<depositType> - DepositTypeInfo
A DepositType optionally with a value and a city tag
[-n nationAccount] - DBNation
The nation account to deduct from (nation id, name or url)
[-a senderAlliance] - DBAlliance
The alliance bank to send from Defaults to the offshore (An alliance name id or url)
[-o allianceAccount] - DBAlliance
The alliance account to deduct from Alliance must be registered to this guild Defaults to all the alliances of this guild (An alliance name id or url)
[-t taxAccount] - TaxBracket
The tax account to deduct from (A tax id or url)
[-ta existingTaxAccount] - boolean
Deduct from the receiver's tax bracket account
[-m onlyMissingFunds] - boolean
Only send funds the receiver is lacking from the amount
[-e expire] - Long[Timediff]
Have the transfer ignored from nation holdings after a timeframe (A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-g token] - UUID
Universally Unique IDentifier
[-c convertCash] - boolean
Transfer valued at cash equivalent in nation holdings
[-em escrow_mode] - EscrowMode
The mode for escrowing funds (e.g. if the receiver is blockaded) Defaults to never (The mode for escrowing funds for a transfer, such as when a receiver is blockaded)
[-b bypassChecks] - boolean
[-f force] - boolean