@emilgroup/accounting-sdk-node 1.19.0 → 1.20.0

package/models/financial-account-class.ts

@@ -0,0 +1,120 @@
+/* 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 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 partner number of the account.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'partnerNumber': 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;
+    /**
+     * The description of the account.
+     * @type {string}
+     * @memberof FinancialAccountClass
+     */
+    'description': string;
+    /**
+     * Whether the account is clearable.
+     * @type {boolean}
+     * @memberof FinancialAccountClass
+     */
+    'clearable': boolean;
+    /**
+     * 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 const FinancialAccountClassTypeEnum = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense',
+    OpeningBalance: 'opening_balance'
+} as const;
+
+export type FinancialAccountClassTypeEnum = typeof FinancialAccountClassTypeEnum[keyof typeof FinancialAccountClassTypeEnum];
+
+

package/models/financial-transaction-class.ts

@@ -0,0 +1,120 @@
+/* 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 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 personal account number that this transaction is related to. This is typically a personal account number.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'personalAccountNumber'?: 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;
+    /**
+     * 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;
+    /**
+     * The date of the booking entry. This represents when the booking was recorded.      Defaults to the current date if not provided.
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    '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 FinancialTransactionClass
+     */
+    'documentDate': string;
+    /**
+     * The type of the transaction. Possible values are \"OPENING_BALANCE\", \"NORMAL\", \"ADJUSTMENT\".
+     * @type {string}
+     * @memberof FinancialTransactionClass
+     */
+    'transactionType': string;
+    /**
+     * 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/models/financial-transaction-data-dto.ts

@@ -0,0 +1,81 @@
+/* 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 FinancialTransactionDataDto
+ */
+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 personal account number associated with the transaction.      This is used to identify the specific account involved in the transaction.
+     * @type {string}
+     * @memberof FinancialTransactionDataDto
+     */
+    'personalAccountNumber'?: string;
+    /**
+     * 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
+     */
+    'description': 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. Negative values indicate a reversal or deduction, while positive values indicate an addition.
+     * @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;
+    /**
+     * 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;
+    /**
+     * Specifies the type of the transaction.     This can be used to categorize transactions for reporting, analysis, or filtering purposes.
+     * @type {string}
+     * @memberof FinancialTransactionDataDto
+     */
+    'transactionType': FinancialTransactionDataDtoTransactionTypeEnum;
+}
+
+export const FinancialTransactionDataDtoDebitCreditEnum = {
+    Debit: 'DEBIT',
+    Credit: 'CREDIT'
+} as const;
+
+export type FinancialTransactionDataDtoDebitCreditEnum = typeof FinancialTransactionDataDtoDebitCreditEnum[keyof typeof FinancialTransactionDataDtoDebitCreditEnum];
+export const FinancialTransactionDataDtoTransactionTypeEnum = {
+    OpeningBalance: 'OPENING_BALANCE',
+    Adjustment: 'ADJUSTMENT',
+    Normal: 'NORMAL'
+} as const;
+
+export type FinancialTransactionDataDtoTransactionTypeEnum = typeof FinancialTransactionDataDtoTransactionTypeEnum[keyof typeof FinancialTransactionDataDtoTransactionTypeEnum];
+
+

package/models/get-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 GetBookingEntryResponseClass
+ */
+export interface GetBookingEntryResponseClass {
+    /**
+     * The booking-entry response.
+     * @type {BookingEntryClass}
+     * @memberof GetBookingEntryResponseClass
+     */
+    'bookingEntry': BookingEntryClass;
+}
+

package/models/get-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 GetFinancialAccountResponseClass
+ */
+export interface GetFinancialAccountResponseClass {
+    /**
+     * The financial account response.
+     * @type {FinancialAccountClass}
+     * @memberof GetFinancialAccountResponseClass
+     */
+    'financialAccount': FinancialAccountClass;
+}
+

package/models/get-financial-transaction-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 { FinancialTransactionClass } from './financial-transaction-class';
+
+/**
+ * 
+ * @export
+ * @interface GetFinancialTransactionResponseClass
+ */
+export interface GetFinancialTransactionResponseClass {
+    /**
+     * The financial-transaction response.
+     * @type {FinancialTransactionClass}
+     * @memberof GetFinancialTransactionResponseClass
+     */
+    'financialTransaction': FinancialTransactionClass;
+}
+

package/models/get-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 GetNumberRangeResponseClass
+ */
+export interface GetNumberRangeResponseClass {
+    /**
+     * The number range response.
+     * @type {NumberRangeClass}
+     * @memberof GetNumberRangeResponseClass
+     */
+    'numberRange': NumberRangeClass;
+}
+

