The structure and content of the reports are subject to change without prior notice.
For example, a new column may be added or the name of the sheet may change.
Payment Report
The method is available for models: FBY, FBS, Express and DBS.
If you are using an API Key token, one of the accesses in the list is required to call the method
- finance-and-accounting — View financial data and reports
- all-methods — Full account management
Starts the generation of a report on payments for the specified period. What kind of report is this
You can find out the generation status and get a link to the finished report using a request. GET v2/reports/info/{reportId}.
The type of report depends on which fields are filled in in the request:
|
Report type |
What fields are needed? |
Comment |
|
About payments for the period |
|
The report includes all payments that were paid and accrued during the selected period. Example: if the transfer was completed on August 31 and credited on September 1, it will be included in the report for both months. |
|
About the payment order |
|
— |
|
[About Yandex.Market points](*баллы_маркета) |
|
— |
You cannot order multiple types of reports with a single request.
Explanation of the report columns:
Sheet Payment report (file transaction_date)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
BUSINESS_ID |
businessId |
Business information/Business account ID |
integer |
|
MODEL |
model |
Business information/Operation models |
string |
|
PARTNER_ID |
partnerId |
Business information/Store IDs |
integer |
|
SHOP_NAME |
shopName |
Business information/Store names |
string |
|
INN |
inn |
Business information/INN (taxpayer identification number) |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Business information/Agreement numbers for placement |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Business information/Agreement numbers for promotion |
string |
|
TRANSACTION_DATE |
transactionDate |
Payment information/Transaction date |
string |
|
TRANSACTION_ID |
transactionId |
Payment information/Transaction ID |
string |
|
ORDER_ID |
orderId |
Payment information/Order or shipment number |
integer |
|
SHOP_ORDER_ID |
shopOrderId |
Payment information/Your order number |
string |
|
ORDER_CREATION_DATE |
orderCreationDate |
Payment information/Order creation date |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Payment information/Order delivery date |
string |
|
CLAIM_NUMBER |
claimNumber |
Payment information/Claim number and date |
string |
|
ORDER_TYPE |
orderType |
Payment information/Order type |
string |
|
SHOP_SKU |
shopSku |
Payment information/Your SKU |
string |
|
ACT_ID |
actId |
Payment information/Certificate of services rendered number |
integer |
|
ACT_DATE |
actDate |
Payment information/Date of the сertificate of services rendered |
string |
|
OFFER_OR_SERVICE_NAME |
offerOrServiceName |
Payment information/Product name (for accrual) or service (for withholding) |
string |
|
COUNT |
count |
Payment information/Quantity |
integer |
|
TRANSACTION_SUM |
transactionSum |
Payment information/Transaction amount |
number |
|
TRANSACTION_TYPE |
transactionType |
Payment information/Transaction type |
string |
|
TRANSACTION_SOURCE |
transactionSource |
Payment information/Transaction source |
string |
|
PAYMENT_STATUS |
paymentStatus |
Payment information/Status |
string |
|
BONUS_ACCOUNT_YEAR_MONTH |
bonusAccountYearMonth |
Payment information/The billing period of the bonus for participation in joint promotions |
string |
|
BANK_ORDER_DATE |
bankOrderDate |
Payment information/Payment order date |
string |
|
BANK_ORDER_ID |
bankOrderId |
Payment information/Payment order number |
integer |
|
BANK_SUM |
bankSum |
Payment information/Payment order amount or the amount withheld for services |
number |
|
COMMENTS |
comments |
Payment information/Comments |
string |
Sheet Payment order report (file netting_report_accruals)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
BUSINESS_ID |
businessId |
Business information/Business account ID |
integer |
|
MODEL |
model |
Business information/Operation models |
string |
|
PARTNER_ID |
partnerId |
Business information/Store IDs |
integer |
|
SHOP_NAME |
shopName |
Business information/Store names |
string |
|
INN |
inn |
Business information/INN (taxpayer identification number) |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Business information/Agreement numbers for placement |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Business information/Agreement numbers for promotion |
string |
|
ORDER_ID |
orderId |
Information about accruals/Order or shipment number |
integer |
|
ORDER_CREATION_DATE |
orderCreationDate |
Information about accruals/Order creation date |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Information about accruals/Order delivery date |
string |
|
CLAIM_NUMBER |
claimNumber |
Information about accruals/Claim number and date |
string |
|
ORDER_TYPE |
orderType |
Information about accruals/Order type |
string |
|
SHOP_SKU |
shopSku |
Information about accruals/Your SKU |
string |
|
OFFER_NAME |
offerName |
Information about accruals/Product name |
string |
|
COUNT |
count |
Information about accruals/Quantity |
integer |
|
TRANSACTION_SUM |
transactionSum |
Information about accruals/Transaction amount |
number |
|
TRANSACTION_SOURCE |
transactionSource |
Information about accruals/Transaction source |
string |
|
ACT_ID |
actId |
Information about accruals/Certificate of services rendered number |
integer |
|
ACT_DATE |
actDate |
Information about accruals/Date of the сertificate of services rendered |
string |
|
TRANSACTION_DATE |
transactionDate |
Information about accruals/Transaction date |
string |
|
TRANSACTION_ID |
transactionId |
Information about accruals/Transaction ID |
string |
Sheet Payment order report (file netting_report_returns_and_compensations)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
BUSINESS_ID |
businessId |
Business information/Business account ID |
integer |
|
MODEL |
model |
Business information/Operation models |
string |
|
PARTNER_ID |
partnerId |
Business information/Store IDs |
integer |
|
SHOP_NAME |
shopName |
Business information/Store names |
string |
|
INN |
inn |
Business information/INN (taxpayer identification number) |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Business information/Agreement numbers for placement |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Business information/Agreement numbers for promotion |
string |
|
ORDER_ID |
orderId |
Information about buyer refunds and compensation/Order or shipment number |
integer |
|
ORDER_CREATION_DATE |
orderCreationDate |
Information about buyer refunds and compensation/Creation date |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Information about buyer refunds and compensation/Order delivery date |
string |
|
ORDER_TYPE |
orderType |
Information about buyer refunds and compensation/Order type |
string |
|
SHOP_SKU |
shopSku |
Information about buyer refunds and compensation/Your SKU |
string |
|
OFFER_NAME |
offerName |
Information about buyer refunds and compensation/Product name |
string |
|
COUNT |
count |
Information about buyer refunds and compensation/Quantity |
integer |
|
TRANSACTION_SUM |
transactionSum |
Information about buyer refunds and compensation/Transaction amount |
number |
|
TRANSACTION_SOURCE |
transactionSource |
Information about buyer refunds and compensation/Transaction source |
string |
|
TRANSACTION_DATE |
transactionDate |
Information about buyer refunds and compensation/Transaction date |
string |
|
TRANSACTION_ID |
transactionId |
Information about buyer refunds and compensation/Transaction ID |
string |
Sheet Payment order report (file netting_report_retentions)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
BUSINESS_ID |
businessId |
Business information/Business account ID |
integer |
|
MODEL |
model |
Business information/Operation models |
string |
|
PARTNER_ID |
partnerId |
Business information/Store IDs |
integer |
|
SHOP_NAME |
shopName |
Business information/Store names |
string |
|
INN |
inn |
Business information/INN (taxpayer identification number) |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Business information/Agreement numbers for placement |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Business information/Agreement numbers for promotion |
string |
|
ACT_ID |
actId |
Information about withheld amounts/Certificate of services rendered number |
integer |
|
ACT_DATE |
actDate |
Information about withheld amounts/Date of the сertificate of services rendered |
string |
|
SERVICE_NAME |
serviceName |
Information about withheld amounts/Name of service to be withheld |
string |
|
TRANSACTION_SUM |
transactionSum |
Information about withheld amounts/Transaction amount |
number |
|
TRANSACTION_SOURCE |
transactionSource |
Information about withheld amounts/Transaction source |
string |
|
TRANSACTION_DATE |
transactionDate |
Information about withheld amounts/Transaction date |
string |
|
TRANSACTION_ID |
transactionId |
Information about withheld amounts/Transaction ID |
string |
Sheet Bonuses report (file netting_bonuses)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
BUSINESS_ID |
businessId |
Business information/Business account ID |
integer |
|
MODEL |
model |
Business information/Operation models |
string |
|
PARTNER_ID |
partnerId |
Business information/Store IDs |
integer |
|
SHOP_NAME |
shopName |
Business information/Store names |
string |
|
INN |
inn |
Business information/INN (taxpayer identification number) |
string |
|
PLACEMENT_CONTRACT |
placementContract |
Business information/Agreement numbers for placement |
string |
|
PROMOTION_CONTRACT |
promotionContract |
Business information/Agreement numbers for promotion |
string |
|
TRANSACTION_DATE |
transactionDate |
Payment information/Transaction date |
string |
|
ORDER_ID |
orderId |
Payment information/Order or shipment number |
integer |
|
SHOP_ORDER_ID |
shopOrderId |
Payment information/Your order number |
string |
|
ORDER_CREATION_DATE |
orderCreationDate |
Payment information/Order creation date |
string |
|
ORDER_DELIVERY_DATE |
orderDeliveryDate |
Payment information/Order delivery date |
string |
|
ORDER_TYPE |
orderType |
Payment information/Order type |
string |
|
SHOP_SKU |
shopSku |
Payment information/Your SKU |
string |
|
OFFER_OR_SERVICE_NAME |
offerOrServiceName |
Payment information/Product name (for accrual) or service (for withholding) |
string |
|
COUNT |
count |
Payment information/Quantity |
integer |
|
TRANSACTION_SUM |
transactionSum |
Payment information/Transaction amount |
number |
|
TRANSACTION_TYPE |
transactionType |
Payment information/Transaction type |
string |
|
TRANSACTION_SOURCE |
transactionSource |
Payment information/Transaction source |
string |
|
PAYMENT_STATUS |
paymentStatus |
Payment information/Status |
string |
|
COMMENTS |
comments |
Payment information/Comments |
string |
|
BONUS_ACCOUNT_YEAR_MONTH |
bonusAccountYearMonth |
Payment information/The month of the premium formation for participation in joint promotions |
string |
| ⚙️ Limit: 100 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/united-netting/generate
Query parameters
|
Name |
Description |
|
format |
Type: string The format of the report or document. Report format:
Default: Enum: |
|
language |
Type: string The language of the report or document. Language of the report:
Enum: |
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 Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market? Min value: |
||||
|
bankOrderDateTime |
Type: string<date-time> The date of the payment order. Example: |
||||
|
bankOrderId |
Type: integer The number of the payment order. |
||||
|
campaignIds |
Type: integer[] | null The list of campaign IDs of those stores that are needed in the report. Min items: Unique items: Example
|
||||
|
dateFrom |
Type: string<date> The beginning of the period, inclusive. Date format: Example: |
||||
|
dateTimeFrom |
Type: string<date-time> The beginning of the period, inclusive. Example: |
||||
|
dateTimeTo |
Type: string<date-time> End of the period, inclusive. Maximum period — 3 months. Example: |
||||
|
dateTo |
Type: string<date> End of the period, inclusive. Maximum period — 3 months. Date format: Example: |
||||
|
inns |
Type: string[] | null The list of INN's that are needed in the report. Min items: Unique items: Example
|
||||
|
monthOfYear |
Type: object
The month for which the report on the Market points is needed. Example
|
||||
|
placementPrograms |
Type: string[] | null The list of models that are needed in the report. Min items: Unique items: Example
|
Responses
200 OK
An identifier is sent in response, which allows you to find out the generation status and download the finished report.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "example",
"estimatedGenerationTime": 0
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
result
Type: object
estimatedGenerationTime
Type: integer
Expected generation time in milliseconds.
reportId
Type: string
The ID that will be needed to track the generation status and receive the finished report or document.
Example:
exampleThe ID that will be needed to track the generation status and receive the finished report or document.
Example
{ "reportId": "example", "estimatedGenerationTime": 0 }Example
{ "result": { "reportId": "example", "estimatedGenerationTime": 0 } }
400 Bad Request
The request contains incorrect data. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
The authorization data is not specified in the request. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
404 Not Found
The requested resource was not found. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
The resource access limit has been exceeded. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Internal error of Yandex. Market. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.
[*баллы_маркета] About what it is, read in Yandex.Market Help for sellers.