dataModel.json

{
  "Users": {
    "User": {
      "uid": "string(uuid)",
      "creationTime": "timeStamp",
      "displayName": "string",
      "email": "string",
      "photoURL": "string",
      "providerData": "array"
    }
  },
  "Budgets": {
    "Budget": {
      "id": "string(uuid)",
      "createdTime": "timeStamp",
      "owner": "string(uid)",
      "sharedWith": "array[string(uuid)]",
      "name": "string",
      "firstMonth": "timeStamp",
      "currencyCode": "enum[list of currency codes]",
      "accounts": {
        "arrayOfObjects": {
          "id": "string(uuid)",
          "name": "string",
          "type": "enum[checking, savings, cash, creditCard, lineOfCredit, otherAsset, otherLiability, investmentAccount, mortgage]",
          "onBudget": "boolean",
          "closed": "boolean",
          "balance": "int",
          "clearedBalance": "int",
          "deleted": "boolean"
        }
      },
      "Transactions(sub-collection)": {
        "Transaction(doc:id)": [
          {
            "id": "string(uuid)",
            "date": "string(date)",
            "amount": "int",
            "note": "string",
            "cleared": "enum[cleared, uncleared, reconciled]",
            "approved": "boolean",
            "accountId": "string(uuid)",
            "payeeId": "string(uuid)",
            "categoryId": "string(uuid)",
            "transferAccountId": "string(uuid)",
            "deleted": "boolean",
            "subTransactions": {
              "arrayOfObjects": {
                "id": "string(uuid)",
                "amount": "int",
                "note": "string",
                "payeeId": "string(uuid)",
                "categoryId": "string(uuid)",
                "transferAccountId": "string(uuid)",
                "deleted": "boolean"
              }
            }
          }
        ]
      },
      "ScheduledTransactions(sub-collection)": {
        "ScheduledTransaction(doc:id)": {
          "id": "string(uuid)",
          "dateFirst": "string(date)",
          "dateNext": "string(date)",
          "frequency": "enum[once, daily, weekly, everyOtherWeek, twiceAMonth, every4Weeks, monthly, everyOtherMonth, every3Months, every4Months, twiceAYear, yearly",
          "amount": "int",
          "note": "string",
          "accountId": "string(uuid)",
          "accountName": "string",
          "payeeId": "string(uuid)",
          "payeeName": "string",
          "categoryId": "string(uuid)",
          "categoryName": "string",
          "transferAccountId": "string(uuid)",
          "transferAccountName": "string",
          "deleted": "boolean",
          "subTransactions": {
            "arrayOfObjects": {
              "id": "string(uuid)",
              "amount": "int",
              "note": "string",
              "payeeId": "string(uuid)",
              "payeeName": "string",
              "categoryId": "string(uuid)",
              "categoryName": "string",
              "transferAccountId": "string(uuid)",
              "transferAccountName": "string",
              "deleted": "boolean"
            }
          }
        }
      },
      "Payees(sub-collection)": {
        "Payee(doc:id)": {
          "id": "string(uuid)",
          "name": "string",
          "lastCategory": "string",
          "lastAccount": "string",
          "deleted": "boolean"
        }
      },
      "categoryGroups": {
        "arrayOfObjects": {
          "id": "string(uuid)",
          "name": "string",
          "hidden": "boolean",
          "deleted": "boolean"
        }
      },
      "categories": {
        "arrayOfObjects": {
          "id": "string(uuid)",
          "groupId": "string(uuid)",
          "name": "string",
          "note": "string",
          "overspending": "int",
          "hidden": "boolean",
          "deleted": "boolean"
        }
      },
      "Months(sub-collection)": {
        "Month(doc:month)": {
          "month": "timeStamp",
          "note": "string",
          "income": "int",
          "budgeted": "int",
          "spent": "int",
          "categories": {
            "categoryId": {
              "budgeted": "int",
              "spent": "int",
              "note": "string"
            }
          }
        }
      }
    }
  }
}