Движения денежного ящика

Журнал ящика смены: продажи и возвраты налом, внесения, выдачи, сдача в сейф, размен и сторно. Только дописывается.

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

Движения денежного ящика

Объекты

PosCashMovement

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

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

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

    ID кассовой смены (/v1/pos-shifts).

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

    Вид движения: sale_cash_in — продажа налом; refund_cash_out — возврат налом; sale_reversal — нал, отданный при отмене незавершённой продажи; change_out — сдача в валюте магазина при оплате купюрами чужой валюты; pay_in и pay_out — внесение и выдача по причине; drop_out — сдача в сейф; float_in — размен из сейфа; waiter_cash_in — нал, сданный официантом; courier_shortage — недосдача курьера; no_sale — ящик открыт без продажи; *_reversal — сторно.

    Значения:
    pay_inpay_outsale_cash_inrefund_cash_outcourier_shortagewaiter_cash_insale_reversalno_salefloat_indrop_outpay_in_reversalpay_out_reversaldrop_out_reversalfloat_in_reversalchange_outchange_out_reversal
  • directionstringобязательно

    Знак в ожидании ящика: in — деньги легли в ящик; out — вышли из него; none — ящик открыт без денег.

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

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

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

    Валюта ящика, который меняет движение, код ISO 4217.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUB
  • occurred_atstring (date-time)обязательно

    Момент события по времени кассы: движение, записанное без связи, доезжает позже.

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

    ID заказа.

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

    ID платежа (/v1/payments) продажи или возврата налом; null у ручных движений.

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

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

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

    ID конверта сейфа — сдачи или размена: журнал денег ссылается на него source вида pos_cash_transfer. null, если конверта нет.

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

    ID причины внесения или выдачи (/v1/pos-cash-reasons); у прочих видов null.

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

    ID поставщика, которому выданы деньги; null, если выдача не поставщику.

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

    Комментарий кассира; null, если его нет.

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

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

Методы

Журнал денежного ящика: продажи и возвраты налом, внесения, выдачи, сдача в сейф, размен и сторно

get/pos-cash-movements

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})$
  • shift_idinteger

    Только движения этой кассовой смены.

    Минимум:
    1

Ответы

200Успешно

application/json

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

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

  • 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/pos-cash-movements" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "shift_id": 0,
      "type": "pay_in",
      "direction": "in",
      "amount": 0,
      "currency": "ARS",
      "occurred_at": "2026-01-15T12:00:00Z",
      "order_id": 0,
      "payment_id": 0,
      "reverses_movement_id": 0,
      "cash_transfer_id": 0,
      "cash_reason_id": 0,
      "supplier_id": 0,
      "comment": "string",
      "created_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"
}

Движение денежного ящика

get/pos-cash-movements/{movement}

Scope: finance:read

Параметры

Путь

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

    ID движения денежного ящика.

Ответы

200Успешно

application/json

Возвращает PosCashMovement

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/pos-cash-movements/{movement}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "shift_id": 0,
  "type": "pay_in",
  "direction": "in",
  "amount": 0,
  "currency": "ARS",
  "occurred_at": "2026-01-15T12:00:00Z",
  "order_id": 0,
  "payment_id": 0,
  "reverses_movement_id": 0,
  "cash_transfer_id": 0,
  "cash_reason_id": 0,
  "supplier_id": 0,
  "comment": "string",
  "created_at": "2026-01-15T12:00:00Z"
}