Движения денег

Журнал приходов и расходов по счетам: сумма проводки, запись-источник и первичный документ.

Загружаем поисковый индекс…

Движения денег

Объекты

MoneyTransaction

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • versionintegerобязательно

    Версия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.

  • account_idintegerобязательно

    ID денежного счёта движения.

  • directionstringобязательно

    income — приход на счёт; expense — расход со счёта.

    Значения:
    incomeexpense
  • amountintegerобязательно

    Сумма проводки в минимальных единицах валюты магазина, всегда положительная: направление задаёт direction. У счёта в чужой валюте — пересчёт по курсу снимка.

  • currencystringобязательно

    Валюта сумм, код ISO 4217: валюта магазина.

  • account_amountstringобязательно

    Сумма в валюте счёта, десятичной строкой.

  • account_currencystringобязательно

    Валюта счёта: код ISO 4217 или актива (USDT).

  • exchange_ratestring или nullобязательно

    Курс снимка: 1 единица валюты счёта = exchange_rate единиц валюты магазина, десятичной строкой. null у счёта в валюте магазина.

  • occurred_atstring (date-time)обязательно

    Момент движения.

  • occurred_onstring (date)обязательно

    Учётная дата, YYYY-MM-DD в часовом поясе магазина.

  • category_idinteger или nullобязательно

    ID статьи; null — перевод между счетами или движение без статьи.

  • supplier_idinteger или nullобязательно

    ID поставщика-контрагента; null, если его нет.

  • transfer_idinteger или nullобязательно

    Общий id ног перевода между счетами: у расхода с одного счёта и прихода на другой он один. null — не перевод.

  • reverses_transaction_idinteger или nullобязательно

    ID движения, которое это сторнирует; null у обычного движения.

  • originstringобязательно

    Класс источника: manual — внесено человеком; sales — продажи; refunds — возвраты; disputes — споры; pos — касса и сейф; suppliers — поставщики; payroll — зарплата; statement — выписка; opening_balance — начальный остаток; exchange_differences — курсовые разницы; group_stores — операции магазинов группы на общем счёте.

    Значения:
    manualstatementsalesrefundsdisputespossupplierspayrollopening_balanceexchange_differencesgroup_stores
  • sourceobject или nullобязательно

    Запись, которая провела движение; null — внесено вручную.

    Поля · 2
    • typestringобязательно

      Вид проводки. payment и payment_* — приход оплаты и её части (чаевые, надбавка, сдача, комиссия провайдера, удержанный налог); refund — выплата возврата; pos_* — документы кассы; supplier_bill_payment — оплата счёта поставщика; exchange_difference — курсовая разница.

      Значения:
      paymentpayment_tippayment_tip_refundpayment_surchargepayment_surcharge_refundpayment_overpaymentpayment_changepayment_change_counterpayment_provider_feepayment_provider_fee_refundpayment_withheld_taxpayment_withheld_tax_refundrefunddisputepos_shiftpos_shift_drawerpos_cash_transferpos_cash_transfer_counterpos_cash_shared_safepos_cash_shared_safe_counterpos_cash_movementpos_drawer_movementpos_cash_advance_expensepos_cash_advance_expense_voidpos_cash_bank_creditpos_cash_bank_credit_counterpos_cash_bank_credit_differencepayroll_periodpurchase_ordersupplier_bill_paymentsupplier_return_refundstatement_lineopening_balanceexchange_differencegroup_member_operation
    • idinteger или nullобязательно

      ID записи-источника: у payment и payment_* — ID платежа, у refund — ID из transactions[] возврата, у exchange_difference — ID движения-расхода; у остальных — внутренний ID.

  • documentobject или nullобязательно

    Первичный документ движения; null — внесено вручную или документ в учёте другого магазина группы.

    Поля · 2
    • typestringобязательно

      Вид документа: order — заказ; pos_shift — смена кассы; supplier_bill — счёт поставщика; purchase_order — заказ поставщику; supplier_return — возврат поставщику; dispute — спор; payroll — зарплатный период; pos_safe — сейф кассы; statement_import — импорт выписки; money_accounts — начальный остаток счёта.

      Значения:
      orderdisputepos_shiftpos_safepurchase_ordersupplier_billsupplier_returnpayrollstatement_importmoney_accounts
    • idinteger или nullобязательно

      ID документа; null у реестров без своей записи: pos_safe, statement_import, money_accounts.

  • descriptionstring или nullобязательно

    Комментарий к движению, как его записал человек или документ; null, если его нет.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

Методы

Движения денег, изменённые с указанного момента: приходы и расходы по счетам с источником и первичным документом

get/money-transactions

Scope: finance:read

Параметры

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • account_idinteger

    Только движения этого денежного счёта.

    Минимум:
    1
  • transfer_idinteger

    Только ноги этого перевода между счетами.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив MoneyTransactionобязательно

    Записи страницы.

  • deletedмассив objectобязательно

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

    Поля · 2
    • idintegerобязательно

      ID стёртой записи.

    • deleted_atstring (date-time)обязательно

      Когда запись стёрта.

  • next_cursorstring или nullобязательно

    Курсор следующей страницы; null на последней.

  • has_morebooleanобязательно

    true, если есть следующая страница.

  • sync_cursorstring или nullобязательно

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/money-transactions" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "version": 0,
      "account_id": 0,
      "direction": "income",
      "amount": 0,
      "currency": "string",
      "account_amount": "string",
      "account_currency": "string",
      "exchange_rate": "string",
      "occurred_at": "2026-01-15T12:00:00Z",
      "occurred_on": "2026-01-15",
      "category_id": 0,
      "supplier_id": 0,
      "transfer_id": 0,
      "reverses_transaction_id": 0,
      "origin": "manual",
      "source": {
        "type": "payment",
        "id": 0
      },
      "document": {
        "type": "order",
        "id": 0
      },
      "description": "string",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Ручной доход или расход по денежному счёту

