aboutsummaryrefslogtreecommitdiffstats
path: root/ynab-api/docs/Category.md
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-08-09 02:06:22 -0400
committerJesse Luehrs <doy@tozt.net>2019-08-09 02:52:44 -0400
commitfaf9c8aa1e41df1889f8382e9c2183e2d5f85de1 (patch)
tree0e4218dd5c1d47735fd6324fb30a01c964aad781 /ynab-api/docs/Category.md
parentd54b8f01ea9c253a326a9601f58a423a64ba8b4a (diff)
downloadynab-api-faf9c8aa1e41df1889f8382e9c2183e2d5f85de1.tar.gz
ynab-api-faf9c8aa1e41df1889f8382e9c2183e2d5f85de1.zip
add openapi-generated api client
Diffstat (limited to 'ynab-api/docs/Category.md')
-rw-r--r--ynab-api/docs/Category.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/ynab-api/docs/Category.md b/ynab-api/docs/Category.md
new file mode 100644
index 0000000..2afbe63
--- /dev/null
+++ b/ynab-api/docs/Category.md
@@ -0,0 +1,25 @@
+# Category
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | |
+**category_group_id** | **String** | |
+**name** | **String** | |
+**hidden** | **bool** | Whether or not the category is hidden |
+**original_category_group_id** | **String** | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional]
+**note** | **String** | |
+**budgeted** | **i64** | Budgeted amount in milliunits format |
+**activity** | **i64** | Activity amount in milliunits format |
+**balance** | **i64** | Balance in milliunits format |
+**goal_type** | **String** | The type of goal, if the cagegory has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) |
+**goal_creation_month** | [***String**](string.md) | The month a goal was created |
+**goal_target** | **i64** | The goal target amount in milliunits |
+**goal_target_month** | [***String**](string.md) | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed |
+**goal_percentage_complete** | **i32** | The percentage completion of the goal |
+**deleted** | **bool** | Whether or not the category has been deleted. Deleted categories will only be included in delta requests. |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+