@emilgroup/accounting-sdk-node 1.32.1-beta.54 → 1.32.1-beta.57

package/api/booking-entries-api.ts

@@ -25,9 +25,17 @@ import { CreateBookingEntryRequestDto } from '../models';
 // @ts-ignore
 import { CreateBookingEntryResponseClass } from '../models';
 // @ts-ignore
+import { CreateOrCorrectOpeningBalanceDto } from '../models';
+// @ts-ignore
+import { CreateOrCorrectOpeningBalanceResponseClass } from '../models';
+// @ts-ignore
 import { GetBookingEntryResponseClass } from '../models';
 // @ts-ignore
 import { ListBookingEntriesResponseClass } from '../models';
+// @ts-ignore
+import { PostFinancialEventRequestDto } from '../models';
+// @ts-ignore
+import { PostFinancialEventResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -85,6 +93,53 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Enters or restates the confirmed opening balance for one or more accounts: a first-time entry for an account with no opening-balance history yet, a restatement for one that already has some. Each item carries the confirmed balance, not the delta; the service derives the delta itself and books it, per account, against the main-ledger bridge account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+         * @summary Update the create or correct opening balance
+         * @param {CreateOrCorrectOpeningBalanceDto} createOrCorrectOpeningBalanceDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrCorrectOpeningBalance: async (createOrCorrectOpeningBalanceDto: CreateOrCorrectOpeningBalanceDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createOrCorrectOpeningBalanceDto' is not null or undefined
+            assertParamExists('createOrCorrectOpeningBalance', 'createOrCorrectOpeningBalanceDto', createOrCorrectOpeningBalanceDto)
+            const localVarPath = `/accountingservice/v1/booking-entries/opening-balances`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createOrCorrectOpeningBalanceDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.entries.view\"
          * @summary Retrieve the booking entry
@@ -208,6 +263,53 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+         * @summary Create the booking entry from a source entity
+         * @param {PostFinancialEventRequestDto} postFinancialEventRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postFinancialEvent: async (postFinancialEventRequestDto: PostFinancialEventRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'postFinancialEventRequestDto' is not null or undefined
+            assertParamExists('postFinancialEvent', 'postFinancialEventRequestDto', postFinancialEventRequestDto)
+            const localVarPath = `/accountingservice/v1/booking-entries/post-financial-event`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(postFinancialEventRequestDto, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -235,6 +337,18 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createBookingEntry(createBookingEntryRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Enters or restates the confirmed opening balance for one or more accounts: a first-time entry for an account with no opening-balance history yet, a restatement for one that already has some. Each item carries the confirmed balance, not the delta; the service derives the delta itself and books it, per account, against the main-ledger bridge account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+         * @summary Update the create or correct opening balance
+         * @param {CreateOrCorrectOpeningBalanceDto} createOrCorrectOpeningBalanceDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createOrCorrectOpeningBalance(createOrCorrectOpeningBalanceDto: CreateOrCorrectOpeningBalanceDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrCorrectOpeningBalanceResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createOrCorrectOpeningBalance(createOrCorrectOpeningBalanceDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.entries.view\"
          * @summary Retrieve the booking entry
@@ -266,6 +380,18 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+         * @summary Create the booking entry from a source entity
+         * @param {PostFinancialEventRequestDto} postFinancialEventRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postFinancialEvent(postFinancialEventRequestDto: PostFinancialEventRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostFinancialEventResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postFinancialEvent(postFinancialEventRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
     }
 };
 
@@ -287,6 +413,17 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
         createBookingEntry(createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBookingEntryResponseClass> {
             return localVarFp.createBookingEntry(createBookingEntryRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Enters or restates the confirmed opening balance for one or more accounts: a first-time entry for an account with no opening-balance history yet, a restatement for one that already has some. Each item carries the confirmed balance, not the delta; the service derives the delta itself and books it, per account, against the main-ledger bridge account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+         * @summary Update the create or correct opening balance
+         * @param {CreateOrCorrectOpeningBalanceDto} createOrCorrectOpeningBalanceDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrCorrectOpeningBalance(createOrCorrectOpeningBalanceDto: CreateOrCorrectOpeningBalanceDto, authorization?: string, options?: any): AxiosPromise<CreateOrCorrectOpeningBalanceResponseClass> {
+            return localVarFp.createOrCorrectOpeningBalance(createOrCorrectOpeningBalanceDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.entries.view\"
          * @summary Retrieve the booking entry
@@ -316,6 +453,17 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
         listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBookingEntriesResponseClass> {
             return localVarFp.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
+        /**
+         * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+         * @summary Create the booking entry from a source entity
+         * @param {PostFinancialEventRequestDto} postFinancialEventRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postFinancialEvent(postFinancialEventRequestDto: PostFinancialEventRequestDto, authorization?: string, options?: any): AxiosPromise<PostFinancialEventResponseClass> {
+            return localVarFp.postFinancialEvent(postFinancialEventRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -340,6 +488,27 @@ export interface BookingEntriesApiCreateBookingEntryRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for createOrCorrectOpeningBalance operation in BookingEntriesApi.
+ * @export
+ * @interface BookingEntriesApiCreateOrCorrectOpeningBalanceRequest
+ */
+export interface BookingEntriesApiCreateOrCorrectOpeningBalanceRequest {
+    /**
+     * 
+     * @type {CreateOrCorrectOpeningBalanceDto}
+     * @memberof BookingEntriesApiCreateOrCorrectOpeningBalance
+     */
+    readonly createOrCorrectOpeningBalanceDto: CreateOrCorrectOpeningBalanceDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingEntriesApiCreateOrCorrectOpeningBalance
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for getBookingEntry operation in BookingEntriesApi.
  * @export
@@ -431,6 +600,27 @@ export interface BookingEntriesApiListBookingEntriesRequest {
     readonly filters?: string
 }
 
+/**
+ * Request parameters for postFinancialEvent operation in BookingEntriesApi.
+ * @export
+ * @interface BookingEntriesApiPostFinancialEventRequest
+ */
+export interface BookingEntriesApiPostFinancialEventRequest {
+    /**
+     * 
+     * @type {PostFinancialEventRequestDto}
+     * @memberof BookingEntriesApiPostFinancialEvent
+     */
+    readonly postFinancialEventRequestDto: PostFinancialEventRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingEntriesApiPostFinancialEvent
+     */
+    readonly authorization?: string
+}
+
 /**
  * BookingEntriesApi - object-oriented interface
  * @export
@@ -450,6 +640,18 @@ export class BookingEntriesApi extends BaseAPI {
         return BookingEntriesApiFp(this.configuration).createBookingEntry(requestParameters.createBookingEntryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Enters or restates the confirmed opening balance for one or more accounts: a first-time entry for an account with no opening-balance history yet, a restatement for one that already has some. Each item carries the confirmed balance, not the delta; the service derives the delta itself and books it, per account, against the main-ledger bridge account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+     * @summary Update the create or correct opening balance
+     * @param {BookingEntriesApiCreateOrCorrectOpeningBalanceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingEntriesApi
+     */
+    public createOrCorrectOpeningBalance(requestParameters: BookingEntriesApiCreateOrCorrectOpeningBalanceRequest, options?: AxiosRequestConfig) {
+        return BookingEntriesApiFp(this.configuration).createOrCorrectOpeningBalance(requestParameters.createOrCorrectOpeningBalanceDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.entries.view\"
      * @summary Retrieve the booking entry
@@ -473,4 +675,16 @@ export class BookingEntriesApi extends BaseAPI {
     public listBookingEntries(requestParameters: BookingEntriesApiListBookingEntriesRequest = {}, options?: AxiosRequestConfig) {
         return BookingEntriesApiFp(this.configuration).listBookingEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+     * @summary Create the booking entry from a source entity
+     * @param {BookingEntriesApiPostFinancialEventRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingEntriesApi
+     */
+    public postFinancialEvent(requestParameters: BookingEntriesApiPostFinancialEventRequest, options?: AxiosRequestConfig) {
+        return BookingEntriesApiFp(this.configuration).postFinancialEvent(requestParameters.postFinancialEventRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
 }