Вам нужен бюджет (независимый издатель)

Вам нужен бюджет (YNAB) позволяет создавать личное приложение для взаимодействия с собственным бюджетом или создавать приложение, которое любой другой YNABer может авторизовать и использовать.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Трой Тейлор
URL https://www.hitachisolutions.com
Адрес электронной почты ttaylor@hitachisolutions.com
Метаданные соединителя
Publisher Трой Тейлор
Веб-сайт https://www.youneedabudget.com/
Политика конфиденциальности https://www.youneedabudget.com/privacy-policy/
Категории Финансы

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Маркер доступа (в форме Bearer AccessToken) securestring Маркер доступа (в форме Bearer AccessToken) для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Импорт транзакций

Импортирует доступные транзакции во всех связанных учетных записях для заданного бюджета. Связанные учетные записи позволяют импортировать транзакции непосредственно из указанного финансового учреждения, и эта конечная точка инициирует этот импорт. Отправка запроса в эту конечную точку эквивалентна нажатию кнопки "Импорт" для каждой учетной записи в веб-приложении или нажатии баннера "Новые транзакции" в мобильных приложениях. Ответ для этой конечной точки содержит идентификаторы транзакций, импортированные.
Массовые операции создания транзакций

Создает несколько транзакций. Хотя эта конечная точка по-прежнему поддерживается, рекомендуется использовать post /budgets/{budget_id}/transactions" для создания нескольких транзакций.
Обновление категории месяца

Обновите категорию в течение определенного месяца. Можно обновить только budgeted сумму.
Обновление транзакции

Обновляет одну транзакцию.
Обновление транзакций

Обновляет несколько транзакций, по id или import_id.
Получение бюджета по идентификатору

Возвращает единый бюджет со всеми связанными сущностями. Этот ресурс фактически является полным экспортом бюджета.
Получение бюджетного месяца

Возвращает один бюджетный месяц.
Получение бюджетных месяцев

Возвращает все бюджетные месяцы.
Получение бюджетов

Возвращает список бюджетов с сводными сведениями.
Получение выплат

Возвращает все выплаты.
Получение запланированной транзакции по идентификатору

Возвращает одну запланированную транзакцию.
Получение запланированных транзакций

Возвращает все запланированные транзакции.
Получение категории месяца по идентификатору

Возвращает одну категорию для определенного бюджетного месяца. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).
Получение категории по идентификатору

Возвращает одну категорию. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).
Получение категорий

Возвращает все категории, сгруппированные по группе категорий. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).
Получение оплаты по идентификатору

Возвращает один платеж.
Получение параметров бюджета по идентификатору

Возвращает параметры бюджета
Получение пользователя

Возвращает данные пользователя, прошедшие проверку подлинности.
Получение расположений выплат по выплатам

Возвращает все расположения выплат для указанного получателя.
Получение расположений получателей оплаты

Возвращает все расположения выплат.
Получение расположения получателя по идентификатору

Возвращает одно место оплаты.
Получение транзакции по идентификатору

Возвращает одну транзакцию.
Получение транзакций

Возвращает бюджетные транзакции.
Получение транзакций по выплатам

Возвращает все транзакции для указанного получателя.
Получение транзакций по категориям

Возвращает все транзакции для указанной категории.
Получение транзакций по учетной записи

Возвращает все транзакции для указанной учетной записи.
Получение учетной записи по идентификатору

Возвращает одну учетную запись.
Получение учетных записей

Возвращает все учетные записи.
Создание транзакции

Создает одну транзакцию или несколько транзакций. Если вы предоставляете текст, содержащий transaction объект, создается одна транзакция, и если вы предоставляете текст, содержащий массив, будет создано несколько транзакций transactions . Запланированные транзакции нельзя создать на этой конечной точке.
Создание учетной записи

Создает новую учетную запись.

Импорт транзакций

Идентификатор операции:
ImportTransactions

Импортирует доступные транзакции во всех связанных учетных записях для заданного бюджета. Связанные учетные записи позволяют импортировать транзакции непосредственно из указанного финансового учреждения, и эта конечная точка инициирует этот импорт. Отправка запроса в эту конечную точку эквивалентна нажатию кнопки "Импорт" для каждой учетной записи в веб-приложении или нажатии баннера "Новые транзакции" в мобильных приложениях. Ответ для этой конечной точки содержит идентификаторы транзакций, импортированные.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget

Возвращаемое значение

Ответ импорта транзакций
TransactionsImportResponse

Массовые операции создания транзакций

Идентификатор операции:
BulkCreateTransactions

Создает несколько транзакций. Хотя эта конечная точка по-прежнему поддерживается, рекомендуется использовать post /budgets/{budget_id}/transactions" для создания нескольких транзакций.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
ID счета
 account_id True string

Идентификатор учетной записи.
Date
 date True date

Дата транзакции в формате ISO (например, 2016-12-01). Будущие даты (запланированные транзакции) не допускаются. Разделить даты транзакции нельзя изменить, и если указана другая дата, она будет игнорироваться.
Сумма
 amount True integer

Сумма транзакции в формате миллиунитов. Разделенные суммы транзакций нельзя изменить, и если указана другая сумма, она будет игнорироваться.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за транзакцию. Чтобы создать передачу между двумя учетными записями, используйте получатель передачи учетных записей, указывающий на целевую учетную запись. Платежи по передаче учетных записей указываются как transfer_payee_id в ресурсе учетной записи.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования получателя (только если import_id указано) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория транзакции. Чтобы настроить разделенную транзакцию, можно указать значение NULL category_id и указать subtransactions массив в составе объекта транзакции. Если существующая транзакция является разделением, category_id невозможно изменить ее. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.
Проверено
 cleared string

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция. Если транзакция не указана, транзакция будет не утверждена по умолчанию.
Цвет флага
 flag_color string

Флаг транзакции.
Идентификатор импорта
 import_id string

При указании новая транзакция будет назначена и import_id считается импортированной. Мы также попытаемся сопоставить эту импортированную транзакцию с существующей транзакцией,введенной пользователем в той же учетной записи, с той же суммой и датой +/-10 дней с даты импортированной транзакции.

Транзакции, импортированные с помощью импорта на основе файлов или прямого импорта (не через API), назначаются import_id в формате "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2". Использование согласованного формата предотвращает дублирование с помощью прямого импорта и импорта на основе файлов.

Если import_id опущен или указан как null, транзакция будет рассматриваться как транзакция, введенная пользователем. Таким образом, оно будет иметь право соответствовать транзакциям позже импортируемых (через DI, ФБР или API).
Сумма
 amount True integer

Сумма субтрансакта в формате миллиунитов.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за субтрансакция.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования выплат (только если import_id также указана в родительской транзакции) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория для подтрансакта. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.

Возвращаемое значение

Массовый ответ
BulkResponse

Обновление категории месяца

Идентификатор операции:
UpdateMonthCategory

Обновите категорию в течение определенного месяца. Можно обновить только budgeted сумму.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Месяц
 month True date

Бюджетный месяц в формате ISO (например, 2016-12-01). ("Current" также можно использовать для указания текущего календарного месяца (UTC))
Идентификатор категории
 category_id True string

Идентификатор категории.
Бюджете
 budgeted True integer

Бюджетная сумма в миллиуниттном формате.

Возвращаемое значение

Сохранение ответа категории
SaveCategoryResponse

Обновление транзакции

Идентификатор операции:
UpdateTransaction

Обновляет одну транзакцию.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Код проводки
 transaction_id True string

Идентификатор транзакции.
ID счета
 account_id True string

Идентификатор учетной записи.
Date
 date True date

Дата транзакции в формате ISO (например, 2016-12-01). Будущие даты (запланированные транзакции) не допускаются. Разделить даты транзакции нельзя изменить, и если указана другая дата, она будет игнорироваться.
Сумма
 amount True integer

Сумма транзакции в формате миллиунитов. Разделенные суммы транзакций нельзя изменить, и если указана другая сумма, она будет игнорироваться.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за транзакцию. Чтобы создать передачу между двумя учетными записями, используйте получатель передачи учетных записей, указывающий на целевую учетную запись. Платежи по передаче учетных записей указываются как transfer_payee_id в ресурсе учетной записи.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования получателя (только если import_id указано) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория транзакции. Чтобы настроить разделенную транзакцию, можно указать значение NULL category_id и указать subtransactions массив в составе объекта транзакции. Если существующая транзакция является разделением, category_id невозможно изменить ее. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.
Проверено
 cleared string

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция. Если транзакция не указана, транзакция будет не утверждена по умолчанию.
Цвет флага
 flag_color string

Флаг транзакции.
Идентификатор импорта
 import_id string

При указании новая транзакция будет назначена и import_id считается импортированной. Мы также попытаемся сопоставить эту импортированную транзакцию с существующей транзакцией,введенной пользователем в той же учетной записи, с той же суммой и датой +/-10 дней с даты импортированной транзакции.

Транзакции, импортированные с помощью импорта на основе файлов или прямого импорта (не через API), назначаются import_id в формате "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2". Использование согласованного формата предотвращает дублирование с помощью прямого импорта и импорта на основе файлов.

Если import_id опущен или указан как null, транзакция будет рассматриваться как транзакция, введенная пользователем. Таким образом, оно будет иметь право соответствовать транзакциям позже импортируемых (через DI, ФБР или API).
Сумма
 amount True integer

Сумма субтрансакта в формате миллиунитов.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за субтрансакция.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования выплат (только если import_id также указана в родительской транзакции) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория для подтрансакта. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.

Возвращаемое значение

Ответ транзакции
TransactionResponse

Обновление транзакций

Идентификатор операции:
UpdateTransactions

Обновляет несколько транзакций, по id или import_id.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор
 id True string

Идентификатор.
ID счета
 account_id True string

Идентификатор учетной записи.
Date
 date True date

Дата транзакции в формате ISO (например, 2016-12-01). Будущие даты (запланированные транзакции) не допускаются. Разделить даты транзакции нельзя изменить, и если указана другая дата, она будет игнорироваться.
Сумма
 amount True integer

Сумма транзакции в формате миллиунитов. Разделенные суммы транзакций нельзя изменить, и если указана другая сумма, она будет игнорироваться.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за транзакцию. Чтобы создать передачу между двумя учетными записями, используйте получатель передачи учетных записей, указывающий на целевую учетную запись. Платежи по передаче учетных записей указываются как transfer_payee_id в ресурсе учетной записи.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования получателя (только если import_id указано) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория транзакции. Чтобы настроить разделенную транзакцию, можно указать значение NULL category_id и указать subtransactions массив в составе объекта транзакции. Если существующая транзакция является разделением, category_id невозможно изменить ее. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.
Проверено
 cleared string

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция. Если транзакция не указана, транзакция будет не утверждена по умолчанию.
Цвет флага
 flag_color string

Флаг транзакции.
Идентификатор импорта
 import_id string

При указании новая транзакция будет назначена и import_id считается импортированной. Мы также попытаемся сопоставить эту импортированную транзакцию с существующей транзакцией,введенной пользователем в той же учетной записи, с той же суммой и датой +/-10 дней с даты импортированной транзакции.

Транзакции, импортированные с помощью импорта на основе файлов или прямого импорта (не через API), назначаются import_id в формате "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2". Использование согласованного формата предотвращает дублирование с помощью прямого импорта и импорта на основе файлов.

Если import_id опущен или указан как null, транзакция будет рассматриваться как транзакция, введенная пользователем. Таким образом, оно будет иметь право соответствовать транзакциям позже импортируемых (через DI, ФБР или API).
Сумма
 amount True integer

Сумма субтрансакта в формате миллиунитов.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за субтрансакция.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования выплат (только если import_id также указана в родительской транзакции) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория для подтрансакта. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.

Возвращаемое значение

Сохранение ответа транзакций
SaveTransactionsResponse

Получение бюджета по идентификатору

Идентификатор операции:
GetBudgetById

