@emilgroup/accounting-sdk 1.18.1-beta.1 → 1.18.1-beta.3
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
|
@@ -93,7 +93,7 @@ var BookingEntriesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* This endpoint creates a new booking entry.
|
|
96
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
97
97
|
* @summary Create the booking entry
|
|
98
98
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -142,7 +142,7 @@ var BookingEntriesApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* This endpoint gets a booking entry.
|
|
145
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
146
146
|
* @summary Retrieve the booking entry
|
|
147
147
|
* @param {string} code
|
|
148
148
|
* @param {string} expand
|
|
@@ -196,16 +196,16 @@ var BookingEntriesApiAxiosParamCreator = function (configuration) {
|
|
|
196
196
|
});
|
|
197
197
|
},
|
|
198
198
|
/**
|
|
199
|
-
* This endpoint gets booking entries.
|
|
199
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
200
200
|
* @summary List booking entries
|
|
201
201
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
|
-
* @param {
|
|
203
|
-
* @param {
|
|
204
|
-
* @param {
|
|
205
|
-
* @param {
|
|
206
|
-
* @param {
|
|
207
|
-
* @param {
|
|
208
|
-
* @param {
|
|
202
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
203
|
+
* @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.
|
|
204
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
205
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
206
|
+
* @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.
|
|
207
|
+
* @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.
|
|
208
|
+
* @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.
|
|
209
209
|
* @param {*} [options] Override http request option.
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
@@ -278,7 +278,7 @@ var BookingEntriesApiFp = function (configuration) {
|
|
|
278
278
|
var localVarAxiosParamCreator = (0, exports.BookingEntriesApiAxiosParamCreator)(configuration);
|
|
279
279
|
return {
|
|
280
280
|
/**
|
|
281
|
-
* This endpoint creates a new booking entry.
|
|
281
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
282
282
|
* @summary Create the booking entry
|
|
283
283
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
284
284
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -299,7 +299,7 @@ var BookingEntriesApiFp = function (configuration) {
|
|
|
299
299
|
});
|
|
300
300
|
},
|
|
301
301
|
/**
|
|
302
|
-
* This endpoint gets a booking entry.
|
|
302
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
303
303
|
* @summary Retrieve the booking entry
|
|
304
304
|
* @param {string} code
|
|
305
305
|
* @param {string} expand
|
|
@@ -321,16 +321,16 @@ var BookingEntriesApiFp = function (configuration) {
|
|
|
321
321
|
});
|
|
322
322
|
},
|
|
323
323
|
/**
|
|
324
|
-
* This endpoint gets booking entries.
|
|
324
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
325
325
|
* @summary List booking entries
|
|
326
326
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
327
|
-
* @param {
|
|
328
|
-
* @param {
|
|
329
|
-
* @param {
|
|
330
|
-
* @param {
|
|
331
|
-
* @param {
|
|
332
|
-
* @param {
|
|
333
|
-
* @param {
|
|
327
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
328
|
+
* @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.
|
|
329
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
330
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
331
|
+
* @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.
|
|
332
|
+
* @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.
|
|
333
|
+
* @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.
|
|
334
334
|
* @param {*} [options] Override http request option.
|
|
335
335
|
* @throws {RequiredError}
|
|
336
336
|
*/
|
|
@@ -358,7 +358,7 @@ var BookingEntriesApiFactory = function (configuration, basePath, axios) {
|
|
|
358
358
|
var localVarFp = (0, exports.BookingEntriesApiFp)(configuration);
|
|
359
359
|
return {
|
|
360
360
|
/**
|
|
361
|
-
* This endpoint creates a new booking entry.
|
|
361
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
362
362
|
* @summary Create the booking entry
|
|
363
363
|
* @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
|
|
364
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -369,7 +369,7 @@ var BookingEntriesApiFactory = function (configuration, basePath, axios) {
|
|
|
369
369
|
return localVarFp.createBookingEntry(createBookingEntryRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
370
370
|
},
|
|
371
371
|
/**
|
|
372
|
-
* This endpoint gets a booking entry.
|
|
372
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
373
373
|
* @summary Retrieve the booking entry
|
|
374
374
|
* @param {string} code
|
|
375
375
|
* @param {string} expand
|
|
@@ -381,16 +381,16 @@ var BookingEntriesApiFactory = function (configuration, basePath, axios) {
|
|
|
381
381
|
return localVarFp.getBookingEntry(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
382
382
|
},
|
|
383
383
|
/**
|
|
384
|
-
* This endpoint gets booking entries.
|
|
384
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
385
385
|
* @summary List booking entries
|
|
386
386
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
387
|
-
* @param {
|
|
388
|
-
* @param {
|
|
389
|
-
* @param {
|
|
390
|
-
* @param {
|
|
391
|
-
* @param {
|
|
392
|
-
* @param {
|
|
393
|
-
* @param {
|
|
387
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
388
|
+
* @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.
|
|
389
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
390
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
391
|
+
* @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.
|
|
392
|
+
* @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.
|
|
393
|
+
* @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.
|
|
394
394
|
* @param {*} [options] Override http request option.
|
|
395
395
|
* @throws {RequiredError}
|
|
396
396
|
*/
|
|
@@ -412,7 +412,7 @@ var BookingEntriesApi = /** @class */ (function (_super) {
|
|
|
412
412
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
413
413
|
}
|
|
414
414
|
/**
|
|
415
|
-
* This endpoint creates a new booking entry.
|
|
415
|
+
* This endpoint creates a new booking entry. **Required Permissions** \"accounting-management.accounts.create\"
|
|
416
416
|
* @summary Create the booking entry
|
|
417
417
|
* @param {BookingEntriesApiCreateBookingEntryRequest} requestParameters Request parameters.
|
|
418
418
|
* @param {*} [options] Override http request option.
|
|
@@ -424,7 +424,7 @@ var BookingEntriesApi = /** @class */ (function (_super) {
|
|
|
424
424
|
return (0, exports.BookingEntriesApiFp)(this.configuration).createBookingEntry(requestParameters.createBookingEntryRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
425
425
|
};
|
|
426
426
|
/**
|
|
427
|
-
* This endpoint gets a booking entry.
|
|
427
|
+
* This endpoint gets a booking entry. **Required Permissions** \"accounting-management.accounts.view\"
|
|
428
428
|
* @summary Retrieve the booking entry
|
|
429
429
|
* @param {BookingEntriesApiGetBookingEntryRequest} requestParameters Request parameters.
|
|
430
430
|
* @param {*} [options] Override http request option.
|
|
@@ -436,7 +436,7 @@ var BookingEntriesApi = /** @class */ (function (_super) {
|
|
|
436
436
|
return (0, exports.BookingEntriesApiFp)(this.configuration).getBookingEntry(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
437
437
|
};
|
|
438
438
|
/**
|
|
439
|
-
* This endpoint gets booking entries.
|
|
439
|
+
* This endpoint gets booking entries. **Required Permissions** \"accounting-management.accounts.view\"
|
|
440
440
|
* @summary List booking entries
|
|
441
441
|
* @param {BookingEntriesApiListBookingEntriesRequest} requestParameters Request parameters.
|
|
442
442
|
* @param {*} [options] Override http request option.
|
|
@@ -22,7 +22,7 @@ import { ListFinancialAccountsResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
* 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.
|
|
25
|
+
* 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\"
|
|
26
26
|
* @summary Create the Financial Account
|
|
27
27
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
28
28
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -31,7 +31,7 @@ export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Con
|
|
|
31
31
|
*/
|
|
32
32
|
createFinancialAccount: (createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
34
|
+
* 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\"
|
|
35
35
|
* @summary Delete the Financial Account
|
|
36
36
|
* @param {string} code Unique identifier for the object.
|
|
37
37
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -40,7 +40,7 @@ export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Con
|
|
|
40
40
|
*/
|
|
41
41
|
deleteFinancialAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
* 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.
|
|
43
|
+
* 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\"
|
|
44
44
|
* @summary Retrieve the Financial Account
|
|
45
45
|
* @param {string} code Unique identifier for the object.
|
|
46
46
|
* @param {string} expand
|
|
@@ -50,20 +50,20 @@ export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Con
|
|
|
50
50
|
*/
|
|
51
51
|
getFinancialAccount: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
52
|
/**
|
|
53
|
-
* 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.
|
|
53
|
+
* 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\"
|
|
54
54
|
* @summary List Financial Accounts
|
|
55
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
|
-
* @param {
|
|
57
|
-
* @param {
|
|
56
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
57
|
+
* @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.
|
|
58
58
|
* @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>
|
|
59
|
-
* @param {
|
|
59
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
60
|
* @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>
|
|
61
61
|
* @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/>
|
|
62
62
|
* @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>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
66
|
-
listFinancialAccounts: (authorization?: string, pageSize?:
|
|
66
|
+
listFinancialAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
};
|
|
68
68
|
/**
|
|
69
69
|
* FinancialAccountsApi - functional programming interface
|
|
@@ -71,7 +71,7 @@ export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Con
|
|
|
71
71
|
*/
|
|
72
72
|
export declare const FinancialAccountsApiFp: (configuration?: Configuration) => {
|
|
73
73
|
/**
|
|
74
|
-
* 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.
|
|
74
|
+
* 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\"
|
|
75
75
|
* @summary Create the Financial Account
|
|
76
76
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
77
77
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -80,7 +80,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
|
|
|
80
80
|
*/
|
|
81
81
|
createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFinancialAccountResponseClass>>;
|
|
82
82
|
/**
|
|
83
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
83
|
+
* 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\"
|
|
84
84
|
* @summary Delete the Financial Account
|
|
85
85
|
* @param {string} code Unique identifier for the object.
|
|
86
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -89,7 +89,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
|
|
|
89
89
|
*/
|
|
90
90
|
deleteFinancialAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
91
91
|
/**
|
|
92
|
-
* 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.
|
|
92
|
+
* 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\"
|
|
93
93
|
* @summary Retrieve the Financial Account
|
|
94
94
|
* @param {string} code Unique identifier for the object.
|
|
95
95
|
* @param {string} expand
|
|
@@ -99,20 +99,20 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
|
|
|
99
99
|
*/
|
|
100
100
|
getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialAccountResponseClass>>;
|
|
101
101
|
/**
|
|
102
|
-
* 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.
|
|
102
|
+
* 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\"
|
|
103
103
|
* @summary List Financial Accounts
|
|
104
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
|
-
* @param {
|
|
106
|
-
* @param {
|
|
105
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
106
|
+
* @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.
|
|
107
107
|
* @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>
|
|
108
|
-
* @param {
|
|
108
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
109
|
* @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>
|
|
110
110
|
* @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/>
|
|
111
111
|
* @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>
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
115
|
-
listFinancialAccounts(authorization?: string, pageSize?:
|
|
115
|
+
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>>;
|
|
116
116
|
};
|
|
117
117
|
/**
|
|
118
118
|
* FinancialAccountsApi - factory interface
|
|
@@ -120,7 +120,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
|
|
|
120
120
|
*/
|
|
121
121
|
export declare const FinancialAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
122
122
|
/**
|
|
123
|
-
* 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.
|
|
123
|
+
* 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\"
|
|
124
124
|
* @summary Create the Financial Account
|
|
125
125
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
126
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -129,7 +129,7 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
|
|
|
129
129
|
*/
|
|
130
130
|
createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFinancialAccountResponseClass>;
|
|
131
131
|
/**
|
|
132
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
132
|
+
* 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\"
|
|
133
133
|
* @summary Delete the Financial Account
|
|
134
134
|
* @param {string} code Unique identifier for the object.
|
|
135
135
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -138,7 +138,7 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
|
|
|
138
138
|
*/
|
|
139
139
|
deleteFinancialAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
140
140
|
/**
|
|
141
|
-
* 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.
|
|
141
|
+
* 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\"
|
|
142
142
|
* @summary Retrieve the Financial Account
|
|
143
143
|
* @param {string} code Unique identifier for the object.
|
|
144
144
|
* @param {string} expand
|
|
@@ -148,20 +148,20 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
|
|
|
148
148
|
*/
|
|
149
149
|
getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialAccountResponseClass>;
|
|
150
150
|
/**
|
|
151
|
-
* 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.
|
|
151
|
+
* 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\"
|
|
152
152
|
* @summary List Financial Accounts
|
|
153
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
|
-
* @param {
|
|
155
|
-
* @param {
|
|
154
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
|
+
* @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.
|
|
156
156
|
* @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>
|
|
157
|
-
* @param {
|
|
157
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
158
|
* @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>
|
|
159
159
|
* @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/>
|
|
160
160
|
* @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>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
164
|
-
listFinancialAccounts(authorization?: string, pageSize?:
|
|
164
|
+
listFinancialAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass>;
|
|
165
165
|
};
|
|
166
166
|
/**
|
|
167
167
|
* Request parameters for createFinancialAccount operation in FinancialAccountsApi.
|
|
@@ -240,16 +240,16 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
240
240
|
readonly authorization?: string;
|
|
241
241
|
/**
|
|
242
242
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
243
|
-
* @type {
|
|
243
|
+
* @type {number}
|
|
244
244
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
245
245
|
*/
|
|
246
|
-
readonly pageSize?:
|
|
246
|
+
readonly pageSize?: number;
|
|
247
247
|
/**
|
|
248
|
-
* 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,
|
|
249
|
-
* @type {
|
|
248
|
+
* 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.
|
|
249
|
+
* @type {string}
|
|
250
250
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
251
251
|
*/
|
|
252
|
-
readonly pageToken?:
|
|
252
|
+
readonly pageToken?: string;
|
|
253
253
|
/**
|
|
254
254
|
* 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>
|
|
255
255
|
* @type {string}
|
|
@@ -258,10 +258,10 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
258
258
|
readonly filter?: string;
|
|
259
259
|
/**
|
|
260
260
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
261
|
-
* @type {
|
|
261
|
+
* @type {string}
|
|
262
262
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
263
263
|
*/
|
|
264
|
-
readonly search?:
|
|
264
|
+
readonly search?: string;
|
|
265
265
|
/**
|
|
266
266
|
* 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>
|
|
267
267
|
* @type {string}
|
|
@@ -289,7 +289,7 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
289
289
|
*/
|
|
290
290
|
export declare class FinancialAccountsApi extends BaseAPI {
|
|
291
291
|
/**
|
|
292
|
-
* 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.
|
|
292
|
+
* 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\"
|
|
293
293
|
* @summary Create the Financial Account
|
|
294
294
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
295
295
|
* @param {*} [options] Override http request option.
|
|
@@ -298,7 +298,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
298
298
|
*/
|
|
299
299
|
createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFinancialAccountResponseClass, any>>;
|
|
300
300
|
/**
|
|
301
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
301
|
+
* 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\"
|
|
302
302
|
* @summary Delete the Financial Account
|
|
303
303
|
* @param {FinancialAccountsApiDeleteFinancialAccountRequest} requestParameters Request parameters.
|
|
304
304
|
* @param {*} [options] Override http request option.
|
|
@@ -307,7 +307,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
307
307
|
*/
|
|
308
308
|
deleteFinancialAccount(requestParameters: FinancialAccountsApiDeleteFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
309
309
|
/**
|
|
310
|
-
* 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.
|
|
310
|
+
* 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\"
|
|
311
311
|
* @summary Retrieve the Financial Account
|
|
312
312
|
* @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
|
|
313
313
|
* @param {*} [options] Override http request option.
|
|
@@ -316,7 +316,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
316
316
|
*/
|
|
317
317
|
getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialAccountResponseClass, any>>;
|
|
318
318
|
/**
|
|
319
|
-
* 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.
|
|
319
|
+
* 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\"
|
|
320
320
|
* @summary List Financial Accounts
|
|
321
321
|
* @param {FinancialAccountsApiListFinancialAccountsRequest} requestParameters Request parameters.
|
|
322
322
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +93,7 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* 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.
|
|
96
|
+
* 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\"
|
|
97
97
|
* @summary Create the Financial Account
|
|
98
98
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -142,7 +142,7 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
145
|
+
* 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\"
|
|
146
146
|
* @summary Delete the Financial Account
|
|
147
147
|
* @param {string} code Unique identifier for the object.
|
|
148
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -190,7 +190,7 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
192
|
/**
|
|
193
|
-
* 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.
|
|
193
|
+
* 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\"
|
|
194
194
|
* @summary Retrieve the Financial Account
|
|
195
195
|
* @param {string} code Unique identifier for the object.
|
|
196
196
|
* @param {string} expand
|
|
@@ -244,13 +244,13 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
244
244
|
});
|
|
245
245
|
},
|
|
246
246
|
/**
|
|
247
|
-
* 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.
|
|
247
|
+
* 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\"
|
|
248
248
|
* @summary List Financial Accounts
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
250
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
|
+
* @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.
|
|
252
252
|
* @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>
|
|
253
|
-
* @param {
|
|
253
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
254
|
* @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>
|
|
255
255
|
* @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/>
|
|
256
256
|
* @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>
|
|
@@ -326,7 +326,7 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
326
326
|
var localVarAxiosParamCreator = (0, exports.FinancialAccountsApiAxiosParamCreator)(configuration);
|
|
327
327
|
return {
|
|
328
328
|
/**
|
|
329
|
-
* 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.
|
|
329
|
+
* 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\"
|
|
330
330
|
* @summary Create the Financial Account
|
|
331
331
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
332
332
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -347,7 +347,7 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
347
347
|
});
|
|
348
348
|
},
|
|
349
349
|
/**
|
|
350
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
350
|
+
* 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\"
|
|
351
351
|
* @summary Delete the Financial Account
|
|
352
352
|
* @param {string} code Unique identifier for the object.
|
|
353
353
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -368,7 +368,7 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
368
368
|
});
|
|
369
369
|
},
|
|
370
370
|
/**
|
|
371
|
-
* 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.
|
|
371
|
+
* 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\"
|
|
372
372
|
* @summary Retrieve the Financial Account
|
|
373
373
|
* @param {string} code Unique identifier for the object.
|
|
374
374
|
* @param {string} expand
|
|
@@ -390,13 +390,13 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
390
390
|
});
|
|
391
391
|
},
|
|
392
392
|
/**
|
|
393
|
-
* 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.
|
|
393
|
+
* 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\"
|
|
394
394
|
* @summary List Financial Accounts
|
|
395
395
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
|
-
* @param {
|
|
397
|
-
* @param {
|
|
396
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
|
+
* @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.
|
|
398
398
|
* @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>
|
|
399
|
-
* @param {
|
|
399
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
400
400
|
* @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>
|
|
401
401
|
* @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/>
|
|
402
402
|
* @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>
|
|
@@ -427,7 +427,7 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
427
427
|
var localVarFp = (0, exports.FinancialAccountsApiFp)(configuration);
|
|
428
428
|
return {
|
|
429
429
|
/**
|
|
430
|
-
* 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.
|
|
430
|
+
* 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\"
|
|
431
431
|
* @summary Create the Financial Account
|
|
432
432
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
433
433
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -438,7 +438,7 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
438
438
|
return localVarFp.createFinancialAccount(createFinancialAccountRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
439
439
|
},
|
|
440
440
|
/**
|
|
441
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
441
|
+
* 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\"
|
|
442
442
|
* @summary Delete the Financial Account
|
|
443
443
|
* @param {string} code Unique identifier for the object.
|
|
444
444
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -449,7 +449,7 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
449
449
|
return localVarFp.deleteFinancialAccount(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
452
|
-
* 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.
|
|
452
|
+
* 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\"
|
|
453
453
|
* @summary Retrieve the Financial Account
|
|
454
454
|
* @param {string} code Unique identifier for the object.
|
|
455
455
|
* @param {string} expand
|
|
@@ -461,13 +461,13 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
461
461
|
return localVarFp.getFinancialAccount(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
462
462
|
},
|
|
463
463
|
/**
|
|
464
|
-
* 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.
|
|
464
|
+
* 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\"
|
|
465
465
|
* @summary List Financial Accounts
|
|
466
466
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
467
|
-
* @param {
|
|
468
|
-
* @param {
|
|
467
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
468
|
+
* @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.
|
|
469
469
|
* @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>
|
|
470
|
-
* @param {
|
|
470
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
471
471
|
* @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>
|
|
472
472
|
* @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/>
|
|
473
473
|
* @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>
|
|
@@ -492,7 +492,7 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
492
492
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
493
493
|
}
|
|
494
494
|
/**
|
|
495
|
-
* 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.
|
|
495
|
+
* 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\"
|
|
496
496
|
* @summary Create the Financial Account
|
|
497
497
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
498
498
|
* @param {*} [options] Override http request option.
|
|
@@ -504,7 +504,7 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
504
504
|
return (0, exports.FinancialAccountsApiFp)(this.configuration).createFinancialAccount(requestParameters.createFinancialAccountRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
505
505
|
};
|
|
506
506
|
/**
|
|
507
|
-
* Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
|
|
507
|
+
* 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\"
|
|
508
508
|
* @summary Delete the Financial Account
|
|
509
509
|
* @param {FinancialAccountsApiDeleteFinancialAccountRequest} requestParameters Request parameters.
|
|
510
510
|
* @param {*} [options] Override http request option.
|
|
@@ -516,7 +516,7 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
516
516
|
return (0, exports.FinancialAccountsApiFp)(this.configuration).deleteFinancialAccount(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
517
517
|
};
|
|
518
518
|
/**
|
|
519
|
-
* 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.
|
|
519
|
+
* 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\"
|
|
520
520
|
* @summary Retrieve the Financial Account
|
|
521
521
|
* @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
@@ -528,7 +528,7 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
528
528
|
return (0, exports.FinancialAccountsApiFp)(this.configuration).getFinancialAccount(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
529
529
|
};
|
|
530
530
|
/**
|
|
531
|
-
* 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.
|
|
531
|
+
* 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\"
|
|
532
532
|
* @summary List Financial Accounts
|
|
533
533
|
* @param {FinancialAccountsApiListFinancialAccountsRequest} requestParameters Request parameters.
|
|
534
534
|
* @param {*} [options] Override http request option.
|