Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
Отчет по платежам
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- finance-and-accounting — Просмотр финансовой информации и отчётности
- all-methods — Полное управление кабинетом
Запускает генерацию отчета по платежам за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET v2/reports/info/{reportId}.
Тип отчета зависит от того, какие поля заполнены в запросе:
|
Тип отчета |
Какие поля нужны |
Комментарий |
|
О платежах за период |
|
В отчет попадают все платежи, которые были выплачены и начислены в выбранный период. Пример: если перевод выполнен 31 августа и зачислен 1 сентября, он попадет в отчет за оба месяца. |
|
О платежном поручении |
|
— |
|
О баллах Маркета |
|
— |
Заказать отчеты нескольких типов одним запросом нельзя.
Пояснение к колонкам отчета:
Лист Отчёт о платежах (файл transaction_date)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
BUSINESS_ID |
businessId |
Информация о бизнесе/ID бизнес-аккаунта |
integer |
|
MODEL |
model |
Информация о бизнесе/Модели работы |
string |
|
PARTNER_ID |
partnerId |
Информация о бизнесе/ID магазинов |
integer |
|
SHOP_NAME |
shopName |
Информация о бизнесе/Названия магазинов |
string |
|
INN |
inn |
Информация о бизнесе/ИНН |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Информация о бизнесе/Номера договоров на размещение |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Информация о бизнесе/Номера договоров на продвижение |
string |
|
TRANSACTION_DATE |
transactionDate |
Информация о платежах/Дата транзакции |
string |
|
TRANSACTION_ID |
transactionId |
Информация о платежах/ID транзакции |
string |
|
ORDER_ID |
orderId |
Информация о платежах/Номер заказа |
integer |
|
SHOP_ORDER_ID |
shopOrderId |
Информация о платежах/Ваш номер заказа |
string |
|
ORDER_CREATION_DATE |
orderCreationDate |
Информация о платежах/Дата создания заказа |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Информация о платежах/Дата доставки заказа |
string |
|
CLAIM_NUMBER |
claimNumber |
Информация о платежах/Номер и дата претензии |
string |
|
ORDER_TYPE |
orderType |
Информация о платежах/Тип заказа |
string |
|
SHOP_SKU |
shopSku |
Информация о платежах/Ваш SKU |
string |
|
ACT_ID |
actId |
Информация о платежах/Номер акта об оказанных услугах |
integer |
|
ACT_DATE |
actDate |
Информация о платежах/Дата акта об оказанных услугах |
string |
|
OFFER_OR_SERVICE_NAME |
offerOrServiceName |
Информация о платежах/Название товара (к начислению) или услуги (к удержанию) |
string |
|
COUNT |
count |
Информация о платежах/Количество |
integer |
|
TRANSACTION_SUM |
transactionSum |
Информация о платежах/Сумма транзакции |
number |
|
TRANSACTION_TYPE |
transactionType |
Информация о платежах/Тип транзакции |
string |
|
TRANSACTION_SOURCE |
transactionSource |
Информация о платежах/Источник транзакции |
string |
|
PAYMENT_STATUS |
paymentStatus |
Информация о платежах/Статус |
string |
|
BONUS_ACCOUNT_YEAR_MONTH |
bonusAccountYearMonth |
Информация о платежах/Расчётный период премии за участие в совместных акциях |
string |
|
BANK_ORDER_DATE |
bankOrderDate |
Информация о платежах/Дата платежного поручения |
string |
|
BANK_ORDER_ID |
bankOrderId |
Информация о платежах/Номер платежного поручения |
integer |
|
BANK_SUM |
bankSum |
Информация о платежах/Сумма платежного поручения или удерживаемая за услуги сумма |
number |
|
COMMENTS |
comments |
Информация о платежах/Комментарии |
string |
Лист Отчёт о платежном поручении (файл netting_report_accruals)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
BUSINESS_ID |
businessId |
Информация о бизнесе/ID бизнес-аккаунта |
integer |
|
MODEL |
model |
Информация о бизнесе/Модели работы |
string |
|
PARTNER_ID |
partnerId |
Информация о бизнесе/ID магазинов |
integer |
|
SHOP_NAME |
shopName |
Информация о бизнесе/Названия магазинов |
string |
|
INN |
inn |
Информация о бизнесе/ИНН |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Информация о бизнесе/Номера договоров на размещение |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Информация о бизнесе/Номера договоров на продвижение |
string |
|
ORDER_ID |
orderId |
Информация о начислениях/Номер заказа |
integer |
|
ORDER_CREATION_DATE |
orderCreationDate |
Информация о начислениях/Дата создания заказа |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Информация о начислениях/Дата доставки заказа |
string |
|
CLAIM_NUMBER |
claimNumber |
Информация о начислениях/Номер и дата претензии |
string |
|
ORDER_TYPE |
orderType |
Информация о начислениях/Тип заказа |
string |
|
SHOP_SKU |
shopSku |
Информация о начислениях/Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Информация о начислениях/Название товара |
string |
|
COUNT |
count |
Информация о начислениях/Количество |
integer |
|
TRANSACTION_SUM |
transactionSum |
Информация о начислениях/Сумма транзакции |
number |
|
TRANSACTION_SOURCE |
transactionSource |
Информация о начислениях/Источник транзакции |
string |
|
ACT_ID |
actId |
Информация о начислениях/Номер акта об оказанных услугах |
integer |
|
ACT_DATE |
actDate |
Информация о начислениях/Дата акта об оказанных услугах |
string |
|
TRANSACTION_DATE |
transactionDate |
Информация о начислениях/Дата транзакции |
string |
|
TRANSACTION_ID |
transactionId |
Информация о начислениях/ID транзакции |
string |
Лист Отчёт о платежном поручении (файл netting_report_returns_and_compensations)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
BUSINESS_ID |
businessId |
Информация о бизнесе/ID бизнес-аккаунта |
integer |
|
MODEL |
model |
Информация о бизнесе/Модели работы |
string |
|
PARTNER_ID |
partnerId |
Информация о бизнесе/ID магазинов |
integer |
|
SHOP_NAME |
shopName |
Информация о бизнесе/Названия магазинов |
string |
|
INN |
inn |
Информация о бизнесе/ИНН |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Информация о бизнесе/Номера договоров на размещение |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Информация о бизнесе/Номера договоров на продвижение |
string |
|
ORDER_ID |
orderId |
Информация о возвратах и компенсациях покупателям/Номер заказа |
integer |
|
ORDER_CREATION_DATE |
orderCreationDate |
Информация о возвратах и компенсациях покупателям/Дата оформления |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Информация о возвратах и компенсациях покупателям/Дата доставки заказа |
string |
|
ORDER_TYPE |
orderType |
Информация о возвратах и компенсациях покупателям/Тип заказа |
string |
|
SHOP_SKU |
shopSku |
Информация о возвратах и компенсациях покупателям/Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Информация о возвратах и компенсациях покупателям/Название товара |
string |
|
COUNT |
count |
Информация о возвратах и компенсациях покупателям/Количество |
integer |
|
TRANSACTION_SUM |
transactionSum |
Информация о возвратах и компенсациях покупателям/Сумма транзакции |
number |
|
TRANSACTION_SOURCE |
transactionSource |
Информация о возвратах и компенсациях покупателям/Источник транзакции |
string |
|
TRANSACTION_DATE |
transactionDate |
Информация о возвратах и компенсациях покупателям/Дата транзакции |
string |
|
TRANSACTION_ID |
transactionId |
Информация о возвратах и компенсациях покупателям/ID транзакции |
string |
Лист Отчёт о платежном поручении (файл netting_report_retentions)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
BUSINESS_ID |
businessId |
Информация о бизнесе/ID бизнес-аккаунта |
integer |
|
MODEL |
model |
Информация о бизнесе/Модели работы |
string |
|
PARTNER_ID |
partnerId |
Информация о бизнесе/ID магазинов |
integer |
|
SHOP_NAME |
shopName |
Информация о бизнесе/Названия магазинов |
string |
|
INN |
inn |
Информация о бизнесе/ИНН |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Информация о бизнесе/Номера договоров на размещение |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Информация о бизнесе/Номера договоров на продвижение |
string |
|
ACT_ID |
actId |
Информация об удержаниях/Номер акта об оказанных услугах |
integer |
|
ACT_DATE |
actDate |
Информация об удержаниях/Дата акта об оказанных услугах |
string |
|
SERVICE_NAME |
serviceName |
Информация об удержаниях/Название услуги к удержанию |
string |
|
TRANSACTION_SUM |
transactionSum |
Информация об удержаниях/Сумма транзакции |
number |
|
TRANSACTION_SOURCE |
transactionSource |
Информация об удержаниях/Источник транзакции |
string |
|
TRANSACTION_DATE |
transactionDate |
Информация об удержаниях/Дата транзакции |
string |
|
TRANSACTION_ID |
transactionId |
Информация об удержаниях/ID транзакции |
string |
Лист Отчёт по баллам (файл netting_bonuses)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
BUSINESS_ID |
businessId |
Информация о бизнесе/ID бизнес-аккаунта |
integer |
|
MODEL |
model |
Информация о бизнесе/Модели работы |
string |
|
PARTNER_ID |
partnerId |
Информация о бизнесе/ID магазинов |
integer |
|
SHOP_NAME |
shopName |
Информация о бизнесе/Названия магазинов |
string |
|
INN |
inn |
Информация о бизнесе/ИНН |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Информация о бизнесе/Номера договоров на размещение |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Информация о бизнесе/Номера договоров на продвижение |
string |
|
TRANSACTION_DATE |
transactionDate |
Информация о платежах/Дата транзакции |
string |
|
ORDER_ID |
orderId |
Информация о платежах/Номер заказа |
integer |
|
SHOP_ORDER_ID |
shopOrderId |
Информация о платежах/Ваш номер заказа |
string |
|
ORDER_CREATION_DATE |
orderCreationDate |
Информация о платежах/Дата создания заказа |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Информация о платежах/Дата доставки заказа |
string |
|
ORDER_TYPE |
orderType |
Информация о платежах/Тип заказа |
string |
|
SHOP_SKU |
shopSku |
Информация о платежах/Ваш SKU |
string |
|
OFFER_OR_SERVICE_NAME |
offerOrServiceName |
Информация о платежах/Название товара (к начислению) или услуги (к удержанию) |
string |
|
COUNT |
count |
Информация о платежах/Количество |
integer |
|
TRANSACTION_SUM |
transactionSum |
Информация о платежах/Сумма транзакции |
number |
|
TRANSACTION_TYPE |
transactionType |
Информация о платежах/Тип транзакции |
string |
|
TRANSACTION_SOURCE |
transactionSource |
Информация о платежах/Источник транзакции |
string |
|
PAYMENT_STATUS |
paymentStatus |
Информация о платежах/Статус |
string |
|
COMMENTS |
comments |
Информация о платежах/Комментарии |
string |
|
BONUS_ACCOUNT_YEAR_MONTH |
bonusAccountYearMonth |
Информация о платежах/Месяц формирования премии за участие в совместных акциях |
string |
| ⚙️ Лимит: 100 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/united-netting/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType Формат отчета или документа. Формат отчета:
Default: Enum: |
|
language |
Type: ReportLanguageType Язык отчета или документа. Язык отчета:
Enum: |
ReportFormatType
Формат отчета:
FILE— файл с электронной таблицей (XLSX).CSV— ZIP-архив с CSV-файлами на каждый лист отчета.JSON— ZIP-архив с JSON-файлами на каждый лист отчета.
Type: string
Default: FILE
Enum: FILE, CSV, JSON
ReportLanguageType
Язык отчета:
RU— русский язык.EN— английский язык.
Type: string
Enum: RU, EN
Body
application/json
{
"businessId": 1,
"dateTimeFrom": "2025-01-01T00:00:00Z",
"dateTimeTo": "2025-01-01T00:00:00Z",
"dateFrom": "2025-08-22",
"dateTo": "2025-01-01",
"bankOrderId": 0,
"bankOrderDateTime": "2025-01-01T00:00:00Z",
"monthOfYear": {
"year": 2025,
"month": 12
},
"placementPrograms": [
"FBS"
],
"inns": [
"example"
],
"campaignIds": [
1
]
}
|
Name |
Description |
|
businessId |
Type: BusinessId Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: Example: |
|
bankOrderDateTime |
Type: string<date-time> Дата платежного поручения. Example: |
|
bankOrderId |
Type: integer Номер платежного поручения. |
|
campaignIds |
Type: CampaignId[] | null Список идентификаторов кампании тех магазинов, которые нужны в отчете. Min items: Unique items: Example
|
|
dateFrom |
Type: PeriodDateFrom Начало периода, включительно. Формат даты: Example: |
|
dateTimeFrom |
Type: string<date-time> Начало периода, включительно. Example: |
|
dateTimeTo |
Type: string<date-time> Конец периода, включительно. Максимальный период — 3 месяца. Example: |
|
dateTo |
Type: string<date> Конец периода, включительно. Максимальный период — 3 месяца. Формат даты: Example: |
|
inns |
Type: string[] | null Список ИНН, которые нужны в отчете. Min items: Unique items: Example
|
|
monthOfYear |
Type: MonthOfYearDTO Месяц, за который нужен отчет о баллах Маркета. Example
|
|
placementPrograms |
Type: PlacementType[] | null Список моделей, которые нужны в отчете. Min items: Unique items: Example
|
BusinessId
Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
Type: integer
Min value: 1
PeriodDateFrom
Начало периода, включительно.
Формат даты: ГГГГ-ММ-ДД.
Type: string<date>
Example: 2025-08-22
Year
Год.
Type: integer
Month
Номер месяца.
Type: integer
Min value: 1
Max value: 12
MonthOfYearDTO
Месяц, за который нужен отчет о баллах Маркета.
|
Name |
Description |
|
month |
Type: Month Номер месяца. Min value: Max value: Example: |
|
year |
Type: Year Год. Example: |
Example
{
"year": 2025,
"month": 12
}
PlacementType
Модель, по которой работает магазин:
FBS— FBS или Экспресс.FBY— FBY.DBS— DBS.
Type: string
Enum: FBS, FBY, DBS, LAAS
CampaignId
Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.
Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
- блок Идентификатор кампании;
- вкладка Лог запросов → выпадающий список в блоке Показывать логи.
⚠️ Не путайте его с:
- идентификатором магазина, который отображается в личном кабинете продавца;
- рекламными кампаниями.
Type: integer
Min value: 1
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "example",
"estimatedGenerationTime": 0
}
}
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
result
Type: GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
Example
{ "reportId": "example", "estimatedGenerationTime": 0 }Example
{ "result": { "reportId": "example", "estimatedGenerationTime": 0 } }
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
|
Name |
Description |
|
estimatedGenerationTime |
Type: integer Ожидаемая продолжительность генерации в миллисекундах. |
|
reportId |
Type: string Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. Example: |
Example
{
"reportId": "example",
"estimatedGenerationTime": 0
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. Example: |
Example
{
"code": "example",
"message": "example"
}
ApiErrorResponse
Стандартная обертка для ошибок сервера.
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
errors
Type: ApiErrorDTO[] | null
Список ошибок.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
No longer supported, please use an alternative and newer version.
О том, что это такое, читайте в Справке Маркета для продавцов.