@emilgroup/accounting-sdk-node 1.0.1-beta.3 → 1.0.1-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +2 -2
- package/api/booking-processes-api.ts +192 -4
- package/base.ts +3 -3
- package/dist/api/booking-processes-api.d.ts +114 -4
- package/dist/api/booking-processes-api.js +133 -4
- package/dist/base.d.ts +2 -2
- package/dist/base.js +1 -2
- package/dist/models/create-booking-entry-request-dto.d.ts +15 -9
- package/dist/models/create-booking-process-request-dto.d.ts +10 -4
- package/dist/models/create-financial-account-request-dto.d.ts +11 -5
- package/dist/models/financial-transaction-data-dto.d.ts +13 -7
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/list-booking-process-response-class.d.ts +31 -0
- package/dist/models/list-booking-process-response-class.js +15 -0
- package/models/create-booking-entry-request-dto.ts +15 -9
- package/models/create-booking-process-request-dto.ts +10 -4
- package/models/create-financial-account-request-dto.ts +11 -5
- package/models/financial-transaction-data-dto.ts +13 -7
- package/models/index.ts +1 -0
- package/models/list-booking-process-response-class.ts +37 -0
- package/package.json +1 -1
|
@@ -97,7 +97,7 @@ var BookingProcessesApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This
|
|
100
|
+
* This endpoint creates a new booking process.
|
|
101
101
|
* @summary Create the booking process
|
|
102
102
|
* @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -145,6 +145,78 @@ var BookingProcessesApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
});
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
|
+
/**
|
|
149
|
+
* Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
150
|
+
* @summary List Booking processes
|
|
151
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
152
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
153
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
154
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code</i>
|
|
155
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
156
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, updatedAt, createdAt</i>
|
|
157
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
158
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code</i>
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
listBookingProcesses: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
163
|
+
if (options === void 0) { options = {}; }
|
|
164
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
165
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
166
|
+
return __generator(this, function (_a) {
|
|
167
|
+
switch (_a.label) {
|
|
168
|
+
case 0:
|
|
169
|
+
localVarPath = "/accountingservice/v1/booking-processes";
|
|
170
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
171
|
+
if (configuration) {
|
|
172
|
+
baseOptions = configuration.baseOptions;
|
|
173
|
+
baseAccessToken = configuration.accessToken;
|
|
174
|
+
}
|
|
175
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
176
|
+
localVarHeaderParameter = {};
|
|
177
|
+
localVarQueryParameter = {};
|
|
178
|
+
// authentication bearer required
|
|
179
|
+
// http bearer authentication required
|
|
180
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
181
|
+
case 1:
|
|
182
|
+
// authentication bearer required
|
|
183
|
+
// http bearer authentication required
|
|
184
|
+
_a.sent();
|
|
185
|
+
if (pageSize !== undefined) {
|
|
186
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
187
|
+
}
|
|
188
|
+
if (pageToken !== undefined) {
|
|
189
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
190
|
+
}
|
|
191
|
+
if (filter !== undefined) {
|
|
192
|
+
localVarQueryParameter['filter'] = filter;
|
|
193
|
+
}
|
|
194
|
+
if (search !== undefined) {
|
|
195
|
+
localVarQueryParameter['search'] = search;
|
|
196
|
+
}
|
|
197
|
+
if (order !== undefined) {
|
|
198
|
+
localVarQueryParameter['order'] = order;
|
|
199
|
+
}
|
|
200
|
+
if (expand !== undefined) {
|
|
201
|
+
localVarQueryParameter['expand'] = expand;
|
|
202
|
+
}
|
|
203
|
+
if (filters !== undefined) {
|
|
204
|
+
localVarQueryParameter['filters'] = filters;
|
|
205
|
+
}
|
|
206
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
207
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
208
|
+
}
|
|
209
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
210
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
211
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
212
|
+
return [2 /*return*/, {
|
|
213
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
214
|
+
options: localVarRequestOptions,
|
|
215
|
+
}];
|
|
216
|
+
}
|
|
217
|
+
});
|
|
218
|
+
});
|
|
219
|
+
},
|
|
148
220
|
};
|
|
149
221
|
};
|
|
150
222
|
exports.BookingProcessesApiAxiosParamCreator = BookingProcessesApiAxiosParamCreator;
|
|
@@ -156,7 +228,7 @@ var BookingProcessesApiFp = function (configuration) {
|
|
|
156
228
|
var localVarAxiosParamCreator = (0, exports.BookingProcessesApiAxiosParamCreator)(configuration);
|
|
157
229
|
return {
|
|
158
230
|
/**
|
|
159
|
-
* This
|
|
231
|
+
* This endpoint creates a new booking process.
|
|
160
232
|
* @summary Create the booking process
|
|
161
233
|
* @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
|
|
162
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -176,6 +248,33 @@ var BookingProcessesApiFp = function (configuration) {
|
|
|
176
248
|
});
|
|
177
249
|
});
|
|
178
250
|
},
|
|
251
|
+
/**
|
|
252
|
+
* Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
253
|
+
* @summary List Booking processes
|
|
254
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
256
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
257
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code</i>
|
|
258
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
259
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, updatedAt, createdAt</i>
|
|
260
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
261
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code</i>
|
|
262
|
+
* @param {*} [options] Override http request option.
|
|
263
|
+
* @throws {RequiredError}
|
|
264
|
+
*/
|
|
265
|
+
listBookingProcesses: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
266
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
267
|
+
var localVarAxiosArgs;
|
|
268
|
+
return __generator(this, function (_a) {
|
|
269
|
+
switch (_a.label) {
|
|
270
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBookingProcesses(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
271
|
+
case 1:
|
|
272
|
+
localVarAxiosArgs = _a.sent();
|
|
273
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
274
|
+
}
|
|
275
|
+
});
|
|
276
|
+
});
|
|
277
|
+
},
|
|
179
278
|
};
|
|
180
279
|
};
|
|
181
280
|
exports.BookingProcessesApiFp = BookingProcessesApiFp;
|
|
@@ -187,7 +286,7 @@ var BookingProcessesApiFactory = function (configuration, basePath, axios) {
|
|
|
187
286
|
var localVarFp = (0, exports.BookingProcessesApiFp)(configuration);
|
|
188
287
|
return {
|
|
189
288
|
/**
|
|
190
|
-
* This
|
|
289
|
+
* This endpoint creates a new booking process.
|
|
191
290
|
* @summary Create the booking process
|
|
192
291
|
* @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
|
|
193
292
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -197,6 +296,23 @@ var BookingProcessesApiFactory = function (configuration, basePath, axios) {
|
|
|
197
296
|
createBookingProcess: function (createBookingProcessRequestDto, authorization, options) {
|
|
198
297
|
return localVarFp.createBookingProcess(createBookingProcessRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
199
298
|
},
|
|
299
|
+
/**
|
|
300
|
+
* Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
301
|
+
* @summary List Booking processes
|
|
302
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
304
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
305
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code</i>
|
|
306
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
307
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, updatedAt, createdAt</i>
|
|
308
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
309
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code</i>
|
|
310
|
+
* @param {*} [options] Override http request option.
|
|
311
|
+
* @throws {RequiredError}
|
|
312
|
+
*/
|
|
313
|
+
listBookingProcesses: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
314
|
+
return localVarFp.listBookingProcesses(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
315
|
+
},
|
|
200
316
|
};
|
|
201
317
|
};
|
|
202
318
|
exports.BookingProcessesApiFactory = BookingProcessesApiFactory;
|
|
@@ -212,7 +328,7 @@ var BookingProcessesApi = /** @class */ (function (_super) {
|
|
|
212
328
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
213
329
|
}
|
|
214
330
|
/**
|
|
215
|
-
* This
|
|
331
|
+
* This endpoint creates a new booking process.
|
|
216
332
|
* @summary Create the booking process
|
|
217
333
|
* @param {BookingProcessesApiCreateBookingProcessRequest} requestParameters Request parameters.
|
|
218
334
|
* @param {*} [options] Override http request option.
|
|
@@ -223,6 +339,19 @@ var BookingProcessesApi = /** @class */ (function (_super) {
|
|
|
223
339
|
var _this = this;
|
|
224
340
|
return (0, exports.BookingProcessesApiFp)(this.configuration).createBookingProcess(requestParameters.createBookingProcessRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
225
341
|
};
|
|
342
|
+
/**
|
|
343
|
+
* Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
344
|
+
* @summary List Booking processes
|
|
345
|
+
* @param {BookingProcessesApiListBookingProcessesRequest} requestParameters Request parameters.
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
* @memberof BookingProcessesApi
|
|
349
|
+
*/
|
|
350
|
+
BookingProcessesApi.prototype.listBookingProcesses = function (requestParameters, options) {
|
|
351
|
+
var _this = this;
|
|
352
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
353
|
+
return (0, exports.BookingProcessesApiFp)(this.configuration).listBookingProcesses(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
354
|
+
};
|
|
226
355
|
return BookingProcessesApi;
|
|
227
356
|
}(base_1.BaseAPI));
|
|
228
357
|
exports.BookingProcessesApi = BookingProcessesApi;
|
package/dist/base.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ export declare const COLLECTION_FORMATS: {
|
|
|
24
24
|
};
|
|
25
25
|
export interface LoginClass {
|
|
26
26
|
accessToken: string;
|
|
27
|
-
permissions:
|
|
27
|
+
permissions: string;
|
|
28
28
|
}
|
|
29
29
|
export declare enum Environment {
|
|
30
30
|
Production = "https://apiv2.emil.de",
|
|
@@ -53,7 +53,7 @@ export declare class BaseAPI {
|
|
|
53
53
|
protected configuration: Configuration;
|
|
54
54
|
private username?;
|
|
55
55
|
private password?;
|
|
56
|
-
private permissions
|
|
56
|
+
private permissions?;
|
|
57
57
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
58
58
|
initialize(env?: Environment): Promise<void>;
|
|
59
59
|
private loadCredentials;
|
package/dist/base.js
CHANGED
|
@@ -150,7 +150,6 @@ var BaseAPI = /** @class */ (function () {
|
|
|
150
150
|
if (axios === void 0) { axios = axios_1.default; }
|
|
151
151
|
this.basePath = basePath;
|
|
152
152
|
this.axios = axios;
|
|
153
|
-
this.permissions = [];
|
|
154
153
|
if (configuration) {
|
|
155
154
|
this.configuration = configuration;
|
|
156
155
|
this.basePath = configuration.basePath || this.basePath;
|
|
@@ -244,7 +243,7 @@ var BaseAPI = /** @class */ (function () {
|
|
|
244
243
|
this.configuration.basePath = env;
|
|
245
244
|
};
|
|
246
245
|
BaseAPI.prototype.getPermissions = function () {
|
|
247
|
-
return this.permissions;
|
|
246
|
+
return this.permissions.split(',');
|
|
248
247
|
};
|
|
249
248
|
BaseAPI.prototype.authorize = function (username, password) {
|
|
250
249
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -17,55 +17,61 @@ import { FinancialTransactionDataDto } from './financial-transaction-data-dto';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface CreateBookingEntryRequestDto {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* The date of the booking entry. This represents when the transaction or booking was recorded. Defaults to the current date if not provided.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof CreateBookingEntryRequestDto
|
|
23
23
|
*/
|
|
24
24
|
'bookingDate'?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* A brief description of the booking entry. This provides context or purpose for the entry, such as \"Monthly premium\" or \"Refund issued\".
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof CreateBookingEntryRequestDto
|
|
29
29
|
*/
|
|
30
30
|
'description': string;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* The policy number associated with this booking entry. This uniquely identifies the policy related to the transaction.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof CreateBookingEntryRequestDto
|
|
35
35
|
*/
|
|
36
36
|
'policyNumber': string;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* The type of entity associated with this entry, such as invoice or payment. This helps categorize the nature of the booking entry.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof CreateBookingEntryRequestDto
|
|
41
41
|
*/
|
|
42
42
|
'entityName': CreateBookingEntryRequestDtoEntityNameEnum;
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* The unique number assigned to the entity, such as an invoice or payment reference number.
|
|
45
45
|
* @type {string}
|
|
46
46
|
* @memberof CreateBookingEntryRequestDto
|
|
47
47
|
*/
|
|
48
48
|
'entityNumber': string;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* The currency of the transaction amount, defaulting to EUR (Euro) if not otherwise specified.
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof CreateBookingEntryRequestDto
|
|
53
53
|
*/
|
|
54
54
|
'currency': CreateBookingEntryRequestDtoCurrencyEnum;
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* 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.
|
|
57
57
|
* @type {number}
|
|
58
58
|
* @memberof CreateBookingEntryRequestDto
|
|
59
59
|
*/
|
|
60
60
|
'amount': number;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* An optional identifier for the booking process associated with this entry. This helps to link the entry to a specific booking process if applicable.
|
|
63
63
|
* @type {number}
|
|
64
64
|
* @memberof CreateBookingEntryRequestDto
|
|
65
65
|
*/
|
|
66
66
|
'bookingProcessId'?: number;
|
|
67
67
|
/**
|
|
68
|
-
*
|
|
68
|
+
* Optional key-value pairs containing additional custom information for the booking entry. These fields may include document numbers, reasons, or other contextual metadata.
|
|
69
|
+
* @type {object}
|
|
70
|
+
* @memberof CreateBookingEntryRequestDto
|
|
71
|
+
*/
|
|
72
|
+
'customFields': object;
|
|
73
|
+
/**
|
|
74
|
+
* An array of financial transactions associated with this booking entry. Each transaction includes details such as financial account, amount, and debit or credit status.
|
|
69
75
|
* @type {Array<FinancialTransactionDataDto>}
|
|
70
76
|
* @memberof CreateBookingEntryRequestDto
|
|
71
77
|
*/
|
|
@@ -17,25 +17,31 @@ import { CreateBookingEntryRequestDto } from './create-booking-entry-request-dto
|
|
|
17
17
|
*/
|
|
18
18
|
export interface CreateBookingProcessRequestDto {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* 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.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof CreateBookingProcessRequestDto
|
|
23
23
|
*/
|
|
24
24
|
'policyNumber': string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* The current status of the booking process, indicating its completion or settlement stage, such as invoiced or paid, etc...
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof CreateBookingProcessRequestDto
|
|
29
29
|
*/
|
|
30
30
|
'status': CreateBookingProcessRequestDtoStatusEnum;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* The type of booking process being created, such as recurringInvoice or \" initialInvoice. This helps categorize the nature of the booking within the system.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof CreateBookingProcessRequestDto
|
|
35
35
|
*/
|
|
36
36
|
'bookingProcessType': CreateBookingProcessRequestDtoBookingProcessTypeEnum;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* 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.
|
|
39
|
+
* @type {object}
|
|
40
|
+
* @memberof CreateBookingProcessRequestDto
|
|
41
|
+
*/
|
|
42
|
+
'customFields': object;
|
|
43
|
+
/**
|
|
44
|
+
* 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.
|
|
39
45
|
* @type {Array<CreateBookingEntryRequestDto>}
|
|
40
46
|
* @memberof CreateBookingProcessRequestDto
|
|
41
47
|
*/
|
|
@@ -16,35 +16,41 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface CreateFinancialAccountRequestDto {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* The name of the financial account. This is a descriptive label used to identify the account within the system.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof CreateFinancialAccountRequestDto
|
|
22
22
|
*/
|
|
23
23
|
'name': string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* The unique account number assigned to this financial account. This number is used to route transactions and manage the account within the financial system.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateFinancialAccountRequestDto
|
|
28
28
|
*/
|
|
29
29
|
'financialAccountNumber': string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* The type of financial account, specifying its category or classification, such as asset, equity, or expense. This categorization helps in accounting and reporting.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CreateFinancialAccountRequestDto
|
|
34
34
|
*/
|
|
35
35
|
'type': CreateFinancialAccountRequestDtoTypeEnum;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* An optional code representing the entity associated with this account. Useful for associating the account with specific organizational entities or departments.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof CreateFinancialAccountRequestDto
|
|
40
40
|
*/
|
|
41
41
|
'entityCode'?: string;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* An optional identifier for the parent account. If provided, this allows the creation of sub-accounts under a parent financial account, establishing a hierarchy.
|
|
44
44
|
* @type {number}
|
|
45
45
|
* @memberof CreateFinancialAccountRequestDto
|
|
46
46
|
*/
|
|
47
47
|
'parentId'?: number;
|
|
48
|
+
/**
|
|
49
|
+
* Optional key-value pairs to store additional custom metadata or specific attributes related to the financial account, such as account purpose or manager.
|
|
50
|
+
* @type {object}
|
|
51
|
+
* @memberof CreateFinancialAccountRequestDto
|
|
52
|
+
*/
|
|
53
|
+
'customFields': object;
|
|
48
54
|
}
|
|
49
55
|
export declare const CreateFinancialAccountRequestDtoTypeEnum: {
|
|
50
56
|
readonly Asset: "asset";
|
|
@@ -16,43 +16,49 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface FinancialTransactionDataDto {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* 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.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof FinancialTransactionDataDto
|
|
22
22
|
*/
|
|
23
23
|
'financialAccountNumber': string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* 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.
|
|
26
26
|
* @type {number}
|
|
27
27
|
* @memberof FinancialTransactionDataDto
|
|
28
28
|
*/
|
|
29
29
|
'amount': number;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Specifies whether the transaction is a debit or a credit. A debit indicates an outgoing payment, while a credit represents incoming funds.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof FinancialTransactionDataDto
|
|
34
34
|
*/
|
|
35
35
|
'debitCredit': FinancialTransactionDataDtoDebitCreditEnum;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* The unique number assigned to the partner involved in the transaction, typically representing a customer, supplier, or other associated party.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof FinancialTransactionDataDto
|
|
40
40
|
*/
|
|
41
41
|
'partnerNumber': string;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* An optional grouping identifier for the partner, used for categorization and reporting purposes.
|
|
44
44
|
* @type {string}
|
|
45
45
|
* @memberof FinancialTransactionDataDto
|
|
46
46
|
*/
|
|
47
47
|
'partnerGroup'?: string;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* The policy number related to this transaction, used for referencing the associated insurance policy or agreement.
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof FinancialTransactionDataDto
|
|
52
52
|
*/
|
|
53
53
|
'policyNumber': string;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* Optional additional information related to the transaction, structured as key-value pairs. These fields may include metadata, identifiers, or contextual details for custom processing.
|
|
56
|
+
* @type {object}
|
|
57
|
+
* @memberof FinancialTransactionDataDto
|
|
58
|
+
*/
|
|
59
|
+
'customFields': object;
|
|
60
|
+
/**
|
|
61
|
+
* A brief summary of the transaction, providing context or purpose, such as \"Payment of invoice #1234\" or \"Monthly premium for policy #5678\".
|
|
56
62
|
* @type {string}
|
|
57
63
|
* @memberof FinancialTransactionDataDto
|
|
58
64
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -11,4 +11,5 @@ export * from './financial-transaction-data-dto';
|
|
|
11
11
|
export * from './get-financial-account-response-class';
|
|
12
12
|
export * from './inline-response200';
|
|
13
13
|
export * from './inline-response503';
|
|
14
|
+
export * from './list-booking-process-response-class';
|
|
14
15
|
export * from './list-financial-accounts-response-class';
|
package/dist/models/index.js
CHANGED
|
@@ -27,4 +27,5 @@ __exportStar(require("./financial-transaction-data-dto"), exports);
|
|
|
27
27
|
__exportStar(require("./get-financial-account-response-class"), exports);
|
|
28
28
|
__exportStar(require("./inline-response200"), exports);
|
|
29
29
|
__exportStar(require("./inline-response503"), exports);
|
|
30
|
+
__exportStar(require("./list-booking-process-response-class"), exports);
|
|
30
31
|
__exportStar(require("./list-financial-accounts-response-class"), exports);
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL AccountingService
|
|
3
|
+
* The EMIL AccountingService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { BookingProcessClass } from './booking-process-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ListBookingProcessResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface ListBookingProcessResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* The list of booking processs.
|
|
21
|
+
* @type {Array<BookingProcessClass>}
|
|
22
|
+
* @memberof ListBookingProcessResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'items': Array<BookingProcessClass>;
|
|
25
|
+
/**
|
|
26
|
+
* Next page token
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ListBookingProcessResponseClass
|
|
29
|
+
*/
|
|
30
|
+
'nextPageToken': string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL AccountingService
|
|
6
|
+
* The EMIL AccountingService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -22,55 +22,61 @@ import { FinancialTransactionDataDto } from './financial-transaction-data-dto';
|
|
|
22
22
|
*/
|
|
23
23
|
export interface CreateBookingEntryRequestDto {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* The date of the booking entry. This represents when the transaction or booking was recorded. Defaults to the current date if not provided.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateBookingEntryRequestDto
|
|
28
28
|
*/
|
|
29
29
|
'bookingDate'?: string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* A brief description of the booking entry. This provides context or purpose for the entry, such as \"Monthly premium\" or \"Refund issued\".
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CreateBookingEntryRequestDto
|
|
34
34
|
*/
|
|
35
35
|
'description': string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* The policy number associated with this booking entry. This uniquely identifies the policy related to the transaction.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof CreateBookingEntryRequestDto
|
|
40
40
|
*/
|
|
41
41
|
'policyNumber': string;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* The type of entity associated with this entry, such as invoice or payment. This helps categorize the nature of the booking entry.
|
|
44
44
|
* @type {string}
|
|
45
45
|
* @memberof CreateBookingEntryRequestDto
|
|
46
46
|
*/
|
|
47
47
|
'entityName': CreateBookingEntryRequestDtoEntityNameEnum;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* The unique number assigned to the entity, such as an invoice or payment reference number.
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof CreateBookingEntryRequestDto
|
|
52
52
|
*/
|
|
53
53
|
'entityNumber': string;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* The currency of the transaction amount, defaulting to EUR (Euro) if not otherwise specified.
|
|
56
56
|
* @type {string}
|
|
57
57
|
* @memberof CreateBookingEntryRequestDto
|
|
58
58
|
*/
|
|
59
59
|
'currency': CreateBookingEntryRequestDtoCurrencyEnum;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* 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.
|
|
62
62
|
* @type {number}
|
|
63
63
|
* @memberof CreateBookingEntryRequestDto
|
|
64
64
|
*/
|
|
65
65
|
'amount': number;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* An optional identifier for the booking process associated with this entry. This helps to link the entry to a specific booking process if applicable.
|
|
68
68
|
* @type {number}
|
|
69
69
|
* @memberof CreateBookingEntryRequestDto
|
|
70
70
|
*/
|
|
71
71
|
'bookingProcessId'?: number;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Optional key-value pairs containing additional custom information for the booking entry. These fields may include document numbers, reasons, or other contextual metadata.
|
|
74
|
+
* @type {object}
|
|
75
|
+
* @memberof CreateBookingEntryRequestDto
|
|
76
|
+
*/
|
|
77
|
+
'customFields': object;
|
|
78
|
+
/**
|
|
79
|
+
* An array of financial transactions associated with this booking entry. Each transaction includes details such as financial account, amount, and debit or credit status.
|
|
74
80
|
* @type {Array<FinancialTransactionDataDto>}
|
|
75
81
|
* @memberof CreateBookingEntryRequestDto
|
|
76
82
|
*/
|
|
@@ -22,25 +22,31 @@ import { CreateBookingEntryRequestDto } from './create-booking-entry-request-dto
|
|
|
22
22
|
*/
|
|
23
23
|
export interface CreateBookingProcessRequestDto {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* 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.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateBookingProcessRequestDto
|
|
28
28
|
*/
|
|
29
29
|
'policyNumber': string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* The current status of the booking process, indicating its completion or settlement stage, such as invoiced or paid, etc...
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CreateBookingProcessRequestDto
|
|
34
34
|
*/
|
|
35
35
|
'status': CreateBookingProcessRequestDtoStatusEnum;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* The type of booking process being created, such as recurringInvoice or \" initialInvoice. This helps categorize the nature of the booking within the system.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof CreateBookingProcessRequestDto
|
|
40
40
|
*/
|
|
41
41
|
'bookingProcessType': CreateBookingProcessRequestDtoBookingProcessTypeEnum;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* 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.
|
|
44
|
+
* @type {object}
|
|
45
|
+
* @memberof CreateBookingProcessRequestDto
|
|
46
|
+
*/
|
|
47
|
+
'customFields': object;
|
|
48
|
+
/**
|
|
49
|
+
* 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.
|
|
44
50
|
* @type {Array<CreateBookingEntryRequestDto>}
|
|
45
51
|
* @memberof CreateBookingProcessRequestDto
|
|
46
52
|
*/
|