Created
January 11, 2025 16:59
-
-
Save alexanderjeurissen/1a1d8bb984371ceea4219c31d56d6ee6 to your computer and use it in GitHub Desktop.
ynab OPENAPI spec as of 11-01-2025
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.1.0", | |
| "info": { | |
| "title": "YNAB API Endpoints", | |
| "description": "Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.ynab.com", | |
| "version": "1.72.1" | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://api.ynab.com/v1" | |
| } | |
| ], | |
| "security": [ | |
| { | |
| "bearer": [] | |
| } | |
| ], | |
| "tags": [ | |
| { | |
| "name": "User" | |
| }, | |
| { | |
| "name": "Budgets" | |
| }, | |
| { | |
| "name": "Accounts", | |
| "description": "The accounts for a budget" | |
| }, | |
| { | |
| "name": "Categories", | |
| "description": "The categories for a budget" | |
| }, | |
| { | |
| "name": "Payees", | |
| "description": "The payees for a budget" | |
| }, | |
| { | |
| "name": "Payee Locations", | |
| "description": "When you enter a transaction and specify a payee on the YNAB mobile apps, the GPS coordinates for that location are stored, with your permission, so that the next time you are in the same place (like the Grocery store) we can pre-populate nearby payees for you! It\u00e2\u20ac\u2122s handy and saves you time. This resource makes these locations available. Locations will not be available for all payees." | |
| }, | |
| { | |
| "name": "Months", | |
| "description": "Each budget contains one or more months, which is where Ready to Assign, Age of Money and category (budgeted / activity / balances) amounts are available." | |
| }, | |
| { | |
| "name": "Transactions", | |
| "description": "The transactions for a budget" | |
| }, | |
| { | |
| "name": "Scheduled Transactions", | |
| "description": "The scheduled transactions for a budget" | |
| } | |
| ], | |
| "paths": { | |
| "/user": { | |
| "get": { | |
| "tags": [ | |
| "User" | |
| ], | |
| "summary": "User info", | |
| "description": "Returns authenticated user information", | |
| "operationId": "getUser", | |
| "responses": { | |
| "200": { | |
| "description": "The user info", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "user" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "user": { | |
| "required": [ | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets": { | |
| "get": { | |
| "tags": [ | |
| "Budgets" | |
| ], | |
| "summary": "List budgets", | |
| "description": "Returns budgets list with summary information", | |
| "operationId": "getBudgets", | |
| "parameters": [ | |
| { | |
| "name": "include_accounts", | |
| "in": "query", | |
| "description": "Whether to include the list of budget accounts", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of budgets", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "budgets" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "budgets": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default_budget": { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No budgets were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}": { | |
| "get": { | |
| "tags": [ | |
| "Budgets" | |
| ], | |
| "summary": "Single budget", | |
| "description": "Returns a single budget with all related entities. This resource is effectively a full budget export.", | |
| "operationId": "getBudgetById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested budget", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "budget", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "budget": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "accounts": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "payees": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "payee_locations": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "category_groups": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "categories": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "months": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "activity", | |
| "budgeted", | |
| "deleted", | |
| "income", | |
| "month", | |
| "to_be_budgeted" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "month": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "income": { | |
| "type": "integer", | |
| "description": "The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month", | |
| "format": "int64" | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "The total amount budgeted in the month", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "to_be_budgeted": { | |
| "type": "integer", | |
| "description": "The available amount for 'Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "age_of_money": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The Age of Money as of the month", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "scheduled_transactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "date_first", | |
| "date_next", | |
| "deleted", | |
| "frequency", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date_first": { | |
| "type": "string", | |
| "description": "The first date for which the Scheduled Transaction was scheduled.", | |
| "format": "date" | |
| }, | |
| "date_next": { | |
| "type": "string", | |
| "description": "The next date for which the Scheduled Transaction is scheduled.", | |
| "format": "date" | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled transaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "scheduled_subtransactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "scheduled_transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "scheduled_transaction_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The specified budget was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/settings": { | |
| "get": { | |
| "tags": [ | |
| "Budgets" | |
| ], | |
| "summary": "Budget Settings", | |
| "description": "Returns settings for a budget", | |
| "operationId": "getBudgetSettingsById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested budget settings", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "settings" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "settings": { | |
| "required": [ | |
| "currency_format", | |
| "date_format" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The specified Budget was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/accounts": { | |
| "get": { | |
| "tags": [ | |
| "Accounts" | |
| ], | |
| "summary": "Account list", | |
| "description": "Returns all accounts", | |
| "operationId": "getAccounts", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested accounts", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "accounts", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "accounts": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No accounts were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Accounts" | |
| ], | |
| "summary": "Create a new account", | |
| "description": "Creates a new account", | |
| "operationId": "createAccount", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget)", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The account to create.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "account" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "required": [ | |
| "balance", | |
| "name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the account" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "The account was successfully created", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "account" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s).", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/accounts/{account_id}": { | |
| "get": { | |
| "tags": [ | |
| "Accounts" | |
| ], | |
| "summary": "Single account", | |
| "description": "Returns a single account", | |
| "operationId": "getAccountById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "account_id", | |
| "in": "path", | |
| "description": "The id of the account", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested account", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "account" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The requested account was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/categories": { | |
| "get": { | |
| "tags": [ | |
| "Categories" | |
| ], | |
| "summary": "List categories", | |
| "description": "Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", | |
| "operationId": "getCategories", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The categories grouped by category group", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category_groups", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category_groups": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No categories were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/categories/{category_id}": { | |
| "get": { | |
| "tags": [ | |
| "Categories" | |
| ], | |
| "summary": "Single category", | |
| "description": "Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", | |
| "operationId": "getCategoryById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "category_id", | |
| "in": "path", | |
| "description": "The id of the category", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested category", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The category not was found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Categories" | |
| ], | |
| "summary": "Update a category", | |
| "description": "Update a category", | |
| "operationId": "updateCategory", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "category_id", | |
| "in": "path", | |
| "description": "The id of the category", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The category to update", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "category" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "The category was successfully updated", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s)", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/months/{month}/categories/{category_id}": { | |
| "get": { | |
| "tags": [ | |
| "Categories" | |
| ], | |
| "summary": "Single category for a specific budget month", | |
| "description": "Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", | |
| "operationId": "getMonthCategoryById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "path", | |
| "description": "The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "category_id", | |
| "in": "path", | |
| "description": "The id of the category", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested month category", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The month category was not was found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Categories" | |
| ], | |
| "summary": "Update a category for a specific month", | |
| "description": "Update a category for a specific month. Only `budgeted` amount can be updated.", | |
| "operationId": "updateMonthCategory", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "path", | |
| "description": "The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "category_id", | |
| "in": "path", | |
| "description": "The id of the category", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "category" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "budgeted" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "The month category was successfully updated", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s)", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/payees": { | |
| "get": { | |
| "tags": [ | |
| "Payees" | |
| ], | |
| "summary": "List payees", | |
| "description": "Returns all payees", | |
| "operationId": "getPayees", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested list of payees", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payees", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payees": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No payees were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/payees/{payee_id}": { | |
| "get": { | |
| "tags": [ | |
| "Payees" | |
| ], | |
| "summary": "Single payee", | |
| "description": "Returns a single payee", | |
| "operationId": "getPayeeById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "payee_id", | |
| "in": "path", | |
| "description": "The id of the payee", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested payee", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The payee was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Payees" | |
| ], | |
| "summary": "Update a payee", | |
| "description": "Update a payee", | |
| "operationId": "updatePayee", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "payee_id", | |
| "in": "path", | |
| "description": "The id of the payee", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The payee to update", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "payee" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "nullable": false, | |
| "maxLength": 500, | |
| "description": "The name of the payee. The name must be a maximum of 500 characters." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "The payee was successfully updated", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s)", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/payee_locations": { | |
| "get": { | |
| "tags": [ | |
| "Payee Locations" | |
| ], | |
| "summary": "List payee locations", | |
| "description": "Returns all payee locations", | |
| "operationId": "getPayeeLocations", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of payee locations", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee_locations" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee_locations": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No payees locations were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/payee_locations/{payee_location_id}": { | |
| "get": { | |
| "tags": [ | |
| "Payee Locations" | |
| ], | |
| "summary": "Single payee location", | |
| "description": "Returns a single payee location", | |
| "operationId": "getPayeeLocationById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "payee_location_id", | |
| "in": "path", | |
| "description": "id of payee location", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The payee location", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee_location" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee_location": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The payee location was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/payees/{payee_id}/payee_locations": { | |
| "get": { | |
| "tags": [ | |
| "Payee Locations" | |
| ], | |
| "summary": "List locations for a payee", | |
| "description": "Returns all payee locations for a specified payee", | |
| "operationId": "getPayeeLocationsByPayee", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "payee_id", | |
| "in": "path", | |
| "description": "id of payee", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested payee locations", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee_locations" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee_locations": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No payees locations were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/months": { | |
| "get": { | |
| "tags": [ | |
| "Months" | |
| ], | |
| "summary": "List budget months", | |
| "description": "Returns all budget months", | |
| "operationId": "getBudgetMonths", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of budget months", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "months", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "months": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "budgeted", | |
| "deleted", | |
| "income", | |
| "month", | |
| "to_be_budgeted" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "month": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "income": { | |
| "type": "integer", | |
| "description": "The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month", | |
| "format": "int64" | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "The total amount budgeted in the month", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "to_be_budgeted": { | |
| "type": "integer", | |
| "description": "The available amount for 'Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "age_of_money": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The Age of Money as of the month", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No budget months were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/months/{month}": { | |
| "get": { | |
| "tags": [ | |
| "Months" | |
| ], | |
| "summary": "Single budget month", | |
| "description": "Returns a single budget month", | |
| "operationId": "getBudgetMonth", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "path", | |
| "description": "The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The budget month detail", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "month" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "month": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "activity", | |
| "budgeted", | |
| "deleted", | |
| "income", | |
| "month", | |
| "to_be_budgeted" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "month": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "income": { | |
| "type": "integer", | |
| "description": "The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month", | |
| "format": "int64" | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "The total amount budgeted in the month", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "to_be_budgeted": { | |
| "type": "integer", | |
| "description": "The available amount for 'Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "age_of_money": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The Age of Money as of the month", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The budget month was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/transactions": { | |
| "get": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "List transactions", | |
| "description": "Returns budget transactions, excluding any pending transactions", | |
| "operationId": "getTransactions", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "since_date", | |
| "in": "query", | |
| "description": "If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).", | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.", | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "uncategorized", | |
| "unapproved" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested transactions", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "server_knowledge", | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No transactions were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "Create a single transaction or multiple transactions", | |
| "description": "Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions (transactions with a future date) cannot be created on this endpoint.", | |
| "operationId": "createTransaction", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, a new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API)." | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, a new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API)." | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "The transaction or transactions were successfully created", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "server_knowledge", | |
| "transaction_ids" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction_ids": { | |
| "type": "array", | |
| "description": "The transaction ids that were saved", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "description": "If multiple transactions were specified, the transactions that were saved", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "duplicate_import_ids": { | |
| "type": "array", | |
| "description": "If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s).", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "409": { | |
| "description": "A transaction on the same account with the same `import_id` already exists.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "Update multiple transactions", | |
| "description": "Updates multiple transactions, by `id` or `import_id`.", | |
| "operationId": "updateTransactions", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by its `import_id`. If an `id` is specified, it will always be used for lookup. You should not specify both `id` and `import_id`. Updating an `import_id` on an existing transaction is not allowed; if an `import_id` is specified, it will only be used to lookup the transaction.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, this id will be used to lookup a transaction by its `id` for the purpose of updating the transaction itself. If not specified, an `import_id` should be supplied." | |
| }, | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, this id will be used to lookup a transaction by its `import_id` for the purpose of updating the transaction itself. If not specified, an `id` should be supplied. You may not provide both an `id` and an `import_id` and updating an `import_id` on an existing transaction is not allowed." | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "209": { | |
| "description": "The transactions were successfully updated", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "server_knowledge", | |
| "transaction_ids" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction_ids": { | |
| "type": "array", | |
| "description": "The transaction ids that were saved", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "description": "If multiple transactions were specified, the transactions that were saved", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "duplicate_import_ids": { | |
| "type": "array", | |
| "description": "If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s).", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/transactions/import": { | |
| "post": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "Import transactions", | |
| "description": "Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.", | |
| "operationId": "importTransactions", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The request was successful but there were no transactions to import", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transaction_ids" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction_ids": { | |
| "type": "array", | |
| "description": "The list of transaction ids that were imported.", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "201": { | |
| "description": "One or more transactions were imported successfully", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transaction_ids" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction_ids": { | |
| "type": "array", | |
| "description": "The list of transaction ids that were imported.", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s)", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/transactions/{transaction_id}": { | |
| "get": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "Single transaction", | |
| "description": "Returns a single transaction", | |
| "operationId": "getTransactionById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "transaction_id", | |
| "in": "path", | |
| "description": "The id of the transaction", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested transaction", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The transaction was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "Updates an existing transaction", | |
| "description": "Updates a single transaction", | |
| "operationId": "updateTransaction", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "transaction_id", | |
| "in": "path", | |
| "description": "The id of the transaction", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The transaction to update", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "type": "object" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "The transaction was successfully updated", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s)", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "Deletes an existing transaction", | |
| "description": "Deletes a transaction", | |
| "operationId": "deleteTransaction", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "transaction_id", | |
| "in": "path", | |
| "description": "The id of the transaction", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The transaction was successfully deleted", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The transaction was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-openai-isConsequential": true | |
| } | |
| }, | |
| "/budgets/{budget_id}/accounts/{account_id}/transactions": { | |
| "get": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "List account transactions", | |
| "description": "Returns all transactions for a specified account, excluding any pending transactions", | |
| "operationId": "getTransactionsByAccount", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "account_id", | |
| "in": "path", | |
| "description": "The id of the account", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "since_date", | |
| "in": "query", | |
| "description": "If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).", | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.", | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "uncategorized", | |
| "unapproved" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested transactions", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "server_knowledge", | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No transactions were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/categories/{category_id}/transactions": { | |
| "get": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "List category transactions, excluding any pending transactions", | |
| "description": "Returns all transactions for a specified category", | |
| "operationId": "getTransactionsByCategory", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "category_id", | |
| "in": "path", | |
| "description": "The id of the category", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "since_date", | |
| "in": "query", | |
| "description": "If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).", | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.", | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "uncategorized", | |
| "unapproved" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested transactions", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Whether the hybrid transaction represents a regular transaction or a subtransaction", | |
| "enum": [ | |
| "transaction", | |
| "subtransaction" | |
| ] | |
| }, | |
| "parent_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null." | |
| }, | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": "string", | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No transactions were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/payees/{payee_id}/transactions": { | |
| "get": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "List payee transactions, excluding any pending transactions", | |
| "description": "Returns all transactions for a specified payee", | |
| "operationId": "getTransactionsByPayee", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "payee_id", | |
| "in": "path", | |
| "description": "The id of the payee", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "since_date", | |
| "in": "query", | |
| "description": "If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).", | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.", | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "uncategorized", | |
| "unapproved" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested transactions", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Whether the hybrid transaction represents a regular transaction or a subtransaction", | |
| "enum": [ | |
| "transaction", | |
| "subtransaction" | |
| ] | |
| }, | |
| "parent_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null." | |
| }, | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": "string", | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No transactions were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/months/{month}/transactions": { | |
| "get": { | |
| "tags": [ | |
| "Transactions" | |
| ], | |
| "summary": "List transactions in month, excluding any pending transactions", | |
| "description": "Returns all transactions for a specified month", | |
| "operationId": "getTransactionsByMonth", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "path", | |
| "description": "The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "since_date", | |
| "in": "query", | |
| "description": "If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).", | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.", | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "uncategorized", | |
| "unapproved" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested transactions", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Whether the hybrid transaction represents a regular transaction or a subtransaction", | |
| "enum": [ | |
| "transaction", | |
| "subtransaction" | |
| ] | |
| }, | |
| "parent_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null." | |
| }, | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": "string", | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No transactions were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/budgets/{budget_id}/scheduled_transactions": { | |
| "get": { | |
| "tags": [ | |
| "Scheduled Transactions" | |
| ], | |
| "summary": "List scheduled transactions", | |
| "description": "Returns all scheduled transactions", | |
| "operationId": "getScheduledTransactions", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "last_knowledge_of_server", | |
| "in": "query", | |
| "description": "The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The list of requested scheduled transactions", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "scheduled_transactions", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "scheduled_transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "date_first", | |
| "date_next", | |
| "deleted", | |
| "frequency", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date_first": { | |
| "type": "string", | |
| "description": "The first date for which the Scheduled Transaction was scheduled.", | |
| "format": "date" | |
| }, | |
| "date_next": { | |
| "type": "string", | |
| "description": "The next date for which the Scheduled Transaction is scheduled.", | |
| "format": "date" | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled transaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split scheduled transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split scheduled transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "scheduled_transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "scheduled_transaction_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "No scheduled transactions were found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Scheduled Transactions" | |
| ], | |
| "summary": "Create a single scheduled transaction", | |
| "description": "Creates a single scheduled transaction (a transaction with a future date).", | |
| "operationId": "createScheduledTransaction", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The scheduled transaction to create", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "scheduled_transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "scheduled_transaction": { | |
| "required": [ | |
| "account_id", | |
| "date" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The scheduled transaction date in ISO format (e.g. 2016-12-01). This should be a future date no more than 5 years into the future.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the scheduled transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name for the the scheduled transaction. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a payee with the same name or (2) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the scheduled transaction. Credit Card Payment categories are not permitted. Creating a split scheduled transaction is not currently supported.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "description": "The scheduled transaction frequency", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "The scheduled transaction was successfully created", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "scheduled_transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "scheduled_transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "date_first", | |
| "date_next", | |
| "deleted", | |
| "frequency", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date_first": { | |
| "type": "string", | |
| "description": "The first date for which the Scheduled Transaction was scheduled.", | |
| "format": "date" | |
| }, | |
| "date_next": { | |
| "type": "string", | |
| "description": "The next date for which the Scheduled Transaction is scheduled.", | |
| "format": "date" | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled transaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split scheduled transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split scheduled transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "scheduled_transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "scheduled_transaction_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "The request could not be understood due to malformed syntax or validation error(s).", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-codegen-request-body-name": "data", | |
| "x-openai-isConsequential": false | |
| } | |
| }, | |
| "/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}": { | |
| "get": { | |
| "tags": [ | |
| "Scheduled Transactions" | |
| ], | |
| "summary": "Single scheduled transaction", | |
| "description": "Returns a single scheduled transaction", | |
| "operationId": "getScheduledTransactionById", | |
| "parameters": [ | |
| { | |
| "name": "budget_id", | |
| "in": "path", | |
| "description": "The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "scheduled_transaction_id", | |
| "in": "path", | |
| "description": "The id of the scheduled transaction", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The requested Scheduled Transaction", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "scheduled_transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "scheduled_transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "date_first", | |
| "date_next", | |
| "deleted", | |
| "frequency", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date_first": { | |
| "type": "string", | |
| "description": "The first date for which the Scheduled Transaction was scheduled.", | |
| "format": "date" | |
| }, | |
| "date_next": { | |
| "type": "string", | |
| "description": "The next date for which the Scheduled Transaction is scheduled.", | |
| "format": "date" | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled transaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split scheduled transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split scheduled transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "scheduled_transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "scheduled_transaction_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The scheduled transaction was not found", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "An error occurred", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "ErrorResponse": { | |
| "required": [ | |
| "error" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ErrorDetail": { | |
| "required": [ | |
| "detail", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "UserResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "user" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "user": { | |
| "required": [ | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "User": { | |
| "required": [ | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "DateFormat": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "CurrencyFormat": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "BudgetSummaryResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "budgets" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "budgets": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default_budget": { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "BudgetSummary": { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "BudgetDetailResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "budget", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "budget": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "accounts": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "payees": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "payee_locations": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "category_groups": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "categories": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "months": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "activity", | |
| "budgeted", | |
| "deleted", | |
| "income", | |
| "month", | |
| "to_be_budgeted" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "month": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "income": { | |
| "type": "integer", | |
| "description": "The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month", | |
| "format": "int64" | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "The total amount budgeted in the month", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "to_be_budgeted": { | |
| "type": "integer", | |
| "description": "The available amount for 'Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "age_of_money": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The Age of Money as of the month", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "scheduled_transactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "date_first", | |
| "date_next", | |
| "deleted", | |
| "frequency", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date_first": { | |
| "type": "string", | |
| "description": "The first date for which the Scheduled Transaction was scheduled.", | |
| "format": "date" | |
| }, | |
| "date_next": { | |
| "type": "string", | |
| "description": "The next date for which the Scheduled Transaction is scheduled.", | |
| "format": "date" | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled transaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "scheduled_subtransactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "scheduled_transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "scheduled_transaction_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "BudgetDetail": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "last_modified_on": { | |
| "type": "string", | |
| "description": "The last time any changes were made to the budget from either a web or mobile client", | |
| "format": "date-time" | |
| }, | |
| "first_month": { | |
| "type": "string", | |
| "description": "The earliest budget month", | |
| "format": "date" | |
| }, | |
| "last_month": { | |
| "type": "string", | |
| "description": "The latest budget month", | |
| "format": "date" | |
| }, | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "accounts": { | |
| "type": "array", | |
| "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "accounts": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "payees": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "payee_locations": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "category_groups": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "categories": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "months": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "activity", | |
| "budgeted", | |
| "deleted", | |
| "income", | |
| "month", | |
| "to_be_budgeted" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "month": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "income": { | |
| "type": "integer", | |
| "description": "The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month", | |
| "format": "int64" | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "The total amount budgeted in the month", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "to_be_budgeted": { | |
| "type": "integer", | |
| "description": "The available amount for 'Ready to Assign'", | |
| "format": "int64" | |
| }, | |
| "age_of_money": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The Age of Money as of the month", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "scheduled_transactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "date_first", | |
| "date_next", | |
| "deleted", | |
| "frequency", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date_first": { | |
| "type": "string", | |
| "description": "The first date for which the Scheduled Transaction was scheduled.", | |
| "format": "date" | |
| }, | |
| "date_next": { | |
| "type": "string", | |
| "description": "The next date for which the Scheduled Transaction is scheduled.", | |
| "format": "date" | |
| }, | |
| "frequency": { | |
| "type": "string", | |
| "enum": [ | |
| "never", | |
| "daily", | |
| "weekly", | |
| "everyOtherWeek", | |
| "twiceAMonth", | |
| "every4Weeks", | |
| "monthly", | |
| "everyOtherMonth", | |
| "every3Months", | |
| "every4Months", | |
| "twiceAYear", | |
| "yearly", | |
| "everyOtherYear" | |
| ] | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled transaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "scheduled_subtransactions": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "scheduled_transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "scheduled_transaction_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The scheduled subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the scheduled subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "BudgetSettingsResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "settings" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "settings": { | |
| "required": [ | |
| "currency_format", | |
| "date_format" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "BudgetSettings": { | |
| "required": [ | |
| "currency_format", | |
| "date_format" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "date_format": { | |
| "required": [ | |
| "format" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| }, | |
| "currency_format": { | |
| "required": [ | |
| "currency_symbol", | |
| "decimal_digits", | |
| "decimal_separator", | |
| "display_symbol", | |
| "example_format", | |
| "group_separator", | |
| "iso_code", | |
| "symbol_first" | |
| ], | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "properties": { | |
| "iso_code": { | |
| "type": "string" | |
| }, | |
| "example_format": { | |
| "type": "string" | |
| }, | |
| "decimal_digits": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "decimal_separator": { | |
| "type": "string" | |
| }, | |
| "symbol_first": { | |
| "type": "boolean" | |
| }, | |
| "group_separator": { | |
| "type": "string" | |
| }, | |
| "currency_symbol": { | |
| "type": "string" | |
| }, | |
| "display_symbol": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null." | |
| } | |
| } | |
| }, | |
| "AccountsResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "accounts", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "accounts": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "AccountResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "account" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "Account": { | |
| "required": [ | |
| "balance", | |
| "cleared_balance", | |
| "closed", | |
| "deleted", | |
| "id", | |
| "name", | |
| "on_budget", | |
| "transfer_payee_id", | |
| "type", | |
| "uncleared_balance" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "on_budget": { | |
| "type": "boolean", | |
| "description": "Whether this account is on budget or not" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "description": "Whether this account is closed or not" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "cleared_balance": { | |
| "type": "integer", | |
| "description": "The current cleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "uncleared_balance": { | |
| "type": "integer", | |
| "description": "The current uncleared balance of the account in milliunits format", | |
| "format": "int64" | |
| }, | |
| "transfer_payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee id which should be used when transferring to this account", | |
| "format": "uuid" | |
| }, | |
| "direct_import_linked": { | |
| "type": "boolean", | |
| "description": "Whether or not the account is linked to a financial institution for automatic transaction import." | |
| }, | |
| "direct_import_in_error": { | |
| "type": "boolean", | |
| "description": "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." | |
| }, | |
| "last_reconciled_at": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "A date/time specifying when the account was last reconciled.", | |
| "format": "date-time" | |
| }, | |
| "debt_original_balance": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The original debt/loan account balance, specified in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "debt_interest_rates": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_minimum_payments": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "debt_escrow_amounts": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "PostAccountWrapper": { | |
| "required": [ | |
| "account" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "required": [ | |
| "balance", | |
| "name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the account" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "SaveAccount": { | |
| "required": [ | |
| "balance", | |
| "name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the account" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "The current balance of the account in milliunits format", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "LoanAccountPeriodicValue": { | |
| "type": [ | |
| "object", | |
| "null" | |
| ], | |
| "additionalProperties": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "AccountType": { | |
| "type": "string", | |
| "description": "The type of account", | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "cash", | |
| "creditCard", | |
| "lineOfCredit", | |
| "otherAsset", | |
| "otherLiability", | |
| "mortgage", | |
| "autoLoan", | |
| "studentLoan", | |
| "personalLoan", | |
| "medicalDebt", | |
| "otherDebt" | |
| ] | |
| }, | |
| "CategoriesResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category_groups", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category_groups": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "CategoryResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "CategoryGroupWithCategories": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "categories" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "categories": { | |
| "type": "array", | |
| "description": "Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", | |
| "items": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "CategoryGroup": { | |
| "required": [ | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group is hidden" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "Category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "SaveCategoryResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "category", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "required": [ | |
| "activity", | |
| "balance", | |
| "budgeted", | |
| "category_group_id", | |
| "deleted", | |
| "hidden", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "category_group_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether or not the category is hidden" | |
| }, | |
| "original_category_group_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "DEPRECATED: No longer used. Value will always be null.", | |
| "format": "uuid" | |
| }, | |
| "note": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "budgeted": { | |
| "type": "integer", | |
| "description": "Budgeted amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "activity": { | |
| "type": "integer", | |
| "description": "Activity amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "balance": { | |
| "type": "integer", | |
| "description": "Balance in milliunits format", | |
| "format": "int64" | |
| }, | |
| "goal_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "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')", | |
| "enum": [ | |
| "TB", | |
| "TBD", | |
| "MF", | |
| "NEED", | |
| "DEBT", | |
| null | |
| ] | |
| }, | |
| "goal_needs_whole_amount": { | |
| "type": [ | |
| "boolean", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "default": null | |
| }, | |
| "goal_day": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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).", | |
| "format": "int32" | |
| }, | |
| "goal_cadence": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_cadence_frequency": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int32" | |
| }, | |
| "goal_creation_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The month a goal was created", | |
| "format": "date" | |
| }, | |
| "goal_target": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The goal target amount in milliunits", | |
| "format": "int64" | |
| }, | |
| "goal_target_month": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The original target month for the goal to be completed. Only some goal types specify this date.", | |
| "format": "date" | |
| }, | |
| "goal_percentage_complete": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The percentage completion of the goal", | |
| "format": "int32" | |
| }, | |
| "goal_months_to_budget": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The number of months, including the current month, left in the current goal period.", | |
| "format": "int32" | |
| }, | |
| "goal_under_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "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.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_funded": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The total amount funded towards the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "goal_overall_left": { | |
| "type": [ | |
| "integer", | |
| "null" | |
| ], | |
| "description": "The amount of funding still needed to complete the goal within the current goal period.", | |
| "format": "int64" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PayeesResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payees", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payees": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PayeeResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "SavePayeeResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee", | |
| "server_knowledge" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "Payee": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer payee, the `account_id` to which this payee transfers to" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "PayeeLocationsResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee_locations" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee_locations": { | |
| "type": "array", | |
| "items": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PayeeLocationResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "payee_location" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "payee_location": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PayeeLocation": { | |
| "required": [ | |
| "deleted", | |
| "id", | |
| "latitude", | |
| "longitude", | |
| "payee_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "TransactionsResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "server_knowledge", | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "HybridTransactionsResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Whether the hybrid transaction represents a regular transaction or a subtransaction", | |
| "enum": [ | |
| "transaction", | |
| "subtransaction" | |
| ] | |
| }, | |
| "parent_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null." | |
| }, | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": "string", | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PutTransactionWrapper": { | |
| "required": [ | |
| "transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "type": "object" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "PostTransactionsWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, a new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API)." | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, a new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API)." | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "PatchTransactionsWrapper": { | |
| "required": [ | |
| "transactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transactions": { | |
| "type": "array", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, this id will be used to lookup a transaction by its `id` for the purpose of updating the transaction itself. If not specified, an `import_id` should be supplied." | |
| }, | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, this id will be used to lookup a transaction by its `import_id` for the purpose of updating the transaction itself. If not specified, an `id` should be supplied. You may not provide both an `id` and an `import_id` and updating an `import_id` on an existing transaction is not allowed." | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "ExistingTransaction": { | |
| "allOf": [ | |
| { | |
| "type": "object" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "NewTransaction": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, a new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API)." | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "SaveTransactionWithIdOrImportId": { | |
| "allOf": [ | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, this id will be used to lookup a transaction by its `id` for the purpose of updating the transaction itself. If not specified, an `import_id` should be supplied." | |
| }, | |
| "import_id": { | |
| "maxLength": 36, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If specified, this id will be used to lookup a transaction by its `import_id` for the purpose of updating the transaction itself. If not specified, an `id` should be supplied. You may not provide both an `id` and an `import_id` and updating an `import_id` on an existing transaction is not allowed." | |
| } | |
| } | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "SaveTransactionWithOptionalFields": { | |
| "type": "object", | |
| "properties": { | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default." | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.", | |
| "items": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "SaveSubTransaction": { | |
| "required": [ | |
| "amount" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format.", | |
| "format": "int64" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee for the subtransaction.", | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "maxLength": 200, | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee." | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.", | |
| "format": "uuid" | |
| }, | |
| "memo": { | |
| "maxLength": 500, | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| } | |
| } | |
| }, | |
| "SaveTransactionsResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "server_knowledge", | |
| "transaction_ids" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction_ids": { | |
| "type": "array", | |
| "description": "The transaction ids that were saved", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "transactions": { | |
| "type": "array", | |
| "description": "If multiple transactions were specified, the transactions that were saved", | |
| "items": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "duplicate_import_ids": { | |
| "type": "array", | |
| "description": "If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "server_knowledge": { | |
| "type": "integer", | |
| "description": "The knowledge of the server", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "TransactionResponse": { | |
| "required": [ | |
| "data" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "required": [ | |
| "transaction" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "transaction": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| { | |
| "required": [ | |
| "account_name", | |
| "subtransactions" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "account_name": { | |
| "type": "string" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The name of the category. If a split transaction, this will be 'Split'." | |
| }, | |
| "subtransactions": { | |
| "type": "array", | |
| "description": "If a split transaction, the subtransactions.", | |
| "items": { | |
| "required": [ | |
| "amount", | |
| "deleted", | |
| "id", | |
| "transaction_id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The subtransaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the account_id which the subtransaction transfers to", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer, the id of transaction on the other side of the transfer" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "TransactionSummary": { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "description": "The transaction date in ISO format (e.g. 2016-12-01)", | |
| "format": "date" | |
| }, | |
| "amount": { | |
| "type": "integer", | |
| "description": "The transaction amount in milliunits format", | |
| "format": "int64" | |
| }, | |
| "memo": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ] | |
| }, | |
| "cleared": { | |
| "type": "string", | |
| "description": "The cleared status of the transaction", | |
| "enum": [ | |
| "cleared", | |
| "uncleared", | |
| "reconciled" | |
| ] | |
| }, | |
| "approved": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction is approved" | |
| }, | |
| "flag_color": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The transaction flag", | |
| "enum": [ | |
| "red", | |
| "orange", | |
| "yellow", | |
| "green", | |
| "blue", | |
| "purple", | |
| null | |
| ] | |
| }, | |
| "flag_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "The customized name of a transaction flag" | |
| }, | |
| "account_id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "payee_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "category_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "format": "uuid" | |
| }, | |
| "transfer_account_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the account to which it transfers", | |
| "format": "uuid" | |
| }, | |
| "transfer_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If a transfer transaction, the id of transaction on the other side of the transfer" | |
| }, | |
| "matched_transaction_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If transaction is matched, the id of the matched transaction" | |
| }, | |
| "import_id": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'." | |
| }, | |
| "import_payee_name": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules" | |
| }, | |
| "import_payee_name_original": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction was imported, the original payee name as it appeared on the statement" | |
| }, | |
| "debt_transaction_type": { | |
| "type": [ | |
| "string", | |
| "null" | |
| ], | |
| "description": "If the transaction is a debt/loan account transaction, the type of transaction", | |
| "enum": [ | |
| "payment", | |
| "refund", | |
| "fee", | |
| "interest", | |
| "escrow", | |
| "balanceAdjustment", | |
| "credit", | |
| "charge", | |
| null | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests." | |
| } | |
| } | |
| }, | |
| "TransactionDetail": { | |
| "allOf": [ | |
| { | |
| "required": [ | |
| "account_id", | |
| "amount", | |
| "approved", | |
| "cleared", | |
| "date", | |
| "deleted", | |
| "id" | |
| ], | |
| "typ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment