@emilgroup/accounting-sdk-node 1.0.1-beta.3 → 1.0.1-beta.4

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/accounting-sdk-node@1.0.1-beta.3 --save
+npm install @emilgroup/accounting-sdk-node@1.0.1-beta.4 --save
 ```
 or 
 ```
-yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.3
+yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.4
 ```
 
 And then you can import `FinancialAccountsApi`.

package/dist/models/create-booking-entry-request-dto.d.ts

@@ -17,55 +17,61 @@ import { FinancialTransactionDataDto } from './financial-transaction-data-dto';
  */
 export interface CreateBookingEntryRequestDto {
     /**
-     *
+     * The date of the booking entry. This represents when the transaction or booking was recorded.      Defaults to the current date if not provided.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'bookingDate'?: string;
     /**
-     *
+     * A brief description of the booking entry.      This provides context or purpose for the entry, such as \"Monthly premium\" or \"Refund issued\".
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'description': string;
     /**
-     *
+     * The policy number associated with this booking entry.      This uniquely identifies the policy related to the transaction.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'policyNumber': string;
     /**
-     *
+     * The type of entity associated with this entry, such as invoice or payment.      This helps categorize the nature of the booking entry.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'entityName': CreateBookingEntryRequestDtoEntityNameEnum;
     /**
-     *
+     * The unique number assigned to the entity, such as an invoice or payment reference number.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'entityNumber': string;
     /**
-     *
+     * The currency of the transaction amount, defaulting to EUR (Euro) if not otherwise specified.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'currency': CreateBookingEntryRequestDtoCurrencyEnum;
     /**
-     *
+     * The monetary value of the booking entry, expressed as an integer in the smallest currency unit (e.g., cents for EUR). Must be a non-negative integer.
      * @type {number}
      * @memberof CreateBookingEntryRequestDto
      */
     'amount': number;
     /**
-     *
+     * An optional identifier for the booking process associated with this entry.      This helps to link the entry to a specific booking process if applicable.
      * @type {number}
      * @memberof CreateBookingEntryRequestDto
      */
     'bookingProcessId'?: number;
     /**
-     *
+     * Optional key-value pairs containing additional custom information for the booking entry.      These fields may include document numbers, reasons, or other contextual metadata.
+     * @type {object}
+     * @memberof CreateBookingEntryRequestDto
+     */
+    'customFields': object;
+    /**
+     * An array of financial transactions associated with this booking entry.      Each transaction includes details such as financial account, amount, and debit or credit status.
      * @type {Array<FinancialTransactionDataDto>}
      * @memberof CreateBookingEntryRequestDto
      */

package/dist/models/create-booking-process-request-dto.d.ts

@@ -17,25 +17,31 @@ import { CreateBookingEntryRequestDto } from './create-booking-entry-request-dto
  */
 export interface CreateBookingProcessRequestDto {
     /**
-     *
+     * The unique policy number associated with this booking process.      This is used to identify the relevant insurance policy or agreement for which the booking process is being created.
      * @type {string}
      * @memberof CreateBookingProcessRequestDto
      */
     'policyNumber': string;
     /**
-     *
+     * The current status of the booking process, indicating its completion or settlement stage, such as invoiced or paid, etc...
      * @type {string}
      * @memberof CreateBookingProcessRequestDto
      */
     'status': CreateBookingProcessRequestDtoStatusEnum;
     /**
-     *
+     * The type of booking process being created, such as recurringInvoice or \"     initialInvoice. This helps categorize the nature of the booking within the system.
      * @type {string}
      * @memberof CreateBookingProcessRequestDto
      */
     'bookingProcessType': CreateBookingProcessRequestDtoBookingProcessTypeEnum;
     /**
-     *
+     * Optional key-value pairs containing additional custom information for the booking process.      These fields allow flexibility to include metadata or specific attributes related to the booking.
+     * @type {object}
+     * @memberof CreateBookingProcessRequestDto
+     */
+    'customFields': object;
+    /**
+     * An array of booking entries associated with this booking process.      Each entry represents an individual transaction or action related to the booking and contains details such as amount, date, and descriptions.
      * @type {Array<CreateBookingEntryRequestDto>}
      * @memberof CreateBookingProcessRequestDto
      */

package/dist/models/create-financial-account-request-dto.d.ts

@@ -16,35 +16,41 @@
  */
 export interface CreateFinancialAccountRequestDto {
     /**
-     *
+     * The name of the financial account. This is a descriptive label used to identify the account within the system.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'name': string;
     /**
-     *
+     * The unique account number assigned to this financial account.      This number is used to route transactions and manage the account within the financial system.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'financialAccountNumber': string;
     /**
-     *
+     * The type of financial account, specifying its category or classification,      such as asset, equity, or expense. This categorization helps in accounting and reporting.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'type': CreateFinancialAccountRequestDtoTypeEnum;
     /**
-     *
+     * An optional code representing the entity associated with this account.      Useful for associating the account with specific organizational entities or departments.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'entityCode'?: string;
     /**
-     *
+     * An optional identifier for the parent account.      If provided, this allows the creation of sub-accounts under a parent financial account, establishing a hierarchy.
      * @type {number}
      * @memberof CreateFinancialAccountRequestDto
      */
     'parentId'?: number;
+    /**
+     * Optional key-value pairs to store additional custom metadata or specific attributes related to the financial account, such as account purpose or manager.
+     * @type {object}
+     * @memberof CreateFinancialAccountRequestDto
+     */
+    'customFields': object;
 }
 export declare const CreateFinancialAccountRequestDtoTypeEnum: {
     readonly Asset: "asset";

package/dist/models/financial-transaction-data-dto.d.ts

@@ -16,43 +16,49 @@
  */
 export interface FinancialTransactionDataDto {
     /**
-     *
+     * The unique identifier of the financial account associated with the transaction.      This is used to route the transaction to the correct account in the financial ledger.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'financialAccountNumber': string;
     /**
-     *
+     * The monetary value of the transaction, expressed as an integer in the smallest currency unit (e.g., cents).    This represents the exact amount being debited or credited. The value must be an integer.
      * @type {number}
      * @memberof FinancialTransactionDataDto
      */
     'amount': number;
     /**
-     *
+     * Specifies whether the transaction is a debit or a credit.      A debit indicates an outgoing payment, while a credit represents incoming funds.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'debitCredit': FinancialTransactionDataDtoDebitCreditEnum;
     /**
-     *
+     * The unique number assigned to the partner involved in the transaction,      typically representing a customer, supplier, or other associated party.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'partnerNumber': string;
     /**
-     *
+     * An optional grouping identifier for the partner, used for categorization and reporting purposes.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'partnerGroup'?: string;
     /**
-     *
+     * The policy number related to this transaction, used for referencing the associated insurance policy or agreement.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'policyNumber': string;
     /**
-     *
+     * Optional additional information related to the transaction, structured as key-value pairs.      These fields may include metadata, identifiers, or contextual details for custom processing.
+     * @type {object}
+     * @memberof FinancialTransactionDataDto
+     */
+    'customFields': object;
+    /**
+     * A brief summary of the transaction, providing context or purpose, such as \"Payment of invoice #1234\" or \"Monthly premium for policy #5678\".
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */

package/models/create-booking-entry-request-dto.ts

@@ -22,55 +22,61 @@ import { FinancialTransactionDataDto } from './financial-transaction-data-dto';
  */
 export interface CreateBookingEntryRequestDto {
     /**
-     * 
+     * The date of the booking entry. This represents when the transaction or booking was recorded.      Defaults to the current date if not provided.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'bookingDate'?: string;
     /**
-     * 
+     * A brief description of the booking entry.      This provides context or purpose for the entry, such as \"Monthly premium\" or \"Refund issued\".
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'description': string;
     /**
-     * 
+     * The policy number associated with this booking entry.      This uniquely identifies the policy related to the transaction.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'policyNumber': string;
     /**
-     * 
+     * The type of entity associated with this entry, such as invoice or payment.      This helps categorize the nature of the booking entry.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'entityName': CreateBookingEntryRequestDtoEntityNameEnum;
     /**
-     * 
+     * The unique number assigned to the entity, such as an invoice or payment reference number.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'entityNumber': string;
     /**
-     * 
+     * The currency of the transaction amount, defaulting to EUR (Euro) if not otherwise specified.
      * @type {string}
      * @memberof CreateBookingEntryRequestDto
      */
     'currency': CreateBookingEntryRequestDtoCurrencyEnum;
     /**
-     * 
+     * The monetary value of the booking entry, expressed as an integer in the smallest currency unit (e.g., cents for EUR). Must be a non-negative integer.
      * @type {number}
      * @memberof CreateBookingEntryRequestDto
      */
     'amount': number;
     /**
-     * 
+     * An optional identifier for the booking process associated with this entry.      This helps to link the entry to a specific booking process if applicable.
      * @type {number}
      * @memberof CreateBookingEntryRequestDto
      */
     'bookingProcessId'?: number;
     /**
-     * 
+     * Optional key-value pairs containing additional custom information for the booking entry.      These fields may include document numbers, reasons, or other contextual metadata.
+     * @type {object}
+     * @memberof CreateBookingEntryRequestDto
+     */
+    'customFields': object;
+    /**
+     * An array of financial transactions associated with this booking entry.      Each transaction includes details such as financial account, amount, and debit or credit status.
      * @type {Array<FinancialTransactionDataDto>}
      * @memberof CreateBookingEntryRequestDto
      */

package/models/create-booking-process-request-dto.ts

@@ -22,25 +22,31 @@ import { CreateBookingEntryRequestDto } from './create-booking-entry-request-dto
  */
 export interface CreateBookingProcessRequestDto {
     /**
-     * 
+     * The unique policy number associated with this booking process.      This is used to identify the relevant insurance policy or agreement for which the booking process is being created.
      * @type {string}
      * @memberof CreateBookingProcessRequestDto
      */
     'policyNumber': string;
     /**
-     * 
+     * The current status of the booking process, indicating its completion or settlement stage, such as invoiced or paid, etc...
      * @type {string}
      * @memberof CreateBookingProcessRequestDto
      */
     'status': CreateBookingProcessRequestDtoStatusEnum;
     /**
-     * 
+     * The type of booking process being created, such as recurringInvoice or \"     initialInvoice. This helps categorize the nature of the booking within the system.
      * @type {string}
      * @memberof CreateBookingProcessRequestDto
      */
     'bookingProcessType': CreateBookingProcessRequestDtoBookingProcessTypeEnum;
     /**
-     * 
+     * Optional key-value pairs containing additional custom information for the booking process.      These fields allow flexibility to include metadata or specific attributes related to the booking.
+     * @type {object}
+     * @memberof CreateBookingProcessRequestDto
+     */
+    'customFields': object;
+    /**
+     * An array of booking entries associated with this booking process.      Each entry represents an individual transaction or action related to the booking and contains details such as amount, date, and descriptions.
      * @type {Array<CreateBookingEntryRequestDto>}
      * @memberof CreateBookingProcessRequestDto
      */

package/models/create-financial-account-request-dto.ts

@@ -21,35 +21,41 @@
  */
 export interface CreateFinancialAccountRequestDto {
     /**
-     * 
+     * The name of the financial account. This is a descriptive label used to identify the account within the system.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'name': string;
     /**
-     * 
+     * The unique account number assigned to this financial account.      This number is used to route transactions and manage the account within the financial system.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'financialAccountNumber': string;
     /**
-     * 
+     * The type of financial account, specifying its category or classification,      such as asset, equity, or expense. This categorization helps in accounting and reporting.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'type': CreateFinancialAccountRequestDtoTypeEnum;
     /**
-     * 
+     * An optional code representing the entity associated with this account.      Useful for associating the account with specific organizational entities or departments.
      * @type {string}
      * @memberof CreateFinancialAccountRequestDto
      */
     'entityCode'?: string;
     /**
-     * 
+     * An optional identifier for the parent account.      If provided, this allows the creation of sub-accounts under a parent financial account, establishing a hierarchy.
      * @type {number}
      * @memberof CreateFinancialAccountRequestDto
      */
     'parentId'?: number;
+    /**
+     * Optional key-value pairs to store additional custom metadata or specific attributes related to the financial account, such as account purpose or manager.
+     * @type {object}
+     * @memberof CreateFinancialAccountRequestDto
+     */
+    'customFields': object;
 }
 
 export const CreateFinancialAccountRequestDtoTypeEnum = {

package/models/financial-transaction-data-dto.ts

@@ -21,43 +21,49 @@
  */
 export interface FinancialTransactionDataDto {
     /**
-     * 
+     * The unique identifier of the financial account associated with the transaction.      This is used to route the transaction to the correct account in the financial ledger.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'financialAccountNumber': string;
     /**
-     * 
+     * The monetary value of the transaction, expressed as an integer in the smallest currency unit (e.g., cents).    This represents the exact amount being debited or credited. The value must be an integer.
      * @type {number}
      * @memberof FinancialTransactionDataDto
      */
     'amount': number;
     /**
-     * 
+     * Specifies whether the transaction is a debit or a credit.      A debit indicates an outgoing payment, while a credit represents incoming funds.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'debitCredit': FinancialTransactionDataDtoDebitCreditEnum;
     /**
-     * 
+     * The unique number assigned to the partner involved in the transaction,      typically representing a customer, supplier, or other associated party.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'partnerNumber': string;
     /**
-     * 
+     * An optional grouping identifier for the partner, used for categorization and reporting purposes.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'partnerGroup'?: string;
     /**
-     * 
+     * The policy number related to this transaction, used for referencing the associated insurance policy or agreement.
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */
     'policyNumber': string;
     /**
-     * 
+     * Optional additional information related to the transaction, structured as key-value pairs.      These fields may include metadata, identifiers, or contextual details for custom processing.
+     * @type {object}
+     * @memberof FinancialTransactionDataDto
+     */
+    'customFields': object;
+    /**
+     * A brief summary of the transaction, providing context or purpose, such as \"Payment of invoice #1234\" or \"Monthly premium for policy #5678\".
      * @type {string}
      * @memberof FinancialTransactionDataDto
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/accounting-sdk-node",
-  "version": "1.0.1-beta.3",
+  "version": "1.0.1-beta.4",
   "description": "OpenAPI client for @emilgroup/accounting-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [