@emilgroup/accounting-sdk-node 1.19.0 → 1.20.0

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

@@ -0,0 +1,105 @@
+/**
+ * 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 PersonalAccountClass
+ */
+export interface PersonalAccountClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PersonalAccountClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'code': string;
+    /**
+     * The name of the account.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'name': string;
+    /**
+     * The personal account number.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'personalAccountNumber': string;
+    /**
+     * The financial account number.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'financialAccountNumber': string;
+    /**
+     * The partner number of the account (account number, partner number, etc...).
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'partnerNumber': string;
+    /**
+     * The entity code of the account (account code, bank account code, etc...).
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'entityCode'?: string;
+    /**
+     * The type of account, e.g. \"Asset\", \"Liability\", \"Equity\", \"Revenue\", \"Expense\".
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'type': PersonalAccountClassTypeEnum;
+    /**
+     * Metadata about the object.
+     * @type {object}
+     * @memberof PersonalAccountClass
+     */
+    'customFields'?: object;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PersonalAccountClass
+     */
+    'updatedBy': string;
+}
+export declare const PersonalAccountClassTypeEnum: {
+    readonly Asset: "asset";
+    readonly Liability: "liability";
+    readonly Equity: "equity";
+    readonly Revenue: "revenue";
+    readonly Expense: "expense";
+    readonly OpeningBalance: "opening_balance";
+};
+export type PersonalAccountClassTypeEnum = typeof PersonalAccountClassTypeEnum[keyof typeof PersonalAccountClassTypeEnum];

package/dist/models/{create-user-request-dto.js → personal-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,12 +13,12 @@
  * 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.PersonalAccountClassTypeEnum = void 0;
+exports.PersonalAccountClassTypeEnum = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense',
+    OpeningBalance: 'opening_balance'
 };

package/index.ts

@@ -1,8 +1,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/models/booking-entry-class.ts

@@ -0,0 +1,132 @@
+/* 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.
+ */
+
+
+import { FinancialTransactionClass } from './financial-transaction-class';
+
+/**
+ * 
+ * @export
+ * @interface BookingEntryClass
+ */
+export interface BookingEntryClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof BookingEntryClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'code': string;
+    /**
+     * The total monetary amount of this booking entry. This amount is distributed among the associated transactions.
+     * @type {number}
+     * @memberof BookingEntryClass
+     */
+    'amount': number;
+    /**
+     * The currency in which the booking entry amount is denominated.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'currency': BookingEntryClassCurrencyEnum;
+    /**
+     * The date of the booking entry. This represents when the booking was recorded.      Defaults to the current date if not provided.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'bookingDate': string;
+    /**
+     * The date of the document. This represents when the document was recorded.      Defaults to the current date if not provided.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'documentDate': 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 BookingEntryClass
+     */
+    'description': string;
+    /**
+     * 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 additional metadata or custom attributes that are specific to their use case.
+     * @type {object}
+     * @memberof BookingEntryClass
+     */
+    'customFields'?: object;
+    /**
+     * The unique identifier for the entity (e.g., claim, invoice) associated with this booking entry.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'entityNumber'?: string;
+    /**
+     * The external document number associated with this booking entry.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'externalNumber'?: string;
+    /**
+     * A list of financial transactions associated with this booking entry.      Each entry represents a transaction linked to the current booking.
+     * @type {Array<FinancialTransactionClass>}
+     * @memberof BookingEntryClass
+     */
+    'financialTransactions': Array<FinancialTransactionClass>;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof BookingEntryClass
+     */
+    'updatedBy': string;
+}
+
+export const BookingEntryClassCurrencyEnum = {
+    Eur: 'EUR',
+    Usd: 'USD',
+    Gbp: 'GBP',
+    Chf: 'CHF',
+    Pln: 'PLN',
+    Aud: 'AUD',
+    Cad: 'CAD',
+    Ddk: 'DDK',
+    Huf: 'HUF',
+    Nok: 'NOK',
+    Sek: 'SEK'
+} as const;
+
+export type BookingEntryClassCurrencyEnum = typeof BookingEntryClassCurrencyEnum[keyof typeof BookingEntryClassCurrencyEnum];
+
+

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

@@ -0,0 +1,67 @@
+/* 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.
+ */
+
+
+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.
+     * @type {string}
+     * @memberof CreateBookingEntryRequestDto
+     */
+    'bookingDate': string;
+    /**
+     * The document date of the booking entry. This represents when the document was created or received.
+     * @type {string}
+     * @memberof CreateBookingEntryRequestDto
+     */
+    'documentDate': string;
+    /**
+     * The entity number assigned to the entry, such as an invoice or payment reference number.
+     * @type {string}
+     * @memberof CreateBookingEntryRequestDto
+     */
+    'entityNumber'?: string;
+    /**
+     * The external document number assigned to the entry, such as an invoice or payment reference number.
+     * @type {string}
+     * @memberof CreateBookingEntryRequestDto
+     */
+    'externalNumber'?: 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;
+    /**
+     * 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>;
+}
+

package/models/create-booking-entry-response-class.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+import { BookingEntryClass } from './booking-entry-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateBookingEntryResponseClass
+ */
+export interface CreateBookingEntryResponseClass {
+    /**
+     * The booking-entry response.
+     * @type {BookingEntryClass}
+     * @memberof CreateBookingEntryResponseClass
+     */
+    'bookingEntry': BookingEntryClass;
+}
+

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

@@ -0,0 +1,84 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @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 partner associated with this account.      Useful for associating the account with specific partner in Emil.
+     * @type {string}
+     * @memberof CreateFinancialAccountRequestDto
+     */
+    'partnerNumber'?: 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;
+    /**
+     * A detailed description of the financial account
+     * @type {string}
+     * @memberof CreateFinancialAccountRequestDto
+     */
+    'description': string;
+    /**
+     * Whether the financial account is clearable
+     * @type {boolean}
+     * @memberof CreateFinancialAccountRequestDto
+     */
+    'clearable': boolean;
+}
+
+export const CreateFinancialAccountRequestDtoTypeEnum = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense',
+    OpeningBalance: 'opening_balance'
+} as const;
+
+export type CreateFinancialAccountRequestDtoTypeEnum = typeof CreateFinancialAccountRequestDtoTypeEnum[keyof typeof CreateFinancialAccountRequestDtoTypeEnum];
+
+

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

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+import { FinancialAccountClass } from './financial-account-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateFinancialAccountResponseClass
+ */
+export interface CreateFinancialAccountResponseClass {
+    /**
+     * The financial account response.
+     * @type {FinancialAccountClass}
+     * @memberof CreateFinancialAccountResponseClass
+     */
+    'financialAccount': FinancialAccountClass;
+}
+

package/models/create-number-range-request-dto.ts

@@ -0,0 +1,62 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateNumberRangeRequestDto
+ */
+export interface CreateNumberRangeRequestDto {
+    /**
+     * The slug of the number range
+     * @type {string}
+     * @memberof CreateNumberRangeRequestDto
+     */
+    'slug': string;
+    /**
+     * The minimum value of the number range
+     * @type {number}
+     * @memberof CreateNumberRangeRequestDto
+     */
+    'minValue': number;
+    /**
+     * The maximum value of the number range
+     * @type {number}
+     * @memberof CreateNumberRangeRequestDto
+     */
+    'maxValue': number;
+    /**
+     * The type of the number range
+     * @type {string}
+     * @memberof CreateNumberRangeRequestDto
+     */
+    'accountType': CreateNumberRangeRequestDtoAccountTypeEnum;
+}
+
+export const CreateNumberRangeRequestDtoAccountTypeEnum = {
+    Customer: 'customer',
+    Supplier: 'supplier',
+    Employee: 'employee',
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense'
+} as const;
+
+export type CreateNumberRangeRequestDtoAccountTypeEnum = typeof CreateNumberRangeRequestDtoAccountTypeEnum[keyof typeof CreateNumberRangeRequestDtoAccountTypeEnum];
+
+

package/models/create-number-range-response-class.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+import { NumberRangeClass } from './number-range-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateNumberRangeResponseClass
+ */
+export interface CreateNumberRangeResponseClass {
+    /**
+     * The number range response.
+     * @type {NumberRangeClass}
+     * @memberof CreateNumberRangeResponseClass
+     */
+    'numberRange': NumberRangeClass;
+}
+

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

@@ -0,0 +1,69 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreatePersonalAccountRequestDto
+ */
+export interface CreatePersonalAccountRequestDto {
+    /**
+     * The name of the financial account. This is a descriptive label used to identify the account within the system.
+     * @type {string}
+     * @memberof CreatePersonalAccountRequestDto
+     */
+    '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 CreatePersonalAccountRequestDto
+     */
+    'personalAccountNumber': 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 CreatePersonalAccountRequestDto
+     */
+    'financialAccountNumber': string;
+    /**
+     * The partner number of the account
+     * @type {string}
+     * @memberof CreatePersonalAccountRequestDto
+     */
+    'partnerNumber': string;
+    /**
+     * The type of personal account, specifying its category or classification,      such as customer, supplier, or employee. This categorization helps in accounting and reporting.
+     * @type {string}
+     * @memberof CreatePersonalAccountRequestDto
+     */
+    'type': CreatePersonalAccountRequestDtoTypeEnum;
+    /**
+     * 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 CreatePersonalAccountRequestDto
+     */
+    'customFields'?: object;
+}
+
+export const CreatePersonalAccountRequestDtoTypeEnum = {
+    Customer: 'customer',
+    Supplier: 'supplier',
+    Employee: 'employee'
+} as const;
+
+export type CreatePersonalAccountRequestDtoTypeEnum = typeof CreatePersonalAccountRequestDtoTypeEnum[keyof typeof CreatePersonalAccountRequestDtoTypeEnum];
+
+

package/models/create-personal-account-response-class.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+import { PersonalAccountClass } from './personal-account-class';
+
+/**
+ * 
+ * @export
+ * @interface CreatePersonalAccountResponseClass
+ */
+export interface CreatePersonalAccountResponseClass {
+    /**
+     * The personal account response.
+     * @type {PersonalAccountClass}
+     * @memberof CreatePersonalAccountResponseClass
+     */
+    'personalAccount': PersonalAccountClass;
+}
+