Поставщики

Справочник поставщиков: реквизиты, валюта закупки, отсрочка оплаты и вид расчётов, а ещё сальдо и акт сверки. Контактное лицо и заметки не отдаются.

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

Поставщики

Объекты

Supplier

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

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

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

    Версия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.

  • external_idstring или nullобязательно

    Внешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.

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

    Название поставщика, как его видит магазин.

  • legal_namestring или nullобязательно

    Юридическое наименование; null, если не задано.

  • tax_idstring или nullобязательно

    Налоговый номер, как его ввёл магазин (CUIT в Аргентине); null, если не задан.

  • tax_id_countrystring или nullобязательно

    Страна налогового номера, ISO 3166-1 alpha-2; null, если номер не задан.

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

    false — поставщик выключен: новые заказы ему не делают, документы остаются.

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

    Валюта закупки у поставщика, ISO 4217: в ней min_order_amount и цены его заказов.

  • payment_term_daysinteger или nullобязательно

    Отсрочка оплаты в днях: из неё считается срок счёта due_on. null — отсрочки нет.

  • prices_include_taxboolean или nullобязательно

    true — поставщик называет цены с налогом, false — без налога; null — по правилу магазина.

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

    on_receipt — обычная закупка: долг возникает при приёмке; on_sale — реализация: магазин платит за проданное по акту реализации.

    Значения:
    on_receipton_sale
  • consignment_loss_policystringобязательно

    Кто платит за просрочку и недостачу товара на реализации: return_to_supplier — товар возвращается поставщику; our_cost — потеря магазина.

    Значения:
    return_to_supplierour_cost
  • lead_time_daysinteger или nullобязательно

    Срок поставки в днях от заказа; null, если не задан.

  • min_order_amountinteger или nullобязательно

    Минимальная сумма заказа в минимальных единицах currency; null — минимума нет.

  • customer_idinteger или null

    ID того же контрагента как покупателя (/v1/customers): по нему магазин зачитывает встречные долги. null, если связи нет. Только с доступом к покупателям.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

SupplierBalance

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

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

  • legal_entity_idinteger или nullобязательно

    ID юрлица магазина, по которому взят срез; null — по всем юрлицам.

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

    День магазина, на который разложена просрочка, YYYY-MM-DD.

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

    Валюта сумм, код ISO 4217: валюта магазина.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUB
  • total_dueintegerобязательно

    Итог долга: bills_outstanding + settled_pending_bill + accrued_unsettled + received_unbilled − returns_expected − advances_unapplied − payments_unapplied.

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

    Есть ли незакрытые позиции: итог может быть нулевым при встречных позициях.

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

    Непогашенные проведённые счета — то, что можно платить сейчас; нота кредита уменьшает.

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

    Из bills_outstanding просрочено по сроку оплаты; по возрасту просрочки раскладывается на overdue_1_30, overdue_31_60, overdue_61_90 и overdue_90_plus, в сумме они дают overdue.

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

    Корзина возраста просрочки из overdue; границы в днях календаря магазина — в имени поля.

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

    Корзина возраста просрочки из overdue; границы в днях календаря магазина — в имени поля.

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

    Корзина возраста просрочки из overdue; границы в днях календаря магазина — в имени поля.

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

    Последняя корзина возраста просрочки из overdue: всё, что старше overdue_61_90.

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

    Из bills_outstanding срок ещё не наступил (сегодня и позже).

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

    Из not_due к оплате в ближайшую неделю.

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

    Из bills_outstanding без срока оплаты.

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

    Признано актом реализации, проведённого счёта ещё нет.

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

    Продано по реализации и ещё не сведено актом.

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

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

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

    Встречное требование по отгруженным возвратам, ещё не компенсированным; уменьшает долг.

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

    Авансы по заказам поставщику, ещё не зачтённые в счета; уменьшают долг.

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

    Выплаты из журнала денег, ещё не зачтённые в счета, за вычетом денег, которые вернул поставщик; уменьшают долг.

