changedInput schema / properties / category / allOf
Previous value: -[
- {
- "properties": {
- "category_group_id": {
- "description": "The id of the category group to which this category belongs. An internal category group may not be specified.",
- "format": "uuid",
- "type": "string"
- },
- "goal_needs_whole_amount": {
- "description": "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...'.",
- "type": [
- "boolean",
- "null"
- ]
- },
- "goal_target": {
- "description": "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.",
- "format": "int64",
- "type": [
- "integer",
- "null"
- ]
- },
- "goal_target_date": {
- "description": "The goal target date in ISO format (e.g. 2016-12-01).",
- "format": "date",
- "type": [
- "string",
- "null"
- ]
- },
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "note": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "category_group_id": {
+ "description": "The id of the category group to which this category belongs. An internal category group may not be specified.",
+ "format": "uuid",
+ "type": "string"
+ },
+ "goal_frequency": {
+ "description": "When specified, configures a recurring 'NEED' target of goal_target that repeats at this frequency, replacing any existing target. Requires goal_target. 'yearly' also requires goal_target_date, the date the target is next due. 'monthly' accepts an optional goal_target_date, and 'weekly' cannot be combined with goal_target_date. Not supported for Credit Card Payment categories or categories paired to a loan account. Omit to leave an existing target's cadence unchanged.",
+ "enum": [
+ "monthly",
+ "weekly",
+ "yearly"
+ ],
+ "type": "string"
+ },
+ "goal_needs_whole_amount": {
+ "description": "Whether the goal requires the full target amount each period. Only supported for 'NEED' goals, and not supported for Credit Card Payment categories or categories paired to a loan account. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "goal_target": {
+ "description": "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 to 'MF' for Credit Card Payment categories and 'DEBT' for categories paired to a loan account. Must not be negative. When updating a category, passing null removes any existing target. Passing 0 does too, except for a Credit Card Payment category's 'TBD' (Pay Off Balance by Date) target, where 0 is a valid amount because the card's balance sets it. Use null to remove that target.",
+ "format": "int64",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "goal_target_date": {
+ "description": "The goal target date in ISO format (e.g. 2016-12-01). Not supported for categories paired to a loan account. When combined with a goal_frequency of 'monthly' or 'yearly', this is the date the recurring target is next due. Required for yearly targets, so it cannot be removed from one.",
+ "format": "date",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "note": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "object"
+ }
+]