Взаимозачёты
Документ зачёта встречных долгов: что магазину должен покупатель против того, что магазин должен поставщику. Аннулированный зачёт остаётся со статусом voided.
Взаимозачёты
Объекты
SettlementOffset
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
numberstringобязательноНомер документа зачёта.
statusstringобязательноposted — проведён; voided — аннулирован: погашения, созданные зачётом, сняты, долги снова открыты.
- Значения:
postedvoided
kindstringобязательноbilateral — двусторонний зачёт; tripartite — трёхсторонний, по соглашению agreement_id.
- Значения:
bilateraltripartite
legal_entity_idintegerобязательноID юрлица магазина, от которого проведён зачёт (/v1/legal-entities).
supplier_idintegerобязательноID поставщика (/v1/suppliers).
agreement_idinteger или nullобязательноID соглашения о зачёте (/v1/settlement-agreements); null у двустороннего зачёта без соглашения.
customer_idinteger или nullID покупателя (/v1/customers); null, если покупатель стёрт. Только с доступом к покупателям.
customer_namestringИмя покупателя на момент проведения. Только с доступом к покупателям.
occurred_onstring (date)обязательноДата зачёта, YYYY-MM-DD в часовом поясе магазина.
totalintegerобязательноСумма зачёта: столько зачтено и по долгам покупателя, и по счетам поставщика.
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
notestring или nullобязательноЗаметка сотрудника; null, если её нет.
posted_atstring (date-time)обязательноКогда зачёт проведён.
voided_atstring (date-time) или nullобязательноКогда зачёт аннулирован; null у проведённого.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Взаимозачёты: встречные долги покупателя и поставщика, закрытые документом зачёта
get/settlement-offsets
Scope: procurement: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})$
supplier_idintegerТолько документы этого поставщика.
- Минимум:
- 1
agreement_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/settlement-offsets" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"status": "posted",
"kind": "bilateral",
"legal_entity_id": 0,
"supplier_id": 0,
"agreement_id": 0,
"customer_id": 0,
"customer_name": "string",
"occurred_on": "2026-01-15",
"total": 0,
"currency": "ARS",
"note": "string",
"posted_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"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/settlement-offsets/{settlement_offset}
Scope: procurement:read
Параметры
Путь
settlement_offsetintegerобязательноID взаимозачёта.
Ответы
200Успешно
application/json
Возвращает SettlementOffset
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/settlement-offsets/{settlement_offset}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"status": "posted",
"kind": "bilateral",
"legal_entity_id": 0,
"supplier_id": 0,
"agreement_id": 0,
"customer_id": 0,
"customer_name": "string",
"occurred_on": "2026-01-15",
"total": 0,
"currency": "ARS",
"note": "string",
"posted_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}