Финансовые транзакции

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

Для просмотра списка финансовых транзакций используется API HEAD /api/finance и GET /api/finance.

В query-параметрах запроса допустимо использование следующих фильтров:

Ключ

Тип

Описание

users

List[ObjectId]

Список ID пользователей.

contractors

List[ObjectId]

Список ID контрагентов.

cashboxes

List[ObjectId]

Список ID касс/счетов.

delta

number

Сумма операции. delta применяется для указания точного совпадения. Для задания интервалов применяются суффиксы _gte (>=), _gt (>), _lte (<=) и _lt (<). Например ?delta_gte=100&delta_lte=200

date

datetime

Используется для задания временного интервала. Допускается исползование только с суффиксами _gte (>=), _gt (>), _lte (<=) и _lt (<). Использовать непосредственно date нельзя.

franchisees

List[ObjectId]

Список ID франчайзи для включения в фильтр.

franchisees_ne

List[ObjectId]

Список ID франчайзи для исключения из фильтрации.

action_type

str

Тип операции

Типы операций (action_type):

  • «order» - заказ;

  • «term_fix» - расхождение при сверке терминала;

  • «income» - поступление;

  • «commission» - комиссия эквайринга;

  • «fix» - расхождение наличной кассы;

  • «outcome» - списание;

  • «transfer» - перевод из одной кассы в другую;

  • «storage» - оплата складской операции.

API использует стандартную схему пагинации.

Пример запроса списка услуг

curl -X GET \
    https://demo.idealist.one/api/finance \
    -H 'Authorization: Bearer persistent 2adbd5dc-38c4-4963-8930-6d75827ff0fe'

Структура транзакции

Ключ

Тип

Описание

action_id

ObjectId

ID операции (заказ, складское поступление и т.д.)

action_cls

str

Тип операции

transact_id

UUID

ID транзакции

transact_cls

str

Тип транзакции

type

str

Тип финансовой операции

subtype

str

Подтип финансовой операции

desc

Optional[str]

Описание

date

datetime

Дата проведения транзакции

cashbox

Cashbox

Касса проведения транзакции

user

User

Пользователь

amount

number

Сумма транзакции

amount_abs

number

Модуль суммы транзакции

balance

number

Баланс кассы/счёта после проведения транзакции