cash.transaction.getShrinkList
Возвращает сокращённый список последних доступных пользователю операций за указанный период.
Параметры
-
from
GET
Дата начала периода, за который нужно получить список операций, в формате «гггг-мм-дд».
-
to
GET
Дата окончания периода, за который нужно получить список операций, в формате «гггг-мм-дд».
-
filter
GET
Хеш-строка с параметрами фильтрации операций. Примеры хешей:
- account/1: Получить операции со счёта, ID которого — 1.
- category/2: Получить операции статьи доходов или расходов, ID которой — 2.
- contractor/3: Получить операции, связанных с контактом, ID которого — 3.
- import/4: Получить операции, добавленных в рамках сессии импорта, ID которой — 4.
- external/shop.5: Получить операции, связанные с заказом Shop-Script, ID которого — 5.
- currency/RUB: Получить операции, идентификатор валюты которых — RUB.
- search/qwerty: Получить операции, в комментариях к которым содержится строка «qwerty».
- trash: Получить только удалённые операции. -
format
GET
Необязательно
Устанавливает формат ответа. Возможные значения:
json
(по умолчанию),xml
.
Возвращаемое значение
Массив со следующими ключами:
- data array Список операций. Каждый элемент списка — массив со следующими ключами:
- data[]['id'] int ID операции.
- data[]['account_id'] int ID счёта.
- data[]['affected_transaction_ids'] array<int> Список ID созданных операций.
- data[]['affected_transactions'] int Количество созданных операций.
- data[]['amount'] float Сумма операции.
- data[]['amountShorten'] string Сокращённое локализованное обозначение суммы операции.
- data[]['category_id'] int ID статьи доходов или расходов, к которой относится операция.
- data[]['contractor_contact'] array|null Свойства контакта, связанного с операцией, в виде массива со следующими ключами:
- data[]['contractor_contact']['firstname'] string Имя.
- data[]['contractor_contact']['lastname'] string Фамилия.
- data[]['contractor_contact']['name'] string Полное имя.
- data[]['contractor_contact']['userpic'] string URL изображения контакта размером 96х96 пикселей.
- data[]['contractor_contact_id'] int ID контакта, связанного с операцией.
- data[]['create_contact'] array|null Свойства пользователя, добавившего операцию, в виде массива со следующими ключами:
- data[]['create_contact']['firstname'] string Имя.
- data[]['create_contact']['lastname'] string Фамилия.
- data[]['create_contact']['name'] string Полное имя.
- data[]['create_contact']['userpic'] string URL изображения пользователя размером 96х96 пикселей.
- data[]['create_contact_id'] int ID пользователя, добавившего операцию.
- data[]['create_datetime'] datetime Дата и время добавления операции.
- data[]['date'] date Текущая дата.
- data[]['datetime'] datetime Время начала текущих суток.
- data[]['description'] string Комментарий к операции.
- data[]['is_archived'] bool Флаг, обозначающий удалённую операцию.
- data[]['is_onbadge'] bool Флаг, обозначающий незавершённую операцию, которую нужно провести вручную.
- data[]['is_self_destruct_when_due'] bool Флаг автоматического удаления повторяющейся операции, когда наступает её день.
- data[]['update_datetime'] datetime Дата и время последнего обновления свойств операции.