Счета покупателей
Книга долгов магазина: остаток каждого покупателя, кредитный лимит, срок оплаты и выписка за период со сроками долгов.
Счета покупателей
Объекты
CustomerAccount
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
statusstringобязательноСостояние: active — покупатель берёт в долг в пределах лимита; suspended — новые продажи в долг закрыты, долг остаётся и гасится.
- Значения:
activesuspended
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
balanceintegerобязательноОстаток в минимальных единицах валюты: плюс — покупатель должен, минус — переплата. Равен сумме amount всех записей счёта (/v1/customer-account-entries).
credit_limitinteger или nullобязательноКредитный лимит в минимальных единицах валюты; null — без лимита. Сверх лимита и при просрочке продают в долг только с подтверждением менеджера.
payment_terms_daysintegerобязательноСрок оплаты продажи в долг, дней: срок начисления (due_on) — день продажи плюс этот срок.
customer_idintegerID покупателя (/v1/customers). Только с доступом к покупателям.
notestring или nullЗаметка сотрудника о покупателе; null, если её нет. Только с доступом к покупателям: удаление покупателя её стирает.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
CustomerAccountStatement
customer_account_idintegerобязательноID счёта покупателя (/v1/customer-accounts).
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
fromstringобязательноПервый день периода, YYYY-MM-DD в часовом поясе магазина; без from в запросе — день первой операции счёта.
tostringобязательноПоследний день периода, YYYY-MM-DD в часовом поясе магазина.
opening_balanceintegerобязательноДолг на начало периода: сумма операций до from.
closing_balanceintegerобязательноДолг на конец периода: opening_balance плюс строки периода.
chargedintegerобязательноСумма увеличений долга за период.
reducedintegerобязательноСумма уменьшений долга за период, положительным числом.
linesмассив objectобязательноЗаписи периода в порядке операций (occurred_at) с нарастающим остатком.
Поля · 8
entry_idintegerобязательноID записи журнала (/v1/customer-account-entries).
kindstringобязательноВид записи, те же значения, что у kind записи журнала.
- Значения:
chargeopening_balanceopening_creditpaymentreturnwrite_offoffsetwithholdingreversal
occurred_atstring (date-time)обязательноМомент операции.
order_idinteger или nullобязательноID заказа (/v1/orders); null, если заказа нет.
due_onstring (date) или nullобязательноСрок оплаты начисления; null у уменьшений долга.
notestring или nullобязательноЗаметка сотрудника; null, если её нет.
amountintegerобязательноСумма со знаком: плюс — долг вырос, минус — уменьшился.
balanceintegerобязательноДолг после этой строки.
open_itemsмассив objectобязательноНачисления, не закрытые на конец периода, по сроку оплаты. Какое погашение закрыло какое начисление, решает распределение FIFO в пределах юрлица.
Поля · 7
entry_idintegerобязательноID начисления (/v1/customer-account-entries).
kindstringобязательноcharge — продажа в долг; opening_balance — долг из прежнего учёта.
- Значения:
chargeopening_balance
occurred_atstring (date-time)обязательноМомент операции.
order_idinteger или nullобязательноID заказа (/v1/orders); null, если заказа нет.
due_onstring (date) или nullобязательноСрок оплаты начисления, YYYY-MM-DD в часовом поясе магазина.
open_amountintegerобязательноНедоплаченная часть начисления на конец периода.
overduebooleanобязательноСрок оплаты прошёл до to: на конец периода долг просрочен.
Методы
Счета покупателей в книге долгов: остаток, кредитный лимит и срок оплаты
get/customer-accounts
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})$
Ответы
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-accounts" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"status": "active",
"currency": "ARS",
"balance": 0,
"credit_limit": 0,
"payment_terms_days": 0,
"customer_id": 0,
"note": "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"
}Счёт покупателя
get/customer-accounts/{customer_account}
Scope: finance:read
Параметры
Путь
customer_accountintegerобязательноID счёта покупателя.
Ответы
200Успешно
application/json
Возвращает CustomerAccount
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-accounts/{customer_account}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"status": "active",
"currency": "ARS",
"balance": 0,
"credit_limit": 0,
"payment_terms_days": 0,
"customer_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Выписка по счёту покупателя за период: долг на начало и конец, движения с нарастающим остатком и открытые долги со сроками
get/customer-accounts/{customer_account}/statement
Scope: finance:read
Параметры
Путь
customer_accountintegerобязательноID счёта покупателя.
Строка запроса
fromstring (date)Первый день периода YYYY-MM-DD в часовом поясе магазина; по умолчанию — день первой операции счёта.
tostring (date)Последний день периода YYYY-MM-DD в часовом поясе магазина; по умолчанию сегодня.
Ответы
200Успешно
application/json
Возвращает CustomerAccountStatement
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-accounts/{customer_account}/statement" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"customer_account_id": 0,
"currency": "ARS",
"from": "string",
"to": "string",
"opening_balance": 0,
"closing_balance": 0,
"charged": 0,
"reduced": 0,
"lines": [
{
"entry_id": 0,
"kind": "charge",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"due_on": "2026-01-15",
"note": "string",
"amount": 0,
"balance": 0
}
],
"open_items": [
{
"entry_id": 0,
"kind": "charge",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"due_on": "2026-01-15",
"open_amount": 0,
"overdue": true
}
]
}Погашение долга покупателя деньгами, которые уже пришли: запись в книгу долгов со справками об удержаниях
post/customer-accounts/{customer_account}/payments
Scope: finance:write
Параметры
Путь
customer_accountintegerобязательноID счёта покупателя.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
amountintegerобязательноСколько денег пришло в счёт долга, в минимальных единицах валюты магазина.
- Минимум:
- 1
- Максимум:
- 10000000000
payment_methodstringобязательноСпособ, которым пришли деньги: он должен гасить долг и подтверждаться руками — например наличные или ручной способ manual.
- Значения:
cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_package
manual_payment_method_idinteger или nullID ручного способа оплаты (/v1/manual-payment-methods) при payment_method=manual, например банковского перевода.
- Минимум:
- 1
location_idintegerобязательноID точки магазина.
legal_entity_idinteger или nullID юрлица магазина (/v1/legal-entities), чей долг гасят: нужен, когда покупатель должен нескольким юрлицам.
withholdingsмассив objectСправки об удержаниях, которые покупатель-агент отдал вместе с деньгами: закрывают долг наравне с деньгами.
- Мин. элементов:
- 1
- Макс. элементов:
- 2000
Поля · 4
regimestringобязательноНалог удержания: vat, turnover, income и другие коды TaxRegime.
jurisdictionstring или nullЮрисдикция провинциального или муниципального налога, например AR-B; у налогов страны — null.
- Макс. длина:
- 8
- Шаблон:
^[A-Z]{2}-[A-Z0-9]{1,5}$
amountintegerобязательноСумма удержания в минимальных единицах валюты магазина.
- Минимум:
- 1
certificate_numberstringобязательноНомер справки об удержании.
- Макс. длина:
- 64
withheld_onstring (date)День удержания, YYYY-MM-DD: по нему справка ложится в налоговый период, закрытый период — отказ.
withholding_agent_tax_idstringCUIT покупателя-агента, удержавшего налог.
- Макс. длина:
- 20
Ответы
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
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
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
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/customer-accounts/{customer_account}/payments" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"amount": 1,
"payment_method": "cash",
"manual_payment_method_id": 1,
"location_id": 0,
"legal_entity_id": 0,
"withholdings": [
{
"regime": "string",
"jurisdiction": "string",
"amount": 1,
"certificate_number": "string"
}
],
"withheld_on": "2026-01-15",
"withholding_agent_tax_id": "string"
}{
"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"
}