Соглашения о взаимозачёте
Основание взаимозачёта: стороны, двусторонний или трёхсторонний зачёт, номер и дата договора, срок действия и расписание регулярного зачёта.
Соглашения о взаимозачёте
Объекты
SettlementAgreement
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
kindstringобязательноbilateral — двусторонний зачёт: поставщик и покупатель — одно лицо; tripartite — трёхсторонний: долг покупателя зачитывается в долг магазина перед другим лицом-поставщиком по согласию трёх сторон.
- Значения:
bilateraltripartite
legal_entity_idintegerобязательноID юрлица магазина, стороны соглашения (/v1/legal-entities).
supplier_idintegerобязательноID поставщика-кредитора (/v1/suppliers).
customer_idinteger или nullID покупателя-должника (/v1/customers); null, если покупатель стёрт. Только с доступом к покупателям.
customer_namestringИмя покупателя на момент заведения соглашения. Только с доступом к покупателям.
referencestring или nullобязательноНомер подписанного соглашения; null, если не указан.
signed_onstring (date) или nullобязательноДата подписания, YYYY-MM-DD; null, если не указана.
valid_fromstringобязательноНачало срока действия, YYYY-MM-DD.
valid_untilstring или nullобязательноКонец срока действия, YYYY-MM-DD включительно; null — бессрочно.
schedulestringобязательноРегулярный зачёт: manual — только вручную; weekly — раз в неделю; monthly — раз в месяц.
- Значения:
manualweeklymonthly
schedule_dayinteger или nullобязательноДень прогона: у weekly — день недели ISO (1 — понедельник), у monthly — число месяца 1–31 (в коротком месяце — последнее); null у manual.
next_run_onstring (date) или nullобязательноДата следующего регулярного зачёта, YYYY-MM-DD в часовом поясе магазина; null — прогонов не будет.
notestring или nullобязательноЗаметка сотрудника; null, если её нет.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Соглашения о взаимозачёте: стороны, вид, реквизиты договора, срок и расписание
get/settlement-agreements
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})$
include_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
supplier_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-agreements" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"kind": "bilateral",
"legal_entity_id": 0,
"supplier_id": 0,
"customer_id": 0,
"customer_name": "string",
"reference": "string",
"signed_on": "2026-01-15",
"valid_from": "string",
"valid_until": "string",
"schedule": "manual",
"schedule_day": 0,
"next_run_on": "2026-01-15",
"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/settlement-agreements/{settlement_agreement}
Scope: procurement:read
Параметры
Путь
settlement_agreementintegerобязательноID соглашения о взаимозачёте.
Ответы
200Успешно
application/json
Возвращает SettlementAgreement
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-agreements/{settlement_agreement}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"kind": "bilateral",
"legal_entity_id": 0,
"supplier_id": 0,
"customer_id": 0,
"customer_name": "string",
"reference": "string",
"signed_on": "2026-01-15",
"valid_from": "string",
"valid_until": "string",
"schedule": "manual",
"schedule_day": 0,
"next_run_on": "2026-01-15",
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}