Строки взаимозачётов
Что именно зачтено: заказ или долг покупателя по книге долгов и счёт поставщика, с погашениями, которые создал зачёт.
Строки взаимозачётов
Объекты
SettlementOffsetLine
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
settlement_offset_idintegerобязательноID взаимозачёта (/v1/settlement-offsets).
sidestringобязательноreceivable — долг покупателя магазину (заказ или долг по книге долгов); payable — долг магазина поставщику (счёт).
- Значения:
receivablepayable
positionintegerобязательноПозиция при сортировке: меньшая идёт первой.
amountintegerобязательноЗачтённая сумма.
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
order_idinteger или nullобязательноID заказа, долг по которому зачтён (/v1/orders); null у других строк.
customer_account_entry_idinteger или nullобязательноID записи книги долгов вида offset, которой зачёт уменьшил долг покупателя по счёту (/v1/customer-account-entries); null у других строк. Аннулирование пишет её сторно.
payment_idinteger или nullобязательноID платежа заказа, созданного зачётом (/v1/payments); null у других строк и после аннулирования.
supplier_bill_idinteger или nullобязательноID счёта поставщика (/v1/supplier-bills); null у строк покупателя. Если долг по поставке заменён фактурой — фактура.
supplier_bill_payment_idinteger или nullобязательноID оплаты счёта, созданной зачётом (/v1/supplier-bill-payments); null у строк покупателя и после аннулирования.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Строки взаимозачётов: зачтённые долги покупателя и счета поставщика
get/settlement-offset-lines
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})$
settlement_offset_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/settlement-offset-lines" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"settlement_offset_id": 0,
"side": "receivable",
"position": 0,
"amount": 0,
"currency": "ARS",
"order_id": 0,
"customer_account_entry_id": 0,
"payment_id": 0,
"supplier_bill_id": 0,
"supplier_bill_payment_id": 0,
"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-offset-lines/{settlement_offset_line}
Scope: procurement:read
Параметры
Путь
settlement_offset_lineintegerобязательноID строки взаимозачёта.
Ответы
200Успешно
application/json
Возвращает SettlementOffsetLine
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-offset-lines/{settlement_offset_line}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"settlement_offset_id": 0,
"side": "receivable",
"position": 0,
"amount": 0,
"currency": "ARS",
"order_id": 0,
"customer_account_entry_id": 0,
"payment_id": 0,
"supplier_bill_id": 0,
"supplier_bill_payment_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}