@smartbooks-ai/api-client 0.0.3

package/src/apis/ReportingApi.ts

@@ -0,0 +1,851 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Smartbooks Restful API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type {
+  AmountsResponse,
+  BulkReportGenerationRequest,
+  BulkReportGenerationResponse,
+  GeneratedReport,
+  OutstandingPayables,
+  OutstandingReceivables,
+  PreviewGenerationResponse,
+  ReportDataResponse,
+  ReportGenerationRequest,
+  ReportGroupsResponse,
+  ReportPreviewGenerationRequest,
+} from '../models/index';
+import * as runtime from '../runtime';
+
+export interface ReportingApiForVisualRequest {
+  companyCode: string;
+  reportGenerationRequest: ReportGenerationRequest;
+}
+
+export interface ReportingApiForVisualsRequest {
+  companyCode: string;
+  bulkReportGenerationRequest: BulkReportGenerationRequest;
+}
+
+export interface ReportingApiOutstandingPayablesRequest {
+  companyCode: string;
+}
+
+export interface ReportingApiOutstandingReceivablesRequest {
+  companyCode: string;
+}
+
+export interface ReportingApiPreviewReportRequest {
+  companyCode: string;
+  reportPreviewGenerationRequest: ReportPreviewGenerationRequest;
+}
+
+export interface ReportingApiReportDataRequest {
+  companyCode: string;
+  reportGroupCode: string;
+  reportCode: string;
+}
+
+export interface ReportingApiReportGroupsRequest {
+  companyCode: string;
+}
+
+export interface ReportingApiYearlyAmountsRequest {
+  companyCode: string;
+  year: number | null;
+  category?: string | null;
+  entity?: string | null;
+  businessDimensionMember?: string | null;
+  view?: YearlyAmountsViewEnum;
+  experimental?: string | null;
+  glimpse?: boolean | null;
+  moduleCode?: string | null;
+  structureType?: YearlyAmountsStructureTypeEnum;
+}
+
+/**
+ * ReportingApi - interface
+ *
+ * @export
+ * @interface ReportingApiInterface
+ */
+export interface ReportingApiInterface {
+  /**
+   *
+   * @param {string} companyCode
+   * @param {ReportGenerationRequest} reportGenerationRequest
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  forVisualRaw(
+    requestParameters: ReportingApiForVisualRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GeneratedReport>>;
+
+  /**
+   */
+  forVisual(
+    companyCode: string,
+    reportGenerationRequest: ReportGenerationRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<GeneratedReport>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {BulkReportGenerationRequest} bulkReportGenerationRequest
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  forVisualsRaw(
+    requestParameters: ReportingApiForVisualsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<BulkReportGenerationResponse>>;
+
+  /**
+   */
+  forVisuals(
+    companyCode: string,
+    bulkReportGenerationRequest: BulkReportGenerationRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<BulkReportGenerationResponse>;
+
+  /**
+   * Get outstanding payables
+   * @summary Get outstanding payables
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  outstandingPayablesRaw(
+    requestParameters: ReportingApiOutstandingPayablesRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<OutstandingPayables>>;
+
+  /**
+   * Get outstanding payables
+   * Get outstanding payables
+   */
+  outstandingPayables(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<OutstandingPayables>;
+
+  /**
+   * Get outstanding receivables
+   * @summary Get outstanding receivables
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  outstandingReceivablesRaw(
+    requestParameters: ReportingApiOutstandingReceivablesRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<OutstandingReceivables>>;
+
+  /**
+   * Get outstanding receivables
+   * Get outstanding receivables
+   */
+  outstandingReceivables(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<OutstandingReceivables>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {ReportPreviewGenerationRequest} reportPreviewGenerationRequest
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  previewReportRaw(
+    requestParameters: ReportingApiPreviewReportRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<PreviewGenerationResponse>>;
+
+  /**
+   */
+  previewReport(
+    companyCode: string,
+    reportPreviewGenerationRequest: ReportPreviewGenerationRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<PreviewGenerationResponse>;
+
+  /**
+   * Get report data
+   * @summary Get report data
+   * @param {string} companyCode
+   * @param {string} reportGroupCode
+   * @param {string} reportCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  reportDataRaw(
+    requestParameters: ReportingApiReportDataRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ReportDataResponse>>;
+
+  /**
+   * Get report data
+   * Get report data
+   */
+  reportData(
+    companyCode: string,
+    reportGroupCode: string,
+    reportCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ReportDataResponse>;
+
+  /**
+   * Get report groups
+   * @summary Get report groups
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  reportGroupsRaw(
+    requestParameters: ReportingApiReportGroupsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ReportGroupsResponse>>;
+
+  /**
+   * Get report groups
+   * Get report groups
+   */
+  reportGroups(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ReportGroupsResponse>;
+
+  /**
+   * Get yearly amounts for a given year
+   * @summary Get yearly amounts
+   * @param {string} companyCode
+   * @param {number} year
+   * @param {string} [category]
+   * @param {string} [entity]
+   * @param {string} [businessDimensionMember]
+   * @param {'periodic' | 'ytd' | 'qtd' | 'ltd'} [view]
+   * @param {string} [experimental]
+   * @param {boolean} [glimpse]
+   * @param {string} [moduleCode]
+   * @param {'default' | 'cashflow'} [structureType]
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportingApiInterface
+   */
+  yearlyAmountsRaw(
+    requestParameters: ReportingApiYearlyAmountsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<AmountsResponse>>;
+
+  /**
+   * Get yearly amounts for a given year
+   * Get yearly amounts
+   */
+  yearlyAmounts(
+    companyCode: string,
+    year: number | null,
+    category?: string | null,
+    entity?: string | null,
+    businessDimensionMember?: string | null,
+    view?: YearlyAmountsViewEnum,
+    experimental?: string | null,
+    glimpse?: boolean | null,
+    moduleCode?: string | null,
+    structureType?: YearlyAmountsStructureTypeEnum,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<AmountsResponse>;
+}
+
+/**
+ *
+ */
+export class ReportingApi extends runtime.BaseAPI implements ReportingApiInterface {
+  /**
+   */
+  async forVisualRaw(
+    requestParameters: ReportingApiForVisualRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GeneratedReport>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling forVisual().',
+      );
+    }
+
+    if (requestParameters['reportGenerationRequest'] == null) {
+      throw new runtime.RequiredError(
+        'reportGenerationRequest',
+        'Required parameter "reportGenerationRequest" was null or undefined when calling forVisual().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/for-visual`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: requestParameters['reportGenerationRequest'],
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async forVisual(
+    companyCode: string,
+    reportGenerationRequest: ReportGenerationRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<GeneratedReport> {
+    const response = await this.forVisualRaw(
+      { companyCode: companyCode, reportGenerationRequest: reportGenerationRequest },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   */
+  async forVisualsRaw(
+    requestParameters: ReportingApiForVisualsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<BulkReportGenerationResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling forVisuals().',
+      );
+    }
+
+    if (requestParameters['bulkReportGenerationRequest'] == null) {
+      throw new runtime.RequiredError(
+        'bulkReportGenerationRequest',
+        'Required parameter "bulkReportGenerationRequest" was null or undefined when calling forVisuals().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/for-visuals`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: requestParameters['bulkReportGenerationRequest'],
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async forVisuals(
+    companyCode: string,
+    bulkReportGenerationRequest: BulkReportGenerationRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<BulkReportGenerationResponse> {
+    const response = await this.forVisualsRaw(
+      { companyCode: companyCode, bulkReportGenerationRequest: bulkReportGenerationRequest },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   * Get outstanding payables
+   * Get outstanding payables
+   */
+  async outstandingPayablesRaw(
+    requestParameters: ReportingApiOutstandingPayablesRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<OutstandingPayables>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling outstandingPayables().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['reporting:read']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/outstanding/payables`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   * Get outstanding payables
+   * Get outstanding payables
+   */
+  async outstandingPayables(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<OutstandingPayables> {
+    const response = await this.outstandingPayablesRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   * Get outstanding receivables
+   * Get outstanding receivables
+   */
+  async outstandingReceivablesRaw(
+    requestParameters: ReportingApiOutstandingReceivablesRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<OutstandingReceivables>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling outstandingReceivables().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['reporting:read']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/outstanding/receivables`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   * Get outstanding receivables
+   * Get outstanding receivables
+   */
+  async outstandingReceivables(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<OutstandingReceivables> {
+    const response = await this.outstandingReceivablesRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   */
+  async previewReportRaw(
+    requestParameters: ReportingApiPreviewReportRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<PreviewGenerationResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling previewReport().',
+      );
+    }
+
+    if (requestParameters['reportPreviewGenerationRequest'] == null) {
+      throw new runtime.RequiredError(
+        'reportPreviewGenerationRequest',
+        'Required parameter "reportPreviewGenerationRequest" was null or undefined when calling previewReport().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/preview/report`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: requestParameters['reportPreviewGenerationRequest'],
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async previewReport(
+    companyCode: string,
+    reportPreviewGenerationRequest: ReportPreviewGenerationRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<PreviewGenerationResponse> {
+    const response = await this.previewReportRaw(
+      { companyCode: companyCode, reportPreviewGenerationRequest: reportPreviewGenerationRequest },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   * Get report data
+   * Get report data
+   */
+  async reportDataRaw(
+    requestParameters: ReportingApiReportDataRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ReportDataResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling reportData().',
+      );
+    }
+
+    if (requestParameters['reportGroupCode'] == null) {
+      throw new runtime.RequiredError(
+        'reportGroupCode',
+        'Required parameter "reportGroupCode" was null or undefined when calling reportData().',
+      );
+    }
+
+    if (requestParameters['reportCode'] == null) {
+      throw new runtime.RequiredError(
+        'reportCode',
+        'Required parameter "reportCode" was null or undefined when calling reportData().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['reporting:read']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/report-groups/{reportGroupCode}/report/{reportCode}`
+          .replace(`{${'company_code'}}`, encodeURIComponent(String(requestParameters['companyCode'])))
+          .replace(`{${'reportGroupCode'}}`, encodeURIComponent(String(requestParameters['reportGroupCode'])))
+          .replace(`{${'reportCode'}}`, encodeURIComponent(String(requestParameters['reportCode']))),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   * Get report data
+   * Get report data
+   */
+  async reportData(
+    companyCode: string,
+    reportGroupCode: string,
+    reportCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ReportDataResponse> {
+    const response = await this.reportDataRaw(
+      { companyCode: companyCode, reportGroupCode: reportGroupCode, reportCode: reportCode },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   * Get report groups
+   * Get report groups
+   */
+  async reportGroupsRaw(
+    requestParameters: ReportingApiReportGroupsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ReportGroupsResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling reportGroups().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['reporting:read']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/report-groups`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   * Get report groups
+   * Get report groups
+   */
+  async reportGroups(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ReportGroupsResponse> {
+    const response = await this.reportGroupsRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   * Get yearly amounts for a given year
+   * Get yearly amounts
+   */
+  async yearlyAmountsRaw(
+    requestParameters: ReportingApiYearlyAmountsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<AmountsResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling yearlyAmounts().',
+      );
+    }
+
+    if (requestParameters['year'] == null) {
+      throw new runtime.RequiredError(
+        'year',
+        'Required parameter "year" was null or undefined when calling yearlyAmounts().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    if (requestParameters['category'] != null) {
+      queryParameters['category'] = requestParameters['category'];
+    }
+
+    if (requestParameters['entity'] != null) {
+      queryParameters['entity'] = requestParameters['entity'];
+    }
+
+    if (requestParameters['businessDimensionMember'] != null) {
+      queryParameters['businessDimensionMember'] = requestParameters['businessDimensionMember'];
+    }
+
+    if (requestParameters['view'] != null) {
+      queryParameters['view'] = requestParameters['view'];
+    }
+
+    if (requestParameters['experimental'] != null) {
+      queryParameters['experimental'] = requestParameters['experimental'];
+    }
+
+    if (requestParameters['glimpse'] != null) {
+      queryParameters['glimpse'] = requestParameters['glimpse'];
+    }
+
+    if (requestParameters['moduleCode'] != null) {
+      queryParameters['moduleCode'] = requestParameters['moduleCode'];
+    }
+
+    if (requestParameters['structureType'] != null) {
+      queryParameters['structureType'] = requestParameters['structureType'];
+    }
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['reporting:read']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/reporting/amounts/yearly/{year}`
+          .replace(`{${'company_code'}}`, encodeURIComponent(String(requestParameters['companyCode'])))
+          .replace(`{${'year'}}`, encodeURIComponent(String(requestParameters['year']))),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   * Get yearly amounts for a given year
+   * Get yearly amounts
+   */
+  async yearlyAmounts(
+    companyCode: string,
+    year: number | null,
+    category?: string | null,
+    entity?: string | null,
+    businessDimensionMember?: string | null,
+    view?: YearlyAmountsViewEnum,
+    experimental?: string | null,
+    glimpse?: boolean | null,
+    moduleCode?: string | null,
+    structureType?: YearlyAmountsStructureTypeEnum,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<AmountsResponse> {
+    const response = await this.yearlyAmountsRaw(
+      {
+        companyCode: companyCode,
+        year: year,
+        category: category,
+        entity: entity,
+        businessDimensionMember: businessDimensionMember,
+        view: view,
+        experimental: experimental,
+        glimpse: glimpse,
+        moduleCode: moduleCode,
+        structureType: structureType,
+      },
+      initOverrides,
+    );
+    return await response.value();
+  }
+}
+
+/**
+ * @export
+ */
+export const YearlyAmountsViewEnum = {
+  Periodic: 'periodic',
+  Ytd: 'ytd',
+  Qtd: 'qtd',
+  Ltd: 'ltd',
+} as const;
+export type YearlyAmountsViewEnum = (typeof YearlyAmountsViewEnum)[keyof typeof YearlyAmountsViewEnum];
+/**
+ * @export
+ */
+export const YearlyAmountsStructureTypeEnum = {
+  Default: 'default',
+  Cashflow: 'cashflow',
+} as const;
+export type YearlyAmountsStructureTypeEnum =
+  (typeof YearlyAmountsStructureTypeEnum)[keyof typeof YearlyAmountsStructureTypeEnum];