@emilgroup/accounting-sdk-node 1.13.0 → 1.13.1-beta.0

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

@@ -0,0 +1,99 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FinancialTransactionDataDto } from './financial-transaction-data-dto';
+/**
+ *
+ * @export
+ * @interface CreateBookingEntryRequestDto
+ */
+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
+     */
+    'financialTransactions': Array<FinancialTransactionDataDto>;
+}
+export declare const CreateBookingEntryRequestDtoEntityNameEnum: {
+    readonly Claim: "claim";
+    readonly Invoice: "invoice";
+    readonly Payment: "payment";
+};
+export type CreateBookingEntryRequestDtoEntityNameEnum = typeof CreateBookingEntryRequestDtoEntityNameEnum[keyof typeof CreateBookingEntryRequestDtoEntityNameEnum];
+export declare const CreateBookingEntryRequestDtoCurrencyEnum: {
+    readonly Eur: "EUR";
+    readonly Usd: "USD";
+    readonly Gbp: "GBP";
+    readonly Chf: "CHF";
+    readonly Pln: "PLN";
+    readonly Aud: "AUD";
+    readonly Cad: "CAD";
+    readonly Ddk: "DDK";
+    readonly Huf: "HUF";
+    readonly Nok: "NOK";
+    readonly Sek: "SEK";
+};
+export type CreateBookingEntryRequestDtoCurrencyEnum = typeof CreateBookingEntryRequestDtoCurrencyEnum[keyof typeof CreateBookingEntryRequestDtoCurrencyEnum];

package/dist/models/create-booking-entry-request-dto.js

@@ -0,0 +1,34 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBookingEntryRequestDtoCurrencyEnum = exports.CreateBookingEntryRequestDtoEntityNameEnum = void 0;
+exports.CreateBookingEntryRequestDtoEntityNameEnum = {
+    Claim: 'claim',
+    Invoice: 'invoice',
+    Payment: 'payment'
+};
+exports.CreateBookingEntryRequestDtoCurrencyEnum = {
+    Eur: 'EUR',
+    Usd: 'USD',
+    Gbp: 'GBP',
+    Chf: 'CHF',
+    Pln: 'PLN',
+    Aud: 'AUD',
+    Cad: 'CAD',
+    Ddk: 'DDK',
+    Huf: 'HUF',
+    Nok: 'NOK',
+    Sek: 'SEK'
+};

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

@@ -0,0 +1,64 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CreateBookingEntryRequestDto } from './create-booking-entry-request-dto';
+/**
+ *
+ * @export
+ * @interface CreateBookingProcessRequestDto
+ */
+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
+     */
+    'bookingEntries': Array<CreateBookingEntryRequestDto>;
+}
+export declare const CreateBookingProcessRequestDtoStatusEnum: {
+    readonly Invoiced: "invoiced";
+    readonly Paid: "paid";
+    readonly Open: "open";
+};
+export type CreateBookingProcessRequestDtoStatusEnum = typeof CreateBookingProcessRequestDtoStatusEnum[keyof typeof CreateBookingProcessRequestDtoStatusEnum];
+export declare const CreateBookingProcessRequestDtoBookingProcessTypeEnum: {
+    readonly TerminationInvoice: "terminationInvoice";
+    readonly ClaimsPayment: "claimsPayment";
+    readonly WithdrawnInvoice: "withdrawnInvoice";
+    readonly CorrectionInvoice: "correctionInvoice";
+    readonly RecurringInvoice: "recurringInvoice";
+    readonly InitialInvoice: "initialInvoice";
+};
+export type CreateBookingProcessRequestDtoBookingProcessTypeEnum = typeof CreateBookingProcessRequestDtoBookingProcessTypeEnum[keyof typeof CreateBookingProcessRequestDtoBookingProcessTypeEnum];

package/dist/models/create-booking-process-request-dto.js

@@ -0,0 +1,29 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBookingProcessRequestDtoBookingProcessTypeEnum = exports.CreateBookingProcessRequestDtoStatusEnum = void 0;
+exports.CreateBookingProcessRequestDtoStatusEnum = {
+    Invoiced: 'invoiced',
+    Paid: 'paid',
+    Open: 'open'
+};
+exports.CreateBookingProcessRequestDtoBookingProcessTypeEnum = {
+    TerminationInvoice: 'terminationInvoice',
+    ClaimsPayment: 'claimsPayment',
+    WithdrawnInvoice: 'withdrawnInvoice',
+    CorrectionInvoice: 'correctionInvoice',
+    RecurringInvoice: 'recurringInvoice',
+    InitialInvoice: 'initialInvoice'
+};

package/dist/models/create-booking-process-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BookingProcessClass } from './booking-process-class';
+/**
+ *
+ * @export
+ * @interface CreateBookingProcessResponseClass
+ */
+export interface CreateBookingProcessResponseClass {
+    /**
+     * The booking-process response.
+     * @type {BookingProcessClass}
+     * @memberof CreateBookingProcessResponseClass
+     */
+    'bookingProcess': BookingProcessClass;
+}

package/dist/models/{address-class.js → create-booking-process-response-class.js}

@@ -2,8 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de

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