Возвращает единый бюджет со всеми связанными сущностями. Этот ресурс фактически является полным экспортом бюджета.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета.
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ на сведения о бюджете
BudgetDetailResponse

Получение бюджетного месяца

Идентификатор операции:
GetBudgetMonth

Возвращает один бюджетный месяц.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Месяц
 month True date

Бюджетный месяц в формате ISO (например, 2016-12-01). ("Current" также можно использовать для указания текущего календарного месяца (UTC))

Возвращаемое значение

Ответ сведений о месяцах
MonthDetailResponse

Получение бюджетных месяцев

Идентификатор операции:
GetBudgetMonths

Возвращает все бюджетные месяцы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ сводок по месяцам
MonthSummariesResponse

Получение бюджетов

Идентификатор операции:
GetBudgets

Возвращает список бюджетов с сводными сведениями.

Параметры

Имя Ключ Обязательно Тип Описание
Включение учетных записей
 include_accounts boolean

Следует ли включать список бюджетных счетов.

Возвращаемое значение

Ответ на сводку бюджета
BudgetSummaryResponse

Получение выплат

Идентификатор операции:
GetPayees

Возвращает все выплаты.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ payees
PayeesResponse

Получение запланированной транзакции по идентификатору

Идентификатор операции:
GetScheduledTransactionById

Возвращает одну запланированную транзакцию.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор запланированной транзакции
 scheduled_transaction_id True string

Идентификатор запланированной транзакции.

Возвращаемое значение

Ответ на запланированные транзакции
ScheduledTransactionResponse

Получение запланированных транзакций

Идентификатор операции:
GetScheduledTransactions

Возвращает все запланированные транзакции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ запланированных транзакций
ScheduledTransactionsResponse

Получение категории месяца по идентификатору

Идентификатор операции:
GetMonthCategoryById

Возвращает одну категорию для определенного бюджетного месяца. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Месяц
 month True date

Бюджетный месяц в формате ISO (например, 2016-12-01). ("Current" также можно использовать для указания текущего календарного месяца (UTC))
Идентификатор категории
 category_id True string

Идентификатор категории.

Возвращаемое значение

Ответ категории
CategoryResponse

Получение категории по идентификатору

Идентификатор операции:
GetCategoryById

Возвращает одну категорию. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор категории
 category_id True string

Идентификатор категории.

Возвращаемое значение

Ответ категории
CategoryResponse

Получение категорий

Идентификатор операции:
GetCategories

Возвращает все категории, сгруппированные по группе категорий. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ категорий
CategoriesResponse

Получение оплаты по идентификатору

Идентификатор операции:
GetPayeeById

Возвращает один платеж.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор получателя оплаты
 payee_id True string

Идентификатор получателя.

Возвращаемое значение

Ответ получателя выплат
PayeeResponse

Получение параметров бюджета по идентификатору

Идентификатор операции:
GetBudgetSettingsById

Возвращает параметры бюджета

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget

Возвращаемое значение

Ответ параметров бюджета
BudgetSettingsResponse

Получение пользователя

Идентификатор операции:
GetUser

Возвращает данные пользователя, прошедшие проверку подлинности.

Возвращаемое значение

Ответ пользователя
UserResponse

Получение расположений выплат по выплатам

Идентификатор операции:
GetPayeeLocationsByPayee

Возвращает все расположения выплат для указанного получателя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор получателя оплаты
 payee_id True string

Идентификатор выплат.

Возвращаемое значение

Ответ на места выплаты
PayeeLocationsResponse

Получение расположений получателей оплаты

Идентификатор операции:
GetPayeeLocations

Возвращает все расположения выплат.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget

Возвращаемое значение

Ответ на места выплаты
PayeeLocationsResponse

Получение расположения получателя по идентификатору

Идентификатор операции:
GetPayeeLocationById

Возвращает одно место оплаты.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор расположения payee
 payee_location_id True string

Идентификатор расположения выплат.

Возвращаемое значение

Ответ о расположении выплат
PayeeLocationResponse

Получение транзакции по идентификатору

Идентификатор операции:
GetTransactionById

Возвращает одну транзакцию.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Код проводки
 transaction_id True string

Идентификатор транзакции.

Возвращаемое значение

Ответ транзакции
TransactionResponse

Получение транзакций

Идентификатор операции:
GetTransactions

Возвращает бюджетные транзакции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Дата с даты
 since_date date

Если задано, будут включены только транзакции по этой дате или после нее. Дата должна быть отформатирована iso (например, 2016-12-30).
Тип
 type string

Если задано, будут включены только транзакции указанного типа. В настоящее время поддерживаются "некатегоризованные" и "неутвержденные".
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ транзакций
TransactionsResponse

Получение транзакций по выплатам

Идентификатор операции:
GetTransactionsByPayee

Возвращает все транзакции для указанного получателя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор получателя оплаты
 payee_id True string

Идентификатор получателя.
Дата с даты
 since_date date

Если задано, будут включены только транзакции по этой дате или после нее. Дата должна быть отформатирована iso (например, 2016-12-30).
Тип
 type string

Если задано, будут включены только транзакции указанного типа. В настоящее время поддерживаются "некатегоризованные" и "неутвержденные".
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ гибридных транзакций
HybridTransactionsResponse

Получение транзакций по категориям

Идентификатор операции:
GetTransactionsByCategory

Возвращает все транзакции для указанной категории.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Идентификатор категории
 category_id True string

Идентификатор категории.
Дата с даты
 since_date date

Если задано, будут включены только транзакции по этой дате или после нее. Дата должна быть отформатирована iso (например, 2016-12-30).
Тип
 type string

Если задано, будут включены только транзакции указанного типа. В настоящее время поддерживаются "некатегоризованные" и "неутвержденные".
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ гибридных транзакций
HybridTransactionsResponse

Получение транзакций по учетной записи

Идентификатор операции:
GetTransactionsByAccount

Возвращает все транзакции для указанной учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
ID счета
 account_id True string

Идентификатор учетной записи.
Дата с даты
 since_date date

