Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
付款报告
方法适用于所有模式.
如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
- finance-and-accounting — 查看财务信息和报告
- all-methods — 全面管理账户
开始生成指定期间的付款报告。 这是什么报告
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.
报告的类型取决于请求中填写了哪些字段:
|
报告类型 |
需要哪些字段？ |
|
关于期间的付款 |
|
|
关于付款订单 |
|
|
关于Yandex的。市场点 |
|
您不能通过一个请求订购多种类型的报告。
报告列说明：
表单付款报告（文件transaction_date）
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
BUSINESS_ID |
businessId |
企业信息/企业帐户 ID |
integer |
|
MODEL |
model |
企业信息/运营模式 |
string |
|
PARTNER_ID |
partnerId |
企业信息/商店 ID |
integer |
|
SHOP_NAME |
shopName |
企业信息/商店名称 |
string |
|
INN |
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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
企业信息/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 报告或文档的格式。 |
|
language |
Type: ReportLanguageType 报告或文件的语言。 |
ReportFormatType
报告格式:
FILE-电子表格文件(XLSX).CSV-ZIP存档与CSV文件的每个报告表。JSON-ZIP存档与JSON文件的每个报告表。
|
Type |
Description |
|
Default: Enum: |
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> 内阁ID。 |
|
bankOrderDateTime |
Type: string<date-time> 付款订单的日期。 |
|
bankOrderId |
Type: integer<int64> 支付订单的编号。 |
|
campaignIds |
Type: integer<int64>[] 报表中需要的那些商店的营销活动Id列表。 您可以使用查询找到它们。 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
请勿使用商店Id，这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。
Min items: Unique items |
|
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: Unique items |
|
monthOfYear |
Type: MonthOfYearDTO 需要市场点数报告的月份。 |
|
placementPrograms |
Type: PlacementType[] 报告中需要的模型列表。
Enum: Min items: Unique items |
MonthOfYearDTO
需要市场点数报告的月份。
|
Name |
Description |
|
month* |
Type: integer<int32> 月号。 Example: Min value: Max value: |
|
year* |
Type: integer<int32> 年。 Example: |
PlacementType
商店使用的模型:
FBS-FBS或快递。FBY-FBY。DBS-DBS。
|
Type |
Description |
|
Enum: |
Responses
200 OK
作为响应，您会收到一个标识符，该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GenerateReportDTO 跟踪生成状态和接收完成的报告或文档所需的ID。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK-没有错误。ERROR-处理请求时发生错误。
|
Type |
Description |
|
Enum: |
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: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
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: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
Yandex的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.
О том, что это такое, читайте в Справке Маркета для продавцов.