SupplierStatement

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

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

  • legal_entity_idinteger или nullобязательно

    ID юрлица магазина, по которому построен акт; null — по всем юрлицам.

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

    Валюта сумм, код ISO 4217: валюта магазина.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUB
  • fromstringобязательно

    Первый день периода, YYYY-MM-DD в часовом поясе магазина; без from в запросе — день первой строки акта.

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

    Последний день периода, YYYY-MM-DD в часовом поясе магазина.

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

    Долг на начало периода: сумма строк до from.

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

    Долг на конец периода: opening_balance плюс строки периода. На сегодня равен total_due сальдо.

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

    Сумма увеличений долга за период.

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

    Сумма уменьшений долга за период, положительным числом.

  • linesмассив objectобязательно

    Строки периода по дате: в один день сначала то, что создаёт долг, затем то, что его гасит.

    Поля · 9
    • datestringобязательно

      Дата строки, YYYY-MM-DD в часовом поясе магазина.

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

      bill — проведённая фактура или нота дебета; credit_note — нота кредита; payment — оплата деньгами из карточки счёта; offset — взаимозачёт; out_of_band_payment — оплата вне системы; journal_payment — выплата из журнала денег; supplier_refund — деньги, которые вернул поставщик; advance — аванс по заказу; fx_difference — курсовая разница; unbilled_receipt — поставка без проведённого счёта; settlement — акт реализации без проведённого счёта; accrual — продано и не сведено актом; return_claim — отгруженный возврат без компенсации.

      Значения:
      billcredit_notepaymentoffsetout_of_band_paymentjournal_paymentsupplier_refundadvancefx_differenceunbilled_receiptsettlementaccrualreturn_claim
    • amountintegerобязательно

      Сумма строки со знаком: плюс — долг вырос, минус — уменьшился.

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

      Долг после строки.

    • documentobject или nullобязательно

      Документ строки; null у начисленного по реализации.

      Поля · 3
      • typestringобязательно

        Вид документа: supplier_bill, money_transaction, purchase_order, goods_receipt, consignment_settlement или supplier_return.

        Значения:
        supplier_billmoney_transactionpurchase_ordergoods_receiptconsignment_settlementsupplier_return
      • idintegerобязательно

        ID документа.

      • numberstring или nullобязательно

        Номер документа; null, если номера нет.

    • supplier_bill_payment_idinteger или nullобязательно

      ID оплаты счёта (/v1/supplier-bill-payments) у строки payment; null у остальных.

    • money_transaction_idinteger или nullобязательно

      ID движения журнала денег (/v1/money-transactions), которым заплачен аванс, у строки advance; null у остальных.

    • settlement_offset_idinteger или nullобязательно

      ID взаимозачёта (/v1/settlement-offsets) у строки offset; null у остальных.

    • document_amountobject или nullобязательно

      Сумма в валюте документа, если она не валюта магазина; null — в валюте магазина.

      Поля · 2
      • currencystringобязательно

        Валюта документа, ISO 4217.

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

        Сумма в минорных единицах валюты документа.

Методы

Поставщики магазина: реквизиты и условия расчётов

get/suppliers

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} в продолжении по курсору синхронизации. Включайте для синхронизации.

Ответы

200Успешно

application/json

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

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

  • 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/suppliers" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "version": 0,
      "external_id": "string",
      "name": "string",
      "legal_name": "string",
      "tax_id": "string",
      "tax_id_country": "string",
      "is_active": true,
      "currency": "string",
      "payment_term_days": 0,
      "prices_include_tax": true,
      "settlement_mode": "on_receipt",
      "consignment_loss_policy": "return_to_supplier",
      "lead_time_days": 0,
      "min_order_amount": 0,
      "customer_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"
}

Создать поставщика: реквизиты и условия расчётов

post/suppliers

Scope: procurement:write