Если задано, будут включены только транзакции по этой дате или после нее. Дата должна быть отформатирована iso (например, 2016-12-30).
Тип
 type string

Если задано, будут включены только транзакции указанного типа. В настоящее время поддерживаются "некатегоризованные" и "неутвержденные".
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ транзакций
TransactionsResponse

Получение учетной записи по идентификатору

Идентификатор операции:
GetAccountById

Возвращает одну учетную запись.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
ID счета
 account_id True uuid

Идентификатор учетной записи.

Возвращаемое значение

Ответ учетной записи
AccountResponse

Получение учетных записей

Идентификатор операции:
GetAccounts

Возвращает все учетные записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
Последнее знание сервера
 last_knowledge_of_server integer

Знания о начальном сервере. Если это указано, будут включены только сущности, которые изменились.last_knowledge_of_server

Возвращаемое значение

Ответ учетных записей
AccountsResponse

Создание транзакции

Идентификатор операции:
CreateTransaction

Создает одну транзакцию или несколько транзакций. Если вы предоставляете текст, содержащий transaction объект, создается одна транзакция, и если вы предоставляете текст, содержащий массив, будет создано несколько транзакций transactions . Запланированные транзакции нельзя создать на этой конечной точке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета. Параметр "last-used" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. следующее). https://api.youneedabudget.com/#oauth-default-budget
ID счета
 account_id True string

Идентификатор учетной записи.
Date
 date True date

Дата транзакции в формате ISO (например, 2016-12-01). Будущие даты (запланированные транзакции) не допускаются. Разделить даты транзакции нельзя изменить, и если указана другая дата, она будет игнорироваться.
Сумма
 amount True integer

Сумма транзакции в формате миллиунитов. Разделенные суммы транзакций нельзя изменить, и если указана другая сумма, она будет игнорироваться.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за транзакцию. Чтобы создать передачу между двумя учетными записями, используйте получатель передачи учетных записей, указывающий на целевую учетную запись. Платежи по передаче учетных записей указываются как transfer_payee_id в ресурсе учетной записи.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования получателя (только если import_id указано) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория транзакции. Чтобы настроить разделенную транзакцию, можно указать значение NULL category_id и указать subtransactions массив в составе объекта транзакции. Если существующая транзакция является разделением, category_id невозможно изменить ее. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.
Проверено
 cleared string

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция. Если транзакция не указана, транзакция будет не утверждена по умолчанию.
Цвет флага
 flag_color string

Флаг транзакции.
Идентификатор импорта
 import_id string

При указании новая транзакция будет назначена и import_id считается импортированной. Мы также попытаемся сопоставить эту импортированную транзакцию с существующей транзакцией,введенной пользователем в той же учетной записи, с той же суммой и датой +/-10 дней с даты импортированной транзакции.

Транзакции, импортированные с помощью импорта на основе файлов или прямого импорта (не через API), назначаются import_id в формате "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2". Использование согласованного формата предотвращает дублирование с помощью прямого импорта и импорта на основе файлов.

Если import_id опущен или указан как null, транзакция будет рассматриваться как транзакция, введенная пользователем. Таким образом, оно будет иметь право соответствовать транзакциям позже импортируемых (через DI, ФБР или API).
Сумма
 amount True integer

Сумма субтрансакта в формате миллиунитов.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за субтрансакция.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования выплат (только если import_id также указана в родительской транзакции) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория для подтрансакта. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.
ID счета
 account_id True string

Идентификатор учетной записи.
Date
 date True date

Дата транзакции в формате ISO (например, 2016-12-01). Будущие даты (запланированные транзакции) не допускаются. Разделить даты транзакции нельзя изменить, и если указана другая дата, она будет игнорироваться.
Сумма
 amount True integer

Сумма транзакции в формате миллиунитов. Разделенные суммы транзакций нельзя изменить, и если указана другая сумма, она будет игнорироваться.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за транзакцию. Чтобы создать передачу между двумя учетными записями, используйте получатель передачи учетных записей, указывающий на целевую учетную запись. Платежи по передаче учетных записей указываются как transfer_payee_id в ресурсе учетной записи.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования получателя (только если import_id указано) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория транзакции. Чтобы настроить разделенную транзакцию, можно указать значение NULL category_id и указать subtransactions массив в составе объекта транзакции. Если существующая транзакция является разделением, category_id невозможно изменить ее. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.
Проверено
 cleared string

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция. Если транзакция не указана, транзакция будет не утверждена по умолчанию.
Цвет флага
 flag_color string

Флаг транзакции.
Идентификатор импорта
 import_id string

При указании новая транзакция будет назначена и import_id считается импортированной. Мы также попытаемся сопоставить эту импортированную транзакцию с существующей транзакцией,введенной пользователем в той же учетной записи, с той же суммой и датой +/-10 дней с даты импортированной транзакции.

Транзакции, импортированные с помощью импорта на основе файлов или прямого импорта (не через API), назначаются import_id в формате "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2". Использование согласованного формата предотвращает дублирование с помощью прямого импорта и импорта на основе файлов.

Если import_id опущен или указан как null, транзакция будет рассматриваться как транзакция, введенная пользователем. Таким образом, оно будет иметь право соответствовать транзакциям позже импортируемых (через DI, ФБР или API).
Сумма
 amount True integer

Сумма субтрансакта в формате миллиунитов.
Идентификатор получателя оплаты
 payee_id uuid

Платеж за субтрансакция.
Получатель
 payee_name string

Имя получателя. payee_name Если указано значение и payee_id имеет значение NULL, payee_name значение будет использоваться для разрешения выплаты либо (1) соответствующего правила переименования выплат (только если import_id также указана в родительской транзакции) или (2) получателя с тем же именем или (3) создание нового получателя.
Идентификатор категории
 category_id uuid

Категория для подтрансакта. Категории оплаты кредитной карты не разрешены и будут игнорироваться при наличии.
Памятка
 memo string

Памятка.

Возвращаемое значение

Сохранение ответа транзакций
SaveTransactionsResponse

