Accounts

Accounts are owned by entities and are used to exchange value. Each Account has an Account Type. Each Account has a currency type. It's worth noting "currency" does not have to mean government (or crypto) money. For example, Giving Credit recognizes a "social capital" account which can be used to barter.

Account

webapp.finances_account
Each Account has exactly one AccountType. Account types can be third party accounts (like Paypal and CashApp) or account types that are native to the Giving Credit platform.
Field Description Type
id
Account ID Number
uuid
Account UUID UUID
entity_id
Entity that owns the account Numeric
show_on_profile
Whether to show this account on an entity's profile. Boolean
currency
Currency type, such as "USD" Text
sum_to_amount
Total amount that has been transfered into this account Numeric
sum_from_amount
Total amount that has been transfered out of this account Numeric
balance
Account balance Numeric
account_type_id
ID of the account type Numeric
handle_username
Entity's user handle for this account, if one exists. For example, if this account is of type “Cash App”, the handle would be a user’s “cashtag”. Text
handle_email
Entity's email for this account. For example, if the type is “Paypal”, the user might provide the email address associated with their Paypal account. Text
handle_phone
Entity's phone number for this account. For example, if the type is "Zelle", the user might provide the phone number associated with their Zelle account. Text

AccountType

webapp.finances_accounttype
There are multiple types of accounts recognized on Giving Credit, each with its own unique features. The Account Type object defines what feature each account has available.
Field Description Type
id
Account Type ID Number
name
Internal system name, like 'paypal' or 'cashapp' Text
display_name
Display name, like 'Paypal Inc.' or 'Cash App' Text
website
Website for the Account Type of applicable Text
connected_account
Whether this Account Type can be connected to a third party payment API Boolean
handle_username_enabled
Whether this account type can have an associated username Boolean
handle_email_enabled
Whether this account type can have an associated email address Boolean
handle_phone_enabled
Whether this account type can have an associated phone number Boolean
payment_option
Whether this account type can be used to make (record) payments on Giving Credit Boolean
fund_note_enabled
Whether this account type can be used to fund a note (loan) Boolean
money
Whether this account type represents money or not Boolean

AccountLedger

webapp.finances_accountledger
The Account Ledger keeps a record of all changes to an account per transaction.
Field Description Type
id
Account Ledger ID Numeric
UUID
Account Ledger UUID UUID
to_amount
Amount that came into the account in this transaction Numeric
from_amount
Amount that left this account in this transaciton Numeric
sum_to_amount
Sum of all transactions into this account Numeric
sum_from_amount
Sum of all transactions from this account Numeric
balance
Account balance Numeric
created_at
Date the ledger entry was created Date
account_id
Account ID Numeric
transaction_id
Transaction for this ledger update Numeric