Параметры

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/json

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

    Название поставщика, как его видит магазин.

    Макс. длина:
    200
  • tax_idstring или null

    Налоговый номер, как его ввёл магазин (CUIT в Аргентине); null, если не задан.

    Макс. длина:
    32
  • tax_id_countrystring или null

    Страна налогового номера, ISO 3166-1 alpha-2; null, если номер не задан.

    Значения:
    ARBRCLCOMXPERUnull
  • legal_namestring или null

    Юридическое наименование; null, если не задано.

    Макс. длина:
    200
  • settlement_modestring

    on_receipt — обычная закупка: долг возникает при приёмке; on_sale — реализация: магазин платит за проданное по акту реализации.

    Значения:
    on_receipton_sale
  • consignment_loss_policystring

    Кто платит за просрочку и недостачу товара на реализации: return_to_supplier — товар возвращается поставщику; our_cost — потеря магазина.

    Значения:
    return_to_supplierour_cost
  • prices_include_taxboolean или null

    true — поставщик называет цены с налогом, false — без налога; null — по правилу магазина.

  • payment_term_daysinteger или null

    Отсрочка оплаты в днях: из неё считается срок счёта due_on. null — отсрочки нет.

    Минимум:
    0
    Максимум:
    365
  • min_order_amountinteger или null

    Минимальная сумма заказа в минимальных единицах currency; null — минимума нет.

    Максимум:
    100000000000000
  • lead_time_daysinteger или null

    Срок поставки в днях от заказа; null, если не задан.

    Минимум:
    1
    Максимум:
    365
  • is_activeboolean

    false — поставщик выключен: новые заказы ему не делают, документы остаются.

  • currencystring

    Валюта закупки у поставщика, ISO 4217: в ней min_order_amount и цены его заказов.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUB
  • external_idstring или null

    Внешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает Supplier

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

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

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/suppliers" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "name": "string",
  "tax_id": "string",
  "tax_id_country": "AR",
  "legal_name": "string",
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "prices_include_tax": true,
  "payment_term_days": 0,
  "min_order_amount": 0,
  "lead_time_days": 1,
  "is_active": true,
  "currency": "ARS",
  "external_id": "string"
}
Пример ответа · 201
{
  "id": 0,
  "version": 0,
  "external_id": "string",
  "name": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_id_country": "string",
  "is_active": true,
  "currency": "string",
  "payment_term_days": 0,
  "prices_include_tax": true,
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "lead_time_days": 0,
  "min_order_amount": 0,
  "customer_id": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Поставщик

get/suppliers/{supplier}

Scope: procurement:read

Параметры

Путь

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

    ID поставщика.

Ответы

200Успешно

Заголовки

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

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает Supplier

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/suppliers/{supplier}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "external_id": "string",
  "name": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_id_country": "string",
  "is_active": true,
  "currency": "string",
  "payment_term_days": 0,
  "prices_include_tax": true,
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "lead_time_days": 0,
  "min_order_amount": 0,
  "customer_id": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Изменить реквизиты, условия расчётов и внешний id поставщика

patch/suppliers/{supplier}

Scope: procurement:write

Параметры

Путь

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

    ID поставщика.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • namestring

    Название поставщика, как его видит магазин.

    Макс. длина:
    200
  • legal_namestring или null

    Юридическое наименование; null, если не задано.

    Макс. длина:
    200
  • tax_idstring или null

    Налоговый номер, как его ввёл магазин (CUIT в Аргентине); null, если не задан.

    Макс. длина:
    32
  • tax_id_countrystring или null

    Страна налогового номера, ISO 3166-1 alpha-2; null, если номер не задан.

  • is_activeboolean

    false — поставщик выключен: новые заказы ему не делают, документы остаются.

  • payment_term_daysinteger или null

    Отсрочка оплаты в днях: из неё считается срок счёта due_on. null — отсрочки нет.

    Минимум:
    0
    Максимум:
    365
  • prices_include_taxboolean или null

    true — поставщик называет цены с налогом, false — без налога; null — по правилу магазина.

  • settlement_modestring

    on_receipt — обычная закупка: долг возникает при приёмке; on_sale — реализация: магазин платит за проданное по акту реализации.

    Значения:
    on_receipton_sale
  • consignment_loss_policystring

    Кто платит за просрочку и недостачу товара на реализации: return_to_supplier — товар возвращается поставщику; our_cost — потеря магазина.

    Значения:
    return_to_supplierour_cost
  • lead_time_daysinteger или null

    Срок поставки в днях от заказа; null, если не задан.

    Минимум:
    1
    Максимум:
    365
  • min_order_amountinteger или null

    Минимальная сумма заказа в минимальных единицах currency; null — минимума нет.

  • currencystring

    Валюта закупки у поставщика, ISO 4217: в ней min_order_amount и цены его заказов.

  • external_idstring или null

    Внешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает Supplier

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

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X PATCH "https://api.saleya.app/v1/suppliers/{supplier}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "name": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_id_country": "string",
  "is_active": true,
  "payment_term_days": 0,
  "prices_include_tax": true,
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "lead_time_days": 1,
  "min_order_amount": 0,
  "currency": "string",
  "external_id": "string"
}
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "external_id": "string",
  "name": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_id_country": "string",
  "is_active": true,
  "currency": "string",
  "payment_term_days": 0,
  "prices_include_tax": true,
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "lead_time_days": 0,
  "min_order_amount": 0,
  "customer_id": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Поставщик по внешнему id

