Закрывающие документы

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

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

Возвращает ZIP-архив с закрывающими документами в формате PDF за указанный месяц.

Состав документов в зависимости от типа договора

  • Договор на размещение

    • акт об оказанных услугах
    • счет-фактура
    • сводный отчет по данным статистики
    • отчет об исполнении поручения и о зачете взаимных требований (отчет агента)

  • Договор на продвижение (в России не заключается после 30 сентября 2024 года)

    • акт об оказании услуг
    • счет-фактура, если этого требует схема налогообложения

  • Договор на маркетинг

    • акт об оказанных услугах
    • счет-фактура
    • счет-фактура на аванс
    • выписка по лицевому счету
    • детализация к акту

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

⚙️ Лимит: 1 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/reports/closure-documents/generate

Body

application/json
{
    "campaignId": 0,
    "monthOfYear": {
        "year": 2025,
        "month": 12
    },
    "contractTypes": [
        "INCOME"
    ]
}

Name

Description

campaignId*

Type: integer<int64>

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

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

monthOfYear*

Type: ClosureDocumentsMonthOfYearDTO

Месяц, за который нужны закрывающие документы.

contractTypes

Type: ClosureDocumentsContractType[]

Типы договоров, по которым нужны закрывающие документы.

Если их не указать, вернется архив с документами по всем найденным договорам.
Тип договора:

  • INCOME — договор на размещение.

  • OUTCOME — договор на продвижение.

  • MARKETING — договор на маркетинг.

Enum: INCOME, OUTCOME, MARKETING

Min items: 1

Max items: 3

Unique items  

ClosureDocumentsMonthOfYearDTO

Месяц и год.

Name

Description

month*

Type: integer<int32>

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

Example: 12

Min value: 1

Max value: 12

year*

Type: integer<int32>

Год.

Example: 2025

ClosureDocumentsContractType

Тип договора:

  • INCOME — договор на размещение.

  • OUTCOME — договор на продвижение.

  • MARKETING — договор на маркетинг.

Type

Description

ClosureDocumentsContractType

Enum: INCOME, OUTCOME, MARKETING

Responses

200 OK

ZIP-архив с закрывающими документами в формате PDF.

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

No longer supported, please use an alternative and newer version.

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

Подробнее об акте читайте в Справке Маркета для продавцов.

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

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

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

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

В счете-фактуре содержится та же информация, что в акте об оказании услуг. Для учета и анализа удобнее пользоваться актом.

Сводный отчет нужен бухгалтеру магазина, чтобы отражать в учете реализацию товаров.

Отчет составляется для магазинов, работающих по моделям FBY и FBS. В нем указано, сколько товаров и на какую сумму:

  • отправлено покупателям;
  • доставлено покупателям;
  • покупатели не выкупили;
  • покупатели вернули.
Отчет находится в том же PDF-файле, что акт об оказанных услугах.

Подробнее об отчете читайте в Справке Маркета для продавцов.

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

Подробнее об отчете читайте в Справке Маркета для продавцов.

В акте указана:

  • общая сумма всех скидок на товары, которые Маркет предоставил покупателям;
  • общая сумма всех скидок на доставку, которые Маркет предоставил покупателям (только для модели DBS);
  • общая сумма платежей баллами Плюса.

Показывает сумму на балансе на начало месяца, которую продавец еще не потратили. Документ пригодится для бухгалтера.

Показывает баланс продавца — расходы и остаток на конец месяца.

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

Предыдущая
Детальная информация по заказам
Следующая
Отчет «Аналитика продаж»