package/models/get-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 GetPersonalAccountResponseClass
+ */
+export interface GetPersonalAccountResponseClass {
+    /**
+     * The personal account response.
+     * @type {PersonalAccountClass}
+     * @memberof GetPersonalAccountResponseClass
+     */
+    'personalAccount': PersonalAccountClass;
+}
+

package/models/index.ts

@@ -1,48 +1,26 @@
-export * from './address-class';
-export * from './create-mailbox-request-dto';
-export * from './create-user-request-dto';
-export * from './create-user-response-class';
-export * from './create-vba-request-dto';
-export * from './create-vba-response-class';
-export * from './create-vbu-request-dto';
-export * from './create-vbu-response-class';
-export * from './create-vbuv-request-dto';
-export * from './create-vbuv-response-class';
-export * from './get-request-message-response-class';
-export * from './get-response-message-response-class';
-export * from './get-user-response-class';
-export * from './get-vba-response-class';
-export * from './get-vbu-response-class';
-export * from './get-zip-code-response-class';
+export * from './booking-entry-class';
+export * from './create-booking-entry-request-dto';
+export * from './create-booking-entry-response-class';
+export * from './create-financial-account-request-dto';
+export * from './create-financial-account-response-class';
+export * from './create-number-range-request-dto';
+export * from './create-number-range-response-class';
+export * from './create-personal-account-request-dto';
+export * from './create-personal-account-response-class';
+export * from './financial-account-class';
+export * from './financial-transaction-class';
+export * from './financial-transaction-data-dto';
+export * from './get-booking-entry-response-class';
+export * from './get-financial-account-response-class';
+export * from './get-financial-transaction-response-class';
+export * from './get-number-range-response-class';
+export * from './get-personal-account-response-class';
 export * from './inline-response200';
 export * from './inline-response503';
-export * from './list-all-messages-response-class';
-export * from './list-requests-messages-response-class';
-export * from './list-responses-messages-response-class';
-export * from './list-users-response-class';
-export * from './list-vbas-response-class';
-export * from './list-vbus-response-class';
-export * from './list-zip-codes-response-class';
-export * from './message-class';
-export * from './request-details-class';
-export * from './request-message-class';
-export * from './response-details-class';
-export * from './response-message-class';
-export * from './store-zip-codes-request-dto';
-export * from './store-zip-codes-response-class';
-export * from './update-request-message-request-dto';
-export * from './update-request-message-response-class';
-export * from './update-response-message-request-dto';
-export * from './update-response-message-response-class';
-export * from './update-user-request-dto';
-export * from './update-user-response-class';
-export * from './update-vba-request-dto';
-export * from './update-vbu-request-dto';
-export * from './update-vbu-response-class';
-export * from './user-class';
-export * from './vba-class';
-export * from './vba-response-class';
-export * from './vbu-class';
-export * from './vbu-response-class';
-export * from './xlsx-zip-code-dto';
-export * from './zip-code-class';
+export * from './list-booking-entries-response-class';
+export * from './list-financial-accounts-response-class';
+export * from './list-financial-transactions-response-class';
+export * from './list-number-range-response-class';
+export * from './list-personal-accounts-response-class';
+export * from './number-range-class';
+export * from './personal-account-class';

package/models/inline-response200.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/inline-response503.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/list-booking-entries-response-class.ts

@@ -0,0 +1,37 @@
+/* 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 ListBookingEntriesResponseClass
+ */
+export interface ListBookingEntriesResponseClass {
+    /**
+     * Booking entries
+     * @type {Array<BookingEntryClass>}
+     * @memberof ListBookingEntriesResponseClass
+     */
+    'items': Array<BookingEntryClass>;
+    /**
+     * The next page token
+     * @type {string}
+     * @memberof ListBookingEntriesResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/list-financial-accounts-response-class.ts

@@ -0,0 +1,37 @@
+/* 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 ListFinancialAccountsResponseClass
+ */
+export interface ListFinancialAccountsResponseClass {
+    /**
+     * The list of financial accounts.
+     * @type {Array<FinancialAccountClass>}
+     * @memberof ListFinancialAccountsResponseClass
+     */
+    'items': Array<FinancialAccountClass>;
+    /**
+     * Next page token
+     * @type {string}
+     * @memberof ListFinancialAccountsResponseClass
+     */
+    'nextPageToken': string;
+}
+