Создание учетной записи

Идентификатор операции:
CreateAccount

Создает новую учетную запись.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор бюджета
 budget_id True string

Идентификатор бюджета ("последний используемый" можно использовать для указания последнего используемого бюджета и "по умолчанию" можно использовать, если включен выбор бюджета по умолчанию (см. ниже https://api.youneedabudget.com/#oauth-default-budget).
Имя
 name True string

Имя учетной записи.
Тип2
 type True string

Тип учетной записи
Баланс
 balance True integer

Текущий баланс счета в миллиуниттном формате.

Возвращаемое значение

Ответ учетной записи
AccountResponse

Определения

UserResponse

Имя Путь Тип Описание
Данные
 data Data

User

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.

DateFormat

Параметр формата даты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.

Имя Путь Тип Описание
Формат
 format string

Формат.

CurrencyFormat

Параметр формата валюты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.

Имя Путь Тип Описание
ISO-код
 iso_code string

Код ISO.
Пример формата
 example_format string

Пример формата.
Десятичные цифры
 decimal_digits integer

Десятичные цифры.
Десятичный разделитель
 decimal_separator string

Десятичный разделитель.
Символ первый
 symbol_first boolean

Указывает, является ли символ первым.
Разделитель групп
 group_separator string

Разделитель групп.
Обозначение денежной единицы
 currency_symbol string

Символ валюты.
Отображаемый символ
 display_symbol boolean

Отображается ли символ.

BudgetSummaryResponse

Имя Путь Тип Описание
Data1
 data Data1

БюджетSummary

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Имя
 name string

Имя.
Последнее изменение
 last_modified_on date-time

При последнем внесении изменений в бюджет из веб-клиента или мобильного клиента.
Первый месяц
 first_month date

Самый ранний бюджетный месяц.
Прошлый месяц
 last_month date

Последний бюджетный месяц.
Формат даты
 date_format DateFormat

Параметр формата даты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.
Формат валюты
 currency_format CurrencyFormat

Параметр формата валюты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.
Accounts
 accounts array of Account

Бюджетные счета (только если include_accounts=true они указаны в качестве параметра запроса).

BudgetDetailResponse

Имя Путь Тип Описание
Data2
 data Data2

BudgetDetail

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Имя
 name string

Имя.
Последнее изменение
 last_modified_on date-time

При последнем внесении изменений в бюджет из веб-клиента или мобильного клиента.
Первый месяц
 first_month date

Самый ранний бюджетный месяц.
Прошлый месяц
 last_month date

Последний бюджетный месяц.
Формат даты
 date_format DateFormat

Параметр формата даты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.
Формат валюты
 currency_format CurrencyFormat

Параметр формата валюты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.
Accounts
 accounts array of Account

Бюджетные счета (только если include_accounts=true они указаны в качестве параметра запроса).
Payees
 payees array of Payee
Расположения выплат
 payee_locations array of PayeeLocation
Группы категорий
 category_groups array of CategoryGroup
Категории
 categories array of Category
Месяцы
 months array of MonthDetail
Транзакции
 transactions array of TransactionSummary
Вложенные передачи
 subtransactions array of SubTransaction
Запланированные транзакции
 scheduled_transactions array of ScheduledTransactionSummary
Запланированные вложенные передачи
 scheduled_subtransactions array of ScheduledSubTransaction

BudgetSettingsResponse

Имя Путь Тип Описание
Data3
 data Data3

Бюджетные наборы

Имя Путь Тип Описание
Формат даты
 date_format DateFormat

Параметр формата даты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.
Формат валюты
 currency_format CurrencyFormat

Параметр формата валюты для бюджета. В некоторых случаях формат не будет доступен и будет указан как null.

AccountsResponse

Имя Путь Тип Описание
Data4
 data Data4

AccountResponse

Имя Путь Тип Описание
Data5
 data Data5

Счет

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Имя
 name string

Имя.
Тип
 type Type

Тип учетной записи. Примечание. PayPal, merchantAccount, инвестицииAccount и ипотечные типы были устарели и будут удалены в будущем.
По бюджету
 on_budget boolean

Независимо от того, находится ли эта учетная запись в бюджете или нет
Закрытый
 closed boolean

Независимо от того, закрыта ли эта учетная запись
Замечание
 note string

Примечание.
Баланс
 balance integer

Текущий баланс счета в миллиуниттном формате.
Очистка баланса
 cleared_balance integer

Текущий счищенный баланс счета в миллиуниттном формате.
Неясный баланс
 uncleared_balance integer

Текущий неясный баланс счета в миллиуниттном формате.
Идентификатор получателя выплаты
 transfer_payee_id string

Идентификатор выплат, который следует использовать при передаче в эту учетную запись.
Связанная прямая импорта
 direct_import_linked boolean

Связана ли учетная запись с финансовым учреждением для автоматического импорта транзакций.
Ошибка прямого импорта
 direct_import_in_error boolean

Если учетная запись, связанная с финансовым учреждением (direct_import_linked=true) и связанное соединение не находится в работоспособном состоянии, это будет верно.
Удалено
 deleted boolean

Удалена ли учетная запись. Удаленные учетные записи будут включены только в разностные запросы.

КатегорииResponse

Имя Путь Тип Описание
Data6
 data Data6

CategoryResponse

Имя Путь Тип Описание
Data7
 data Data7

CategoryGroupWithCategories

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Имя
 name string

Имя.
Скрытый
 hidden boolean

Скрыта ли группа категорий.
Удалено
 deleted boolean

Удалена ли группа категорий. Удаленные группы категорий будут включены только в разностные запросы.
Catagories
 categories array of Category

Категории групп. Суммы (бюджетные, действия, баланс и т. д.) относятся к текущему бюджетному месяцу (UTC).

CategoryGroup

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Имя
 name string

Имя.
Скрытый
 hidden boolean

Скрыта ли группа категорий.
Удалено
 deleted boolean

Удалена ли группа категорий. Удаленные группы категорий будут включены только в разностные запросы.

Категория

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Идентификатор группы категорий
 category_group_id string

Идентификатор группы категорий.
Имя
 name string

Имя.
Скрытый
 hidden boolean

Независимо от того, скрыта ли категория.
Исходный идентификатор группы категорий
 original_category_group_id uuid

Если категория скрыта, это идентификатор группы категорий, к которой она первоначально принадлежала, прежде чем она была скрыта.
Замечание
 note string

Примечание.
Бюджете
 budgeted integer

Бюджетная сумма в миллиуниттном формате.
Activity
 activity integer

Количество действий в миллиуниттном формате.
Баланс
 balance integer

Баланс в миллиунитах формата.
Тип цели
 goal_type GoalType

Тип цели, если категория имеет цель (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')
Месяц создания цели
 goal_creation_month date

Месяц был создан.
Целевой объект цели
 goal_target integer

Целевой объем цели в миллиунитах.
Целевой месяц цели
 goal_target_month date

Исходный целевой месяц для завершения цели. Укажите эту дату только некоторые типы целей.
Процент завершения цели
 goal_percentage_complete integer

Процент завершения цели.
Цели месяцы бюджета
 goal_months_to_budget integer

Количество месяцев, включая текущий месяц, осталось в текущем целевом периоде.
Цель в рамках финансирования
 goal_under_funded integer

Объем финансирования по-прежнему необходим в текущем месяце, чтобы оставаться на пути к завершению цели в течение текущего периода цели. Эта сумма, как правило, соответствует сумме "Недофинансировано" в веб-и мобильных клиентах, за исключением случаев, когда просматривается категория с необходимой для цели расходов в будущем месяце. Веб-клиенты и мобильные клиенты будут игнорировать любое финансирование из предыдущего периода цели при просмотре категории с необходимой целью расходов в будущем месяце.
Общая финансируемая цель
 goal_overall_funded integer

Общая сумма, финансируемая в рамках текущего периода цели.
Цель в целом слева
 goal_overall_left integer

Объем финансирования по-прежнему необходим для завершения цели в течение текущего периода цели.
Удалено
 deleted boolean

Удалена ли категория. Удаленные категории будут включены только в разностные запросы.

SaveCategoryResponse

Имя Путь Тип Описание
Data8
 data Data8

PayeesResponse

Имя Путь Тип Описание
Data9
 data Data9

PayeeResponse

Имя Путь Тип Описание
Data10
 data Data10

Получатель

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Имя
 name string

Имя.
Идентификатор учетной записи передачи
 transfer_account_id string

Если платеж за передачу, account_id в который передается этот получатель.
Удалено
 deleted boolean

Независимо от того, был ли удален получатель выплат. Удаленные платежи будут включены только в разностные запросы.

PayeeLocationsResponse

Имя Путь Тип Описание
Data11
 data Data11

PayeeLocationResponse

Имя Путь Тип Описание
Data12
 data Data12

PayeeLocation

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Широта
 latitude string

Широта.
Долгота
 longitude string

Долгота.
Удалено
 deleted boolean

Независимо от того, удалено ли расположение выплат. Удаленные расположения выплат будут включены только в разностные запросы.

TransactionsResponse

Имя Путь Тип Описание
Data13
 data Data13

HybridTransactionsResponse

Имя Путь Тип Описание
Data14
 data Data14

SaveTransactionsResponse

Имя Путь Тип Описание
Data15
 data Data15

TransactionResponse

Имя Путь Тип Описание
Data16
 data Data16

TransactionSummary

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Date
 date date

Дата транзакции в формате ISO (например, 2016-12-01).
Сумма
 amount integer

Сумма транзакции в формате миллиунитов.
Памятка
 memo string

Памятка.
Проверено
 cleared Cleared

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция.
Цвет флага
 flag_color FlagColor

Флаг транзакции.
ID счета
 account_id string

Идентификатор учетной записи.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Идентификатор категории
 category_id string

Идентификатор категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

Если транзакция передачи, учетная запись, в которую она передается.
Идентификатор транзакции передачи
 transfer_transaction_id string

Если транзакция передачи, идентификатор транзакции на другой стороне передачи.
Идентификатор сопоставленной транзакции
 matched_transaction_id string

Если транзакция совпадает, идентификатор соответствующей транзакции.
Идентификатор импорта
 import_id string

Если транзакция импортирована, это поле является уникальным (по учетной записи) идентификатором импорта. Если эта транзакция была импортирована через импорт на основе файлов или прямой импорт, а не через API, import_id будет иметь формат: "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2".
Удалено
 deleted boolean

Независимо от того, была ли удалена транзакция. Удаленные транзакции будут включены только в разностные запросы.

TransactionDetail

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Date
 date date

Дата транзакции в формате ISO (например, 2016-12-01).
Сумма
 amount integer

Сумма транзакции в формате миллиунитов.
Памятка
 memo string

Памятка.
Проверено
 cleared Cleared

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция.
Цвет флага
 flag_color FlagColor

Флаг транзакции.
ID счета
 account_id string

Идентификатор учетной записи.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Идентификатор категории
 category_id string

Идентификатор категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

Если транзакция передачи, учетная запись, в которую она передается.
Идентификатор транзакции передачи
 transfer_transaction_id string

Если транзакция передачи, идентификатор транзакции на другой стороне передачи.
Идентификатор сопоставленной транзакции
 matched_transaction_id string

Если транзакция совпадает, идентификатор соответствующей транзакции.
Идентификатор импорта
 import_id string

Если транзакция импортирована, это поле является уникальным (по учетной записи) идентификатором импорта. Если эта транзакция была импортирована через импорт на основе файлов или прямой импорт, а не через API, import_id будет иметь формат: "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2".
Удалено
 deleted boolean

Независимо от того, была ли удалена транзакция. Удаленные транзакции будут включены только в разностные запросы.
Имя учетной записи
 account_name string

Имя учетной записи.
Получатель
 payee_name string

Имя получателя.
Категория
 category_name string

Имя категории.
Вложенные передачи
 subtransactions array of SubTransaction

Если транзакция разделена, вложенные транзакции.

HybridTransaction

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Date
 date date

Дата транзакции в формате ISO (например, 2016-12-01).
Сумма
 amount integer

Сумма транзакции в формате миллиунитов.
Памятка
 memo string

Памятка.
Проверено
 cleared Cleared

Очищенное состояние транзакции.
Утверждено
 approved boolean

Утверждается ли транзакция.
Цвет флага
 flag_color FlagColor

Флаг транзакции.
ID счета
 account_id string

Идентификатор учетной записи.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Идентификатор категории
 category_id string

Идентификатор категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

Если транзакция передачи, учетная запись, в которую она передается.
Идентификатор транзакции передачи
 transfer_transaction_id string

Если транзакция передачи, идентификатор транзакции на другой стороне передачи.
Идентификатор сопоставленной транзакции
 matched_transaction_id string

Если транзакция совпадает, идентификатор соответствующей транзакции.
Идентификатор импорта
 import_id string

Если транзакция импортирована, это поле является уникальным (по учетной записи) идентификатором импорта. Если эта транзакция была импортирована через импорт на основе файлов или прямой импорт, а не через API, import_id будет иметь формат: "YNAB:[milliunit_amount]:[iso_date]:[вхождение]". Например, транзакция 2015-12-30 в размере $294,23 USD будет иметь import_id 'YNAB:-294230:2015-12-30:1'. Если вторая транзакция на той же учетной записи импортирована и имела ту же дату и ту же сумму, ее import_id будет "YNAB:-294230:2015-12-30:2".
Удалено
 deleted boolean

Независимо от того, была ли удалена транзакция. Удаленные транзакции будут включены только в разностные запросы.
Тип3
 type Type3

Указывает, представляет ли гибридная транзакция обычную транзакцию или подтрансляция
Идентификатор родительской транзакции
 parent_transaction_id string

Для типов подтрансакта это идентификатор родительской транзакции. Для типов транзакций этот идентификатор всегда будет иметь значение NULL.
Имя учетной записи
 account_name string

Имя учетной записи.
Получатель
 payee_name string

Имя получателя.
Категория
 category_name string

Имя категории.

TransactionsImportResponse

Имя Путь Тип Описание
Data17
 data Data17

BulkResponse

Имя Путь Тип Описание
Data18
 data Data18

SubTransaction

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Код проводки
 transaction_id string

Транзакция.
Сумма
 amount integer

Сумма субтрансакта в формате миллиунитов.
Памятка
 memo string

Памятка.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Получатель
 payee_name string

Имя получателя.
Идентификатор категории
 category_id string

Идентификатор категории.
Категория
 category_name string

Имя категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

При передаче account_id, в которую передается субтрансакция.
Идентификатор транзакции передачи
 transfer_transaction_id string

При передаче идентификатор транзакции на другой стороне передачи.
Удалено
 deleted boolean

Удаляется ли подтрансакт. Удаленные вложенные запросы будут включены только в разностные запросы.

ScheduledTransactionsResponse

Имя Путь Тип Описание
Data19
 data Data19

ScheduledTransactionResponse

Имя Путь Тип Описание
Data20
 data Data20

ScheduledTransactionSummary

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Первая дата
 date_first date

Первая дата, для которой запланирована запланированная транзакция.
Следующая дата
 date_next date

Следующая дата, для которой запланирована запланированная транзакция.
Частота
 frequency Frequency

Частота.
Сумма
 amount integer

Сумма запланированной транзакции в формате миллиунитов.
Памятка
 memo string

Памятка.
FlagColor1
 flag_color FlagColor1

Флаг запланированной транзакции.
ID счета
 account_id string

Идентификатор учетной записи.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Идентификатор категории
 category_id string

Идентификатор категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

При передаче account_id, в которую передается запланированная транзакция.
Удалено
 deleted boolean

Удалена ли запланированная транзакция. Удаленные запланированные транзакции будут включены только в разностные запросы.

ScheduledTransactionDetail

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Первая дата
 date_first date

Первая дата, для которой запланирована запланированная транзакция.
Следующая дата
 date_next date

Следующая дата, для которой запланирована запланированная транзакция.
Частота
 frequency Frequency

Частота.
Сумма
 amount integer

Сумма запланированной транзакции в формате миллиунитов.
Памятка
 memo string

Памятка.
FlagColor1
 flag_color FlagColor1

Флаг запланированной транзакции.
ID счета
 account_id string

Идентификатор учетной записи.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Идентификатор категории
 category_id string

Идентификатор категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

При передаче account_id, в которую передается запланированная транзакция.
Удалено
 deleted boolean

Удалена ли запланированная транзакция. Удаленные запланированные транзакции будут включены только в разностные запросы.
Имя учетной записи
 account_name string

Имя учетной записи.
Получатель
 payee_name string

Имя получателя.
Категория
 category_name string

Имя категории.
subtransactions
 subtransactions array of ScheduledSubTransaction

Если разделенная запланированная транзакция, вложенные данные передаются.

ScheduledSubTransaction

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор.
Идентификатор запланированной транзакции
 scheduled_transaction_id string

Идентификатор запланированной транзакции.
Сумма
 amount integer

Запланированное количество субтрансакций в формате миллиунитов.
Памятка
 memo string

Памятка.
Идентификатор получателя оплаты
 payee_id string

Идентификатор получателя выплат.
Идентификатор категории
 category_id string

Идентификатор категории.
Идентификатор учетной записи передачи
 transfer_account_id uuid

При передаче account_id, в которую передается запланированный вложенный перевод.
Удалено
 deleted boolean

Удаляется ли запланированное подтрансакто. Удаленные запланированные вложенные передачи будут включены только в разностные запросы.

MonthSummariesResponse

Имя Путь Тип Описание
Data21
 data Data21

MonthDetailResponse

Имя Путь Тип Описание
Data22
 data Data22

MonthSummary

Имя Путь Тип Описание
Месяц
 month date

Месяц.
Замечание
 note string

Примечание.
доход
 income integer

Общий объем транзакций, классифицированных на "Поток: готово к назначению" в месяц.
Бюджете
 budgeted integer

Общая сумма, бюджетная сумма в течение месяца.
Activity
 activity integer

Общий объем транзакций в месяц, за исключением тех, кто классифицируется как "Поток: готово к назначению".
Бюджет
 to_be_budgeted integer

Доступное количество для параметра "Готово к назначению".
Возраст денег
 age_of_money integer

Возраст денег по состоянию на месяц.
Удалено
 deleted boolean

Независимо от того, был ли удален месяц. Удаленные месяцы будут включены только в разностные запросы.

MonthDetail

Имя Путь Тип Описание
Месяц
 month date

Месяц.
Замечание
 note string

Примечание.
доход
 income integer

Общий объем транзакций, классифицированных на "Поток: готово к назначению" в месяц.
Бюджете
 budgeted integer

Общая сумма, бюджетная сумма в течение месяца.
Activity
 activity integer

Общий объем транзакций в месяц, за исключением тех, кто классифицируется как "Поток: готово к назначению".
Бюджет
 to_be_budgeted integer

Доступное количество для параметра "Готово к назначению".
Возраст денег
 age_of_money integer

Возраст денег по состоянию на месяц.
Удалено
 deleted boolean

Независимо от того, был ли удален месяц. Удаленные месяцы будут включены только в разностные запросы.
Категории
 categories array of Category

Категории бюджетного месяца. Суммы (бюджетные, действия, баланс и т. д.) относятся к указанному параметру {month}.

Bulk

Имя Путь Тип Описание
Идентификаторы транзакций
 transaction_ids array of string

Список созданных идентификаторов транзакций.
Повторяющиеся идентификаторы импорта
 duplicate_import_ids array of string

Если какие-либо транзакции не были созданы, так как они имели соответствующую import_id транзакцию уже в той же учетной записи, указанные import_id будут включены в этот список.

Проверено

Очищенное состояние транзакции.

Очищенное состояние транзакции.

Проверено
string

Данные

Имя Путь Тип Описание
User
 user User

Data1

Имя Путь Тип Описание
бюджеты
 budgets array of BudgetSummary
Сводка по бюджету
 default_budget BudgetSummary

Data2

Имя Путь Тип Описание
Сведения о бюджете
 budget BudgetDetail
Знание сервера
 server_knowledge integer

Знание сервера.

Data3

Имя Путь Тип Описание
Параметры бюджета
 settings BudgetSettings

Data4

Имя Путь Тип Описание
Accounts
 accounts array of Account
Знание сервера
 server_knowledge integer

Знание сервера.

Data5

Имя Путь Тип Описание
Счет
 account Account

Data6

Имя Путь Тип Описание
Группы категорий
 category_groups array of CategoryGroupWithCategories

Группы категорий.
Знание сервера
 server_knowledge integer

Знание сервера.

Data7

Имя Путь Тип Описание
Категория
 category Category

Data8

Имя Путь Тип Описание
Категория
 category Category
Знание сервера
 server_knowledge integer

Знание сервера.

Data9

Имя Путь Тип Описание
Payees
 payees array of Payee

Выплаты.
Знание сервера
 server_knowledge integer

Знание сервера.

Data10

Имя Путь Тип Описание
Получатель
 payee Payee

Data11

Имя Путь Тип Описание
Расположения выплат
 payee_locations array of PayeeLocation

Расположения выплат.

Data12

Имя Путь Тип Описание
Расположение payee
 payee_location PayeeLocation

Data13

Имя Путь Тип Описание
Транзакции
 transactions array of TransactionDetail

Транзакции.
Знание сервера
 server_knowledge integer

Знание сервера.

Data14

Имя Путь Тип Описание
Транзакции
 transactions array of HybridTransaction

Транзакции.

Data15

Имя Путь Тип Описание
Идентификаторы транзакций
 transaction_ids array of string

Идентификаторы транзакций, сохраненные.
Сведения о транзакциях
 transaction TransactionDetail
транзакции;
 transactions array of TransactionDetail

Если были указаны несколько транзакций, сохраненные транзакции.
Повторяющиеся идентификаторы импорта
 duplicate_import_ids array of string

Если задано несколько транзакций, список import_ids, которые не были созданы из-за существующей import_id учетной записи.
Знание сервера
 server_knowledge integer

Знание сервера.

Data16

Имя Путь Тип Описание
Сведения о транзакциях
 transaction TransactionDetail

Data17

Имя Путь Тип Описание
Идентификаторы транзакций
 transaction_ids array of string

Список импортированных идентификаторов транзакций.

Data18

Имя Путь Тип Описание
Bulk
 bulk Bulk

Data19

Имя Путь Тип Описание
scheduled_transactions
 scheduled_transactions array of ScheduledTransactionDetail
Знание сервера
 server_knowledge integer

Знание сервера.

Data20

Имя Путь Тип Описание
Сведения о запланированных транзакциях
 scheduled_transaction ScheduledTransactionDetail

Data21

Имя Путь Тип Описание
Месяцы
 months array of MonthSummary
Знание сервера
 server_knowledge integer

Знание сервера.

Data22

Имя Путь Тип Описание
Сведения о месяце
 month MonthDetail

FlagColor

Флаг транзакции.

Флаг транзакции.

Цвет флага
string

FlagColor1

Флаг запланированной транзакции.

Флаг запланированной транзакции.

FlagColor1
string

Частота

Частота.

Частота.

Частота
string

GoalType

Тип цели, если категория имеет цель (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')

Тип цели, если категория имеет цель (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')

Тип цели
string

Тип

Тип учетной записи. Примечание. PayPal, merchantAccount, инвестицииAccount и ипотечные типы были устарели и будут удалены в будущем.

Тип учетной записи. Примечание. PayPal, merchantAccount, инвестицииAccount и ипотечные типы были устарели и будут удалены в будущем.

Тип
string

Тип3

Указывает, представляет ли гибридная транзакция обычную транзакцию или подтрансляция

Указывает, представляет ли гибридная транзакция обычную транзакцию или подтрансляция

Тип3
string