@emilgroup/accounting-sdk-node 1.18.0 → 1.18.1-beta.0
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/base.ts +1 -1
- 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/dist/base.js +1 -1
- 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-node@1.18.0 --save
|
|
20
|
+
npm install @emilgroup/accounting-sdk-node@1.18.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/accounting-sdk-node@1.18.0
|
|
24
|
+
yarn add @emilgroup/accounting-sdk-node@1.18.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `FinancialAccountsApi`.
|
|
@@ -39,7 +39,7 @@ const FormData = require('form-data');
|
|
|
39
39
|
export const BookingEntriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* This endpoint creates a new booking entry.
|
|
42
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
43
43
|
* @summary Create the booking entry
|
|
44
44
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
45
45
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -86,7 +86,7 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* This endpoint gets a booking entry.
|
|
89
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
90
90
|
* @summary Retrieve the booking entry
|
|
91
91
|
* @param {string} code
|
|
92
92
|
* @param {string} expand
|
|
@@ -138,20 +138,20 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
138
138
|
};
|
|
139
139
|
},
|
|
140
140
|
/**
|
|
141
|
-
* This endpoint gets booking entries.
|
|
141
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
142
142
|
* @summary List booking entries
|
|
143
143
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
144
|
-
* @param {
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {
|
|
144
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
145
|
+
* @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.
|
|
146
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
147
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
148
|
+
* @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.
|
|
149
|
+
* @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.
|
|
150
|
+
* @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.
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
152
152
|
* @throws {RequiredError}
|
|
153
153
|
*/
|
|
154
|
-
listBookingEntries: async (authorization?: string, pageSize?:
|
|
154
|
+
listBookingEntries: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
155
155
|
const localVarPath = `/accountingservice/v1/booking-entries`;
|
|
156
156
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
157
157
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -224,7 +224,7 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
|
|
|
224
224
|
const localVarAxiosParamCreator = BookingEntriesApiAxiosParamCreator(configuration)
|
|
225
225
|
return {
|
|
226
226
|
/**
|
|
227
|
-
* This endpoint creates a new booking entry.
|
|
227
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
228
228
|
* @summary Create the booking entry
|
|
229
229
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
230
230
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -236,7 +236,7 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
|
|
|
236
236
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
237
237
|
},
|
|
238
238
|
/**
|
|
239
|
-
* This endpoint gets a booking entry.
|
|
239
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
240
240
|
* @summary Retrieve the booking entry
|
|
241
241
|
* @param {string} code
|
|
242
242
|
* @param {string} expand
|
|
@@ -249,20 +249,20 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
|
|
|
249
249
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
250
250
|
},
|
|
251
251
|
/**
|
|
252
|
-
* This endpoint gets booking entries.
|
|
252
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
253
253
|
* @summary List booking entries
|
|
254
254
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
258
|
-
* @param {
|
|
259
|
-
* @param {
|
|
260
|
-
* @param {
|
|
261
|
-
* @param {
|
|
255
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
256
|
+
* @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.
|
|
257
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
258
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
259
|
+
* @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.
|
|
260
|
+
* @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.
|
|
261
|
+
* @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.
|
|
262
262
|
* @param {*} [options] Override http request option.
|
|
263
263
|
* @throws {RequiredError}
|
|
264
264
|
*/
|
|
265
|
-
async listBookingEntries(authorization?: string, pageSize?:
|
|
265
|
+
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>> {
|
|
266
266
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
267
267
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
268
268
|
},
|
|
@@ -277,7 +277,7 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
|
|
|
277
277
|
const localVarFp = BookingEntriesApiFp(configuration)
|
|
278
278
|
return {
|
|
279
279
|
/**
|
|
280
|
-
* This endpoint creates a new booking entry.
|
|
280
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
281
281
|
* @summary Create the booking entry
|
|
282
282
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
283
283
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -288,7 +288,7 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
|
|
|
288
288
|
return localVarFp.createBookingEntry(createBookingEntryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
289
289
|
},
|
|
290
290
|
/**
|
|
291
|
-
* This endpoint gets a booking entry.
|
|
291
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
292
292
|
* @summary Retrieve the booking entry
|
|
293
293
|
* @param {string} code
|
|
294
294
|
* @param {string} expand
|
|
@@ -300,20 +300,20 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
|
|
|
300
300
|
return localVarFp.getBookingEntry(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
301
301
|
},
|
|
302
302
|
/**
|
|
303
|
-
* This endpoint gets booking entries.
|
|
303
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
304
304
|
* @summary List booking entries
|
|
305
305
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
306
|
-
* @param {
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {
|
|
311
|
-
* @param {
|
|
312
|
-
* @param {
|
|
306
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
307
|
+
* @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.
|
|
308
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
309
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
310
|
+
* @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.
|
|
311
|
+
* @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.
|
|
312
|
+
* @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.
|
|
313
313
|
* @param {*} [options] Override http request option.
|
|
314
314
|
* @throws {RequiredError}
|
|
315
315
|
*/
|
|
316
|
-
listBookingEntries(authorization?: string, pageSize?:
|
|
316
|
+
listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBookingEntriesResponseClass> {
|
|
317
317
|
return localVarFp.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
318
318
|
},
|
|
319
319
|
};
|
|
@@ -383,52 +383,52 @@ export interface BookingEntriesApiListBookingEntriesRequest {
|
|
|
383
383
|
|
|
384
384
|
/**
|
|
385
385
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
386
|
-
* @type {
|
|
386
|
+
* @type {number}
|
|
387
387
|
* @memberof BookingEntriesApiListBookingEntries
|
|
388
388
|
*/
|
|
389
|
-
readonly pageSize?:
|
|
389
|
+
readonly pageSize?: number
|
|
390
390
|
|
|
391
391
|
/**
|
|
392
|
-
* 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,
|
|
393
|
-
* @type {
|
|
392
|
+
* 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.
|
|
393
|
+
* @type {string}
|
|
394
394
|
* @memberof BookingEntriesApiListBookingEntries
|
|
395
395
|
*/
|
|
396
|
-
readonly pageToken?:
|
|
396
|
+
readonly pageToken?: string
|
|
397
397
|
|
|
398
398
|
/**
|
|
399
399
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
400
|
-
* @type {
|
|
400
|
+
* @type {string}
|
|
401
401
|
* @memberof BookingEntriesApiListBookingEntries
|
|
402
402
|
*/
|
|
403
|
-
readonly filter?:
|
|
403
|
+
readonly filter?: string
|
|
404
404
|
|
|
405
405
|
/**
|
|
406
406
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
407
|
-
* @type {
|
|
407
|
+
* @type {string}
|
|
408
408
|
* @memberof BookingEntriesApiListBookingEntries
|
|
409
409
|
*/
|
|
410
|
-
readonly search?:
|
|
410
|
+
readonly search?: string
|
|
411
411
|
|
|
412
412
|
/**
|
|
413
413
|
* 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.
|
|
414
|
-
* @type {
|
|
414
|
+
* @type {string}
|
|
415
415
|
* @memberof BookingEntriesApiListBookingEntries
|
|
416
416
|
*/
|
|
417
|
-
readonly order?:
|
|
417
|
+
readonly order?: string
|
|
418
418
|
|
|
419
419
|
/**
|
|
420
|
-
* 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
|
|
421
|
-
* @type {
|
|
420
|
+
* 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.
|
|
421
|
+
* @type {string}
|
|
422
422
|
* @memberof BookingEntriesApiListBookingEntries
|
|
423
423
|
*/
|
|
424
|
-
readonly expand?:
|
|
424
|
+
readonly expand?: string
|
|
425
425
|
|
|
426
426
|
/**
|
|
427
427
|
* 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.
|
|
428
|
-
* @type {
|
|
428
|
+
* @type {string}
|
|
429
429
|
* @memberof BookingEntriesApiListBookingEntries
|
|
430
430
|
*/
|
|
431
|
-
readonly filters?:
|
|
431
|
+
readonly filters?: string
|
|
432
432
|
}
|
|
433
433
|
|
|
434
434
|
/**
|
|
@@ -439,7 +439,7 @@ export interface BookingEntriesApiListBookingEntriesRequest {
|
|
|
439
439
|
*/
|
|
440
440
|
export class BookingEntriesApi extends BaseAPI {
|
|
441
441
|
/**
|
|
442
|
-
* This endpoint creates a new booking entry.
|
|
442
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
443
443
|
* @summary Create the booking entry
|
|
444
444
|
* @param {BookingEntriesApiCreateBookingEntryRequest} requestParameters Request parameters.
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
@@ -451,7 +451,7 @@ export class BookingEntriesApi extends BaseAPI {
|
|
|
451
451
|
}
|
|
452
452
|
|
|
453
453
|
/**
|
|
454
|
-
* This endpoint gets a booking entry.
|
|
454
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
455
455
|
* @summary Retrieve the booking entry
|
|
456
456
|
* @param {BookingEntriesApiGetBookingEntryRequest} requestParameters Request parameters.
|
|
457
457
|
* @param {*} [options] Override http request option.
|
|
@@ -463,7 +463,7 @@ export class BookingEntriesApi extends BaseAPI {
|
|
|
463
463
|
}
|
|
464
464
|
|
|
465
465
|
/**
|
|
466
|
-
* This endpoint gets booking entries.
|
|
466
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
467
467
|
* @summary List booking entries
|
|
468
468
|
* @param {BookingEntriesApiListBookingEntriesRequest} requestParameters Request parameters.
|
|
469
469
|
* @param {*} [options] Override http request option.
|
|
@@ -39,7 +39,7 @@ const FormData = require('form-data');
|
|
|
39
39
|
export const FinancialAccountsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* 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.
|
|
42
|
+
* 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\"
|
|
43
43
|
* @summary Create the Financial Account
|
|
44
44
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
45
45
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -86,7 +86,7 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
89
|
+
* 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\"
|
|
90
90
|
* @summary Delete the Financial Account
|
|
91
91
|
* @param {string} code Unique identifier for the object.
|
|
92
92
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -131,7 +131,7 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
* 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.
|
|
134
|
+
* 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\"
|
|
135
135
|
* @summary Retrieve the Financial Account
|
|
136
136
|
* @param {string} code Unique identifier for the object.
|
|
137
137
|
* @param {string} expand
|
|
@@ -183,20 +183,20 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* 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.
|
|
186
|
+
* 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\"
|
|
187
187
|
* @summary List Financial Accounts
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {
|
|
189
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
|
+
* @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.
|
|
191
191
|
* @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>
|
|
192
|
-
* @param {
|
|
192
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @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>
|
|
194
194
|
* @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/>
|
|
195
195
|
* @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>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
199
|
-
listFinancialAccounts: async (authorization?: string, pageSize?:
|
|
199
|
+
listFinancialAccounts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
200
|
const localVarPath = `/accountingservice/v1/financial-accounts`;
|
|
201
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -269,7 +269,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
269
269
|
const localVarAxiosParamCreator = FinancialAccountsApiAxiosParamCreator(configuration)
|
|
270
270
|
return {
|
|
271
271
|
/**
|
|
272
|
-
* 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.
|
|
272
|
+
* 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\"
|
|
273
273
|
* @summary Create the Financial Account
|
|
274
274
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
275
275
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -281,7 +281,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
281
281
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
282
282
|
},
|
|
283
283
|
/**
|
|
284
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
284
|
+
* 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\"
|
|
285
285
|
* @summary Delete the Financial Account
|
|
286
286
|
* @param {string} code Unique identifier for the object.
|
|
287
287
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -293,7 +293,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
293
293
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
294
294
|
},
|
|
295
295
|
/**
|
|
296
|
-
* 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.
|
|
296
|
+
* 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\"
|
|
297
297
|
* @summary Retrieve the Financial Account
|
|
298
298
|
* @param {string} code Unique identifier for the object.
|
|
299
299
|
* @param {string} expand
|
|
@@ -306,20 +306,20 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
|
|
|
306
306
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
307
307
|
},
|
|
308
308
|
/**
|
|
309
|
-
* 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.
|
|
309
|
+
* 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\"
|
|
310
310
|
* @summary List Financial Accounts
|
|
311
311
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
312
|
-
* @param {
|
|
313
|
-
* @param {
|
|
312
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
313
|
+
* @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.
|
|
314
314
|
* @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>
|
|
315
|
-
* @param {
|
|
315
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
316
316
|
* @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>
|
|
317
317
|
* @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/>
|
|
318
318
|
* @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>
|
|
319
319
|
* @param {*} [options] Override http request option.
|
|
320
320
|
* @throws {RequiredError}
|
|
321
321
|
*/
|
|
322
|
-
async listFinancialAccounts(authorization?: string, pageSize?:
|
|
322
|
+
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>> {
|
|
323
323
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
324
324
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
325
325
|
},
|
|
@@ -334,7 +334,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
334
334
|
const localVarFp = FinancialAccountsApiFp(configuration)
|
|
335
335
|
return {
|
|
336
336
|
/**
|
|
337
|
-
* 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.
|
|
337
|
+
* 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\"
|
|
338
338
|
* @summary Create the Financial Account
|
|
339
339
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
340
340
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -345,7 +345,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
345
345
|
return localVarFp.createFinancialAccount(createFinancialAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
346
346
|
},
|
|
347
347
|
/**
|
|
348
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
348
|
+
* 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\"
|
|
349
349
|
* @summary Delete the Financial Account
|
|
350
350
|
* @param {string} code Unique identifier for the object.
|
|
351
351
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -356,7 +356,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
356
356
|
return localVarFp.deleteFinancialAccount(code, authorization, options).then((request) => request(axios, basePath));
|
|
357
357
|
},
|
|
358
358
|
/**
|
|
359
|
-
* 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.
|
|
359
|
+
* 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\"
|
|
360
360
|
* @summary Retrieve the Financial Account
|
|
361
361
|
* @param {string} code Unique identifier for the object.
|
|
362
362
|
* @param {string} expand
|
|
@@ -368,20 +368,20 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
|
|
|
368
368
|
return localVarFp.getFinancialAccount(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
369
369
|
},
|
|
370
370
|
/**
|
|
371
|
-
* 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.
|
|
371
|
+
* 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\"
|
|
372
372
|
* @summary List Financial Accounts
|
|
373
373
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
374
|
-
* @param {
|
|
375
|
-
* @param {
|
|
374
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
|
+
* @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.
|
|
376
376
|
* @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>
|
|
377
|
-
* @param {
|
|
377
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
378
378
|
* @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>
|
|
379
379
|
* @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/>
|
|
380
380
|
* @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>
|
|
381
381
|
* @param {*} [options] Override http request option.
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
384
|
-
listFinancialAccounts(authorization?: string, pageSize?:
|
|
384
|
+
listFinancialAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass> {
|
|
385
385
|
return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
386
386
|
},
|
|
387
387
|
};
|
|
@@ -472,17 +472,17 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
472
472
|
|
|
473
473
|
/**
|
|
474
474
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
475
|
-
* @type {
|
|
475
|
+
* @type {number}
|
|
476
476
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
477
477
|
*/
|
|
478
|
-
readonly pageSize?:
|
|
478
|
+
readonly pageSize?: number
|
|
479
479
|
|
|
480
480
|
/**
|
|
481
|
-
* 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,
|
|
482
|
-
* @type {
|
|
481
|
+
* 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.
|
|
482
|
+
* @type {string}
|
|
483
483
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
484
484
|
*/
|
|
485
|
-
readonly pageToken?:
|
|
485
|
+
readonly pageToken?: string
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
488
|
* 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>
|
|
@@ -493,10 +493,10 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
493
493
|
|
|
494
494
|
/**
|
|
495
495
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
496
|
-
* @type {
|
|
496
|
+
* @type {string}
|
|
497
497
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
498
498
|
*/
|
|
499
|
-
readonly search?:
|
|
499
|
+
readonly search?: string
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
502
|
* 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>
|
|
@@ -528,7 +528,7 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
528
528
|
*/
|
|
529
529
|
export class FinancialAccountsApi extends BaseAPI {
|
|
530
530
|
/**
|
|
531
|
-
* 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.
|
|
531
|
+
* 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\"
|
|
532
532
|
* @summary Create the Financial Account
|
|
533
533
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
534
534
|
* @param {*} [options] Override http request option.
|
|
@@ -540,7 +540,7 @@ export class FinancialAccountsApi extends BaseAPI {
|
|
|
540
540
|
}
|
|
541
541
|
|
|
542
542
|
/**
|
|
543
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
543
|
+
* 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\"
|
|
544
544
|
* @summary Delete the Financial Account
|
|
545
545
|
* @param {FinancialAccountsApiDeleteFinancialAccountRequest} requestParameters Request parameters.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
@@ -552,7 +552,7 @@ export class FinancialAccountsApi extends BaseAPI {
|
|
|
552
552
|
}
|
|
553
553
|
|
|
554
554
|
/**
|
|
555
|
-
* 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.
|
|
555
|
+
* 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\"
|
|
556
556
|
* @summary Retrieve the Financial Account
|
|
557
557
|
* @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
|
|
558
558
|
* @param {*} [options] Override http request option.
|
|
@@ -564,7 +564,7 @@ export class FinancialAccountsApi extends BaseAPI {
|
|
|
564
564
|
}
|
|
565
565
|
|
|
566
566
|
/**
|
|
567
|
-
* 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.
|
|
567
|
+
* 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\"
|
|
568
568
|
* @summary List Financial Accounts
|
|
569
569
|
* @param {FinancialAccountsApiListFinancialAccountsRequest} requestParameters Request parameters.
|
|
570
570
|
* @param {*} [options] Override http request option.
|