@emilgroup/accounting-sdk 1.18.1-beta.1 → 1.18.1-beta.2
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/README.md +2 -2
- package/api/booking-entries-api.ts +52 -52
- package/api/financial-accounts-api.ts +35 -35
- package/api/financial-transactions-api.ts +48 -48
- package/api/number-ranges-api.ts +35 -35
- package/api/personal-accounts-api.ts +35 -35
- package/dist/api/booking-entries-api.d.ts +52 -52
- package/dist/api/booking-entries-api.js +33 -33
- package/dist/api/financial-accounts-api.d.ts +35 -35
- package/dist/api/financial-accounts-api.js +25 -25
- package/dist/api/financial-transactions-api.d.ts +48 -48
- package/dist/api/financial-transactions-api.js +29 -29
- package/dist/api/number-ranges-api.d.ts +35 -35
- package/dist/api/number-ranges-api.js +25 -25
- package/dist/api/personal-accounts-api.d.ts +35 -35
- package/dist/api/personal-accounts-api.js +25 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/accounting-sdk@1.18.1-beta.
|
|
20
|
+
npm install @emilgroup/accounting-sdk@1.18.1-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/accounting-sdk@1.18.1-beta.
|
|
24
|
+
yarn add @emilgroup/accounting-sdk@1.18.1-beta.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `FinancialAccountsApi`.
|
|
@@ -35,7 +35,7 @@ import { ListBookingEntriesResponseClass } from '../models';
|
|
|
35
35
|
export const BookingEntriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* This endpoint creates a new booking entry.
|
|
38
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
39
39
|
* @summary Create the booking entry
|
|
40
40
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -82,7 +82,7 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* This endpoint gets a booking entry.
|
|
85
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
86
86
|
* @summary Retrieve the booking entry
|
|
87
87
|
* @param {string} code
|
|
88
88
|
* @param {string} expand
|
|
@@ -134,20 +134,20 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
134
134
|
};
|
|
135
135
|
},
|
|
136
136
|
/**
|
|
137
|
-
* This endpoint gets booking entries.
|
|
137
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
138
138
|
* @summary List booking entries
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
140
|
-
* @param {
|
|
141
|
-
* @param {
|
|
142
|
-
* @param {
|
|
143
|
-
* @param {
|
|
144
|
-
* @param {
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
140
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
141
|
+
* @param {string} [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.
|
|
142
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
143
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
144
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
145
|
+
* @param {string} [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.
|
|
146
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
148
148
|
* @throws {RequiredError}
|
|
149
149
|
*/
|
|
150
|
-
listBookingEntries: async (authorization?: string, pageSize?:
|
|
150
|
+
listBookingEntries: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
151
151
|
const localVarPath = `/accountingservice/v1/booking-entries`;
|
|
152
152
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153
153
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -220,7 +220,7 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
|
|
|
220
220
|
const localVarAxiosParamCreator = BookingEntriesApiAxiosParamCreator(configuration)
|
|
221
221
|
return {
|
|
222
222
|
/**
|
|
223
|
-
* This endpoint creates a new booking entry.
|
|
223
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
224
224
|
* @summary Create the booking entry
|
|
225
225
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
226
226
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -232,7 +232,7 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
|
|
|
232
232
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
233
233
|
},
|
|
234
234
|
/**
|
|
235
|
-
* This endpoint gets a booking entry.
|
|
235
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
236
236
|
* @summary Retrieve the booking entry
|
|
237
237
|
* @param {string} code
|
|
238
238
|
* @param {string} expand
|
|
@@ -245,20 +245,20 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
|
|
|
245
245
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
* This endpoint gets booking entries.
|
|
248
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
249
249
|
* @summary List booking entries
|
|
250
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
|
-
* @param {
|
|
252
|
-
* @param {
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
251
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
252
|
+
* @param {string} [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.
|
|
253
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
254
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
255
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
256
|
+
* @param {string} [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.
|
|
257
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
261
|
-
async listBookingEntries(authorization?: string, pageSize?:
|
|
261
|
+
async listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBookingEntriesResponseClass>> {
|
|
262
262
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
263
263
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
264
264
|
},
|
|
@@ -273,7 +273,7 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
|
|
|
273
273
|
const localVarFp = BookingEntriesApiFp(configuration)
|
|
274
274
|
return {
|
|
275
275
|
/**
|
|
276
|
-
* This endpoint creates a new booking entry.
|
|
276
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
277
277
|
* @summary Create the booking entry
|
|
278
278
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
279
279
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -284,7 +284,7 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
|
|
|
284
284
|
return localVarFp.createBookingEntry(createBookingEntryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
285
285
|
},
|
|
286
286
|
/**
|
|
287
|
-
* This endpoint gets a booking entry.
|
|
287
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
288
288
|
* @summary Retrieve the booking entry
|
|
289
289
|
* @param {string} code
|
|
290
290
|
* @param {string} expand
|
|
@@ -296,20 +296,20 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
|
|
|
296
296
|
return localVarFp.getBookingEntry(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
297
297
|
},
|
|
298
298
|
/**
|
|
299
|
-
* This endpoint gets booking entries.
|
|
299
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
300
300
|
* @summary List booking entries
|
|
301
301
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
|
-
* @param {
|
|
303
|
-
* @param {
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
302
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
303
|
+
* @param {string} [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.
|
|
304
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
305
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
306
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
307
|
+
* @param {string} [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.
|
|
308
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
309
309
|
* @param {*} [options] Override http request option.
|
|
310
310
|
* @throws {RequiredError}
|
|
311
311
|
*/
|
|
312
|
-
listBookingEntries(authorization?: string, pageSize?:
|
|
312
|
+
listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBookingEntriesResponseClass> {
|
|
313
313
|
return localVarFp.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
314
314
|
},
|
|
315
315
|
};
|
|
@@ -379,52 +379,52 @@ export interface BookingEntriesApiListBookingEntriesRequest {
|
|
|
379
379
|
|
|
380
380
|
/**
|
|
381
381
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
382
|
-
* @type {
|
|
382
|
+
* @type {number}
|
|
383
383
|
* @memberof BookingEntriesApiListBookingEntries
|
|
384
384
|
*/
|
|
385
|
-
readonly pageSize?:
|
|
385
|
+
readonly pageSize?: number
|
|
386
386
|
|
|
387
387
|
/**
|
|
388
|
-
* 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,
|
|
389
|
-
* @type {
|
|
388
|
+
* 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.
|
|
389
|
+
* @type {string}
|
|
390
390
|
* @memberof BookingEntriesApiListBookingEntries
|
|
391
391
|
*/
|
|
392
|
-
readonly pageToken?:
|
|
392
|
+
readonly pageToken?: string
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
395
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
396
|
-
* @type {
|
|
396
|
+
* @type {string}
|
|
397
397
|
* @memberof BookingEntriesApiListBookingEntries
|
|
398
398
|
*/
|
|
399
|
-
readonly filter?:
|
|
399
|
+
readonly filter?: string
|
|
400
400
|
|
|
401
401
|
/**
|
|
402
402
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
403
|
-
* @type {
|
|
403
|
+
* @type {string}
|
|
404
404
|
* @memberof BookingEntriesApiListBookingEntries
|
|
405
405
|
*/
|
|
406
|
-
readonly search?:
|
|
406
|
+
readonly search?: string
|
|
407
407
|
|
|
408
408
|
/**
|
|
409
409
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
410
|
-
* @type {
|
|
410
|
+
* @type {string}
|
|
411
411
|
* @memberof BookingEntriesApiListBookingEntries
|
|
412
412
|
*/
|
|
413
|
-
readonly order?:
|
|
413
|
+
readonly order?: string
|
|
414
414
|
|
|
415
415
|
/**
|
|
416
|
-
* 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
|
|
417
|
-
* @type {
|
|
416
|
+
* 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.
|
|
417
|
+
* @type {string}
|
|
418
418
|
* @memberof BookingEntriesApiListBookingEntries
|
|
419
419
|
*/
|
|
420
|
-
readonly expand?:
|
|
420
|
+
readonly expand?: string
|
|
421
421
|
|
|
422
422
|
/**
|
|
423
423
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
424
|
-
* @type {
|
|
424
|
+
* @type {string}
|
|
425
425
|
* @memberof BookingEntriesApiListBookingEntries
|
|
426
426
|
*/
|
|
427
|
-
readonly filters?:
|
|
427
|
+
readonly filters?: string
|
|
428
428
|
}
|
|
429
429
|
|
|
430
430
|
/**
|
|
@@ -435,7 +435,7 @@ export interface BookingEntriesApiListBookingEntriesRequest {
|
|
|
435
435
|
*/
|
|
436
436
|
export class BookingEntriesApi extends BaseAPI {
|
|
437
437
|
/**
|
|
438
|
-
* This endpoint creates a new booking entry.
|
|
438
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
439
439
|
* @summary Create the booking entry
|
|
440
440
|
* @param {BookingEntriesApiCreateBookingEntryRequest} requestParameters Request parameters.
|
|
441
441
|
* @param {*} [options] Override http request option.
|
|
@@ -447,7 +447,7 @@ export class BookingEntriesApi extends BaseAPI {
|
|
|
447
447
|
}
|
|
448
448
|
|
|
449
449
|
/**
|
|
450
|
-
* This endpoint gets a booking entry.
|
|
450
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
451
451
|
* @summary Retrieve the booking entry
|
|
452
452
|
* @param {BookingEntriesApiGetBookingEntryRequest} requestParameters Request parameters.
|
|
453
453
|
* @param {*} [options] Override http request option.
|
|
@@ -459,7 +459,7 @@ export class BookingEntriesApi extends BaseAPI {
|
|
|
459
459
|
}
|
|
460
460
|
|
|
461
461
|
/**
|
|
462
|
-
* This endpoint gets booking entries.
|
|
462
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
463
463
|
* @summary List booking entries
|
|
464
464
|
* @param {BookingEntriesApiListBookingEntriesRequest} requestParameters Request parameters.
|
|
465
465
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ import { ListFinancialAccountsResponseClass } from '../models';
|
|
|
35
35
|
export const FinancialAccountsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
38
|
+
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
39
39
|
* @summary Create the Financial Account
|
|
40
40
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -82,7 +82,7 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
85
|
+
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
86
86
|
* @summary Delete the Financial Account
|
|
87
87
|
* @param {string} code Unique identifier for the object.
|
|
88
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -127,7 +127,7 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
|
|
|
127
127
|
};
|
|
128
128
|
},
|
|
129
129
|
/**
|
|
130
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
130
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
131
131
|
* @summary Retrieve the Financial Account
|
|
132
132
|
* @param {string} code Unique identifier for the object.
|
|
133
133
|
* @param {string} expand
|
|
@@ -179,20 +179,20 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
|
|
|
179
179
|
};
|
|
180
180
|
},
|
|
181
181
|
/**
|
|
182
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
182
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
183
183
|
* @summary List Financial Accounts
|
|
184
184
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
|
-
* @param {
|
|
186
|
-
* @param {
|
|
185
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
|
+
* @param {string} [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.
|
|
187
187
|
* @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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
188
|
-
* @param {
|
|
188
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
189
|
* @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, createdAt, name, financialAccountNumber</i>
|
|
190
190
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
191
191
|
* @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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
195
|
-
listFinancialAccounts: async (authorization?: string, pageSize?:
|
|
195
|
+
listFinancialAccounts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
196
|
const localVarPath = `/accountingservice/v1/financial-accounts`;
|
|
197
197
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
198
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -265,7 +265,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
265
265
|
const localVarAxiosParamCreator = FinancialAccountsApiAxiosParamCreator(configuration)
|
|
266
266
|
return {
|
|
267
267
|
/**
|
|
268
|
-
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
268
|
+
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
269
269
|
* @summary Create the Financial Account
|
|
270
270
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
271
271
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -277,7 +277,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
277
277
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
278
278
|
},
|
|
279
279
|
/**
|
|
280
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
280
|
+
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
281
281
|
* @summary Delete the Financial Account
|
|
282
282
|
* @param {string} code Unique identifier for the object.
|
|
283
283
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -289,7 +289,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
289
289
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
290
290
|
},
|
|
291
291
|
/**
|
|
292
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
292
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
293
293
|
* @summary Retrieve the Financial Account
|
|
294
294
|
* @param {string} code Unique identifier for the object.
|
|
295
295
|
* @param {string} expand
|
|
@@ -302,20 +302,20 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
302
302
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
303
303
|
},
|
|
304
304
|
/**
|
|
305
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
305
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
306
306
|
* @summary List Financial Accounts
|
|
307
307
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
308
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
|
+
* @param {string} [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.
|
|
310
310
|
* @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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
311
|
-
* @param {
|
|
311
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
312
|
* @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, createdAt, name, financialAccountNumber</i>
|
|
313
313
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
314
314
|
* @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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
async listFinancialAccounts(authorization?: string, pageSize?:
|
|
318
|
+
async listFinancialAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialAccountsResponseClass>> {
|
|
319
319
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
320
320
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
321
321
|
},
|
|
@@ -330,7 +330,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
330
330
|
const localVarFp = FinancialAccountsApiFp(configuration)
|
|
331
331
|
return {
|
|
332
332
|
/**
|
|
333
|
-
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
333
|
+
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
334
334
|
* @summary Create the Financial Account
|
|
335
335
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
336
336
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -341,7 +341,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
341
341
|
return localVarFp.createFinancialAccount(createFinancialAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
342
342
|
},
|
|
343
343
|
/**
|
|
344
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
344
|
+
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
345
345
|
* @summary Delete the Financial Account
|
|
346
346
|
* @param {string} code Unique identifier for the object.
|
|
347
347
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -352,7 +352,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
352
352
|
return localVarFp.deleteFinancialAccount(code, authorization, options).then((request) => request(axios, basePath));
|
|
353
353
|
},
|
|
354
354
|
/**
|
|
355
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
355
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
356
356
|
* @summary Retrieve the Financial Account
|
|
357
357
|
* @param {string} code Unique identifier for the object.
|
|
358
358
|
* @param {string} expand
|
|
@@ -364,20 +364,20 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
364
364
|
return localVarFp.getFinancialAccount(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
365
365
|
},
|
|
366
366
|
/**
|
|
367
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
367
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
368
368
|
* @summary List Financial Accounts
|
|
369
369
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
370
|
-
* @param {
|
|
371
|
-
* @param {
|
|
370
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
371
|
+
* @param {string} [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.
|
|
372
372
|
* @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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
373
|
-
* @param {
|
|
373
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
374
374
|
* @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, createdAt, name, financialAccountNumber</i>
|
|
375
375
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
376
376
|
* @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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
379
379
|
*/
|
|
380
|
-
listFinancialAccounts(authorization?: string, pageSize?:
|
|
380
|
+
listFinancialAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass> {
|
|
381
381
|
return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
382
382
|
},
|
|
383
383
|
};
|
|
@@ -468,17 +468,17 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
468
468
|
|
|
469
469
|
/**
|
|
470
470
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
471
|
-
* @type {
|
|
471
|
+
* @type {number}
|
|
472
472
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
473
473
|
*/
|
|
474
|
-
readonly pageSize?:
|
|
474
|
+
readonly pageSize?: number
|
|
475
475
|
|
|
476
476
|
/**
|
|
477
|
-
* 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,
|
|
478
|
-
* @type {
|
|
477
|
+
* 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.
|
|
478
|
+
* @type {string}
|
|
479
479
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
480
480
|
*/
|
|
481
|
-
readonly pageToken?:
|
|
481
|
+
readonly pageToken?: string
|
|
482
482
|
|
|
483
483
|
/**
|
|
484
484
|
* 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, name, financialAccountNumber, createdAt, entityCode, type</i>
|
|
@@ -489,10 +489,10 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
489
489
|
|
|
490
490
|
/**
|
|
491
491
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
492
|
-
* @type {
|
|
492
|
+
* @type {string}
|
|
493
493
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
494
494
|
*/
|
|
495
|
-
readonly search?:
|
|
495
|
+
readonly search?: string
|
|
496
496
|
|
|
497
497
|
/**
|
|
498
498
|
* 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, createdAt, name, financialAccountNumber</i>
|
|
@@ -524,7 +524,7 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
524
524
|
*/
|
|
525
525
|
export class FinancialAccountsApi extends BaseAPI {
|
|
526
526
|
/**
|
|
527
|
-
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
527
|
+
* This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
528
528
|
* @summary Create the Financial Account
|
|
529
529
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
530
530
|
* @param {*} [options] Override http request option.
|
|
@@ -536,7 +536,7 @@ export class FinancialAccountsApi extends BaseAPI {
|
|
|
536
536
|
}
|
|
537
537
|
|
|
538
538
|
/**
|
|
539
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
539
|
+
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
540
540
|
* @summary Delete the Financial Account
|
|
541
541
|
* @param {FinancialAccountsApiDeleteFinancialAccountRequest} requestParameters Request parameters.
|
|
542
542
|
* @param {*} [options] Override http request option.
|
|
@@ -548,7 +548,7 @@ export class FinancialAccountsApi extends BaseAPI {
|
|
|
548
548
|
}
|
|
549
549
|
|
|
550
550
|
/**
|
|
551
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
551
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
552
552
|
* @summary Retrieve the Financial Account
|
|
553
553
|
* @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
|
|
554
554
|
* @param {*} [options] Override http request option.
|
|
@@ -560,7 +560,7 @@ export class FinancialAccountsApi extends BaseAPI {
|
|
|
560
560
|
}
|
|
561
561
|
|
|
562
562
|
/**
|
|
563
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
563
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
564
564
|
* @summary List Financial Accounts
|
|
565
565
|
* @param {FinancialAccountsApiListFinancialAccountsRequest} requestParameters Request parameters.
|
|
566
566
|
* @param {*} [options] Override http request option.
|