Журнал счетов покупателей
Записи книги долгов: продажа в долг, погашение, возврат, списание, взаимозачёт, удержание и сторно. Только дописывается.
Журнал счетов покупателей
Объекты
CustomerAccountEntry
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
customer_account_idintegerобязательноID счёта покупателя (/v1/customer-accounts). Меняется только при слиянии покупателей: запись переезжает на счёт оставшегося.
kindstringобязательноВид записи: charge — продажа в долг; opening_balance — долг из прежнего учёта; opening_credit — переплата из прежнего учёта; payment — погашение; return — возврат товара по долговой продаже; write_off — списание безнадёжного долга; offset — взаимозачёт с покупателем как поставщиком; withholding — налог, удержанный покупателем-агентом при погашении; reversal — сторно записи reverses_entry_id.
- Значения:
chargeopening_balanceopening_creditpaymentreturnwrite_offoffsetwithholdingreversal
amountintegerобязательноСумма со знаком в минимальных единицах валюты: плюс — долг вырос, минус — уменьшился.
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
legal_entity_idinteger или nullобязательноID юрлица магазина (/v1/legal-entities), перед которым долг: погашение закрывает долги только своего юрлица. null, если юрлицо не задано.
due_onstring (date) или nullобязательноСрок оплаты начисления, YYYY-MM-DD в часовом поясе магазина: со следующего дня долг просрочен. null у уменьшений долга.
occurred_atstring (date-time)обязательноМомент операции. Долг из прежнего учёта датирован задним числом: порядок операций — по этому полю, а не по порядку записи.
order_idinteger или nullобязательноID заказа (/v1/orders): продажа в долг или заказ-погашение с account_payment_amount; null, если заказа нет.
payment_idinteger или nullобязательноID платежа (/v1/payments) способом on_account у продажи в долг; null у остальных записей. Деньги погашения — платёж его заказа order_id.
refund_idinteger или nullобязательноID возврата (/v1/refunds), которым товар вернули по долговой продаже; null у других записей.
reverses_entry_idinteger или nullобязательноID записи, которую гасит это сторно; null у обычной записи.
settlement_offset_idinteger или nullобязательноID взаимозачёта (/v1/settlement-offsets) у записи вида offset; null у остальных. Сторно зачёта ссылается на запись (reverses_entry_id).
tax_withholding_idinteger или nullобязательноID справки в реестре удержаний (/v1/tax-withholdings, scope fiscal:read) у записи вида withholding; null у остальных и когда справку сняли из реестра — сторно записи снимает справку, заведённую погашением.
notestring или nullобязательноЗаметка сотрудника: основание списания, переноса или сторно; null, если её нет.
created_atstring (date-time)обязательноКогда запись внесена в журнал.
Методы
Журнал счетов покупателей: продажа в долг, погашение, возврат, списание, взаимозачёт, удержание и сторно
get/customer-account-entries
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})$
customer_account_idintegerТолько записи этого счёта покупателя.
- Минимум:
- 1
payment_idintegerТолько строки этого платежа.
- Минимум:
- 1
order_idintegerТолько записи этого заказа.
- Минимум:
- 1
Ответы
200Успешно
application/json
Записи страницы.
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/customer-account-entries" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"customer_account_id": 0,
"kind": "charge",
"amount": 0,
"currency": "ARS",
"legal_entity_id": 0,
"due_on": "2026-01-15",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"payment_id": 0,
"refund_id": 0,
"reverses_entry_id": 0,
"settlement_offset_id": 0,
"tax_withholding_id": 0,
"note": "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/customer-account-entries/{customer_account_entry}
Scope: finance:read
Параметры
Путь
customer_account_entryintegerобязательноID записи журнала счёта покупателя.
Ответы
200Успешно
application/json
Возвращает CustomerAccountEntry
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/customer-account-entries/{customer_account_entry}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"customer_account_id": 0,
"kind": "charge",
"amount": 0,
"currency": "ARS",
"legal_entity_id": 0,
"due_on": "2026-01-15",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"payment_id": 0,
"refund_id": 0,
"reverses_entry_id": 0,
"settlement_offset_id": 0,
"tax_withholding_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z"
}