@@ -0,0 +1,62 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateFinancialAccountRequestDto
+ */
+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";
+    readonly Liability: "liability";
+    readonly Equity: "equity";
+    readonly Revenue: "revenue";
+    readonly Expense: "expense";
+};
+export type CreateFinancialAccountRequestDtoTypeEnum = typeof CreateFinancialAccountRequestDtoTypeEnum[keyof typeof CreateFinancialAccountRequestDtoTypeEnum];

package/dist/models/{create-user-request-dto.js → create-financial-account-request-dto.js}

@@ -2,8 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -13,12 +13,11 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateUserRequestDtoModeEnum = exports.CreateUserRequestDtoTypeEnum = void 0;
-exports.CreateUserRequestDtoTypeEnum = {
-    Vu: 'VU',
-    Vm: 'VM'
-};
-exports.CreateUserRequestDtoModeEnum = {
-    Tu: 'TU',
-    Pp: 'PP'
+exports.CreateFinancialAccountRequestDtoTypeEnum = void 0;
+exports.CreateFinancialAccountRequestDtoTypeEnum = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense'
 };

package/dist/models/create-financial-account-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FinancialAccountClass } from './financial-account-class';
+/**
+ *
+ * @export
+ * @interface CreateFinancialAccountResponseClass
+ */
+export interface CreateFinancialAccountResponseClass {
+    /**
+     * The financial account response.
+     * @type {FinancialAccountClass}
+     * @memberof CreateFinancialAccountResponseClass
+     */
+    'financialAccount': FinancialAccountClass;
+}

package/dist/models/{create-user-response-class.js → create-financial-account-response-class.js}

@@ -2,8 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de

package/dist/models/financial-account-class.d.ts

@@ -0,0 +1,98 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FinancialAccountClass
+ */
+export interface FinancialAccountClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof FinancialAccountClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'code': string;
+    /**
+     * The name of the account.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'name': string;
+    /**
+     * The financial account number.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'financialAccountNumber': string;
+    /**
+     * The ID of the parent account, if any.
+     * @type {number}
+     * @memberof FinancialAccountClass
+     */
+    'parentId': number;
+    /**
+     * The entity code of the account (account code, bank account code, etc...).
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'entityCode': string;
+    /**
+     * The type of account, e.g. \"Asset\", \"Liability\", \"Equity\", \"Revenue\", \"Expense\".
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'type': FinancialAccountClassTypeEnum;
+    /**
+     * Metadata about the object.
+     * @type {object}
+     * @memberof FinancialAccountClass
+     */
+    'customFields': object;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'updatedBy': string;
+}
+export declare const FinancialAccountClassTypeEnum: {
+    readonly Asset: "asset";
+    readonly Liability: "liability";
+    readonly Equity: "equity";
+    readonly Revenue: "revenue";
+    readonly Expense: "expense";
+};
+export type FinancialAccountClassTypeEnum = typeof FinancialAccountClassTypeEnum[keyof typeof FinancialAccountClassTypeEnum];

package/dist/models/{user-class.js → financial-account-class.js}

@@ -2,8 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -13,8 +13,11 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserClassModeEnum = void 0;
-exports.UserClassModeEnum = {
-    Tu: 'TU',
-    Pp: 'PP'
+exports.FinancialAccountClassTypeEnum = void 0;
+exports.FinancialAccountClassTypeEnum = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense'
 };

package/dist/models/financial-transaction-class.d.ts

@@ -0,0 +1,108 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FinancialTransactionClass
+ */
+export interface FinancialTransactionClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof FinancialTransactionClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'code': string;
+    /**
+     * A brief description or note associated with the financial transaction, providing additional context about the transaction.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'description': string;
+    /**
+     * The financial account number that this transaction is related to. This is typically a general ledger account number.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'financialAccountNumber': string;
+    /**
+     * The partner number that this transaction is related to. This is typically a customer or supplier number.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'partnerNumber': string;
+    /**
+     * The partner group that this transaction is related to. This is typically a customer or supplier group.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'partnerGroup'?: string;
+    /**
+     * Internal identifier for the associated booking entry. This links the transaction to a specific entry in the booking system.
+     * @type {number}
+     * @memberof FinancialTransactionClass
+     */
+    'bookingEntryId': number;
+    /**
+     * Indicates whether the transaction is a debit or credit. Possible values are \"DEBIT\" or \"CREDIT\".
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'debitCredit': string;
+    /**
+     * Indicates whether the transaction is \"soll\" or \"haben\" (typically the same as \"debit\" or \"credit\" in English). This is a simplification for German users.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'sollHaben': string;
+    /**
+     * The total amount of the transaction, represented in cents (e.g., 1550 means €15.50). This value is required for all transactions.
+     * @type {number}
+     * @memberof FinancialTransactionClass
+     */
+    'amount': number;
+    /**
+     * A flexible JSON object that allows tenants to include any custom fields.      The keys represent the names of the custom fields, and the values can be of any data type.      This enables tenants to store specific data that may vary by use case, such as additional metadata or custom attributes.
+     * @type {object}
+     * @memberof FinancialTransactionClass
+     */
+    'customFields'?: object;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'updatedBy': string;
+}

package/dist/models/{create-mailbox-request-dto.js → financial-transaction-class.js}

@@ -2,8 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de