get/suppliers/by-external-id/{external_id}

Scope: procurement:read

Параметры

Путь

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

    Внешний id — id записи в вашей системе.

Ответы

200Успешно

Заголовки

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

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает Supplier

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/suppliers/by-external-id/{external_id}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "external_id": "string",
  "name": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_id_country": "string",
  "is_active": true,
  "currency": "string",
  "payment_term_days": 0,
  "prices_include_tax": true,
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "lead_time_days": 0,
  "min_order_amount": 0,
  "customer_id": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Создать или изменить поставщика по внешнему id

patch/suppliers/by-external-id/{external_id}

Scope: procurement:write

Параметры

Путь

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

    Внешний id — id записи в вашей системе.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstring

    ETag записи из последнего чтения. Обязателен, если запись с этим внешним id уже есть (иначе 428), и не передаётся, если её нет.

    Пример:
    "7"
  • If-None-Matchstring

    * — только создать: если запись с этим внешним id уже есть, запрос получит 412.

    Значения:
    *

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает Supplier

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает Supplier

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

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X PATCH "https://api.saleya.app/v1/suppliers/by-external-id/{external_id}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "external_id": "string",
  "name": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_id_country": "string",
  "is_active": true,
  "currency": "string",
  "payment_term_days": 0,
  "prices_include_tax": true,
  "settlement_mode": "on_receipt",
  "consignment_loss_policy": "return_to_supplier",
  "lead_time_days": 0,
  "min_order_amount": 0,
  "customer_id": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Сальдо поставщика: сколько магазин должен сейчас, по слагаемым и срокам оплаты

get/suppliers/{supplier}/balance

Scope: procurement:read

Параметры

Путь

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

    ID поставщика.

Строка запроса

  • legal_entity_idinteger

    Только долг перед этим юрлицом магазина.

Ответы

200Успешно

application/json

Возвращает SupplierBalance

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/suppliers/{supplier}/balance" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "supplier_id": 0,
  "legal_entity_id": 0,
  "as_of": "string",
  "currency": "ARS",
  "total_due": 0,
  "has_open_items": true,
  "bills_outstanding": 0,
  "overdue": 0,
  "overdue_1_30": 0,
  "overdue_31_60": 0,
  "overdue_61_90": 0,
  "overdue_90_plus": 0,
  "not_due": 0,
  "due_soon": 0,
  "no_due_date": 0,
  "settled_pending_bill": 0,
  "accrued_unsettled": 0,
  "received_unbilled": 0,
  "returns_expected": 0,
  "advances_unapplied": 0,
  "payments_unapplied": 0
}

Акт сверки с поставщиком за период: сальдо на начало и конец, строки с нарастающим остатком

get/suppliers/{supplier}/statement

Scope: procurement:read

Параметры

Путь

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

    ID поставщика.

Строка запроса

  • fromstring (date)

    Первый день периода YYYY-MM-DD в часовом поясе магазина; по умолчанию — день первой строки акта.

  • tostring (date)

    Последний день периода YYYY-MM-DD в часовом поясе магазина; по умолчанию сегодня.

  • legal_entity_idinteger

    Акт по этому юрлицу магазина: строки и сальдо только его доли.

Ответы

200Успешно

application/json

Возвращает SupplierStatement

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/suppliers/{supplier}/statement" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "supplier_id": 0,
  "legal_entity_id": 0,
  "currency": "ARS",
  "from": "string",
  "to": "string",
  "opening_balance": 0,
  "closing_balance": 0,
  "increase_total": 0,
  "decrease_total": 0,
  "lines": [
    {
      "date": "string",
      "kind": "bill",
      "amount": 0,
      "balance": 0,
      "document": {
        "type": "supplier_bill",
        "id": 0,
        "number": "string"
      },
      "supplier_bill_payment_id": 0,
      "money_transaction_id": 0,
      "settlement_offset_id": 0,
      "document_amount": {
        "currency": "string",
        "amount": 0
      }
    }
  ]
}