@emilgroup/accounting-sdk-node 1.10.0 → 1.11.1-beta.0

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

@@ -0,0 +1,74 @@
+/* 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 { 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 const CreateBookingProcessRequestDtoStatusEnum = {
+    Invoiced: 'invoiced',
+    Paid: 'paid',
+    Open: 'open'
+} as const;
+
+export type CreateBookingProcessRequestDtoStatusEnum = typeof CreateBookingProcessRequestDtoStatusEnum[keyof typeof CreateBookingProcessRequestDtoStatusEnum];
+export const CreateBookingProcessRequestDtoBookingProcessTypeEnum = {
+    TerminationInvoice: 'terminationInvoice',
+    ClaimsPayment: 'claimsPayment',
+    WithdrawnInvoice: 'withdrawnInvoice',
+    CorrectionInvoice: 'correctionInvoice',
+    RecurringInvoice: 'recurringInvoice',
+    InitialInvoice: 'initialInvoice'
+} as const;
+
+export type CreateBookingProcessRequestDtoBookingProcessTypeEnum = typeof CreateBookingProcessRequestDtoBookingProcessTypeEnum[keyof typeof CreateBookingProcessRequestDtoBookingProcessTypeEnum];
+
+

package/models/create-booking-process-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 { BookingProcessClass } from './booking-process-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateBookingProcessResponseClass
+ */
+export interface CreateBookingProcessResponseClass {
+    /**
+     * The booking-process response.
+     * @type {BookingProcessClass}
+     * @memberof CreateBookingProcessResponseClass
+     */
+    'bookingProcess': BookingProcessClass;
+}
+

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

@@ -0,0 +1,71 @@
+/* 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 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 = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense'
+} 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/financial-account-class.ts

@@ -0,0 +1,107 @@
+/* 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 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 const FinancialAccountClassTypeEnum = {
+    Asset: 'asset',
+    Liability: 'liability',
+    Equity: 'equity',
+    Revenue: 'revenue',
+    Expense: 'expense'
+} as const;
+
+export type FinancialAccountClassTypeEnum = typeof FinancialAccountClassTypeEnum[keyof typeof FinancialAccountClassTypeEnum];
+
+

package/models/financial-transaction-class.ts

@@ -0,0 +1,114 @@
+/* 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 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/models/financial-transaction-data-dto.ts

@@ -0,0 +1,80 @@
+/* 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 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
+     */
+    'description': string;
+}
+
+export const FinancialTransactionDataDtoDebitCreditEnum = {
+    Debit: 'DEBIT',
+    Credit: 'CREDIT'
+} as const;
+
+export type FinancialTransactionDataDtoDebitCreditEnum = typeof FinancialTransactionDataDtoDebitCreditEnum[keyof typeof FinancialTransactionDataDtoDebitCreditEnum];
+
+

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/index.ts

@@ -1,48 +1,15 @@
-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 './booking-process-class';
+export * from './create-booking-entry-request-dto';
+export * from './create-booking-process-request-dto';
+export * from './create-booking-process-response-class';
+export * from './create-financial-account-request-dto';
+export * from './create-financial-account-response-class';
+export * from './financial-account-class';
+export * from './financial-transaction-class';
+export * from './financial-transaction-data-dto';
+export * from './get-financial-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-process-response-class';
+export * from './list-financial-accounts-response-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-process-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 { BookingProcessClass } from './booking-process-class';
+
+/**
+ * 
+ * @export
+ * @interface ListBookingProcessResponseClass
+ */
+export interface ListBookingProcessResponseClass {
+    /**
+     * The list of booking processs.
+     * @type {Array<BookingProcessClass>}
+     * @memberof ListBookingProcessResponseClass
+     */
+    'items': Array<BookingProcessClass>;
+    /**
+     * Next page token
+     * @type {string}
+     * @memberof ListBookingProcessResponseClass
+     */
+    'nextPageToken': string;
+}
+