Closing documents

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

Returns a ZIP archive with closing documents in the format PDF for the specified month.

The composition of the documents depends on the type of contract

  • Placement agreement

    • act on services rendered
    • invoice
    • summary report on statistics
    • report on the execution of the assignment and on the settlement of mutual claims (agent's report)

  • Promotion agreement (not concluded in Russia after September 30, 2024)

    • service provision act
    • invoice if the tax scheme requires it

  • Marketing agreement

    • act on services rendered
    • invoice
    • advance invoice
    • personal account statement
    • details to the act

You can find out the generation status and get a link to the archive using a request. GET v2/reports/info/{reportId}.

⚙️ Limit: 1,000 requests per hour

Request

POST

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

Body

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

Name

Description

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

  • block Campaign ID;
  • tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

  • the store's identifier, which is displayed in the merchant's personal account.
  • advertising campaigns.

Min value: 1

monthOfYear
Type: object

month

Type: integer

The month number.

Min value: 1

Max value: 12

year

Type: integer

Year.

Month and year.

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

contractTypes

Type: string[] | null

Types of contracts that require closing documents.

If you do not specify them, the archive with documents for all found contracts will be returned.

Min items: 1

Max items: 3

Unique items: true

Example
[
  "INCOME"
]

Responses

200 OK

ZIP archive with closing documents in the format PDF.

Body

application/json
{
  "status": "OK"
}

Type: object

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams: []
searchParams: []
headers: []
body: |-
  {
    "campaignId": 1,
    "monthOfYear": {
      "year": 2025,
      "month": 12
    },
    "contractTypes": [
      "INCOME"
    ]
  }
schema:
  description: |
    The data required to request the closing documents.
  type: object
  required:
    - campaignId
    - monthOfYear
  properties:
    campaignId:
      description: "The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) or find it in the seller's office on the Market. Click on your account icon → **Settings** and in the menu on the left, select **APIs and modules**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
      type: integer
      format: int64
      minimum: 1
    monthOfYear:
      description: |
        Month and year.
      type: object
      required:
        - year
        - month
      properties:
        year:
          description: Year.
          type: integer
          format: int32
          example: 2025
        month:
          description: The month number.
          type: integer
          format: int32
          minimum: 1
          maximum: 12
          example: 12
    contractTypes:
      description: >
        Types of contracts that require closing documents.


        If you do not specify them, the archive with documents for all found
        contracts will be returned.
      type: array
      uniqueItems: true
      minItems: 1
      maxItems: 3
      nullable: true
      items:
        description: >
          Type of agreement:


          * `INCOME` — the accommodation
          agreement.


          * `OUTCOME` — the promotion agreement.


          * `MARKETING` — a marketing contract.
        type: string
        enum:
          - INCOME
          - OUTCOME
          - MARKETING
bodyType: application/json
method: post
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/closure-documents/generate
host: https://api.partner.market.yandex.ru

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

It lists all the services that the Market has provided to the seller over the past month.

Read more about the act in Yandex.Market Help for sellers.

It lists all the services that the Market has provided to the seller over the past month.

This is a mandatory document regulated by a special Government decree.

The invoice contains the same information as in the certificate of services rendered. It is more convenient to use an act for accounting and analysis.

This is a mandatory document regulated by a special Government decree.

The invoice contains the same information as the service delivery certificate. It is more convenient to use an act for accounting and analysis.

The store's accountant needs a summary report to reflect the sale of goods in accounting.

The report is compiled for stores operating according to the models FBY and FBS. It indicates how many items and for what amount:

  • sent to customers;
  • delivered to customers;
  • The buyers did not buy back;
  • the buyers returned it.
The report is in the same PDF-the file is that of a certificate of services rendered.

Read more about the report in Yandex.Market Help for sellers.

The report shows how much money the Market has received from customers, how much it has already transferred to the seller, and how much it still owes.

Read more about the report in Yandex.Market Help for sellers.

The act states:

  • the total amount of all discounts on products that the Market has provided to customers;
  • the total amount of all shipping discounts that the Market has provided to customers (only for the model DBS);
  • the total amount of payments in Plus points.

Shows the amount on the balance at the beginning of the month that the seller has not spent yet. The document is useful for an accountant.

Shows the seller's balance — expenses and the balance at the end of the month.

Shows the services provided by all the brands of the seller or advertiser. The details are useful for accounting purposes.

Previous
Report on the cost of services
Next
Report on convergence with closing documents