Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет по платежам

Info

Console

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

finance-and-accounting — Просмотр финансовой информации и отчётности
all-methods — Полное управление кабинетом

Запускает генерацию отчета по платежам за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Тип отчета зависит от того, какие поля заполнены в запросе:

Тип отчета	Какие поля нужны
О платежах за период	`dateFrom` и `dateTo`
О платежном поручении	`bankOrderId` и `bankOrderDateTime`
О баллах Маркета	`monthOfYear`

Заказать отчеты нескольких типов одним запросом нельзя.

Пояснение к колонкам отчета:

Лист Отчёт о платежах (файл 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/reports/united-netting/generate

Query parameters

Name

Description

format

Type: ReportFormatType

Формат отчета.

language

Type: ReportLanguageType

Язык отчета.

ReportFormatType

Формат отчета:

FILE — файл с электронной таблицей (XLSX).
CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

ReportLanguageType

Язык отчета:

RU — русский язык.
EN — английский язык.

Type	Description
ReportLanguageType	Enum: `RU`, `EN`

Body

application/json

{
    "businessId": 0,
    "dateTimeFrom": "2022-12-29T18:02:01Z",
    "dateTimeTo": "2022-12-29T18:02:01Z",
    "dateFrom": "string",
    "dateTo": "string",
    "bankOrderId": 0,
    "bankOrderDateTime": "2022-12-29T18:02:01Z",
    "monthOfYear": {
        "year": 2025,
        "month": 12
    },
    "placementPrograms": [
        "FBS"
    ],
    "inns": [
        "string"
    ],
    "campaignIds": [
        0
    ]
}

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета.

bankOrderDateTime

Type: string<date-time>

Дата платежного поручения.

bankOrderId

Type: integer<int64>

Номер платежного поручения.

campaignIds

Type: integer<int64>[]

Список магазинов, которые нужны в отчете.

Min items: 1

dateFrom

Type: string<date>

Начало периода, включительно.

dateTimeFrom

⦸

Type: string<date-time>

Этот параметр устарел

Не используйте его.

Начало периода, включительно.

dateTimeTo

⦸

Type: string<date-time>

Этот параметр устарел

Не используйте его.

Конец периода, включительно. Максимальный период — 3 месяца.

dateTo

Type: string<date>

Конец периода, включительно. Максимальный период — 3 месяца.

inns

Type: string[]

Список ИНН, которые нужны в отчете.

Min items: 1

monthOfYear

Type: MonthOfYearDTO

Месяц, за который нужен отчет о баллах Маркета.

placementPrograms

Type: PlacementType[]

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

FBS — FBS или Экспресс.
FBY — FBY.
DBS — DBS.

Enum: FBS, FBY, DBS

Min items: 1

MonthOfYearDTO

Месяц, за который нужен отчет о баллах Маркета.

Name

Description

month*

Type: integer<int32>

Номер месяца.

Example: 12

Min value: 1

Max value: 12

year*

Type: integer<int32>

Год.

Example: 2025

PlacementType

Модель, по которой работает магазин:

FBS — FBS или Экспресс.
FBY — FBY.
DBS — DBS.

Type	Description
PlacementType	Enum: `FBS`, `FBY`, `DBS`

Responses

200 OK

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.

Body

application/json

{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

result

Type: GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Отчет по остаткам на складах

Отчет по полкам