ynab 1.31.0 → 2.0.0

data/docs/PayeeLocationsApi.md

@@ -0,0 +1,69 @@
+# YNAB::PayeeLocationsApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **GET** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location |
+| [**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **GET** /budgets/{budget_id}/payee_locations | List payee locations |
+| [**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee |
+
+
+## get_payee_location_by_id
+
+> <PayeeLocationResponse> get_payee_location_by_id(budget_id, payee_location_id)
+
+Single payee location
+
+Returns a single payee location
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **payee_location_id** | **String** | id of payee location |  |
+
+### Return type
+
+[**PayeeLocationResponse**](PayeeLocationResponse.md)
+
+
+## get_payee_locations
+
+> <PayeeLocationsResponse> get_payee_locations(budget_id)
+
+List payee locations
+
+Returns all payee locations
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+
+### Return type
+
+[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
+
+
+## get_payee_locations_by_payee
+
+> <PayeeLocationsResponse> get_payee_locations_by_payee(budget_id, payee_id)
+
+List locations for a payee
+
+Returns all payee locations for a specified payee
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **payee_id** | **String** | id of payee |  |
+
+### Return type
+
+[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
+

data/docs/PayeeLocationsResponse.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeLocationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PayeeLocationsResponseData**](PayeeLocationsResponseData.md) |  |  |
+

data/docs/PayeeLocationsResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeLocationsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payee_locations** | [**Array<PayeeLocation>**](PayeeLocation.md) |  |  |
+

data/docs/PayeeLocationsWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeLocationsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_locations** | [**Array<PayeeLocation>**](PayeeLocation.md) |  | 
+
+

data/docs/PayeeResponse.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PayeeResponseData**](PayeeResponseData.md) |  |  |
+

data/docs/PayeeResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payee** | [**Payee**](Payee.md) |  |  |
+

data/docs/PayeeWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee** | [**Payee**](Payee.md) |  | 
+
+

data/docs/PayeesApi.md

@@ -0,0 +1,49 @@
+# YNAB::PayeesApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **GET** /budgets/{budget_id}/payees/{payee_id} | Single payee |
+| [**get_payees**](PayeesApi.md#get_payees) | **GET** /budgets/{budget_id}/payees | List payees |
+
+
+## get_payee_by_id
+
+> <PayeeResponse> get_payee_by_id(budget_id, payee_id)
+
+Single payee
+
+Returns a single payee
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **payee_id** | **String** | The id of the payee |  |
+
+### Return type
+
+[**PayeeResponse**](PayeeResponse.md)
+
+
+## get_payees
+
+> <PayeesResponse> get_payees(budget_id, opts)
+
+List payees
+
+Returns all payees
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
+
+### Return type
+
+[**PayeesResponse**](PayeesResponse.md)
+

data/docs/PayeesResponse.md

@@ -0,0 +1,8 @@
+# YNAB::PayeesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PayeesResponseData**](PayeesResponseData.md) |  |  |
+

data/docs/PayeesResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::PayeesResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payees** | [**Array<Payee>**](Payee.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/PayeesWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::PayeesWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payees** | [**Array<Payee>**](Payee.md) |  | 
+**server_knowledge** | **Integer** | The knowledge of the server | 
+
+

data/docs/PostAccountWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PostAccountWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | [**SaveAccount**](SaveAccount.md) |  |  |
+

data/docs/PostTransactionsWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::PostTransactionsWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction** | [**SaveTransaction**](SaveTransaction.md) |  | [optional] |
+| **transactions** | [**Array<SaveTransaction>**](SaveTransaction.md) |  | [optional] |
+

data/docs/PutTransactionWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PutTransactionWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction** | [**SaveTransaction**](SaveTransaction.md) |  |  |
+

data/docs/SaveAccount.md

@@ -0,0 +1,10 @@
+# YNAB::SaveAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the account |  |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **balance** | **Integer** | The current balance of the account in milliunits format |  |
+

data/docs/SaveAccountWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::SaveAccountWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**SaveAccount**](SaveAccount.md) |  | 
+
+

data/docs/SaveCategoryResponse.md

@@ -0,0 +1,8 @@
+# YNAB::SaveCategoryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**SaveCategoryResponseData**](SaveCategoryResponseData.md) |  |  |
+

data/docs/SaveCategoryResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::SaveCategoryResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | [**Category**](Category.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/SaveMonthCategory.md

@@ -0,0 +1,8 @@
+# YNAB::SaveMonthCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budgeted** | **Integer** | Budgeted amount in milliunits format |  |
+

data/docs/SaveMonthCategoryWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::SaveMonthCategoryWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | [**SaveMonthCategory**](SaveMonthCategory.md) |  | 
+
+

data/docs/SaveSubTransaction.md

@@ -0,0 +1,12 @@
+# YNAB::SaveSubTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The subtransaction amount in milliunits format. |  |
+| **payee_id** | **String** | The payee for the subtransaction. | [optional] |
+| **payee_name** | **String** | 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. | [optional] |
+| **category_id** | **String** | The category for the subtransaction.  Credit Card Payment categories are not permitted and will be ignored if supplied. | [optional] |
+| **memo** | **String** |  | [optional] |
+

data/docs/SaveTransaction.md

@@ -0,0 +1,19 @@
+# YNAB::SaveTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  | [optional] |
+| **date** | **Date** | 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. | [optional] |
+| **amount** | **Integer** | The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | [optional] |
+| **payee_id** | **String** | 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 `tranfer_payee_id` on the account resource. | [optional] |
+| **payee_name** | **String** | 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. | [optional] |
+| **category_id** | **String** | 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. | [optional] |
+| **memo** | **String** |  | [optional] |
+| **cleared** | **String** | The cleared status of the transaction | [optional] |
+| **approved** | **Boolean** | Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default. | [optional] |
+| **flag_color** | **String** | The transaction flag | [optional] |
+| **import_id** | **String** | If specified, the 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\" transation 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). | [optional] |
+| **subtransactions** | [**Array<SaveSubTransaction>**](SaveSubTransaction.md) | An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported. | [optional] |
+

data/docs/SaveTransactionWithId.md

@@ -0,0 +1,20 @@
+# YNAB::SaveTransactionWithId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **account_id** | **String** |  | [optional] |
+| **date** | **Date** | 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. | [optional] |
+| **amount** | **Integer** | The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | [optional] |
+| **payee_id** | **String** | 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 `tranfer_payee_id` on the account resource. | [optional] |
+| **payee_name** | **String** | 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. | [optional] |
+| **category_id** | **String** | 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. | [optional] |
+| **memo** | **String** |  | [optional] |
+| **cleared** | **String** | The cleared status of the transaction | [optional] |
+| **approved** | **Boolean** | Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default. | [optional] |
+| **flag_color** | **String** | The transaction flag | [optional] |
+| **import_id** | **String** | If specified, the 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\" transation 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). | [optional] |
+| **subtransactions** | [**Array<SaveSubTransaction>**](SaveSubTransaction.md) | An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported. | [optional] |
+

data/docs/SaveTransactionWithIdAllOf.md

@@ -0,0 +1,8 @@
+# YNAB::SaveTransactionWithIdAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+

data/docs/SaveTransactionWithOptionalFields.md

@@ -0,0 +1,19 @@
+# YNAB::SaveTransactionWithOptionalFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  | [optional] |
+| **date** | **Date** | 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. | [optional] |
+| **amount** | **Integer** | The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | [optional] |
+| **payee_id** | **String** | 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 `tranfer_payee_id` on the account resource. | [optional] |
+| **payee_name** | **String** | 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. | [optional] |
+| **category_id** | **String** | 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. | [optional] |
+| **memo** | **String** |  | [optional] |
+| **cleared** | **String** | The cleared status of the transaction | [optional] |
+| **approved** | **Boolean** | Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default. | [optional] |
+| **flag_color** | **String** | The transaction flag | [optional] |
+| **import_id** | **String** | If specified, the 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\" transation 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). | [optional] |
+| **subtransactions** | [**Array<SaveSubTransaction>**](SaveSubTransaction.md) | An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported. | [optional] |
+

data/docs/SaveTransactionWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::SaveTransactionWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction** | [**SaveTransaction**](SaveTransaction.md) |  | 
+
+

data/docs/SaveTransactionsResponse.md

@@ -0,0 +1,8 @@
+# YNAB::SaveTransactionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**SaveTransactionsResponseData**](SaveTransactionsResponseData.md) |  |  |
+

data/docs/SaveTransactionsResponseData.md

@@ -0,0 +1,12 @@
+# YNAB::SaveTransactionsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_ids** | **Array<String>** | The transaction ids that were saved |  |
+| **transaction** | [**TransactionDetail**](TransactionDetail.md) |  | [optional] |
+| **transactions** | [**Array<TransactionDetail>**](TransactionDetail.md) | If multiple transactions were specified, the transactions that were saved | [optional] |
+| **duplicate_import_ids** | **Array<String>** | 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 | [optional] |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/SaveTransactionsWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::SaveTransactionsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction** | [**SaveTransaction**](SaveTransaction.md) |  | [optional] 
+**transactions** | [**Array<SaveTransaction>**](SaveTransaction.md) |  | [optional] 
+
+

data/docs/ScheduledSubTransaction.md

@@ -0,0 +1,15 @@
+# YNAB::ScheduledSubTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **scheduled_transaction_id** | **String** |  |  |
+| **amount** | **Integer** | The scheduled subtransaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional] |
+| **deleted** | **Boolean** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. |  |
+

data/docs/ScheduledTransactionDetail.md

@@ -0,0 +1,23 @@
+# YNAB::ScheduledTransactionDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **date_first** | **Date** | The first date for which the Scheduled Transaction was scheduled. |  |
+| **date_next** | **Date** | The next date for which the Scheduled Transaction is scheduled. |  |
+| **frequency** | **String** |  |  |
+| **amount** | **Integer** | The scheduled transaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **flag_color** | **String** | The scheduled transaction flag | [optional] |
+| **account_id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] |
+| **deleted** | **Boolean** | 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** |  | [optional] |
+| **category_name** | **String** | The name of the category.  If a split scheduled transaction, this will be 'Split'. | [optional] |
+| **subtransactions** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. |  |
+

data/docs/ScheduledTransactionDetailAllOf.md

@@ -0,0 +1,11 @@
+# YNAB::ScheduledTransactionDetailAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_name** | **String** |  |  |
+| **payee_name** | **String** |  | [optional] |
+| **category_name** | **String** | The name of the category.  If a split scheduled transaction, this will be 'Split'. | [optional] |
+| **subtransactions** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. |  |
+

data/docs/ScheduledTransactionResponse.md

@@ -0,0 +1,8 @@
+# YNAB::ScheduledTransactionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ScheduledTransactionResponseData**](ScheduledTransactionResponseData.md) |  |  |
+

data/docs/ScheduledTransactionResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::ScheduledTransactionResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scheduled_transaction** | [**ScheduledTransactionDetail**](ScheduledTransactionDetail.md) |  |  |
+

data/docs/ScheduledTransactionSummary.md

@@ -0,0 +1,19 @@
+# YNAB::ScheduledTransactionSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **date_first** | **Date** | The first date for which the Scheduled Transaction was scheduled. |  |
+| **date_next** | **Date** | The next date for which the Scheduled Transaction is scheduled. |  |
+| **frequency** | **String** |  |  |
+| **amount** | **Integer** | The scheduled transaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **flag_color** | **String** | The scheduled transaction flag | [optional] |
+| **account_id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] |
+| **deleted** | **Boolean** | Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests. |  |
+

data/docs/ScheduledTransactionWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::ScheduledTransactionWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheduled_transaction** | [**ScheduledTransactionDetail**](ScheduledTransactionDetail.md) |  | 
+
+

data/docs/ScheduledTransactionsApi.md

@@ -0,0 +1,49 @@
+# YNAB::ScheduledTransactionsApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_scheduled_transaction_by_id**](ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **GET** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction |
+| [**get_scheduled_transactions**](ScheduledTransactionsApi.md#get_scheduled_transactions) | **GET** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions |
+
+
+## get_scheduled_transaction_by_id
+
+> <ScheduledTransactionResponse> get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
+
+Single scheduled transaction
+
+Returns a single scheduled transaction
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **scheduled_transaction_id** | **String** | The id of the scheduled transaction |  |
+
+### Return type
+
+[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
+
+
+## get_scheduled_transactions
+
+> <ScheduledTransactionsResponse> get_scheduled_transactions(budget_id, opts)
+
+List scheduled transactions
+
+Returns all scheduled transactions
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
+
+### Return type
+
+[**ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md)
+

data/docs/ScheduledTransactionsResponse.md

@@ -0,0 +1,8 @@
+# YNAB::ScheduledTransactionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ScheduledTransactionsResponseData**](ScheduledTransactionsResponseData.md) |  |  |
+

data/docs/ScheduledTransactionsResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::ScheduledTransactionsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scheduled_transactions** | [**Array<ScheduledTransactionDetail>**](ScheduledTransactionDetail.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/ScheduledTransactionsWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::ScheduledTransactionsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheduled_transactions** | [**Array<ScheduledTransactionDetail>**](ScheduledTransactionDetail.md) |  | 
+
+