aboutsummaryrefslogtreecommitdiffstats
path: root/ynab-api/docs
diff options
context:
space:
mode:
Diffstat (limited to 'ynab-api/docs')
-rw-r--r--ynab-api/docs/Account.md2
-rw-r--r--ynab-api/docs/BudgetSummaryResponseData.md2
-rw-r--r--ynab-api/docs/Category.md10
-rw-r--r--ynab-api/docs/HybridTransaction.md16
-rw-r--r--ynab-api/docs/MonthDetail.md4
-rw-r--r--ynab-api/docs/MonthSummary.md4
-rw-r--r--ynab-api/docs/Payee.md2
-rw-r--r--ynab-api/docs/ScheduledSubTransaction.md6
-rw-r--r--ynab-api/docs/ScheduledTransactionDetail.md6
-rw-r--r--ynab-api/docs/ScheduledTransactionSummary.md6
-rw-r--r--ynab-api/docs/SubTransaction.md8
-rw-r--r--ynab-api/docs/TransactionDetail.md16
-rw-r--r--ynab-api/docs/TransactionSummary.md16
13 files changed, 49 insertions, 49 deletions
diff --git a/ynab-api/docs/Account.md b/ynab-api/docs/Account.md
index adeab71..265294b 100644
--- a/ynab-api/docs/Account.md
+++ b/ynab-api/docs/Account.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**_type** | **String** | The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future. |
**on_budget** | **bool** | Whether this account is on budget or not |
**closed** | **bool** | Whether this account is closed or not |
-**note** | **String** | |
+**note** | **String** | | [optional]
**balance** | **i64** | The current balance of the account in milliunits format |
**cleared_balance** | **i64** | The current cleared balance of the account in milliunits format |
**uncleared_balance** | **i64** | The current uncleared balance of the account in milliunits format |
diff --git a/ynab-api/docs/BudgetSummaryResponseData.md b/ynab-api/docs/BudgetSummaryResponseData.md
index 6adce43..2836bfa 100644
--- a/ynab-api/docs/BudgetSummaryResponseData.md
+++ b/ynab-api/docs/BudgetSummaryResponseData.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**budgets** | [**Vec<::models::BudgetSummary>**](BudgetSummary.md) | |
-**default_budget** | [***::models::BudgetSummary**](BudgetSummary.md) | |
+**default_budget** | [***::models::BudgetSummary**](BudgetSummary.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/Category.md b/ynab-api/docs/Category.md
index 2afbe63..217979b 100644
--- a/ynab-api/docs/Category.md
+++ b/ynab-api/docs/Category.md
@@ -9,15 +9,15 @@ Name | Type | Description | Notes
**name** | **String** | |
**hidden** | **bool** | Whether or not the category is hidden |
**original_category_group_id** | **String** | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional]
-**note** | **String** | |
+**note** | **String** | | [optional]
**budgeted** | **i64** | Budgeted amount in milliunits format |
**activity** | **i64** | Activity amount in milliunits format |
**balance** | **i64** | Balance in milliunits format |
-**goal_type** | **String** | The type of goal, if the cagegory has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) |
-**goal_creation_month** | [***String**](string.md) | The month a goal was created |
+**goal_type** | **String** | The type of goal, if the cagegory has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) | [optional]
+**goal_creation_month** | [***String**](string.md) | The month a goal was created | [optional]
**goal_target** | **i64** | The goal target amount in milliunits |
-**goal_target_month** | [***String**](string.md) | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed |
-**goal_percentage_complete** | **i32** | The percentage completion of the goal |
+**goal_target_month** | [***String**](string.md) | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed | [optional]
+**goal_percentage_complete** | **i32** | The percentage completion of the goal | [optional]
**deleted** | **bool** | Whether or not the category has been deleted. Deleted categories will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/HybridTransaction.md b/ynab-api/docs/HybridTransaction.md
index 8c88165..69c0a4e 100644
--- a/ynab-api/docs/HybridTransaction.md
+++ b/ynab-api/docs/HybridTransaction.md
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
**id** | **String** | |
**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) |
**amount** | **i64** | The transaction amount in milliunits format |
-**memo** | **String** | |
+**memo** | **String** | | [optional]
**cleared** | **String** | The cleared status of the transaction |
**approved** | **bool** | Whether or not the transaction is approved |
-**flag_color** | **String** | The transaction flag |
+**flag_color** | **String** | The transaction flag | [optional]
**account_id** | **String** | |
-**payee_id** | **String** | |
-**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers |
-**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer |
-**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction |
-**import_id** | **String** | 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'. |
+**payee_id** | **String** | | [optional]
+**category_id** | **String** | | [optional]
+**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional]
+**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional]
+**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional]
+**import_id** | **String** | 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'. | [optional]
**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. |
**_type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction |
**parent_transaction_id** | **String** | For subtransaction types, this is the id of the pararent transaction. For transaction types, this id will be always be null. |
diff --git a/ynab-api/docs/MonthDetail.md b/ynab-api/docs/MonthDetail.md
index d1fc13a..1d7a22b 100644
--- a/ynab-api/docs/MonthDetail.md
+++ b/ynab-api/docs/MonthDetail.md
@@ -5,12 +5,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**month** | [***String**](string.md) | |
-**note** | **String** | |
+**note** | **String** | | [optional]
**income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month |
**budgeted** | **i64** | The total amount budgeted in the month |
**activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' |
**to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' |
-**age_of_money** | **i32** | The Age of Money as of the month |
+**age_of_money** | **i32** | The Age of Money as of the month | [optional]
**deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. |
**categories** | [**Vec<::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. |
diff --git a/ynab-api/docs/MonthSummary.md b/ynab-api/docs/MonthSummary.md
index e48e3a4..a78cbfc 100644
--- a/ynab-api/docs/MonthSummary.md
+++ b/ynab-api/docs/MonthSummary.md
@@ -5,12 +5,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**month** | [***String**](string.md) | |
-**note** | **String** | |
+**note** | **String** | | [optional]
**income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month |
**budgeted** | **i64** | The total amount budgeted in the month |
**activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' |
**to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' |
-**age_of_money** | **i32** | The Age of Money as of the month |
+**age_of_money** | **i32** | The Age of Money as of the month | [optional]
**deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/Payee.md b/ynab-api/docs/Payee.md
index a52f0f9..ff886e6 100644
--- a/ynab-api/docs/Payee.md
+++ b/ynab-api/docs/Payee.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**name** | **String** | |
-**transfer_account_id** | **String** | If a transfer payee, the account_id to which this payee transfers to |
+**transfer_account_id** | **String** | If a transfer payee, the account_id to which this payee transfers to | [optional]
**deleted** | **bool** | Whether or not the payee has been deleted. Deleted payees will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/ScheduledSubTransaction.md b/ynab-api/docs/ScheduledSubTransaction.md
index 377c31f..6178bab 100644
--- a/ynab-api/docs/ScheduledSubTransaction.md
+++ b/ynab-api/docs/ScheduledSubTransaction.md
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
**id** | **String** | |
**scheduled_transaction_id** | **String** | |
**amount** | **i64** | The scheduled subtransaction amount in milliunits format |
-**memo** | **String** | |
-**payee_id** | **String** | |
+**memo** | **String** | | [optional]
+**payee_id** | **String** | | [optional]
**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to |
+**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional]
**deleted** | **bool** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/ScheduledTransactionDetail.md b/ynab-api/docs/ScheduledTransactionDetail.md
index b140d03..5f45c7e 100644
--- a/ynab-api/docs/ScheduledTransactionDetail.md
+++ b/ynab-api/docs/ScheduledTransactionDetail.md
@@ -9,12 +9,12 @@ Name | Type | Description | Notes
**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. |
**frequency** | **String** | |
**amount** | **i64** | The scheduled transaction amount in milliunits format |
-**memo** | **String** | |
+**memo** | **String** | | [optional]
**flag_color** | **String** | The scheduled transaction flag |
**account_id** | **String** | |
-**payee_id** | **String** | |
+**payee_id** | **String** | | [optional]
**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to |
+**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional]
**deleted** | **bool** | Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests. |
**account_name** | **String** | |
**payee_name** | **String** | |
diff --git a/ynab-api/docs/ScheduledTransactionSummary.md b/ynab-api/docs/ScheduledTransactionSummary.md
index e66c915..4b248b0 100644
--- a/ynab-api/docs/ScheduledTransactionSummary.md
+++ b/ynab-api/docs/ScheduledTransactionSummary.md
@@ -9,12 +9,12 @@ Name | Type | Description | Notes
**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. |
**frequency** | **String** | |
**amount** | **i64** | The scheduled transaction amount in milliunits format |
-**memo** | **String** | |
+**memo** | **String** | | [optional]
**flag_color** | **String** | The scheduled transaction flag |
**account_id** | **String** | |
-**payee_id** | **String** | |
+**payee_id** | **String** | | [optional]
**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to |
+**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional]
**deleted** | **bool** | Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/SubTransaction.md b/ynab-api/docs/SubTransaction.md
index 9e48239..77bad7f 100644
--- a/ynab-api/docs/SubTransaction.md
+++ b/ynab-api/docs/SubTransaction.md
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
**id** | **String** | |
**transaction_id** | **String** | |
**amount** | **i64** | The subtransaction amount in milliunits format |
-**memo** | **String** | |
-**payee_id** | **String** | |
-**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to |
+**memo** | **String** | | [optional]
+**payee_id** | **String** | | [optional]
+**category_id** | **String** | | [optional]
+**transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional]
**deleted** | **bool** | Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/ynab-api/docs/TransactionDetail.md b/ynab-api/docs/TransactionDetail.md
index f9a1de5..ad156d7 100644
--- a/ynab-api/docs/TransactionDetail.md
+++ b/ynab-api/docs/TransactionDetail.md
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
**id** | **String** | |
**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) |
**amount** | **i64** | The transaction amount in milliunits format |
-**memo** | **String** | |
+**memo** | **String** | | [optional]
**cleared** | **String** | The cleared status of the transaction |
**approved** | **bool** | Whether or not the transaction is approved |
-**flag_color** | **String** | The transaction flag |
+**flag_color** | **String** | The transaction flag | [optional]
**account_id** | **String** | |
-**payee_id** | **String** | |
-**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers |
-**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer |
-**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction |
-**import_id** | **String** | 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'. |
+**payee_id** | **String** | | [optional]
+**category_id** | **String** | | [optional]
+**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional]
+**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional]
+**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional]
+**import_id** | **String** | 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'. | [optional]
**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. |
**account_name** | **String** | |
**payee_name** | **String** | |
diff --git a/ynab-api/docs/TransactionSummary.md b/ynab-api/docs/TransactionSummary.md
index bad149c..fd93b15 100644
--- a/ynab-api/docs/TransactionSummary.md
+++ b/ynab-api/docs/TransactionSummary.md
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
**id** | **String** | |
**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) |
**amount** | **i64** | The transaction amount in milliunits format |
-**memo** | **String** | |
+**memo** | **String** | | [optional]
**cleared** | **String** | The cleared status of the transaction |
**approved** | **bool** | Whether or not the transaction is approved |
-**flag_color** | **String** | The transaction flag |
+**flag_color** | **String** | The transaction flag | [optional]
**account_id** | **String** | |
-**payee_id** | **String** | |
-**category_id** | **String** | |
-**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers |
-**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer |
-**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction |
-**import_id** | **String** | 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'. |
+**payee_id** | **String** | | [optional]
+**category_id** | **String** | | [optional]
+**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional]
+**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional]
+**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional]
+**import_id** | **String** | 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'. | [optional]
**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)