报告的结构及内容如有更改,恕不另行通知

例如,可以添加新列或更改工作表的名称。

付款报告

方法适用于所有模式.

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

开始生成指定期间的付款报告。 这是什么报告

您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.

报告的类型取决于请求中填写了哪些字段:

报告类型

需要哪些字段?

评论

关于期间的付款

dateFromdateTo

该报告包括选定期间支付和应计的所有款项。

示例:如果转账于8月31日完成并于9月1日入账,则这两个月都将包含在报告中。

关于付款订单

bankOrderIdbankOrderDateTime

[关于Yandex的。市场点](*баллы_маркета)

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

企业信息/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: string

报告或文档的格式。 报告格式:

  • FILE — 电子表格文件(XLSX).
  • CSV — 每个报告表都有一个包含CSV文件的ZIP存档。
  • JSON — 每个报告表都有一个带有JSON文件的ZIP压缩包.

Default: FILE

Enum: FILE, CSV, JSON

language

Type: string

报告或文件的语言。 报告的语言:

  • RU — 俄语。
  • EN — 英语。

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: integer

内阁ID。 要找到答案,请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店?

Min value: 1

bankOrderDateTime

Type: string<date-time>

付款订单的日期。

Example: 2025-01-01T00:00:00Z

bankOrderId

Type: integer

支付订单的编号。

campaignIds

Type: integer[] | null

报表中需要的那些商店的营销活动Id列表。

Min items: 1

Unique items: true

Example
[
  1
]

dateFrom

Type: string<date>

期的开始,包括在内。

日期格式: YYYY-MM-DD.

Example: 2025-08-22

dateTimeFrom

Type: string<date-time>

期的开始,包括在内。

Example: 2025-01-01T00:00:00Z

dateTimeTo

Type: string<date-time>

期结束,包括在内。 最长期限 — 3个月。

Example: 2025-01-01T00:00:00Z

dateTo

Type: string<date>

期结束,包括在内。 最长期限 — 3个月。

日期格式: YYYY-MM-DD.

Example: 2025-01-01

inns

Type: string[] | null

报告中需要的客栈名单.

Min items: 1

Unique items: true

Example
[
  "example"
]

monthOfYear

Type: object

month

Type: integer

月号。

Min value: 1

Max value: 12

year

Type: integer

年。

需要市场点数报告的月份。

Example
{
  "year": 2025,
  "month": 12
}

placementPrograms

Type: string[] | null

报告中需要的模型列表。

Min items: 1

Unique items: true

Example
[
  "FBS"
]

Responses

200 OK

作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。

Body

application/json
{
  "status": "OK",
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

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

    Enum: OK, ERROR

    服务器响应的标准包装器。

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    estimatedGenerationTime

    Type: integer

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

    reportId

    Type: string

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

    Example: example

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

    Example
    {
      "reportId": "example",
      "estimatedGenerationTime": 0
    }
    
    Example
    {
      "result": {
        "reportId": "example",
        "estimatedGenerationTime": 0
      }
    }
    

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

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

[*баллы_маркета] 关于它是什么,请阅读 燕基科斯.对卖家的市场帮助.