包简介

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

README 文档

README

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

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AccountsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$budget_id = 'budget_id_example'; // 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 = new \OpenAPI\Client\Model\PostAccountWrapper(); // \OpenAPI\Client\Model\PostAccountWrapper | The account to create.

try {
    $result = $apiInstance->createAccount($budget_id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->createAccount: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	createAccount	POST /budgets/{budget_id}/accounts	Create a new account
AccountsApi	getAccountById	GET /budgets/{budget_id}/accounts/{account_id}	Single account
AccountsApi	getAccounts	GET /budgets/{budget_id}/accounts	Account list
BudgetsApi	getBudgetById	GET /budgets/{budget_id}	Single budget
BudgetsApi	getBudgetSettingsById	GET /budgets/{budget_id}/settings	Budget Settings
BudgetsApi	getBudgets	GET /budgets	List budgets
CategoriesApi	getCategories	GET /budgets/{budget_id}/categories	List categories
CategoriesApi	getCategoryById	GET /budgets/{budget_id}/categories/{category_id}	Single category
CategoriesApi	getMonthCategoryById	GET /budgets/{budget_id}/months/{month}/categories/{category_id}	Single category for a specific budget month
CategoriesApi	updateCategory	PATCH /budgets/{budget_id}/categories/{category_id}	Update a category
CategoriesApi	updateMonthCategory	PATCH /budgets/{budget_id}/months/{month}/categories/{category_id}	Update a category for a specific month
MonthsApi	getBudgetMonth	GET /budgets/{budget_id}/months/{month}	Single budget month
MonthsApi	getBudgetMonths	GET /budgets/{budget_id}/months	List budget months
PayeeLocationsApi	getPayeeLocationById	GET /budgets/{budget_id}/payee_locations/{payee_location_id}	Single payee location
PayeeLocationsApi	getPayeeLocations	GET /budgets/{budget_id}/payee_locations	List payee locations
PayeeLocationsApi	getPayeeLocationsByPayee	GET /budgets/{budget_id}/payees/{payee_id}/payee_locations	List locations for a payee
PayeesApi	getPayeeById	GET /budgets/{budget_id}/payees/{payee_id}	Single payee
PayeesApi	getPayees	GET /budgets/{budget_id}/payees	List payees
PayeesApi	updatePayee	PATCH /budgets/{budget_id}/payees/{payee_id}	Update a payee
ScheduledTransactionsApi	createScheduledTransaction	POST /budgets/{budget_id}/scheduled_transactions	Create a single scheduled transaction
ScheduledTransactionsApi	getScheduledTransactionById	GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}	Single scheduled transaction
ScheduledTransactionsApi	getScheduledTransactions	GET /budgets/{budget_id}/scheduled_transactions	List scheduled transactions
TransactionsApi	createTransaction	POST /budgets/{budget_id}/transactions	Create a single transaction or multiple transactions
TransactionsApi	deleteTransaction	DELETE /budgets/{budget_id}/transactions/{transaction_id}	Deletes an existing transaction
TransactionsApi	getTransactionById	GET /budgets/{budget_id}/transactions/{transaction_id}	Single transaction
TransactionsApi	getTransactions	GET /budgets/{budget_id}/transactions	List transactions
TransactionsApi	getTransactionsByAccount	GET /budgets/{budget_id}/accounts/{account_id}/transactions	List account transactions
TransactionsApi	getTransactionsByCategory	GET /budgets/{budget_id}/categories/{category_id}/transactions	List category transactions, excluding any pending transactions
TransactionsApi	getTransactionsByMonth	GET /budgets/{budget_id}/months/{month}/transactions	List transactions in month, excluding any pending transactions
TransactionsApi	getTransactionsByPayee	GET /budgets/{budget_id}/payees/{payee_id}/transactions	List payee transactions, excluding any pending transactions
TransactionsApi	importTransactions	POST /budgets/{budget_id}/transactions/import	Import transactions
TransactionsApi	updateTransaction	PUT /budgets/{budget_id}/transactions/{transaction_id}	Updates an existing transaction
TransactionsApi	updateTransactions	PATCH /budgets/{budget_id}/transactions	Update multiple transactions
UserApi	getUser	GET /user	User info

Models

Authorization

Authentication schemes defined for the API:

bearer

Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.72.1
- Generator version: 7.11.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PhpClientCodegen

dratejinn/ynab-open-api 适用场景与选型建议

dratejinn/ynab-open-api 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 1 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 01 月 11 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「rest」「api」「sdk」「openapi」「openapitools」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 dratejinn/ynab-open-api 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 dratejinn/ynab-open-api 我们能提供哪些服务？

定制开发 / 二次开发

基于 dratejinn/ynab-open-api 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 dratejinn/ynab-open-api 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

theodorejb/phaster 6

A PSR-7 compatible library for making CRUD API endpoints

braune-digital/api-base-bundle 0

Api bundle

foxtes/alfabank-rest 1

Alfabank REST API integration

intahwebz/flickrguzzle 4

A Flickr wrapper to allow you to call the Flickr api with Guzzle as the backend.Goal is to have 100% Flickr api coverage rather than just upload/display photos (currently at 23%).

gego-soft/php-client 0

BlockCypher's PHP SDK for REST API

wellrested/cookies 0

Helper classes for creating cookie headers

dratejinn/ynab-open-api

包简介

关键字：