Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 3.01 KB

ScheduledTransactionsApi.md

File metadata and controls

70 lines (40 loc) · 3.01 KB

YNAB::ScheduledTransactionsApi

All URIs are relative to https://api.ynab.com/v1

Method HTTP request Description
create_scheduled_transaction POST /budgets/{budget_id}/scheduled_transactions Create a single scheduled transaction
get_scheduled_transaction_by_id GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} Single scheduled transaction
get_scheduled_transactions GET /budgets/{budget_id}/scheduled_transactions List scheduled transactions

create_scheduled_transaction

create_scheduled_transaction(budget_id, data)

Create a single scheduled transaction

Creates a single scheduled transaction (a transaction with a future date).

Parameters

Name Type Description Notes
budget_id String 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).
data PostScheduledTransactionWrapper The scheduled transaction to create

Return type

ScheduledTransactionResponse

get_scheduled_transaction_by_id

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. "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).
scheduled_transaction_id String The id of the scheduled transaction

Return type

ScheduledTransactionResponse

get_scheduled_transactions

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. "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).
last_knowledge_of_server Integer The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. [optional]

Return type

ScheduledTransactionsResponse