You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**on_budget**|**Boolean**| Whether this account is \"on budget\" or not ||
11
+
|**closed**|**Boolean**| Whether this account is closed or not ||
12
+
|**note**|**String**||[optional]|
13
+
|**balance**|**Integer**| The current available balance of the account in milliunits format ||
14
+
|**cleared_balance**|**Integer**| The current cleared balance of the account in milliunits format ||
15
+
|**uncleared_balance**|**Integer**| The current uncleared balance of the account in milliunits format ||
16
+
|**transfer_payee_id**|**String**| The payee id which should be used when transferring to this account ||
17
+
|**direct_import_linked**|**Boolean**| Whether or not the account is linked to a financial institution for automatic transaction import. |[optional]|
18
+
|**direct_import_in_error**|**Boolean**| If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true. |[optional]|
19
+
|**last_reconciled_at**|**Time**| A date/time specifying when the account was last reconciled. |[optional]|
20
+
|**debt_original_balance**|**Integer**| This field is deprecated and will always be null. |[optional]|
Copy file name to clipboardExpand all lines: docs/Category.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,4 +30,18 @@
30
30
|**goal_overall_left**|**Integer**| The amount of funding still needed to complete the goal within the current goal period. |[optional]|
31
31
|**goal_snoozed_at**|**Time**| The date/time the goal was snoozed. If the goal is not snoozed, this will be null. |[optional]|
32
32
|**deleted**|**Boolean**| Whether or not the category has been deleted. Deleted categories will only be included in delta requests. ||
33
+
|**balance_formatted**|**String**| Available balance of the category formatted in the plan's currency format |[optional]|
34
+
|**balance_currency**|**Float**| Available balance of the category as a decimal currency amount |[optional]|
35
+
|**activity_formatted**|**String**| Activity of the category formatted in the plan's currency format |[optional]|
36
+
|**activity_currency**|**Float**| Activity of the category as a decimal currency amount |[optional]|
37
+
|**budgeted_formatted**|**String**| Assigned (budgeted) amount of the category formatted in the plan's currency format |[optional]|
38
+
|**budgeted_currency**|**Float**| Assigned (budgeted) amount of the category as a decimal currency amount |[optional]|
39
+
|**goal_target_formatted**|**String**| The goal target amount formatted in the plan's currency format |[optional]|
40
+
|**goal_target_currency**|**Float**| The goal target amount as a decimal currency amount |[optional]|
41
+
|**goal_under_funded_formatted**|**String**| The goal underfunded amount formatted in the plan's currency format |[optional]|
42
+
|**goal_under_funded_currency**|**Float**| The goal underfunded amount as a decimal currency amount |[optional]|
43
+
|**goal_overall_funded_formatted**|**String**| The total amount funded towards the goal formatted in the plan's currency format |[optional]|
44
+
|**goal_overall_funded_currency**|**Float**| The total amount funded towards the goal as a decimal currency amount |[optional]|
45
+
|**goal_overall_left_formatted**|**String**| The amount of funding still needed to complete the goal formatted in the plan's currency format |[optional]|
46
+
|**goal_overall_left_currency**|**Float**| The amount of funding still needed to complete the goal as a decimal currency amount |[optional]|
|**hidden**|**Boolean**| Whether or not the category is hidden ||
12
+
|**original_category_group_id**|**String**| DEPRECATED: No longer used. Value will always be null. |[optional]|
13
+
|**note**|**String**||[optional]|
14
+
|**budgeted**|**Integer**| Assigned (budgeted) amount in milliunits format ||
15
+
|**activity**|**Integer**| Activity amount in milliunits format ||
16
+
|**balance**|**Integer**| Available balance in milliunits format ||
17
+
|**goal_type**|**String**| The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending') |[optional]|
18
+
|**goal_needs_whole_amount**|**Boolean**| Indicates the monthly rollover behavior for \"NEED\"-type goals. When \"true\", the goal will always ask for the target amount in the new month (\"Set Aside\"). When \"false\", previous month category funding is used (\"Refill\"). For other goal types, this field will be null. |[optional]|
19
+
|**goal_day**|**Integer**| A day offset modifier for the goal's due date. When goal_cadence is 2 (Weekly), this value specifies which day of the week the goal is due (0 = Sunday, 6 = Saturday). Otherwise, this value specifies which day of the month the goal is due (1 = 1st, 31 = 31st, null = Last day of Month). |[optional]|
20
+
|**goal_cadence**|**Integer**| The goal cadence. Value in range 0-14. There are two subsets of these values which behave differently. For values 0, 1, 2, and 13, the goal's due date repeats every goal_cadence * goal_cadence_frequency, where 0 = None, 1 = Monthly, 2 = Weekly, and 13 = Yearly. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. For values 3-12 and 14, goal_cadence_frequency is ignored and the goal's due date repeats every goal_cadence, where 3 = Every 2 Months, 4 = Every 3 Months, ..., 12 = Every 11 Months, and 14 = Every 2 Years. |[optional]|
21
+
|**goal_cadence_frequency**|**Integer**| The goal cadence frequency. When goal_cadence is 0, 1, 2, or 13, a goal's due date repeats every goal_cadence * goal_cadence_frequency. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. When goal_cadence is 3-12 or 14, goal_cadence_frequency is ignored. |[optional]|
22
+
|**goal_creation_month**|**Date**| The month a goal was created |[optional]|
23
+
|**goal_target**|**Integer**| The goal target amount in milliunits |[optional]|
24
+
|**goal_target_month**|**Date**| DEPRECATED: No longer used. Use `goal_target_date` instead. |[optional]|
25
+
|**goal_target_date**|**Date**| The target date for the goal to be completed. Only some goal types specify this date. |[optional]|
26
+
|**goal_percentage_complete**|**Integer**| The percentage completion of the goal |[optional]|
27
+
|**goal_months_to_budget**|**Integer**| The number of months, including the current month, left in the current goal period. |[optional]|
28
+
|**goal_under_funded**|**Integer**| The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month. The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month. |[optional]|
29
+
|**goal_overall_funded**|**Integer**| The total amount funded towards the goal within the current goal period. |[optional]|
30
+
|**goal_overall_left**|**Integer**| The amount of funding still needed to complete the goal within the current goal period. |[optional]|
31
+
|**goal_snoozed_at**|**Time**| The date/time the goal was snoozed. If the goal is not snoozed, this will be null. |[optional]|
32
+
|**deleted**|**Boolean**| Whether or not the category has been deleted. Deleted categories will only be included in delta requests. ||
Copy file name to clipboardExpand all lines: docs/ExistingCategory.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@
7
7
|**name**|**String**||[optional]|
8
8
|**note**|**String**||[optional]|
9
9
|**category_group_id**|**String**||[optional]|
10
-
|**goal_target**|**Integer**| The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending'goal will be created for the category with this target amount. |[optional]|
10
+
|**goal_target**|**Integer**| The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. |[optional]|
11
11
|**goal_target_date**|**Date**| The goal target date in ISO format (e.g. 2016-12-01). |[optional]|
12
+
|**goal_needs_whole_amount**|**Boolean**| Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. |[optional]|
Copy file name to clipboardExpand all lines: docs/HybridTransaction.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,8 @@
23
23
|**import_payee_name_original**|**String**| If the transaction was imported, the original payee name as it appeared on the statement |[optional]|
24
24
|**debt_transaction_type**|**String**| If the transaction is a debt/loan account transaction, the type of transaction |[optional]|
25
25
|**deleted**|**Boolean**| Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. ||
26
+
|**amount_formatted**|**String**| The transaction amount formatted in the plan's currency format |[optional]|
27
+
|**amount_currency**|**Float**| The transaction amount as a decimal currency amount |[optional]|
26
28
|**type**|**String**| Whether the hybrid transaction represents a regular transaction or a subtransaction ||
27
29
|**parent_transaction_id**|**String**| For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. |[optional]|
0 commit comments