Список

Примечание

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

Весь список с постраничной выдачей

POST https://do.freshoffice.ru/common/list/paging/5?columns=id,date,sum

Query Parameters

Name Type Description
columns* String Список колонок
records_onpage Int Записей на странице, но не более 500
page Int Номер страницы
sorting_column String Колонка сортировки
sorting_direction Int Сортировка 0 Asc 1 Desc 
curl --location --request POST 'https://do.freshoffice.ru/common/list/paging/5?columns=id,date,sum,direction_id,note,company_id&records_onpage=50&page=1' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Columns

Имя Описание
id Идентификатор движения
date Дата движения
sum Сумма в базовой валюте
sum_currency Сумма в валюте
direction_id Направление: 1 — приход, 2 — расход
direction Направление текстом
type_id Идентификатор формы оплаты
type Форма оплаты текстом
category_id Идентификатор статьи доходов/расходов
category Статья текстом
account_id Идентификатор счёта
account Счёт текстом
currency Валюта счёта текстом
note Примечание
user_id Идентификатор ответственного
user_name Ответственный
company_id Идентификатор контрагента
company_name Наименование контрагента
deal_id Идентификатор сделки
tags Теги

Фильтрация

Фильтры добавляются к запросу как query-параметры и сочетаются между собой:

  • company_id — код контрагента, только движения одной компании: ?company_id=368132
  • deal_id — код сделки, только движения одной сделки: ?deal_id=12345
  • user_ids — коды ответственных, один или несколько: ?user_ids=37 или ?user_ids=1,3,5
  • date1 — с даты (формат YYYY-MM-DD): ?date1=2026-08-01
  • date2 — по дату (формат YYYY-MM-DD): ?date2=2026-08-31
  • tags — теги через запятую: ?tags=аренда

Пример — движения одного контрагента за август:

curl --location --request POST 'https://do.freshoffice.ru/common/list/paging/5?columns=id,date,sum&company_id=368132&date1=2026-08-01&date2=2026-08-31' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Примечание

Это общий паттерн: пагинация и фильтры работают одинаково во всех модулях универсального списка common/list/paging/{модуль} — подробное описание на странице списка сделок.

Быстрый список по контрагенту или сделке

GET https://do.freshoffice.ru/finance/list?company_id=368132

Упрощённый метод без пагинации: возвращает движения денежных средств одного контрагента, от новых к старым. Вместо контрагента можно запросить движения по одной сделке:

GET https://do.freshoffice.ru/finance/list?deal_id=12345

Query Parameters

Name Type Description
company_id Int ID контрагента. Обязателен, если не передан deal_id
deal_id Int ID сделки. Обязателен, если не передан company_id 
curl --location --request GET 'https://do.freshoffice.ru/finance/list?company_id=368132' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX'

Ответ

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "[ { ...движение... }, { ...движение... } ]"
}
// value - JSON-массив движений денежных средств
Предыдущая
Финансы
Следующая
Добавление