Skip to content

deposits

Jump to bottom
xdnw edited this page Apr 4, 2024 · 16 revisions

Member balances are determined by what they deposit into the bank, as well as funds they receive from the alliance. Offshores/Training alliances etc.

Viewing balances

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 #guild has 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 -p to include past depositors
Add -f to force an update

Arguments:

[nations] - [Set](arguments#setdbnation)
A comma separated list of nations, alliances and filters
[offshores] - [Set](arguments#setdballiance)
The alliances to track transfers from
(A comma separated list of alliances)
[-b ignoreTaxBase] - [boolean](arguments#boolean)
use 0/0 as the tax base
[-o ignoreOffsets] - [boolean](arguments#boolean)
Do NOT include any manual deposit offsets
[-t noTaxes] - [boolean](arguments#boolean)
Do NOT include taxes
[-l noLoans] - [boolean](arguments#boolean)
Do NOT include loans
[-g noGrants] - [boolean](arguments#boolean)
Do NOT include grants
[-d noDeposits] - [boolean](arguments#boolean)
Do NOT include deposits
[-p includePastDepositors] - [Set](arguments#setinteger)
Include past depositors
[-e noEscrowSheet] - [boolean](arguments#boolean)
Do NOT include escrow sheet
[-n useFlowNote] - [DepositType](arguments#deposittype)
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)
[-f force] - [boolean](arguments#boolean)

See also:Locutus/Wiki/bank_flows

Changing how balances are displayed

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)

Listing records

📚 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> - [NationOrAllianceOrGuildOrTaxid](arguments#nationorallianceorguildortaxid)
A nation or alliance name, url or id, or a guild id, or a tax id or url
__Optional: Specify timeframe:__
> [timeframe=%epoch%] - [long[Timestamp]](arguments#longtimestamp)
> Only show transactions after this time
> (A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date)
__Display Options:__
> [useTaxBase=false] - [boolean](arguments#boolean)
> Do NOT include the tax record resources below the internal tax rate
> Default: False
> [useOffset=true] - [boolean](arguments#boolean)
> Include balance offset records (i.e. from commands)
> Default: True

[-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_NAMEFor 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_NAMEFor a url, append #gid=1234 or #tab=tabName to specify the id of the tab to use

📚 Get a sheet of a nation's in-game tax records and full resource amounts over a period
/tax records

Get a sheet of a nation's in-game tax records and full resource amounts 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_NAMEFor a url, append #gid=1234 or #tab=tabName to specify the id of the tab to use

Transfer Notes

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

Primary Notes

  • #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 or #decay=3w
  • #ignore: Excluded from deposits
  • #trade: Sub type of deposits, earmarked as trading funds

Modifier Notes

These notes are used in addition to a primary note, and usually have a value

Tracking alliances

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/coalitions

Tax accounts & Including taxes in deposits

See: Locutus/Wiki/tax_automation

Manually adding/subtracing balances

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)

Bulk add balance

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

Shifting balance notes

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)
[expireTime] - [Long[Timestamp]](arguments#longtimestamp)
Make the funds expire
(A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date)
[decayTime] - [Long[Timestamp]](arguments#longtimestamp)
Make the funds decay
(A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date)

Converting negative deposits

📚 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
__Optional: Resources to convert:__
> If no resources are specified, all negative resources are converted to money
> [negativeResources=manu,raws,food] - [List](arguments#listresourcetype)
> The resources to convert
> (A comma separated list of resource types)
> [convertTo=money] - [ResourceType](arguments#resourcetype)
> What resource to convert to
> Conversion uses weekly market average prices
> (The name of a resource)
__Optional (max 1): Specify the deposit notes to convert:__
> Defaults to all types, except grants
> [-g includeGrants] - [boolean](arguments#boolean)
> If grants are also converted
> [-t depositType] - [DepositTypeInfo](arguments#deposittypeinfo)
> Convert transfers of this note category
> (A DepositType optionally with a value and a city tag
> See: https://github.com/xdnw/locutus/wiki/deposits#transfer-notes)
__Conversion Options:__
> [-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)
> [-n note] - [String](arguments#string)
> The transfer note to use for the adjustment
> (A single line of text)

[-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_NAMEFor a url, append #gid=1234 or #tab=tabName to specify the id of the tab to use

Resetting deposits

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
__Reset Options:__
> [-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)

Allow members to withdraw or offshore

See: Locutus/Wiki/banking

Resource conversion

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)

Alerts

📚 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 for transfers when a nation goes into VM
/settings_bank_info bank_alert_channel

The #channel to receive alerts for transfers when a nation goes into VM

Arguments:

<channel> - [MessageChannel](arguments#messagechannel)
A discord channel name or mention

Transfer command arguments

/transfer resources

Transfer from the alliance bank (alliance deposits)

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 <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 See: https://github.com/xdnw/locutus/wiki/deposits#transfer-notes [-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) [-d decay] - Long[Timediff] Have the transfer decrease linearly to zero for balances over 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

Clone this wiki locally