Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.67 KB

README.md

File metadata and controls

39 lines (29 loc) · 1.67 KB
Raw

YNAB.Rest Contributor Covenant

YNAB.Rest

A cross-platform .NET client for the YNAB REST API, using the Refit REST library. All REST methods are asynchronous and awaitable.

See the source on GitHub.

Getting Started

  1. Install the Nuget package or compile the code.
  2. Import the namespace YNAB.Rest.
  3. Create an IApiClient by calling ApiClientFactory.Create([accessToken]).
  4. Start coding!

Example Code

string accessToken = "secret_api_access_token";
var api = ApiClientFactory.Create(accessToken);
var budgetsResponse = await api.GetBudgets();
var budgets = budgetsResponse.Data.Budgets;

Response Objects

All methods return a response object that has a Data property containing the data from the REST API call. In this example, the response object contains a Data property that has a Budgets property with a list of Budgets.

This structure follows the convention of the YNAB REST API.

Project Status

This is a new project. There are plenty of opportunities for improvement.

What Works

GET Budgets, Accounts, Categories, Transactions, Payees, Payee Locations POST/PUT Transactions

What Needs To Be Done

GET Months, Scheduled Transactions

License

This code is licensed under the MIT License. Use of this code requires consent to the terms of the license.