"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* Документация Ozon Seller API
* По вопросам работы с Seller API обращайтесь в поддержку через личный кабинет. > [Инструкции по работе с маркетплейсом](https://seller-edu.ozon.ru) > [Информационная платформа и сообщество разработчиков Ozon for dev](https://dev.ozon.ru/)
*
* The version of the OpenAPI document: 2.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FinanceAPI = void 0;
const runtime = require("../runtime");
const index_1 = require("../models/index");
/**
*
*/
class FinanceAPI extends runtime.BaseAPI {
/**
* Возвращает подробную информацию по всем начислениям. Максимальный период, за который можно получить информацию в одном запросе — 1 месяц. Если в запросе не указывать `posting_number`, то в ответе будут все отправления за указанный период или отправления определённого типа.
* Список транзакций
*/
financeAPIFinanceTransactionListV3Raw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['clientId'] == null) {
throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling financeAPIFinanceTransactionListV3().');
}
if (requestParameters['apiKey'] == null) {
throw new runtime.RequiredError('apiKey', 'Required parameter "apiKey" was null or undefined when calling financeAPIFinanceTransactionListV3().');
}
if (requestParameters['financev3FinanceTransactionListV3Request'] == null) {
throw new runtime.RequiredError('financev3FinanceTransactionListV3Request', 'Required parameter "financev3FinanceTransactionListV3Request" was null or undefined when calling financeAPIFinanceTransactionListV3().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (requestParameters['clientId'] != null) {
headerParameters['Client-Id'] = String(requestParameters['clientId']);
}
if (requestParameters['apiKey'] != null) {
headerParameters['Api-Key'] = String(requestParameters['apiKey']);
}
const response = yield this.request({
path: `/v3/finance/transaction/list`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.Financev3FinanceTransactionListV3RequestToJSON)(requestParameters['financev3FinanceTransactionListV3Request']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.Financev3FinanceTransactionListV3ResponseFromJSON)(jsonValue));
});
}
/**
* Возвращает подробную информацию по всем начислениям. Максимальный период, за который можно получить информацию в одном запросе — 1 месяц. Если в запросе не указывать `posting_number`, то в ответе будут все отправления за указанный период или отправления определённого типа.
* Список транзакций
*/
financeAPIFinanceTransactionListV3(clientId, apiKey, financev3FinanceTransactionListV3Request, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.financeAPIFinanceTransactionListV3Raw({ clientId: clientId, apiKey: apiKey, financev3FinanceTransactionListV3Request: financev3FinanceTransactionListV3Request }, initOverrides);
return yield response.value();
});
}
/**
* Возвращает итоговые суммы по транзакциям за указанный период. Если вы неправильно заполните номера отправлений, в ответе вернутся нулевые значения.
* Суммы транзакций
*/
financeAPIFinanceTransactionTotalV3Raw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['clientId'] == null) {
throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling financeAPIFinanceTransactionTotalV3().');
}
if (requestParameters['apiKey'] == null) {
throw new runtime.RequiredError('apiKey', 'Required parameter "apiKey" was null or undefined when calling financeAPIFinanceTransactionTotalV3().');
}
if (requestParameters['financev3FinanceTransactionTotalsV3Request'] == null) {
throw new runtime.RequiredError('financev3FinanceTransactionTotalsV3Request', 'Required parameter "financev3FinanceTransactionTotalsV3Request" was null or undefined when calling financeAPIFinanceTransactionTotalV3().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (requestParameters['clientId'] != null) {
headerParameters['Client-Id'] = String(requestParameters['clientId']);
}
if (requestParameters['apiKey'] != null) {
headerParameters['Api-Key'] = String(requestParameters['apiKey']);
}
const response = yield this.request({
path: `/v3/finance/transaction/totals`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.Financev3FinanceTransactionTotalsV3RequestToJSON)(requestParameters['financev3FinanceTransactionTotalsV3Request']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.Financev3FinanceTransactionTotalsV3ResponseFromJSON)(jsonValue));
});
}
/**
* Возвращает итоговые суммы по транзакциям за указанный период. Если вы неправильно заполните номера отправлений, в ответе вернутся нулевые значения.
* Суммы транзакций
*/
financeAPIFinanceTransactionTotalV3(clientId, apiKey, financev3FinanceTransactionTotalsV3Request, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.financeAPIFinanceTransactionTotalV3Raw({ clientId: clientId, apiKey: apiKey, financev3FinanceTransactionTotalsV3Request: financev3FinanceTransactionTotalsV3Request }, initOverrides);
return yield response.value();
});
}
/**
* Отчёт о реализации доставленных и возвращённых товаров с детализацией по каждому заказу. Отмены и невыкупы не включаются. Отчёт доступен с настоящего времени по август 2023 года включительно.
* Позаказный отчёт о реализации товаров
*/
financeAPIGetRealizationReportV1Raw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['clientId'] == null) {
throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling financeAPIGetRealizationReportV1().');
}
if (requestParameters['apiKey'] == null) {
throw new runtime.RequiredError('apiKey', 'Required parameter "apiKey" was null or undefined when calling financeAPIGetRealizationReportV1().');
}
if (requestParameters['v1GetRealizationReportPostingRequest'] == null) {
throw new runtime.RequiredError('v1GetRealizationReportPostingRequest', 'Required parameter "v1GetRealizationReportPostingRequest" was null or undefined when calling financeAPIGetRealizationReportV1().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (requestParameters['clientId'] != null) {
headerParameters['Client-Id'] = String(requestParameters['clientId']);
}
if (requestParameters['apiKey'] != null) {
headerParameters['Api-Key'] = String(requestParameters['apiKey']);
}
const response = yield this.request({
path: `/v1/finance/realization/posting`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1GetRealizationReportPostingRequestToJSON)(requestParameters['v1GetRealizationReportPostingRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.V1GetRealizationReportPostingResponseFromJSON)(jsonValue));
});
}
/**
* Отчёт о реализации доставленных и возвращённых товаров с детализацией по каждому заказу. Отмены и невыкупы не включаются. Отчёт доступен с настоящего времени по август 2023 года включительно.
* Позаказный отчёт о реализации товаров
*/
financeAPIGetRealizationReportV1(clientId, apiKey, v1GetRealizationReportPostingRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.financeAPIGetRealizationReportV1Raw({ clientId: clientId, apiKey: apiKey, v1GetRealizationReportPostingRequest: v1GetRealizationReportPostingRequest }, initOverrides);
return yield response.value();
});
}
/**
* Отчёт о реализации доставленных и возвращённых товаров за месяц. Отмены и невыкупы не включаются. Соответствует разделу **Финансы → Документы → Отчёты о реализации → Отчёт о реализации товара** в личном кабинете. Отчёт придёт не позднее 5-го числа следующего месяца. [Подробнее об отчёте в Базе знаний продавца](https://seller-edu.ozon.ru/docs/finances-documents/calculations-documents/otchet-o-realizacii-tovarov.html)
* Отчёт о реализации товаров (версия 2)
*/
financeAPIGetRealizationReportV2Raw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['clientId'] == null) {
throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling financeAPIGetRealizationReportV2().');
}
if (requestParameters['apiKey'] == null) {
throw new runtime.RequiredError('apiKey', 'Required parameter "apiKey" was null or undefined when calling financeAPIGetRealizationReportV2().');
}
if (requestParameters['v2GetRealizationReportRequestV2'] == null) {
throw new runtime.RequiredError('v2GetRealizationReportRequestV2', 'Required parameter "v2GetRealizationReportRequestV2" was null or undefined when calling financeAPIGetRealizationReportV2().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (requestParameters['clientId'] != null) {
headerParameters['Client-Id'] = String(requestParameters['clientId']);
}
if (requestParameters['apiKey'] != null) {
headerParameters['Api-Key'] = String(requestParameters['apiKey']);
}
const response = yield this.request({
path: `/v2/finance/realization`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V2GetRealizationReportRequestV2ToJSON)(requestParameters['v2GetRealizationReportRequestV2']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.V2GetRealizationReportResponseV2FromJSON)(jsonValue));
});
}
/**
* Отчёт о реализации доставленных и возвращённых товаров за месяц. Отмены и невыкупы не включаются. Соответствует разделу **Финансы → Документы → Отчёты о реализации → Отчёт о реализации товара** в личном кабинете. Отчёт придёт не позднее 5-го числа следующего месяца. [Подробнее об отчёте в Базе знаний продавца](https://seller-edu.ozon.ru/docs/finances-documents/calculations-documents/otchet-o-realizacii-tovarov.html)
* Отчёт о реализации товаров (версия 2)
*/
financeAPIGetRealizationReportV2(clientId, apiKey, v2GetRealizationReportRequestV2, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.financeAPIGetRealizationReportV2Raw({ clientId: clientId, apiKey: apiKey, v2GetRealizationReportRequestV2: v2GetRealizationReportRequestV2 }, initOverrides);
return yield response.value();
});
}
/**
* Возвращает отчёт о товарах, которые выкупил Ozon. Соответствует разделу **Финансы → Документы → УПД по сделкам с юр. лицами → УПД по выкупленным товарам** в личном кабинете. [Подробнее о выкупе товаров в Базе знаний](https://seller-edu.ozon.ru/commissions-tariffs/commissions-tariffs-ozon/prodaji-tovarov-v-eaes-i-drugie-strany?search=выкупленные+товары)
* Отчёт о выкупленных товарах
*/
getFinanceProductsBuyoutRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = yield this.request({
path: `/v1/finance/products/buyout`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1GetFinanceProductsBuyoutRequestToJSON)(requestParameters['v1GetFinanceProductsBuyoutRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.V1GetFinanceProductsBuyoutResponseFromJSON)(jsonValue));
});
}
/**
* Возвращает отчёт о товарах, которые выкупил Ozon. Соответствует разделу **Финансы → Документы → УПД по сделкам с юр. лицами → УПД по выкупленным товарам** в личном кабинете. [Подробнее о выкупе товаров в Базе знаний](https://seller-edu.ozon.ru/commissions-tariffs/commissions-tariffs-ozon/prodaji-tovarov-v-eaes-i-drugie-strany?search=выкупленные+товары)
* Отчёт о выкупленных товарах
*/
getFinanceProductsBuyout(v1GetFinanceProductsBuyoutRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getFinanceProductsBuyoutRaw({ v1GetFinanceProductsBuyoutRequest: v1GetFinanceProductsBuyoutRequest }, initOverrides);
return yield response.value();
});
}
/**
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам в JSON-формате. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
* Реестр продаж юридическим лицам в JSON-формате
*/
reportAPICreateDocumentB2BSalesJSONReportRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['v1CreateDocumentB2BSalesJSONReportRequest'] == null) {
throw new runtime.RequiredError('v1CreateDocumentB2BSalesJSONReportRequest', 'Required parameter "v1CreateDocumentB2BSalesJSONReportRequest" was null or undefined when calling reportAPICreateDocumentB2BSalesJSONReport().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = yield this.request({
path: `/v1/finance/document-b2b-sales/json`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1CreateDocumentB2BSalesJSONReportRequestToJSON)(requestParameters['v1CreateDocumentB2BSalesJSONReportRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.V1CreateDocumentB2BSalesJSONReportResponseFromJSON)(jsonValue));
});
}
/**
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам в JSON-формате. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
* Реестр продаж юридическим лицам в JSON-формате
*/
reportAPICreateDocumentB2BSalesJSONReport(v1CreateDocumentB2BSalesJSONReportRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.reportAPICreateDocumentB2BSalesJSONReportRaw({ v1CreateDocumentB2BSalesJSONReportRequest: v1CreateDocumentB2BSalesJSONReportRequest }, initOverrides);
return yield response.value();
});
}
/**
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
* Реестр продаж юридическим лицам
*/
reportAPICreateDocumentB2BSalesReportRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['v1CreateDocumentB2BSalesReportRequest'] == null) {
throw new runtime.RequiredError('v1CreateDocumentB2BSalesReportRequest', 'Required parameter "v1CreateDocumentB2BSalesReportRequest" was null or undefined when calling reportAPICreateDocumentB2BSalesReport().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = yield this.request({
path: `/v1/finance/document-b2b-sales`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1CreateDocumentB2BSalesReportRequestToJSON)(requestParameters['v1CreateDocumentB2BSalesReportRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CommonCreateReportResponseFromJSON)(jsonValue));
});
}
/**
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
* Реестр продаж юридическим лицам
*/
reportAPICreateDocumentB2BSalesReport(v1CreateDocumentB2BSalesReportRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.reportAPICreateDocumentB2BSalesReportRaw({ v1CreateDocumentB2BSalesReportRequest: v1CreateDocumentB2BSalesReportRequest }, initOverrides);
return yield response.value();
});
}
/**
* Используйте метод, чтобы получить отчёт о взаиморасчетах. Соответствует разделу **Финансы → Документы → Аналитические отчеты → Отчет о взаиморасчетах** в личном кабинете.
* Отчёт о взаиморасчётах
*/
reportAPICreateMutualSettlementReportRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['clientId'] == null) {
throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling reportAPICreateMutualSettlementReport().');
}
if (requestParameters['apiKey'] == null) {
throw new runtime.RequiredError('apiKey', 'Required parameter "apiKey" was null or undefined when calling reportAPICreateMutualSettlementReport().');
}
if (requestParameters['v1CreateMutualSettlementReportRequest'] == null) {
throw new runtime.RequiredError('v1CreateMutualSettlementReportRequest', 'Required parameter "v1CreateMutualSettlementReportRequest" was null or undefined when calling reportAPICreateMutualSettlementReport().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (requestParameters['clientId'] != null) {
headerParameters['Client-Id'] = String(requestParameters['clientId']);
}
if (requestParameters['apiKey'] != null) {
headerParameters['Api-Key'] = String(requestParameters['apiKey']);
}
const response = yield this.request({
path: `/v1/finance/mutual-settlement`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1CreateMutualSettlementReportRequestToJSON)(requestParameters['v1CreateMutualSettlementReportRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CommonCreateReportResponseFromJSON)(jsonValue));
});
}
/**
* Используйте метод, чтобы получить отчёт о взаиморасчетах. Соответствует разделу **Финансы → Документы → Аналитические отчеты → Отчет о взаиморасчетах** в личном кабинете.
* Отчёт о взаиморасчётах
*/
reportAPICreateMutualSettlementReport(clientId, apiKey, v1CreateMutualSettlementReportRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.reportAPICreateMutualSettlementReportRaw({ clientId: clientId, apiKey: apiKey, v1CreateMutualSettlementReportRequest: v1CreateMutualSettlementReportRequest }, initOverrides);
return yield response.value();
});
}
/**
* Метод для получения отчёта о компенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
* Отчёт о компенсациях
*/
reportAPIGetCompensationReportRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['v1GetCompensationReportRequest'] == null) {
throw new runtime.RequiredError('v1GetCompensationReportRequest', 'Required parameter "v1GetCompensationReportRequest" was null or undefined when calling reportAPIGetCompensationReport().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = yield this.request({
path: `/v1/finance/compensation`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1GetCompensationReportRequestToJSON)(requestParameters['v1GetCompensationReportRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateReportResponseFromJSON)(jsonValue));
});
}
/**
* Метод для получения отчёта о компенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
* Отчёт о компенсациях
*/
reportAPIGetCompensationReport(v1GetCompensationReportRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.reportAPIGetCompensationReportRaw({ v1GetCompensationReportRequest: v1GetCompensationReportRequest }, initOverrides);
return yield response.value();
});
}
/**
* Метод для получения отчёта о декомпенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
* Отчёт о декомпенсациях
*/
reportAPIGetDecompensationReportRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['v1GetDecompensationReportRequest'] == null) {
throw new runtime.RequiredError('v1GetDecompensationReportRequest', 'Required parameter "v1GetDecompensationReportRequest" was null or undefined when calling reportAPIGetDecompensationReport().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = yield this.request({
path: `/v1/finance/decompensation`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.V1GetDecompensationReportRequestToJSON)(requestParameters['v1GetDecompensationReportRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateReportResponseFromJSON)(jsonValue));
});
}
/**
* Метод для получения отчёта о декомпенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
* Отчёт о декомпенсациях
*/
reportAPIGetDecompensationReport(v1GetDecompensationReportRequest, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.reportAPIGetDecompensationReportRaw({ v1GetDecompensationReportRequest: v1GetDecompensationReportRequest }, initOverrides);
return yield response.value();
});
}
}
exports.FinanceAPI = FinanceAPI;