Wildberries API TypeScript SDK / FinancesModule

Class: FinancesModule

Defined in: modules/finances/index.ts:35

Constructors

Constructor

new FinancesModule(client: BaseClient): FinancesModule;

Defined in: modules/finances/index.ts:36

Parameters

Parameter	Type
`client`	`BaseClient`

Returns

FinancesModule

Methods

getAccountBalance()

getAccountBalance(): Promise<AccountBalanceResponse>;

Defined in: modules/finances/index.ts:55

Получить баланс продавца

Метод возвращает данные виджета баланса на главной странице портала продавцов. <br><br> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Returns

Promise<AccountBalanceResponse>

Account balance data including currency, current balance, and available withdrawal amount

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/financial-reports-and-accounting#tag/Balans

Example

typescript

const result = await sdk.finances.getAccountBalance();
console.log(result);

getSupplierReportDetailByPeriod()

getSupplierReportDetailByPeriod(options: {
  dateFrom: string;
  dateTo: string;
  limit?: number;
  rrdid?: number;
  period?: "weekly" | "daily";
}): Promise<DetailReportItem[]>;

Defined in: modules/finances/index.ts:98

Отчёт о продажах по реализации (v5, deprecated)

Parameters

Parameter	Type	Description
`options`	{ `dateFrom`: `string`; `dateTo`: `string`; `limit?`: `number`; `rrdid?`: `number`; `period?`: `"weekly"` \| `"daily"`; }	Query parameters including required dateFrom and dateTo
`options.dateFrom`	`string`	-
`options.dateTo`	`string`	-
`options.limit?`	`number`	-
`options.rrdid?`	`number`	-
`options.period?`	`"weekly"` \| `"daily"`	-

Returns

Promise<DetailReportItem[]>

Array of detailed report items for the specified period

Deprecated

This method will be disabled by Wildberries on 2026-07-15. Migrate to getSalesReportsDetailed (v1) before that date.

Key migration differences (v5 → v1):

HTTP method: GET → POST
Field names: snake_case → camelCase (e.g., ppvz_for_pay → forPay)
Money amounts: number → string (use parseMoneyAmount() helper)
Domain: statistics-api.wildberries.ru → finance-api.wildberries.ru
New fields[] parameter for selective field loading

See the migration guide for complete field mapping and code examples.

Метод возвращает детализации к отчётам реализации. <br><br> Данные доступны с 29 января 2024 года. <div class="description_important"> Вы можете выгрузить данные в <a href="https://dev.wildberries.ru/ru/cases/1">Google Таблицы</a> </div> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty

Example

typescript

// DEPRECATED — migrate to getSalesReportsDetailed() before 2026-07-15
const result = await sdk.finances.getSupplierReportDetailByPeriod({
  dateFrom: '2024-01-01',
  dateTo: '2024-01-31',
  period: 'weekly',
});
console.log(result);

getDocumentsCategories()

getDocumentsCategories(options?: {
  locale?: DocumentsLocale;
}): Promise<GetCategories>;

Defined in: modules/finances/index.ts:135

Категории документов

Метод возвращает категории документов для получения списка документов продавца. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 секунд | 1 запрос | 10 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `locale?`: `DocumentsLocale`; }	Query parameters
`options.locale?`	`DocumentsLocale`	-

Returns

Promise<GetCategories>

List of document categories available for the seller

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/financial-reports-and-accounting#tag/Dokumenty

Example

typescript

const result = await sdk.finances.getDocumentsCategories({ locale: 'ru' });
console.log(result);

getDocumentsList()

getDocumentsList(options?: {
  locale?: DocumentsLocale;
  beginTime?: string;
  endTime?: string;
  sort?: "date" | "category";
  order?: "desc" | "asc";
  category?: string;
  serviceName?: string;
  limit?: number;
  offset?: number;
}): Promise<GetList>;

Defined in: modules/finances/index.ts:165

Список документов

Метод возвращает список документов продавца. Вы можете получить один или несколько документов из полученного списка. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 секунд | 1 запрос | 10 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `locale?`: `DocumentsLocale`; `beginTime?`: `string`; `endTime?`: `string`; `sort?`: `"date"` \| `"category"`; `order?`: `"desc"` \| `"asc"`; `category?`: `string`; `serviceName?`: `string`; `limit?`: `number`; `offset?`: `number`; }	Query parameters
`options.locale?`	`DocumentsLocale`	-
`options.beginTime?`	`string`	-
`options.endTime?`	`string`	-
`options.sort?`	`"date"` \| `"category"`	-
`options.order?`	`"desc"` \| `"asc"`	-
`options.category?`	`string`	-
`options.serviceName?`	`string`	-
`options.limit?`	`number`	-
`options.offset?`	`number`	-

Returns

Promise<GetList>

Paginated list of seller documents with metadata

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Remarks

The sort and order parameters work together — specifying order without sort has no effect. The beginTime and endTime parameters define a date range and should be used as a pair.

See

https://dev.wildberries.ru/openapi/financial-reports-and-accounting#tag/Dokumenty

Example

typescript

const result = await sdk.finances.getDocumentsList({
  locale: 'ru',
  sort: 'date',
  order: 'desc',
});
console.log(result);

getDocumentsDownload()

getDocumentsDownload(options: {
  serviceName: string;
  extension: string;
}): Promise<GetDoc>;

Defined in: modules/finances/index.ts:203

Получить документ

Метод загружает один документ из списка документов продавца. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 секунд | 1 запрос | 10 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options`	{ `serviceName`: `string`; `extension`: `string`; }	Query parameters including required serviceName and extension
`options.serviceName`	`string`	-
`options.extension`	`string`	-

Returns

Promise<GetDoc>

Document file data for the requested document

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/financial-reports-and-accounting#tag/Dokumenty

Example

typescript

const result = await sdk.finances.getDocumentsDownload({
  serviceName: 'act',
  extension: 'pdf',
});
console.log(result);

createDownloadAll()

createDownloadAll(data?: RequestDownload): Promise<GetDocs>;

Defined in: modules/finances/index.ts:230

Получить документы

Метод загружает несколько документов из списка документов продавца. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 минут | 1 запрос | 5 минут | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data?`	`RequestDownload`	Request body data

Returns

Promise<GetDocs>

Download details for the requested batch of documents

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/financial-reports-and-accounting#tag/Dokumenty

Example

typescript

const result = await sdk.finances.createDownloadAll({
  serviceNames: ['act', 'invoice'],
});
console.log(result);

getSalesReportsList()

getSalesReportsList(data: SalesReportListRequest): Promise<SalesReportListItem[]>;

Defined in: modules/finances/index.ts:273

Список отчётов реализации (v1)

Returns list of sales reports by report format. Data available from 2025-01-01.

Available token types: Personal, Service (NOT Basic or Test)

Rate limit: 1 req/min, 1 minute interval, burst 1

Parameters

Parameter	Type	Description
`data`	`SalesReportListRequest`	Request body with dateFrom, dateTo, limit, offset, period

Returns

Promise<SalesReportListItem[]>

Array of SalesReportListItem (money sums as string — use parseMoneyAmount helper)

Throws