post/money-transactions

Scope: finance:write

Параметры

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/json

  • account_idintegerобязательно

    ID денежного счёта движения.

    Минимум:
    1
  • directionstringобязательно

    income — приход на счёт; expense — расход со счёта.

    Значения:
    incomeexpense
  • account_amountstringобязательно

    Сумма в валюте счёта, десятичной строкой.

    Макс. длина:
    37
  • amountinteger или null

    Сумма проводки в минимальных единицах валюты магазина, всегда положительная: направление задаёт direction. У счёта в чужой валюте — пересчёт по курсу снимка.

    Минимум:
    0
    Максимум:
    100000000000000
  • occurred_onstring (date)

    Учётная дата, YYYY-MM-DD в часовом поясе магазина.

  • occurred_atstring (date-time)

    Момент движения.

  • category_idinteger или null

    ID статьи; null — перевод между счетами или движение без статьи.

  • supplier_idinteger или null

    ID поставщика-контрагента; null, если его нет.

  • descriptionstring или null

    Комментарий к движению, как его записал человек или документ; null, если его нет.

    Макс. длина:
    1000

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает MoneyTransaction

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/money-transactions" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "account_id": 1,
  "direction": "income",
  "account_amount": "string",
  "amount": 0,
  "occurred_on": "2026-01-15",
  "occurred_at": "2026-01-15T12:00:00Z",
  "category_id": 0,
  "supplier_id": 0,
  "description": "string"
}
Пример ответа · 201
{
  "id": 0,
  "version": 0,
  "account_id": 0,
  "direction": "income",
  "amount": 0,
  "currency": "string",
  "account_amount": "string",
  "account_currency": "string",
  "exchange_rate": "string",
  "occurred_at": "2026-01-15T12:00:00Z",
  "occurred_on": "2026-01-15",
  "category_id": 0,
  "supplier_id": 0,
  "transfer_id": 0,
  "reverses_transaction_id": 0,
  "origin": "manual",
  "source": {
    "type": "payment",
    "id": 0
  },
  "document": {
    "type": "order",
    "id": 0
  },
  "description": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Движение денег

get/money-transactions/{transaction}

Scope: finance:read

Параметры

Путь

  • transactionintegerобязательно

    ID движения денег.

Ответы

200Успешно

Заголовки

  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает MoneyTransaction

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/money-transactions/{transaction}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "account_id": 0,
  "direction": "income",
  "amount": 0,
  "currency": "string",
  "account_amount": "string",
  "account_currency": "string",
  "exchange_rate": "string",
  "occurred_at": "2026-01-15T12:00:00Z",
  "occurred_on": "2026-01-15",
  "category_id": 0,
  "supplier_id": 0,
  "transfer_id": 0,
  "reverses_transaction_id": 0,
  "origin": "manual",
  "source": {
    "type": "payment",
    "id": 0
  },
  "document": {
    "type": "order",
    "id": 0
  },
  "description": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Правка движения денег: у движения с документом-источником — только статья, контрагент и описание

patch/money-transactions/{transaction}

Scope: finance:write

Параметры

Путь

  • transactionintegerобязательно

    ID движения денег.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • account_idinteger

    ID денежного счёта движения.

    Минимум:
    1
  • directionstring

    income — приход на счёт; expense — расход со счёта.

    Значения:
    incomeexpense
  • account_amountstring

    Сумма в валюте счёта, десятичной строкой.

    Макс. длина:
    37
  • amountinteger или null

    Сумма проводки в минимальных единицах валюты магазина, всегда положительная: направление задаёт direction. У счёта в чужой валюте — пересчёт по курсу снимка.

    Минимум:
    0
    Максимум:
    100000000000000
  • occurred_onstring (date)

    Учётная дата, YYYY-MM-DD в часовом поясе магазина.

  • occurred_atstring (date-time)

    Момент движения.

  • category_idinteger или null

    ID статьи; null — перевод между счетами или движение без статьи.

  • supplier_idinteger или null

    ID поставщика-контрагента; null, если его нет.

  • descriptionstring или null

    Комментарий к движению, как его записал человек или документ; null, если его нет.

    Макс. длина:
    1000

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает MoneyTransaction

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X PATCH "https://api.saleya.app/v1/money-transactions/{transaction}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "account_id": 1,
  "direction": "income",
  "account_amount": "string",
  "amount": 0,
  "occurred_on": "2026-01-15",
  "occurred_at": "2026-01-15T12:00:00Z",
  "category_id": 0,
  "supplier_id": 0,
  "description": "string"
}
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "account_id": 0,
  "direction": "income",
  "amount": 0,
  "currency": "string",
  "account_amount": "string",
  "account_currency": "string",
  "exchange_rate": "string",
  "occurred_at": "2026-01-15T12:00:00Z",
  "occurred_on": "2026-01-15",
  "category_id": 0,
  "supplier_id": 0,
  "transfer_id": 0,
  "reverses_transaction_id": 0,
  "origin": "manual",
  "source": {
    "type": "payment",
    "id": 0
  },
  "document": {
    "type": "order",
    "id": 0
  },
  "description": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Удаление ручного движения денег с возвратом остатка счёта

delete/money-transactions/{transaction}

Scope: finance:write

Параметры

Путь

  • transactionintegerобязательно

    ID движения денег.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Ответы

204Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

Без тела

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X DELETE "https://api.saleya.app/v1/money-transactions/{transaction}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'