关闭文件

Info

Console

方法适用于模式：FBY, FBS, Express 和 DBS.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

finance-and-accounting — 查看财务信息和报告
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

返回带有关闭文档格式的ZIP存档 PDF 为指定月份。

文件的组成取决于合同的类型

就业协议
- 提供服务法
- 发票
- 统计摘要报告
- 关于执行转让和解决相互索赔的报告 (代理人报告)
推广协议 （2024年9月30日之后未在俄罗斯结束）
- 服务提供法
- 发票如果税收计划需要它
营销协议
- 提供服务法
- 发票
- 预付发票
- 个人户口结单
- 法案详情

您可以查找生成状态，并使用请求获取到存档的链接。 GET v2/reports/info/{reportId}.

⚙️ 限制: 每小时1,000个请求

Request

POST

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

Body

application/json

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

Name	Description
campaignId*	Type: integer<int64> 活动ID。您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置在左边的菜单中，选择 Api和模块: 座运动ID; 标签查询日志 →块中的下拉列表显示日志. ⚠️ 不要发送商店ID，这是在市场上的卖家帐户旁边的商店名称和一些报告。
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

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

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

GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

Name

Description

estimatedGenerationTime*

Type: integer<int64>

以毫秒为单位的预期生成时间。

reportId*

Type: string

跟踪生成状态和接收完成的报告或文档所需的ID。

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

这篇文章是否有用？

订单的详细信息

销售分析报告