Соглашения о взаимозачёте

Основание взаимозачёта: стороны, двусторонний или трёхсторонний зачёт, номер и дата договора, срок действия и расписание регулярного зачёта.

Загружаем поисковый индекс…

Соглашения о взаимозачёте

Объекты

SettlementAgreement

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • kindstringобязательно

    bilateral — двусторонний зачёт: поставщик и покупатель — одно лицо; tripartite — трёхсторонний: долг покупателя зачитывается в долг магазина перед другим лицом-поставщиком по согласию трёх сторон.

    Значения:
    bilateraltripartite
  • legal_entity_idintegerобязательно

    ID юрлица магазина, стороны соглашения (/v1/legal-entities).

  • supplier_idintegerобязательно

    ID поставщика-кредитора (/v1/suppliers).

  • customer_idinteger или null

    ID покупателя-должника (/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_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • supplier_idinteger

    Только документы этого поставщика.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив SettlementAgreementобязательно

    Записи страницы.

  • 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"
Пример ответа · 200
{
  "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"
Пример ответа · 200
{
  "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"
}