Счета покупателей

Книга долгов магазина: остаток каждого покупателя, кредитный лимит, срок оплаты и выписка за период со сроками долгов.

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

Счета покупателей

Объекты

CustomerAccount

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

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

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

    Состояние: active — покупатель берёт в долг в пределах лимита; suspended — новые продажи в долг закрыты, долг остаётся и гасится.

    Значения:
    activesuspended
  • currencystringобязательно

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

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

    Остаток в минимальных единицах валюты: плюс — покупатель должен, минус — переплата. Равен сумме amount всех записей счёта (/v1/customer-account-entries).

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

    Кредитный лимит в минимальных единицах валюты; null — без лимита. Сверх лимита и при просрочке продают в долг только с подтверждением менеджера.

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

    Срок оплаты продажи в долг, дней: срок начисления (due_on) — день продажи плюс этот срок.

  • customer_idinteger

    ID покупателя (/v1/customers). Только с доступом к покупателям.

  • notestring или null

    Заметка сотрудника о покупателе; null, если её нет. Только с доступом к покупателям: удаление покупателя её стирает.

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

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

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

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

CustomerAccountStatement

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

    ID счёта покупателя (/v1/customer-accounts).

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

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

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

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

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

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

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

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

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

    Долг на конец периода: opening_balance плюс строки периода.

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

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

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

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

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

    Записи периода в порядке операций (occurred_at) с нарастающим остатком.

    Поля · 8
    • entry_idintegerобязательно

      ID записи журнала (/v1/customer-account-entries).

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

      Вид записи, те же значения, что у kind записи журнала.

      Значения:
      chargeopening_balanceopening_creditpaymentreturnwrite_offoffsetwithholdingreversal
    • occurred_atstring (date-time)обязательно

      Момент операции.

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

      ID заказа (/v1/orders); null, если заказа нет.

    • due_onstring (date) или nullобязательно

      Срок оплаты начисления; null у уменьшений долга.

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

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

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

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

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

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

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

    Начисления, не закрытые на конец периода, по сроку оплаты. Какое погашение закрыло какое начисление, решает распределение FIFO в пределах юрлица.

    Поля · 7
    • entry_idintegerобязательно

      ID начисления (/v1/customer-account-entries).

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

      charge — продажа в долг; opening_balance — долг из прежнего учёта.

      Значения:
      chargeopening_balance
    • occurred_atstring (date-time)обязательно

      Момент операции.

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

      ID заказа (/v1/orders); null, если заказа нет.

    • due_onstring (date) или nullобязательно

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

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

      Недоплаченная часть начисления на конец периода.

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

      Срок оплаты прошёл до to: на конец периода долг просрочен.

Методы

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

get/customer-accounts

Scope: finance: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})$

Ответы

200Успешно

application/json

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

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

  • 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/customer-accounts" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "status": "active",
      "currency": "ARS",
      "balance": 0,
      "credit_limit": 0,
      "payment_terms_days": 0,
      "customer_id": 0,
      "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/customer-accounts/{customer_account}

Scope: finance:read

Параметры

Путь

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

    ID счёта покупателя.

Ответы

200Успешно

application/json

Возвращает CustomerAccount

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/customer-accounts/{customer_account}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "status": "active",
  "currency": "ARS",
  "balance": 0,
  "credit_limit": 0,
  "payment_terms_days": 0,
  "customer_id": 0,
  "note": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Выписка по счёту покупателя за период: долг на начало и конец, движения с нарастающим остатком и открытые долги со сроками

get/customer-accounts/{customer_account}/statement

Scope: finance:read

Параметры

Путь

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

    ID счёта покупателя.

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

  • fromstring (date)

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

  • tostring (date)

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

Ответы

200Успешно

application/json

Возвращает CustomerAccountStatement

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/customer-accounts/{customer_account}/statement" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "customer_account_id": 0,
  "currency": "ARS",
  "from": "string",
  "to": "string",
  "opening_balance": 0,
  "closing_balance": 0,
  "charged": 0,
  "reduced": 0,
  "lines": [
    {
      "entry_id": 0,
      "kind": "charge",
      "occurred_at": "2026-01-15T12:00:00Z",
      "order_id": 0,
      "due_on": "2026-01-15",
      "note": "string",
      "amount": 0,
      "balance": 0
    }
  ],
  "open_items": [
    {
      "entry_id": 0,
      "kind": "charge",
      "occurred_at": "2026-01-15T12:00:00Z",
      "order_id": 0,
      "due_on": "2026-01-15",
      "open_amount": 0,
      "overdue": true
    }
  ]
}

Погашение долга покупателя деньгами, которые уже пришли: запись в книгу долгов со справками об удержаниях

post/customer-accounts/{customer_account}/payments

Scope: finance:write

Параметры

Путь

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

    ID счёта покупателя.

Заголовок

  • Idempotency-Keystring

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

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

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

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

    Сколько денег пришло в счёт долга, в минимальных единицах валюты магазина.

    Минимум:
    1
    Максимум:
    10000000000
  • payment_methodstringобязательно

    Способ, которым пришли деньги: он должен гасить долг и подтверждаться руками — например наличные или ручной способ manual.

    Значения:
    cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_package
  • manual_payment_method_idinteger или null

    ID ручного способа оплаты (/v1/manual-payment-methods) при payment_method=manual, например банковского перевода.

    Минимум:
    1
  • location_idintegerобязательно

    ID точки магазина.

  • legal_entity_idinteger или null

    ID юрлица магазина (/v1/legal-entities), чей долг гасят: нужен, когда покупатель должен нескольким юрлицам.

  • withholdingsмассив object

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

    Мин. элементов:
    1
    Макс. элементов:
    2000
    Поля · 4
    • regimestringобязательно

      Налог удержания: vat, turnover, income и другие коды TaxRegime.

    • jurisdictionstring или null

      Юрисдикция провинциального или муниципального налога, например AR-B; у налогов страны — null.

      Макс. длина:
      8
      Шаблон:
      ^[A-Z]{2}-[A-Z0-9]{1,5}$
    • amountintegerобязательно

      Сумма удержания в минимальных единицах валюты магазина.

      Минимум:
      1
    • certificate_numberstringобязательно

      Номер справки об удержании.

      Макс. длина:
      64
  • withheld_onstring (date)

    День удержания, YYYY-MM-DD: по нему справка ложится в налоговый период, закрытый период — отказ.

  • withholding_agent_tax_idstring

    CUIT покупателя-агента, удержавшего налог.

    Макс. длина:
    20

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

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

    Значения:
    true

application/json

Возвращает CustomerAccountEntry

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

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/customer-accounts/{customer_account}/payments" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "amount": 1,
  "payment_method": "cash",
  "manual_payment_method_id": 1,
  "location_id": 0,
  "legal_entity_id": 0,
  "withholdings": [
    {
      "regime": "string",
      "jurisdiction": "string",
      "amount": 1,
      "certificate_number": "string"
    }
  ],
  "withheld_on": "2026-01-15",
  "withholding_agent_tax_id": "string"
}
Пример ответа · 201
{
  "id": 0,
  "customer_account_id": 0,
  "kind": "charge",
  "amount": 0,
  "currency": "ARS",
  "legal_entity_id": 0,
  "due_on": "2026-01-15",
  "occurred_at": "2026-01-15T12:00:00Z",
  "order_id": 0,
  "payment_id": 0,
  "refund_id": 0,
  "reverses_entry_id": 0,
  "settlement_offset_id": 0,
  "tax_withholding_id": 0,
  "note": "string",
  "created_at": "2026-01-15T12:00:00Z"
}