API / Named Ranges

Google Apps Script Documentation
You can learn more about the APIs available here in Google's documentation.
Named Ranges
These are the current Named Ranges that are safely consumable by [email protected] projects. If there's data in the core Aspire Budgeting sheets you'd like to reference, please let me know and we can likely get a Named Range created for that data.
Values
Reference
Format
Notes
v_Version
String
A string that represents the version of the current spreadsheet.
Example: '3.3.0'
v_Today
Number
This value represents today's date in integer format.
v_ReportableCategorySymbol
String
Value: ✧
v_NonReportableCategorySymbol
String
Value: ※
v_DebtAccountSymbol
String
Value: ◘
v_CategoryGroupSymbol
String
Value: ✦
v_ApprovedSymbol
String
Value: ✅
v_PendingSymbol
String
Value: 🅿️
v_BreakSymbol
String
Value: *️⃣
v_AccountTransfer
String
Value: ↕️ Account Transfer
v_BalanceAdjustment
String
Value: 🔢 Balance Adjustment
v_StartingBalance
String
Value: ➡️ Starting Balance
Ranges (single column)
Reference
Format
Notes
trx_Dates
Range
Column of Dates on the Transactions tab
trx_Outflows
Range
Column of Outflows on the Transactions tab
trx_Inflows
Range
Column of Inflows on the Transactions tab
trx_Categories
Range
Column of Categories on the Transactions tab
trx_Accounts
Range
Column of Accounts on the Transactions tab
trx_Statuses
Range
Column of Statuses on the Transactions tab
ntw_Dates
Range
Column of Dates on the Net Worth Reports tab
ntw_Amounts
Range
Column of Amounts on the Net Worth Reports tab
ntw_Categories
Range
Column of Categories on the Net Worth Reports tab
cts_Dates
Range
Column of Dates on the Category Transfers tab
cts_Amounts
Range
Column of Amounts on the Category Transfers tab
cts_FromCategories
Range
Column of From Categories on the Category Transfers tab
cts_ToCategories
Range
Column of to Categories on the Category Transfers tab
cfg_Accounts
Range
Range of Bank Accounts on the Configuration tab
cfg_Cards
Range
Range of Credit Cards on the Configuration tab
Ranges (two dimensional)
Reference
Format
Notes
r_ConfigurationData
Range
A two dimensional array of the user entered categories and groups from the Configuration tab
r_DashboardData
Range
A two dimensional array of the values in the header of the Dashboard

[email protected] - Previous

Submission Guidelines

Next - [email protected]

Colors

Last updated 12 months ago

Reference	Format	Notes
v_Version	String	A string that represents the version of the current spreadsheet. Example: '3.3.0'
v_Today	Number	This value represents today's date in integer format.
v_ReportableCategorySymbol	String	Value: ✧
v_NonReportableCategorySymbol	String	Value: ※
v_DebtAccountSymbol	String	Value: ◘
v_CategoryGroupSymbol	String	Value: ✦
v_ApprovedSymbol	String	Value: ✅
v_PendingSymbol	String	Value: 🅿️
v_BreakSymbol	String	Value: *️⃣
v_AccountTransfer	String	Value: ↕️ Account Transfer
v_BalanceAdjustment	String	Value: 🔢 Balance Adjustment
v_StartingBalance	String	Value: ➡️ Starting Balance

Reference	Format	Notes
trx_Dates	Range	Column of Dates on the Transactions tab
trx_Outflows	Range	Column of Outflows on the Transactions tab
trx_Inflows	Range	Column of Inflows on the Transactions tab
trx_Categories	Range	Column of Categories on the Transactions tab
trx_Accounts	Range	Column of Accounts on the Transactions tab
trx_Statuses	Range	Column of Statuses on the Transactions tab
ntw_Dates	Range	Column of Dates on the Net Worth Reports tab
ntw_Amounts	Range	Column of Amounts on the Net Worth Reports tab
ntw_Categories	Range	Column of Categories on the Net Worth Reports tab
cts_Dates	Range	Column of Dates on the Category Transfers tab
cts_Amounts	Range	Column of Amounts on the Category Transfers tab
cts_FromCategories	Range	Column of From Categories on the Category Transfers tab
cts_ToCategories	Range	Column of to Categories on the Category Transfers tab
cfg_Accounts	Range	Range of Bank Accounts on the Configuration tab
cfg_Cards	Range	Range of Credit Cards on the Configuration tab