cash.transaction.update
Обновляет информацию об операции.
Параметры
-
id
POST
ID операции.
-
apply_to_all_in_future
POST
Флаг, обозначающий необходимость обновить все будущие повторения операции.
-
amount
POST
Сумма операции.
-
account_id
POST
ID счёта.
-
category_id
POST
ID статьи доходов или расходов.
-
contractor_contact_id
POST
Необязательно
ID контакта, с которым должна быть связана операция.
-
contractor
POST
Необязательно
Имя нового контакта, который нужно создать, чтобы связать с ним созданную операцию. Используется, только если не заполнено значение параметра 'contractor_contact_id'.
-
description
POST
Необязательно
Комментарий к операции.
-
is_repeating
POST
Необязательно
Флаг, обозначающий, что операция должна повторяться.
-
repeating_frequency
GET
Необязательно
Периодичность повторения операции, выраженная количеством отрезков времени, указанных в параметре 'repeating_interval', по истечении которых нужно повторить операцию. Используется для повторяющихся операций. Если не указано, по умолчанию используется значение '1'.
-
repeating_interval
POST
Необязательно
Обозначение отрезка времени для вычисления периодичности повторения операции: 'day' (день), 'week' (неделя), 'month' (месяц), 'year' (год). Используется для повторяющихся операций. Если не указано, по умолчанию используется значение 'month'.
-
repeating_end_type
POST
Необязательно
Обозначение длительности повторения операции: 'never' (повторять всегда), 'after' (повторять заданное количество раз), 'ondate' (повторять до указанной даты). Используется для повторяющихся операций. Если не указано, по умолчанию используется значение 'never'. Если используется значение 'never', то, кроме данной операции, будет также создано несколько дополнительных операций в качестве её повторения; их количество зависит от значения в параметре 'repeating_interval': 'day' — операции будут созданы на следующие 3 года; 'week' — операции будут созданы на следующие 16 недель; 'month' — операции будут созданы на следующие 36 месяцев; 'year' — операции будут созданы на следующие 10 лет.
-
repeating_end_after
POST
Необязательно
Количество повторений для повторяющейся операции. Используется для повторяющихся операций, если в параметре 'repeating_end_type' указано значение 'after'.
-
transfer_account_id
POST
Необязательно
ID счёта, с которого нужно выполнить операцию-перевод.
-
transfer_incoming_amount
POST
Необязательно
ID счёта, на который нужно зачислить средства в рамках операции-перевода.
-
is_onbadge
POST
Необязательно
Флаг, обозначающий незавершённую операцию, которую нужно провести вручную.
-
is_self_destruct_when_due
GET+POST
Необязательно
Флаг автоматического удаления повторяющейся операции, когда наступает её день.
-
external
POST
Необязательно
Массив со следующими ключами:
- external_source: Идентификатор приложения, с объектом которого должна быть связана операция.
- external_id: Идентификатор объекта другого приложения, с которым должна быть связана операция.
- external_data: Информация об объекте другого приложения, с которым должна быть связана операция. -
repeating_end_ondate
POST
Необязательно
Дата окончания повторяющейся операции в формате «гггг-мм-дд».
-
format
GET
Необязательно
Устанавливает формат ответа. Возможные значения:
json
(по умолчанию),xml
.
Возвращаемое значение
Свойства обновлённой операции в виде массива со следующими ключами:
- id int ID операции.
- account_id int ID счёта.
- affected_transaction_ids array Список ID созданных операций с учётом повторения.
- affected_transactions int Количество созданных операций.
- amount float Сумма операции.
- amountShorten string Сокращённое локализованное обозначение суммы операции.
- category_id int ID статьи доходов или расходов, к которой относится операция.
- contractor_contact array|null Свойства контакта, связанного с операцией, в виде массива со следующими ключами:
- contractor_contact['firstname string Имя.
- contractor_contact['lastname string Фамилия.
- contractor_contact['name string Полное имя.
- contractor_contact['userpic string URL изображения контакта размером 96х96 пикселей.
- contractor_contact_id int ID контакта, связанного с операцией.
- create_contact array|null Свойства пользователя, добавившего операцию, в виде массива со следующими ключами:
- create_contact['firstname string Имя.
- create_contact['lastname string Фамилия.
- create_contact['name string Полное имя.
- create_contact['userpic string URL изображения пользователя размером 96х96 пикселей.
- create_contact_id int ID пользователя, добавившего операцию.
- create_datetime datetime Дата и время добавления операции.
- date date Текущая дата.
- datetime datetime Время начала текущих суток.
- description string Комментарий к операции.
- is_onbadge bool Флаг, обозначающий незавершённую операцию, которую нужно провести вручную.
- is_self_destruct_when_due bool Флаг автоматического удаления повторяющейся операции, когда наступает её день.
- repeating_data array Свойства повторяющейся операции в виде массива со следующими ключами:
- repeating_data['frequency'] int Периодичность повторения операции, выраженная количеством отрезков времени, указанных в ключе
interval
, по истечении которых нужно повторить операцию. - repeating_data['interval'] string Обозначение отрезка времени для вычисления периодичности повторения операции: 'day' (день), 'week' (неделя), 'month' (месяц), 'year' (год).
- repeating_id int|null Порядковый номер повторяющейся операции.
- update_datetime datetime Дата и время последнего обновления свойств операции.