When token type is Basic or Test — this endpoint requires Personal or Service token (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/docs/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty/operation/postV1SalesReportsList

Since

v3.7.0

Example

typescript

import { parseMoneyAmount } from 'daytona-wildberries-typescript-sdk';

const reports = await sdk.finances.getSalesReportsList({
  dateFrom: '2026-03-17',
  dateTo: '2026-03-20',
  period: 'weekly',
});
console.log(parseMoneyAmount(reports[0].forPaySum));

getSalesReportsDetailed()

getSalesReportsDetailed(data: SalesReportDetailedRequest): Promise<SalesReportDetailedItem[]>;

Defined in: modules/finances/index.ts:313

Детализации к отчётам реализации за период (v1)

Returns detailed rows for sales reports within a date range. Replaces the deprecated v5 method. Data available from 2024-01-29. Supports selective field loading via fields parameter.

Available token types: Personal, Service (NOT Basic or Test)

Rate limit: 1 req/min, 1 minute interval, burst 1

Parameters

Parameter	Type	Description
`data`	`SalesReportDetailedRequest`	Request body with dateFrom, dateTo, limit, rrdId, period, fields

Returns

Promise<SalesReportDetailedItem[]>

Array of SalesReportDetailedItem (~70 fields, money amounts as string — use parseMoneyAmount)

Throws

When token type is Basic or Test — this endpoint requires Personal or Service token (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/docs/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty/operation/postV1SalesReportsDetailed

Since

v3.7.0

Example

typescript

import { parseMoneyAmount } from 'daytona-wildberries-typescript-sdk';

const rows = await sdk.finances.getSalesReportsDetailed({
  dateFrom: '2026-03-17',
  dateTo: '2026-03-20',
  limit: 100000,
  rrdId: 0,
  fields: ['rrdId', 'nmId', 'forPay'],  // Optional: load only specific fields
});
const totalPayout = rows.reduce((sum, r) => sum + parseMoneyAmount(r.forPay), 0);

getSalesReportsDetailedByReportId()

getSalesReportsDetailedByReportId(reportId: string | number | bigint, data: SalesReportDetailedByIdRequest): Promise<SalesReportDetailedItem[]>;

Defined in: modules/finances/index.ts:357

Детализации к отчётам реализации по ID отчёта (v1)

Returns detailed rows for a specific report by its ID. Data available from 2025-01-01.

BigInt precision note: For daily reports, reportId may exceed Number.MAX_SAFE_INTEGER (2^53). If you obtained the ID from getSalesReportsList() response (which returns number), standard JSON parsing may already have truncated precision. For precision-safe handling, fetch the ID via a custom BigInt-aware parser and pass it as bigint or string.

Available token types: Personal, Service (NOT Basic or Test)

Rate limit: 1 req/min, 1 minute interval, burst 1

Parameters

Parameter	Type	Description
`reportId`	`string` \| `number` \| `bigint`	Report ID (number for typical use, bigint/string for BigInt precision on daily reports)
`data`	`SalesReportDetailedByIdRequest`	Request body with optional limit, rrdId, fields

Returns

Promise<SalesReportDetailedItem[]>

Array of SalesReportDetailedItem

Throws

When token type is Basic or Test — this endpoint requires Personal or Service token (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/docs/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty/operation/postV1SalesReportsDetailedReportId

Since

v3.7.0

Example

typescript

// Typical weekly report usage:
const rows = await sdk.finances.getSalesReportsDetailedByReportId(307401554);

// Daily report with BigInt precision:
const rows = await sdk.finances.getSalesReportsDetailedByReportId('9007199254740993', {
  fields: ['rrdId', 'nmId', 'retailAmount'],
});

getAcquiringReportsList()

getAcquiringReportsList(data: AcquiringReportListRequest): Promise<AcquiringReportListItem[]>;

Defined in: modules/finances/index.ts:403

Список отчётов об издержках на приём платежей (v1)

Returns list of acquiring reports. Available only to Russian sellers.

Available token types: Personal, Service (NOT Basic or Test)

Rate limit: 1 req/min, 1 minute interval, burst 1

Parameters

Parameter	Type	Description
`data`	`AcquiringReportListRequest`	Request body with dateFrom, dateTo, limit, offset

Returns

Promise<AcquiringReportListItem[]>

Array of AcquiringReportListItem (money sums as string — use parseMoneyAmount helper)

Throws

When token type is Basic or Test — this endpoint requires Personal or Service token

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/docs/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty/operation/postV1AcquiringList

Since

v3.7.0

Example

typescript

import { parseMoneyAmount } from 'daytona-wildberries-typescript-sdk';

const reports = await sdk.finances.getAcquiringReportsList({
  dateFrom: '2026-03-17',
  dateTo: '2026-03-20',
});
const totalFees = reports.reduce(
  (sum, r) => sum + parseMoneyAmount(r.acquiringFeeSum), 0
);

getAcquiringReportsDetailed()

getAcquiringReportsDetailed(data: AcquiringReportDetailedRequest): Promise<AcquiringReportDetailedItem[]>;

Defined in: modules/finances/index.ts:447

Детализации к отчётам об издержках на приём платежей за период (v1)

Returns detailed rows for acquiring reports within a date range. Available only to Russian sellers. Supports selective field loading via fields parameter.

Available token types: Personal, Service (NOT Basic or Test)

Rate limit: 1 req/min, 1 minute interval, burst 1

Parameters

Parameter	Type	Description
`data`	`AcquiringReportDetailedRequest`	Request body with dateFrom, dateTo, limit, rrdId, fields

Returns

Promise<AcquiringReportDetailedItem[]>

Array of AcquiringReportDetailedItem (money amounts as string — use parseMoneyAmount)

Throws

When token type is Basic or Test — this endpoint requires Personal or Service token

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/docs/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty/operation/postV1AcquiringDetailed

Since

v3.7.0

Example

typescript

import { parseMoneyAmount } from 'daytona-wildberries-typescript-sdk';

const rows = await sdk.finances.getAcquiringReportsDetailed({
  dateFrom: '2026-03-17',
  dateTo: '2026-03-20',
  limit: 100000,
  rrdId: 0,
  fields: ['rrdId', 'acquiringBank', 'acquiringFee'],
});
const totalFees = rows.reduce(
  (sum, r) => sum + parseMoneyAmount(r.acquiringFee), 0
);

getAcquiringReportsDetailedByReportId()

getAcquiringReportsDetailedByReportId(reportId: string | number | bigint, data: AcquiringReportDetailedByIdRequest): Promise<AcquiringReportDetailedItem[]>;

Defined in: modules/finances/index.ts:493

Детализации к отчётам об издержках на приём платежей по ID отчёта (v1)

Returns detailed rows for a specific acquiring report by ID. Available only to Russian sellers.

BigInt precision note: For daily reports, reportId may exceed Number.MAX_SAFE_INTEGER. Pass as bigint or string for precision-safe handling.

Available token types: Personal, Service (NOT Basic or Test)

Rate limit: 1 req/min, 1 minute interval, burst 1

Parameters

Parameter	Type	Description
`reportId`	`string` \| `number` \| `bigint`	Report ID (number/bigint/string)
`data`	`AcquiringReportDetailedByIdRequest`	Request body with optional limit, rrdId, fields

Returns

Promise<AcquiringReportDetailedItem[]>

Array of AcquiringReportDetailedItem

Throws

When token type is Basic or Test — this endpoint requires Personal or Service token

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/docs/openapi/financial-reports-and-accounting#tag/Finansovye-otchyoty/operation/postV1AcquiringDetailedReportId

Since

v3.7.0

Example

typescript

import { parseMoneyAmount } from 'daytona-wildberries-typescript-sdk';

// Typical number reportId
const rows = await sdk.finances.getAcquiringReportsDetailedByReportId(307401554);

// BigInt precision for daily reports — pass as string or bigint
const rows = await sdk.finances.getAcquiringReportsDetailedByReportId(
  '9007199254740993',
  { fields: ['rrdId', 'acquiringFee'] }
);

Class: FinancesModule ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Methods ​

getAccountBalance() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Example ​

getSupplierReportDetailByPeriod() ​

Parameters ​

Returns ​

Deprecated ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Example ​

getDocumentsCategories() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Example ​

getDocumentsList() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Remarks ​

See ​

Example ​

getDocumentsDownload() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Example ​

createDownloadAll() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Example ​

getSalesReportsList() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Since ​

Example ​

getSalesReportsDetailed() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

See ​

Since ​

Class: FinancesModule

Constructors

Constructor

Parameters

Returns

Methods

getAccountBalance()

Returns

Throws

Throws

Throws

Throws

See

Example

getSupplierReportDetailByPeriod()

Parameters

Returns

Deprecated

Throws

Throws

Throws

Throws

See

Example

getDocumentsCategories()

Parameters

Returns

Throws

Throws

Throws

Throws

See

Example

getDocumentsList()

Parameters

Returns

Throws

Throws

Throws

Throws

Remarks

See

Example

getDocumentsDownload()

Parameters

Returns

Throws

Throws

Throws

Throws

See

Example

createDownloadAll()

Parameters

Returns

Throws

Throws

Throws

Throws

See

Example

getSalesReportsList()

Parameters

Returns

Throws

Throws

Throws

Throws

See

Since

Example

getSalesReportsDetailed()

Parameters

Returns

Throws

Throws

Throws

Throws

See

Since