Удержания и перцепции
Налог, удержанный у магазина, — его зачёт, и удержанный магазином у поставщика — к перечислению; сертификаты магазина в PDF.
Удержания и перцепции
Объекты
TaxWithholding
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
legal_entity_idinteger или nullобязательноID юрлица магазина (/v1/legal-entities), у которого удержали или которое удержало; null, если юрлицо удалено.
directionstringобязательноsuffered — удержали у магазина (провайдер расчёта, банк, покупатель-агент): его аванс по налогу; practiced — удержал магазин, заплатив поставщику меньше: обязательство перечислить в бюджет, зачёта не даёт.
- Значения:
sufferedpracticed
kindstringобязательноwithholding — удержание: удержано из выплаты; perception — перцепция: добавлена к сумме к оплате.
- Значения:
withholdingperception
regimestringобязательноКакой налог удержан: vat — НДС (IVA), income — налог на прибыль (Ganancias), turnover — оборотный (Ingresos Brutos), municipal — муниципальный и другие.
- Значения:
vatincometurnovermunicipalinternalsocialother
jurisdictionstring или nullобязательноПровинция или муниципалитет у налогов, которым они нужны (turnover, municipal); иначе null.
credit_regimestring или nullобязательноВ какой налог магазин зачитывает удержание; null — зачесть некуда (сумма к возврату) или удержал магазин (practiced).
- Значения:
vatincometurnovermunicipalinternalsocialothernull
credit_periodstringобязательноМесяц зачёта, YYYY-MM: может отличаться от месяца удержания.
amountintegerобязательноУдержанная сумма в минимальных единицах валюты магазина.
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
base_amountinteger или nullобязательноОблагаемая база, с которой удержано, в минимальных единицах валюты; null, если в основании её нет.
rate_bpsinteger или nullобязательноСтавка в сотых долях процента: 250 — 2,5 %; null, если ставки в основании нет.
rate_sourcestring или nullобязательноОткуда ставка: padron — падрон налоговой; default — ставка по умолчанию в настройках агента; manual — сумму задал сотрудник; import — ставка с бумаги агента. null, если ставки нет.
- Значения:
padrondefaultmanualimportnull
counterparty_tax_idstring или nullобязательноНалоговый номер контрагента: агента, который удержал у магазина, или поставщика, у которого удержал магазин; null, если неизвестен.
counterparty_namestring или nullобязательноНаименование контрагента на момент удержания — так оно напечатано в сертификате; null, если неизвестно.
occurred_onstring (date)обязательноДата удержания, YYYY-MM-DD.
certificate_numberstring или nullобязательноНомер сертификата: у удержанного у магазина — номер бумаги агента, у удержанного магазином — номер из его ряда; null, если сертификата нет.
sourceobject или nullобязательноЗапись, которая провела удержание; null — внесено сотрудником.
Поля · 2
typestringобязательноpayment_settlement — расчёт провайдера по платежу (id — /v1/payments); supplier_bill_payment — оплата счёта поставщика (id — /v1/supplier-bill-payments); money_transaction — выплата в журнале денег (id — /v1/money-transactions); statement_line — строка банковской выписки; import_row — строка загруженного реестра агента; account_payment_withholding — справка погашения долга покупателя: на неё ссылается запись журнала счёта покупателя полем tax_withholding_id. У трёх последних id — внутренний.
- Значения:
payment_settlementsupplier_bill_paymentmoney_transactionstatement_lineimport_rowaccount_payment_withholding
idintegerобязательноID записи-источника.
notestring или nullобязательноЗаметка сотрудника; null, если её нет.
annulled_atstring (date-time) или nullобязательноКогда магазин аннулировал свой сертификат: сумма больше не к перечислению, номер остаётся занятым. null у действующей записи.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Удержания и перцепции, изменённые с указанного момента: удержанное у магазина к зачёту и удержанное магазином к перечислению
get/tax-withholdings
Scope: fiscal: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} в продолжении по курсору синхронизации. Включайте для синхронизации.
directionstringТолько одна сторона реестра: suffered — удержанное у магазина, practiced — удержанное магазином.
- Значения:
sufferedpracticed
Ответы
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/tax-withholdings" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"legal_entity_id": 0,
"direction": "suffered",
"kind": "withholding",
"regime": "vat",
"jurisdiction": "string",
"credit_regime": "vat",
"credit_period": "string",
"amount": 0,
"currency": "ARS",
"base_amount": 0,
"rate_bps": 0,
"rate_source": "padron",
"counterparty_tax_id": "string",
"counterparty_name": "string",
"occurred_on": "2026-01-15",
"certificate_number": "string",
"source": {
"type": "payment_settlement",
"id": 0
},
"note": "string",
"annulled_at": "2026-01-15T12:00:00Z",
"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/tax-withholdings/{tax_withholding}
Scope: fiscal:read
Параметры
Путь
tax_withholdingintegerобязательноID удержания или перцепции.
Ответы
200Успешно
application/json
Возвращает TaxWithholding
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/tax-withholdings/{tax_withholding}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"legal_entity_id": 0,
"direction": "suffered",
"kind": "withholding",
"regime": "vat",
"jurisdiction": "string",
"credit_regime": "vat",
"credit_period": "string",
"amount": 0,
"currency": "ARS",
"base_amount": 0,
"rate_bps": 0,
"rate_source": "padron",
"counterparty_tax_id": "string",
"counterparty_name": "string",
"occurred_on": "2026-01-15",
"certificate_number": "string",
"source": {
"type": "payment_settlement",
"id": 0
},
"note": "string",
"annulled_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}PDF сертификата удержания, который магазин выдаёт контрагенту
get/tax-withholdings/{tax_withholding}/certificate
Scope: fiscal:read
Параметры
Путь
tax_withholdingintegerобязательноID удержания или перцепции.
Ответы
200Успешно
application/pdf
string (binary)
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 "https://api.saleya.app/v1/tax-withholdings/{tax_withholding}/certificate" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"