@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
|
@@ -31,7 +31,7 @@ import { ListFinancialTransactionsResponseClass } from '../models';
|
|
|
31
31
|
export const FinancialTransactionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
|
-
* This endpoint gets a financial transaction.
|
|
34
|
+
* This endpoint gets a financial transaction. **Required Permissions** \"accounting-management.accounts.view\"
|
|
35
35
|
* @summary Retrieve the financial transaction
|
|
36
36
|
* @param {string} code
|
|
37
37
|
* @param {string} expand
|
|
@@ -83,20 +83,20 @@ export const FinancialTransactionsApiAxiosParamCreator = function (configuration
|
|
|
83
83
|
};
|
|
84
84
|
},
|
|
85
85
|
/**
|
|
86
|
-
* This endpoint list financial transactions.
|
|
86
|
+
* This endpoint list financial transactions. **Required Permissions** \"accounting-management.accounts.view\"
|
|
87
87
|
* @summary List financial transactions
|
|
88
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
|
-
* @param {
|
|
90
|
-
* @param {
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
93
|
-
* @param {
|
|
94
|
-
* @param {
|
|
95
|
-
* @param {
|
|
89
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
90
|
+
* @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.
|
|
91
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
92
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
93
|
+
* @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.
|
|
94
|
+
* @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.
|
|
95
|
+
* @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.
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
97
97
|
* @throws {RequiredError}
|
|
98
98
|
*/
|
|
99
|
-
listFinancialTransactions: async (authorization?: string, pageSize?:
|
|
99
|
+
listFinancialTransactions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
100
100
|
const localVarPath = `/accountingservice/v1/financial-transactions`;
|
|
101
101
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
102
102
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -169,7 +169,7 @@ export const FinancialTransactionsApiFp = function(configuration?: Configuration
|
|
|
169
169
|
const localVarAxiosParamCreator = FinancialTransactionsApiAxiosParamCreator(configuration)
|
|
170
170
|
return {
|
|
171
171
|
/**
|
|
172
|
-
* This endpoint gets a financial transaction.
|
|
172
|
+
* This endpoint gets a financial transaction. **Required Permissions** \"accounting-management.accounts.view\"
|
|
173
173
|
* @summary Retrieve the financial transaction
|
|
174
174
|
* @param {string} code
|
|
175
175
|
* @param {string} expand
|
|
@@ -182,20 +182,20 @@ export const FinancialTransactionsApiFp = function(configuration?: Configuration
|
|
|
182
182
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
183
183
|
},
|
|
184
184
|
/**
|
|
185
|
-
* This endpoint list financial transactions.
|
|
185
|
+
* This endpoint list financial transactions. **Required Permissions** \"accounting-management.accounts.view\"
|
|
186
186
|
* @summary List financial transactions
|
|
187
187
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
188
|
-
* @param {
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {
|
|
192
|
-
* @param {
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
188
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
189
|
+
* @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.
|
|
190
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
191
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
192
|
+
* @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.
|
|
193
|
+
* @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.
|
|
194
|
+
* @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.
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
196
196
|
* @throws {RequiredError}
|
|
197
197
|
*/
|
|
198
|
-
async listFinancialTransactions(authorization?: string, pageSize?:
|
|
198
|
+
async listFinancialTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialTransactionsResponseClass>> {
|
|
199
199
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
200
200
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
201
201
|
},
|
|
@@ -210,7 +210,7 @@ export const FinancialTransactionsApiFactory = function (configuration?: Configu
|
|
|
210
210
|
const localVarFp = FinancialTransactionsApiFp(configuration)
|
|
211
211
|
return {
|
|
212
212
|
/**
|
|
213
|
-
* This endpoint gets a financial transaction.
|
|
213
|
+
* This endpoint gets a financial transaction. **Required Permissions** \"accounting-management.accounts.view\"
|
|
214
214
|
* @summary Retrieve the financial transaction
|
|
215
215
|
* @param {string} code
|
|
216
216
|
* @param {string} expand
|
|
@@ -222,20 +222,20 @@ export const FinancialTransactionsApiFactory = function (configuration?: Configu
|
|
|
222
222
|
return localVarFp.getFinancialTransaction(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
223
223
|
},
|
|
224
224
|
/**
|
|
225
|
-
* This endpoint list financial transactions.
|
|
225
|
+
* This endpoint list financial transactions. **Required Permissions** \"accounting-management.accounts.view\"
|
|
226
226
|
* @summary List financial transactions
|
|
227
227
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
228
|
-
* @param {
|
|
229
|
-
* @param {
|
|
230
|
-
* @param {
|
|
231
|
-
* @param {
|
|
232
|
-
* @param {
|
|
233
|
-
* @param {
|
|
234
|
-
* @param {
|
|
228
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
229
|
+
* @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.
|
|
230
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
231
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
232
|
+
* @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.
|
|
233
|
+
* @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.
|
|
234
|
+
* @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.
|
|
235
235
|
* @param {*} [options] Override http request option.
|
|
236
236
|
* @throws {RequiredError}
|
|
237
237
|
*/
|
|
238
|
-
listFinancialTransactions(authorization?: string, pageSize?:
|
|
238
|
+
listFinancialTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialTransactionsResponseClass> {
|
|
239
239
|
return localVarFp.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
240
240
|
},
|
|
241
241
|
};
|
|
@@ -284,52 +284,52 @@ export interface FinancialTransactionsApiListFinancialTransactionsRequest {
|
|
|
284
284
|
|
|
285
285
|
/**
|
|
286
286
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
287
|
-
* @type {
|
|
287
|
+
* @type {number}
|
|
288
288
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
289
289
|
*/
|
|
290
|
-
readonly pageSize?:
|
|
290
|
+
readonly pageSize?: number
|
|
291
291
|
|
|
292
292
|
/**
|
|
293
|
-
* 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,
|
|
294
|
-
* @type {
|
|
293
|
+
* 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.
|
|
294
|
+
* @type {string}
|
|
295
295
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
296
296
|
*/
|
|
297
|
-
readonly pageToken?:
|
|
297
|
+
readonly pageToken?: string
|
|
298
298
|
|
|
299
299
|
/**
|
|
300
300
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
301
|
-
* @type {
|
|
301
|
+
* @type {string}
|
|
302
302
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
303
303
|
*/
|
|
304
|
-
readonly filter?:
|
|
304
|
+
readonly filter?: string
|
|
305
305
|
|
|
306
306
|
/**
|
|
307
307
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
308
|
-
* @type {
|
|
308
|
+
* @type {string}
|
|
309
309
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
310
310
|
*/
|
|
311
|
-
readonly search?:
|
|
311
|
+
readonly search?: string
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
314
|
* 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.
|
|
315
|
-
* @type {
|
|
315
|
+
* @type {string}
|
|
316
316
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
317
317
|
*/
|
|
318
|
-
readonly order?:
|
|
318
|
+
readonly order?: string
|
|
319
319
|
|
|
320
320
|
/**
|
|
321
|
-
* 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
|
|
322
|
-
* @type {
|
|
321
|
+
* 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.
|
|
322
|
+
* @type {string}
|
|
323
323
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
324
324
|
*/
|
|
325
|
-
readonly expand?:
|
|
325
|
+
readonly expand?: string
|
|
326
326
|
|
|
327
327
|
/**
|
|
328
328
|
* 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.
|
|
329
|
-
* @type {
|
|
329
|
+
* @type {string}
|
|
330
330
|
* @memberof FinancialTransactionsApiListFinancialTransactions
|
|
331
331
|
*/
|
|
332
|
-
readonly filters?:
|
|
332
|
+
readonly filters?: string
|
|
333
333
|
}
|
|
334
334
|
|
|
335
335
|
/**
|
|
@@ -340,7 +340,7 @@ export interface FinancialTransactionsApiListFinancialTransactionsRequest {
|
|
|
340
340
|
*/
|
|
341
341
|
export class FinancialTransactionsApi extends BaseAPI {
|
|
342
342
|
/**
|
|
343
|
-
* This endpoint gets a financial transaction.
|
|
343
|
+
* This endpoint gets a financial transaction. **Required Permissions** \"accounting-management.accounts.view\"
|
|
344
344
|
* @summary Retrieve the financial transaction
|
|
345
345
|
* @param {FinancialTransactionsApiGetFinancialTransactionRequest} requestParameters Request parameters.
|
|
346
346
|
* @param {*} [options] Override http request option.
|
|
@@ -352,7 +352,7 @@ export class FinancialTransactionsApi extends BaseAPI {
|
|
|
352
352
|
}
|
|
353
353
|
|
|
354
354
|
/**
|
|
355
|
-
* This endpoint list financial transactions.
|
|
355
|
+
* This endpoint list financial transactions. **Required Permissions** \"accounting-management.accounts.view\"
|
|
356
356
|
* @summary List financial transactions
|
|
357
357
|
* @param {FinancialTransactionsApiListFinancialTransactionsRequest} requestParameters Request parameters.
|
|
358
358
|
* @param {*} [options] Override http request option.
|
package/api/number-ranges-api.ts
CHANGED
|
@@ -35,7 +35,7 @@ import { ListNumberRangeResponseClass } from '../models';
|
|
|
35
35
|
export const NumberRangesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
38
|
+
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
39
39
|
* @summary Create the Number Range
|
|
40
40
|
* @param {CreateNumberRangeRequestDto} createNumberRangeRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -82,7 +82,7 @@ export const NumberRangesApiAxiosParamCreator = function (configuration?: Config
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.
|
|
85
|
+
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
86
86
|
* @summary Delete the Personal Account
|
|
87
87
|
* @param {string} code Unique identifier for the object.
|
|
88
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -127,7 +127,7 @@ export const NumberRangesApiAxiosParamCreator = function (configuration?: Config
|
|
|
127
127
|
};
|
|
128
128
|
},
|
|
129
129
|
/**
|
|
130
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
130
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
131
131
|
* @summary Retrieve the Financial Account
|
|
132
132
|
* @param {string} code Unique identifier for the object.
|
|
133
133
|
* @param {string} expand
|
|
@@ -179,20 +179,20 @@ export const NumberRangesApiAxiosParamCreator = function (configuration?: Config
|
|
|
179
179
|
};
|
|
180
180
|
},
|
|
181
181
|
/**
|
|
182
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
182
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
183
183
|
* @summary List Financial Accounts
|
|
184
184
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
|
-
* @param {
|
|
186
|
-
* @param {
|
|
185
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
187
187
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
188
|
-
* @param {
|
|
188
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
189
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, slug, accountType</i>
|
|
190
190
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
191
191
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
195
|
-
listNumberRanges: async (authorization?: string, pageSize?:
|
|
195
|
+
listNumberRanges: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
196
|
const localVarPath = `/accountingservice/v1/number-ranges`;
|
|
197
197
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
198
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -265,7 +265,7 @@ export const NumberRangesApiFp = function(configuration?: Configuration) {
|
|
|
265
265
|
const localVarAxiosParamCreator = NumberRangesApiAxiosParamCreator(configuration)
|
|
266
266
|
return {
|
|
267
267
|
/**
|
|
268
|
-
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
268
|
+
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
269
269
|
* @summary Create the Number Range
|
|
270
270
|
* @param {CreateNumberRangeRequestDto} createNumberRangeRequestDto
|
|
271
271
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -277,7 +277,7 @@ export const NumberRangesApiFp = function(configuration?: Configuration) {
|
|
|
277
277
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
278
278
|
},
|
|
279
279
|
/**
|
|
280
|
-
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.
|
|
280
|
+
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
281
281
|
* @summary Delete the Personal Account
|
|
282
282
|
* @param {string} code Unique identifier for the object.
|
|
283
283
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -289,7 +289,7 @@ export const NumberRangesApiFp = function(configuration?: Configuration) {
|
|
|
289
289
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
290
290
|
},
|
|
291
291
|
/**
|
|
292
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
292
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
293
293
|
* @summary Retrieve the Financial Account
|
|
294
294
|
* @param {string} code Unique identifier for the object.
|
|
295
295
|
* @param {string} expand
|
|
@@ -302,20 +302,20 @@ export const NumberRangesApiFp = function(configuration?: Configuration) {
|
|
|
302
302
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
303
303
|
},
|
|
304
304
|
/**
|
|
305
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
305
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
306
306
|
* @summary List Financial Accounts
|
|
307
307
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
308
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
310
310
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
311
|
-
* @param {
|
|
311
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
312
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, slug, accountType</i>
|
|
313
313
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
314
314
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
async listNumberRanges(authorization?: string, pageSize?:
|
|
318
|
+
async listNumberRanges(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNumberRangeResponseClass>> {
|
|
319
319
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listNumberRanges(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
320
320
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
321
321
|
},
|
|
@@ -330,7 +330,7 @@ export const NumberRangesApiFactory = function (configuration?: Configuration, b
|
|
|
330
330
|
const localVarFp = NumberRangesApiFp(configuration)
|
|
331
331
|
return {
|
|
332
332
|
/**
|
|
333
|
-
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
333
|
+
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
334
334
|
* @summary Create the Number Range
|
|
335
335
|
* @param {CreateNumberRangeRequestDto} createNumberRangeRequestDto
|
|
336
336
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -341,7 +341,7 @@ export const NumberRangesApiFactory = function (configuration?: Configuration, b
|
|
|
341
341
|
return localVarFp.createNumberRange(createNumberRangeRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
342
342
|
},
|
|
343
343
|
/**
|
|
344
|
-
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.
|
|
344
|
+
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
345
345
|
* @summary Delete the Personal Account
|
|
346
346
|
* @param {string} code Unique identifier for the object.
|
|
347
347
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -352,7 +352,7 @@ export const NumberRangesApiFactory = function (configuration?: Configuration, b
|
|
|
352
352
|
return localVarFp.deleteNumberRange(code, authorization, options).then((request) => request(axios, basePath));
|
|
353
353
|
},
|
|
354
354
|
/**
|
|
355
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
355
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
356
356
|
* @summary Retrieve the Financial Account
|
|
357
357
|
* @param {string} code Unique identifier for the object.
|
|
358
358
|
* @param {string} expand
|
|
@@ -364,20 +364,20 @@ export const NumberRangesApiFactory = function (configuration?: Configuration, b
|
|
|
364
364
|
return localVarFp.getNumberRange(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
365
365
|
},
|
|
366
366
|
/**
|
|
367
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
367
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
368
368
|
* @summary List Financial Accounts
|
|
369
369
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
370
|
-
* @param {
|
|
371
|
-
* @param {
|
|
370
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
371
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
372
372
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
373
|
-
* @param {
|
|
373
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
374
374
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, slug, accountType</i>
|
|
375
375
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
376
376
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
379
379
|
*/
|
|
380
|
-
listNumberRanges(authorization?: string, pageSize?:
|
|
380
|
+
listNumberRanges(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNumberRangeResponseClass> {
|
|
381
381
|
return localVarFp.listNumberRanges(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
382
382
|
},
|
|
383
383
|
};
|
|
@@ -468,17 +468,17 @@ export interface NumberRangesApiListNumberRangesRequest {
|
|
|
468
468
|
|
|
469
469
|
/**
|
|
470
470
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
471
|
-
* @type {
|
|
471
|
+
* @type {number}
|
|
472
472
|
* @memberof NumberRangesApiListNumberRanges
|
|
473
473
|
*/
|
|
474
|
-
readonly pageSize?:
|
|
474
|
+
readonly pageSize?: number
|
|
475
475
|
|
|
476
476
|
/**
|
|
477
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
478
|
-
* @type {
|
|
477
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
478
|
+
* @type {string}
|
|
479
479
|
* @memberof NumberRangesApiListNumberRanges
|
|
480
480
|
*/
|
|
481
|
-
readonly pageToken?:
|
|
481
|
+
readonly pageToken?: string
|
|
482
482
|
|
|
483
483
|
/**
|
|
484
484
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: slug, createdAt, accountType</i>
|
|
@@ -489,10 +489,10 @@ export interface NumberRangesApiListNumberRangesRequest {
|
|
|
489
489
|
|
|
490
490
|
/**
|
|
491
491
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
492
|
-
* @type {
|
|
492
|
+
* @type {string}
|
|
493
493
|
* @memberof NumberRangesApiListNumberRanges
|
|
494
494
|
*/
|
|
495
|
-
readonly search?:
|
|
495
|
+
readonly search?: string
|
|
496
496
|
|
|
497
497
|
/**
|
|
498
498
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, slug, accountType</i>
|
|
@@ -524,7 +524,7 @@ export interface NumberRangesApiListNumberRangesRequest {
|
|
|
524
524
|
*/
|
|
525
525
|
export class NumberRangesApi extends BaseAPI {
|
|
526
526
|
/**
|
|
527
|
-
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
|
|
527
|
+
* This will create an number range in the database. The number range will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account. **Required Permissions** \"accounting-management.accounts.create\"
|
|
528
528
|
* @summary Create the Number Range
|
|
529
529
|
* @param {NumberRangesApiCreateNumberRangeRequest} requestParameters Request parameters.
|
|
530
530
|
* @param {*} [options] Override http request option.
|
|
@@ -536,7 +536,7 @@ export class NumberRangesApi extends BaseAPI {
|
|
|
536
536
|
}
|
|
537
537
|
|
|
538
538
|
/**
|
|
539
|
-
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.
|
|
539
|
+
* Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it. **Required Permissions** \"accounting-management.accounts.delete\"
|
|
540
540
|
* @summary Delete the Personal Account
|
|
541
541
|
* @param {NumberRangesApiDeleteNumberRangeRequest} requestParameters Request parameters.
|
|
542
542
|
* @param {*} [options] Override http request option.
|
|
@@ -548,7 +548,7 @@ export class NumberRangesApi extends BaseAPI {
|
|
|
548
548
|
}
|
|
549
549
|
|
|
550
550
|
/**
|
|
551
|
-
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
|
|
551
|
+
* Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information. **Required Permissions** \"accounting-management.accounts.view\"
|
|
552
552
|
* @summary Retrieve the Financial Account
|
|
553
553
|
* @param {NumberRangesApiGetNumberRangeRequest} requestParameters Request parameters.
|
|
554
554
|
* @param {*} [options] Override http request option.
|
|
@@ -560,7 +560,7 @@ export class NumberRangesApi extends BaseAPI {
|
|
|
560
560
|
}
|
|
561
561
|
|
|
562
562
|
/**
|
|
563
|
-
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
563
|
+
* Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"accounting-management.accounts.view\"
|
|
564
564
|
* @summary List Financial Accounts
|
|
565
565
|
* @param {NumberRangesApiListNumberRangesRequest} requestParameters Request parameters.
|
|
566
566
|
* @param {*} [options] Override http request option.
|