@emilgroup/accounting-sdk 1.34.1-beta.7 → 1.34.1-beta.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +35 -0
- package/README.md +2 -2
- package/api/accounting-configs-api.ts +120 -14
- package/api/booking-entries-api.ts +234 -10
- package/api/commission-account-mappings-api.ts +1207 -0
- package/api/financial-accounts-api.ts +150 -20
- package/api/financial-transactions-api.ts +8 -4
- package/api/number-ranges-api.ts +16 -8
- package/api/personal-accounts-api.ts +16 -8
- package/api/product-account-mappings-api.ts +1715 -0
- package/api.ts +4 -0
- package/base.ts +174 -41
- package/common.ts +3 -2
- package/configuration.ts +20 -0
- package/dist/api/accounting-configs-api.d.ts +54 -7
- package/dist/api/accounting-configs-api.js +139 -28
- package/dist/api/booking-entries-api.d.ts +121 -7
- package/dist/api/booking-entries-api.js +211 -14
- package/dist/api/commission-account-mappings-api.d.ts +685 -0
- package/dist/api/commission-account-mappings-api.js +1022 -0
- package/dist/api/financial-accounts-api.d.ts +82 -16
- package/dist/api/financial-accounts-api.js +134 -24
- package/dist/api/financial-transactions-api.d.ts +2 -2
- package/dist/api/financial-transactions-api.js +8 -6
- package/dist/api/health-api.d.ts +1 -1
- package/dist/api/number-ranges-api.d.ts +4 -4
- package/dist/api/number-ranges-api.js +22 -14
- package/dist/api/personal-accounts-api.d.ts +4 -4
- package/dist/api/personal-accounts-api.js +22 -14
- package/dist/api/product-account-mappings-api.d.ts +972 -0
- package/dist/api/product-account-mappings-api.js +1447 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +24 -0
- package/dist/base.js +178 -59
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -0
- package/dist/configuration.d.ts +17 -0
- package/dist/configuration.js +2 -0
- package/dist/models/account-mapping-class.d.ts +2 -0
- package/dist/models/account-mapping-class.js +3 -1
- package/dist/models/accounting-config-class.d.ts +11 -0
- package/dist/models/accounting-config-class.js +5 -0
- package/dist/models/accounting-config-data-dto-default-account-mappings.d.ts +8 -0
- package/dist/models/accounting-config-data-dto-default-account-mappings.js +3 -1
- package/dist/models/booking-entry-class.d.ts +21 -0
- package/dist/models/booking-entry-class.js +9 -1
- package/dist/models/commission-account-mapping-class.d.ts +49 -0
- package/dist/models/commission-account-mapping-class.js +15 -0
- package/dist/models/commission-agreement-account-mapping-detail-class.d.ts +44 -0
- package/dist/models/commission-agreement-account-mapping-detail-class.js +15 -0
- package/dist/models/commission-agreement-partner-class.d.ts +30 -0
- package/dist/models/commission-agreement-partner-class.js +15 -0
- package/dist/models/commission-agreement-with-account-mapping-class.d.ts +43 -0
- package/dist/models/commission-agreement-with-account-mapping-class.js +15 -0
- package/dist/models/commission-type-account-mapping-class.d.ts +31 -0
- package/dist/models/commission-type-account-mapping-class.js +15 -0
- package/dist/models/create-booking-entry-request-dto.d.ts +21 -0
- package/dist/models/create-booking-entry-request-dto.js +9 -0
- package/dist/models/create-financial-account-request-dto.d.ts +8 -0
- package/dist/models/create-financial-account-request-dto.js +3 -1
- package/dist/models/create-or-correct-opening-balance-dto.d.ts +25 -0
- package/dist/models/create-or-correct-opening-balance-dto.js +15 -0
- package/dist/models/create-or-correct-opening-balance-response-class.d.ts +25 -0
- package/dist/models/create-or-correct-opening-balance-response-class.js +15 -0
- package/dist/models/financial-account-class.d.ts +24 -1
- package/dist/models/financial-account-class.js +5 -1
- package/dist/models/financial-transaction-class.d.ts +6 -0
- package/dist/models/financial-transaction-data-dto.d.ts +7 -0
- package/dist/models/financial-transaction-data-dto.js +1 -0
- package/dist/models/get-activation-snapshot-response-class.d.ts +25 -0
- package/dist/models/get-activation-snapshot-response-class.js +15 -0
- package/dist/models/index.d.ts +33 -0
- package/dist/models/index.js +33 -0
- package/dist/models/list-commission-account-mappings-response-class.d.ts +43 -0
- package/dist/models/list-commission-account-mappings-response-class.js +15 -0
- package/dist/models/list-commission-agreements-with-account-mappings-response-class.d.ts +43 -0
- package/dist/models/list-commission-agreements-with-account-mappings-response-class.js +15 -0
- package/dist/models/list-commission-type-account-mappings-response-class.d.ts +43 -0
- package/dist/models/list-commission-type-account-mappings-response-class.js +15 -0
- package/dist/models/list-product-account-mappings-response-class.d.ts +43 -0
- package/dist/models/list-product-account-mappings-response-class.js +15 -0
- package/dist/models/list-products-with-account-mappings-response-class.d.ts +43 -0
- package/dist/models/list-products-with-account-mappings-response-class.js +15 -0
- package/dist/models/opening-balance-item-dto.d.ts +41 -0
- package/dist/models/opening-balance-item-dto.js +20 -0
- package/dist/models/post-financial-event-request-dto.d.ts +45 -0
- package/dist/models/post-financial-event-request-dto.js +24 -0
- package/dist/models/post-financial-event-response-class.d.ts +25 -0
- package/dist/models/post-financial-event-response-class.js +15 -0
- package/dist/models/premium-item-account-mapping-class.d.ts +37 -0
- package/dist/models/premium-item-account-mapping-class.js +15 -0
- package/dist/models/product-account-mapping-class.d.ts +61 -0
- package/dist/models/product-account-mapping-class.js +15 -0
- package/dist/models/product-account-mapping-detail-class.d.ts +56 -0
- package/dist/models/product-account-mapping-detail-class.js +15 -0
- package/dist/models/product-risk-carrier-class.d.ts +42 -0
- package/dist/models/product-risk-carrier-class.js +15 -0
- package/dist/models/product-version-account-mapping-detail-class.d.ts +50 -0
- package/dist/models/product-version-account-mapping-detail-class.js +15 -0
- package/dist/models/product-version-with-account-mappings-class.d.ts +42 -0
- package/dist/models/product-version-with-account-mappings-class.js +15 -0
- package/dist/models/product-with-account-mappings-class.d.ts +49 -0
- package/dist/models/product-with-account-mappings-class.js +15 -0
- package/dist/models/put-premium-item-account-body-dto.d.ts +24 -0
- package/dist/models/put-premium-item-account-body-dto.js +15 -0
- package/dist/models/put-product-category-account-body-dto.d.ts +24 -0
- package/dist/models/put-product-category-account-body-dto.js +15 -0
- package/dist/models/put-product-risk-carrier-body-dto.d.ts +24 -0
- package/dist/models/put-product-risk-carrier-body-dto.js +15 -0
- package/dist/models/put-product-version-category-account-body-dto.d.ts +24 -0
- package/dist/models/put-product-version-category-account-body-dto.js +15 -0
- package/dist/models/resolved-account-mapping-class.d.ts +31 -0
- package/dist/models/resolved-account-mapping-class.js +15 -0
- package/dist/models/resolved-commission-account-mapping-class.d.ts +37 -0
- package/dist/models/resolved-commission-account-mapping-class.js +21 -0
- package/dist/models/update-commission-agreement-account-body-dto.d.ts +24 -0
- package/dist/models/update-commission-agreement-account-body-dto.js +15 -0
- package/dist/models/update-commission-type-account-body-dto.d.ts +24 -0
- package/dist/models/update-commission-type-account-body-dto.js +15 -0
- package/dist/models/update-financial-account-body-dto.d.ts +48 -0
- package/dist/models/update-financial-account-body-dto.js +15 -0
- package/dist/models/update-financial-account-response-class.d.ts +25 -0
- package/dist/models/update-financial-account-response-class.js +15 -0
- package/models/account-mapping-class.ts +3 -1
- package/models/accounting-config-class.ts +14 -0
- package/models/accounting-config-data-dto-default-account-mappings.ts +9 -1
- package/models/booking-entry-class.ts +22 -0
- package/models/commission-account-mapping-class.ts +55 -0
- package/models/commission-agreement-account-mapping-detail-class.ts +50 -0
- package/models/commission-agreement-partner-class.ts +36 -0
- package/models/commission-agreement-with-account-mapping-class.ts +49 -0
- package/models/commission-type-account-mapping-class.ts +37 -0
- package/models/create-booking-entry-request-dto.ts +24 -0
- package/models/create-financial-account-request-dto.ts +9 -1
- package/models/create-or-correct-opening-balance-dto.ts +31 -0
- package/models/create-or-correct-opening-balance-response-class.ts +31 -0
- package/models/financial-account-class.ts +25 -1
- package/models/financial-transaction-class.ts +6 -0
- package/models/financial-transaction-data-dto.ts +7 -0
- package/models/get-activation-snapshot-response-class.ts +31 -0
- package/models/index.ts +33 -0
- package/models/list-commission-account-mappings-response-class.ts +49 -0
- package/models/list-commission-agreements-with-account-mappings-response-class.ts +49 -0
- package/models/list-commission-type-account-mappings-response-class.ts +49 -0
- package/models/list-product-account-mappings-response-class.ts +49 -0
- package/models/list-products-with-account-mappings-response-class.ts +49 -0
- package/models/opening-balance-item-dto.ts +50 -0
- package/models/post-financial-event-request-dto.ts +54 -0
- package/models/post-financial-event-response-class.ts +31 -0
- package/models/premium-item-account-mapping-class.ts +43 -0
- package/models/product-account-mapping-class.ts +67 -0
- package/models/product-account-mapping-detail-class.ts +62 -0
- package/models/product-risk-carrier-class.ts +48 -0
- package/models/product-version-account-mapping-detail-class.ts +56 -0
- package/models/product-version-with-account-mappings-class.ts +48 -0
- package/models/product-with-account-mappings-class.ts +55 -0
- package/models/put-premium-item-account-body-dto.ts +30 -0
- package/models/put-product-category-account-body-dto.ts +30 -0
- package/models/put-product-risk-carrier-body-dto.ts +30 -0
- package/models/put-product-version-category-account-body-dto.ts +30 -0
- package/models/resolved-account-mapping-class.ts +37 -0
- package/models/resolved-commission-account-mapping-class.ts +46 -0
- package/models/update-commission-agreement-account-body-dto.ts +30 -0
- package/models/update-commission-type-account-body-dto.ts +30 -0
- package/models/update-financial-account-body-dto.ts +54 -0
- package/models/update-financial-account-response-class.ts +31 -0
- package/package.json +2 -2
|
@@ -16,13 +16,15 @@ import { CreateFinancialAccountRequestDto } from '../models';
|
|
|
16
16
|
import { CreateFinancialAccountResponseClass } from '../models';
|
|
17
17
|
import { GetFinancialAccountResponseClass } from '../models';
|
|
18
18
|
import { ListFinancialAccountsResponseClass } from '../models';
|
|
19
|
+
import { UpdateFinancialAccountBodyDto } from '../models';
|
|
20
|
+
import { UpdateFinancialAccountResponseClass } from '../models';
|
|
19
21
|
/**
|
|
20
22
|
* FinancialAccountsApi - axios parameter creator
|
|
21
23
|
* @export
|
|
22
24
|
*/
|
|
23
25
|
export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
26
|
/**
|
|
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.financial-accounts.create\"
|
|
27
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
26
28
|
* @summary Create the Financial Account
|
|
27
29
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
28
30
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -55,15 +57,25 @@ export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Con
|
|
|
55
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
57
59
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
60
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
59
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
62
|
* @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, description, functionalCategory, type</i>
|
|
61
63
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
64
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
64
66
|
* @throws {RequiredError}
|
|
65
67
|
*/
|
|
66
68
|
listFinancialAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
71
|
+
* @summary Update the Financial Account
|
|
72
|
+
* @param {string} code Unique identifier for the object.
|
|
73
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
74
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
updateFinancialAccount: (code: string, updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
79
|
};
|
|
68
80
|
/**
|
|
69
81
|
* FinancialAccountsApi - functional programming interface
|
|
@@ -71,7 +83,7 @@ export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Con
|
|
|
71
83
|
*/
|
|
72
84
|
export declare const FinancialAccountsApiFp: (configuration?: Configuration) => {
|
|
73
85
|
/**
|
|
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.financial-accounts.create\"
|
|
86
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
75
87
|
* @summary Create the Financial Account
|
|
76
88
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
77
89
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -104,15 +116,25 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
|
|
|
104
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
106
118
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
119
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
108
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
121
|
* @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, description, functionalCategory, type</i>
|
|
110
122
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
123
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
112
124
|
* @param {*} [options] Override http request option.
|
|
113
125
|
* @throws {RequiredError}
|
|
114
126
|
*/
|
|
115
127
|
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>>;
|
|
128
|
+
/**
|
|
129
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
130
|
+
* @summary Update the Financial Account
|
|
131
|
+
* @param {string} code Unique identifier for the object.
|
|
132
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
133
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
updateFinancialAccount(code: string, updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFinancialAccountResponseClass>>;
|
|
116
138
|
};
|
|
117
139
|
/**
|
|
118
140
|
* FinancialAccountsApi - factory interface
|
|
@@ -120,7 +142,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
|
|
|
120
142
|
*/
|
|
121
143
|
export declare const FinancialAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
122
144
|
/**
|
|
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.financial-accounts.create\"
|
|
145
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
124
146
|
* @summary Create the Financial Account
|
|
125
147
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
126
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -153,15 +175,25 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
|
|
|
153
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
177
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
178
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
157
179
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
180
|
* @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, description, functionalCategory, type</i>
|
|
159
181
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
182
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
161
183
|
* @param {*} [options] Override http request option.
|
|
162
184
|
* @throws {RequiredError}
|
|
163
185
|
*/
|
|
164
186
|
listFinancialAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass>;
|
|
187
|
+
/**
|
|
188
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
189
|
+
* @summary Update the Financial Account
|
|
190
|
+
* @param {string} code Unique identifier for the object.
|
|
191
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
192
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
updateFinancialAccount(code: string, updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto, authorization?: string, options?: any): AxiosPromise<UpdateFinancialAccountResponseClass>;
|
|
165
197
|
};
|
|
166
198
|
/**
|
|
167
199
|
* Request parameters for createFinancialAccount operation in FinancialAccountsApi.
|
|
@@ -251,7 +283,7 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
251
283
|
*/
|
|
252
284
|
readonly pageToken?: string;
|
|
253
285
|
/**
|
|
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, status, isControlAccount, functionalCategory</i>
|
|
286
|
+
* 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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
255
287
|
* @type {string}
|
|
256
288
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
257
289
|
*/
|
|
@@ -275,12 +307,37 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
275
307
|
*/
|
|
276
308
|
readonly expand?: string;
|
|
277
309
|
/**
|
|
278
|
-
* 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, status, isControlAccount, functionalCategory</i>
|
|
310
|
+
* 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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
279
311
|
* @type {string}
|
|
280
312
|
* @memberof FinancialAccountsApiListFinancialAccounts
|
|
281
313
|
*/
|
|
282
314
|
readonly filters?: string;
|
|
283
315
|
}
|
|
316
|
+
/**
|
|
317
|
+
* Request parameters for updateFinancialAccount operation in FinancialAccountsApi.
|
|
318
|
+
* @export
|
|
319
|
+
* @interface FinancialAccountsApiUpdateFinancialAccountRequest
|
|
320
|
+
*/
|
|
321
|
+
export interface FinancialAccountsApiUpdateFinancialAccountRequest {
|
|
322
|
+
/**
|
|
323
|
+
* Unique identifier for the object.
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof FinancialAccountsApiUpdateFinancialAccount
|
|
326
|
+
*/
|
|
327
|
+
readonly code: string;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {UpdateFinancialAccountBodyDto}
|
|
331
|
+
* @memberof FinancialAccountsApiUpdateFinancialAccount
|
|
332
|
+
*/
|
|
333
|
+
readonly updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto;
|
|
334
|
+
/**
|
|
335
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof FinancialAccountsApiUpdateFinancialAccount
|
|
338
|
+
*/
|
|
339
|
+
readonly authorization?: string;
|
|
340
|
+
}
|
|
284
341
|
/**
|
|
285
342
|
* FinancialAccountsApi - object-oriented interface
|
|
286
343
|
* @export
|
|
@@ -289,14 +346,14 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
|
|
|
289
346
|
*/
|
|
290
347
|
export declare class FinancialAccountsApi extends BaseAPI {
|
|
291
348
|
/**
|
|
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.financial-accounts.create\"
|
|
349
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
293
350
|
* @summary Create the Financial Account
|
|
294
351
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
295
352
|
* @param {*} [options] Override http request option.
|
|
296
353
|
* @throws {RequiredError}
|
|
297
354
|
* @memberof FinancialAccountsApi
|
|
298
355
|
*/
|
|
299
|
-
createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFinancialAccountResponseClass, any, {}>>;
|
|
356
|
+
createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFinancialAccountResponseClass, any, {}, any>>;
|
|
300
357
|
/**
|
|
301
358
|
* 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.financial-accounts.delete\"
|
|
302
359
|
* @summary Delete the Financial Account
|
|
@@ -305,7 +362,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
305
362
|
* @throws {RequiredError}
|
|
306
363
|
* @memberof FinancialAccountsApi
|
|
307
364
|
*/
|
|
308
|
-
deleteFinancialAccount(requestParameters: FinancialAccountsApiDeleteFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
365
|
+
deleteFinancialAccount(requestParameters: FinancialAccountsApiDeleteFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
309
366
|
/**
|
|
310
367
|
* 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.financial-accounts.view\"
|
|
311
368
|
* @summary Retrieve the Financial Account
|
|
@@ -314,7 +371,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
314
371
|
* @throws {RequiredError}
|
|
315
372
|
* @memberof FinancialAccountsApi
|
|
316
373
|
*/
|
|
317
|
-
getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialAccountResponseClass, any, {}>>;
|
|
374
|
+
getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialAccountResponseClass, any, {}, any>>;
|
|
318
375
|
/**
|
|
319
376
|
* 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.financial-accounts.view\"
|
|
320
377
|
* @summary List Financial Accounts
|
|
@@ -323,5 +380,14 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
323
380
|
* @throws {RequiredError}
|
|
324
381
|
* @memberof FinancialAccountsApi
|
|
325
382
|
*/
|
|
326
|
-
listFinancialAccounts(requestParameters?: FinancialAccountsApiListFinancialAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialAccountsResponseClass, any, {}>>;
|
|
383
|
+
listFinancialAccounts(requestParameters?: FinancialAccountsApiListFinancialAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialAccountsResponseClass, any, {}, any>>;
|
|
384
|
+
/**
|
|
385
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
386
|
+
* @summary Update the Financial Account
|
|
387
|
+
* @param {FinancialAccountsApiUpdateFinancialAccountRequest} requestParameters Request parameters.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
* @memberof FinancialAccountsApi
|
|
391
|
+
*/
|
|
392
|
+
updateFinancialAccount(requestParameters: FinancialAccountsApiUpdateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFinancialAccountResponseClass, any, {}, any>>;
|
|
327
393
|
}
|
|
@@ -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. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-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.
|
|
@@ -103,7 +103,7 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
103
103
|
createFinancialAccount: function (createFinancialAccountRequestDto, authorization, options) {
|
|
104
104
|
if (options === void 0) { options = {}; }
|
|
105
105
|
return __awaiter(_this, void 0, void 0, function () {
|
|
106
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
106
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
107
107
|
return __generator(this, function (_a) {
|
|
108
108
|
switch (_a.label) {
|
|
109
109
|
case 0:
|
|
@@ -120,13 +120,16 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
120
120
|
localVarQueryParameter = {};
|
|
121
121
|
// authentication bearer required
|
|
122
122
|
// http bearer authentication required
|
|
123
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
123
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
124
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
125
|
+
];
|
|
124
126
|
case 1:
|
|
125
127
|
// authentication bearer required
|
|
126
128
|
// http bearer authentication required
|
|
127
129
|
_a.sent();
|
|
128
|
-
|
|
129
|
-
|
|
130
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
131
|
+
if (authorizationValue) {
|
|
132
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
130
133
|
}
|
|
131
134
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
132
135
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -152,7 +155,7 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
152
155
|
deleteFinancialAccount: function (code, authorization, options) {
|
|
153
156
|
if (options === void 0) { options = {}; }
|
|
154
157
|
return __awaiter(_this, void 0, void 0, function () {
|
|
155
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
158
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
156
159
|
return __generator(this, function (_a) {
|
|
157
160
|
switch (_a.label) {
|
|
158
161
|
case 0:
|
|
@@ -170,13 +173,16 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
170
173
|
localVarQueryParameter = {};
|
|
171
174
|
// authentication bearer required
|
|
172
175
|
// http bearer authentication required
|
|
173
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
176
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
177
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
178
|
+
];
|
|
174
179
|
case 1:
|
|
175
180
|
// authentication bearer required
|
|
176
181
|
// http bearer authentication required
|
|
177
182
|
_a.sent();
|
|
178
|
-
|
|
179
|
-
|
|
183
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
184
|
+
if (authorizationValue) {
|
|
185
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
180
186
|
}
|
|
181
187
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
182
188
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -201,7 +207,7 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
201
207
|
getFinancialAccount: function (code, expand, authorization, options) {
|
|
202
208
|
if (options === void 0) { options = {}; }
|
|
203
209
|
return __awaiter(_this, void 0, void 0, function () {
|
|
204
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
210
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
205
211
|
return __generator(this, function (_a) {
|
|
206
212
|
switch (_a.label) {
|
|
207
213
|
case 0:
|
|
@@ -229,8 +235,9 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
229
235
|
if (expand !== undefined) {
|
|
230
236
|
localVarQueryParameter['expand'] = expand;
|
|
231
237
|
}
|
|
232
|
-
|
|
233
|
-
|
|
238
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
239
|
+
if (authorizationValue) {
|
|
240
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
234
241
|
}
|
|
235
242
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
236
243
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -249,18 +256,18 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
249
256
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
257
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
258
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
259
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
253
260
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
261
|
* @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, description, functionalCategory, type</i>
|
|
255
262
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
263
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
257
264
|
* @param {*} [options] Override http request option.
|
|
258
265
|
* @throws {RequiredError}
|
|
259
266
|
*/
|
|
260
267
|
listFinancialAccounts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
261
268
|
if (options === void 0) { options = {}; }
|
|
262
269
|
return __awaiter(_this, void 0, void 0, function () {
|
|
263
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
270
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
264
271
|
return __generator(this, function (_a) {
|
|
265
272
|
switch (_a.label) {
|
|
266
273
|
case 0:
|
|
@@ -301,8 +308,9 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
301
308
|
if (filters !== undefined) {
|
|
302
309
|
localVarQueryParameter['filters'] = filters;
|
|
303
310
|
}
|
|
304
|
-
|
|
305
|
-
|
|
311
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
312
|
+
if (authorizationValue) {
|
|
313
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
306
314
|
}
|
|
307
315
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
308
316
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -315,6 +323,62 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
315
323
|
});
|
|
316
324
|
});
|
|
317
325
|
},
|
|
326
|
+
/**
|
|
327
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
328
|
+
* @summary Update the Financial Account
|
|
329
|
+
* @param {string} code Unique identifier for the object.
|
|
330
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
331
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
332
|
+
* @param {*} [options] Override http request option.
|
|
333
|
+
* @throws {RequiredError}
|
|
334
|
+
*/
|
|
335
|
+
updateFinancialAccount: function (code, updateFinancialAccountBodyDto, authorization, options) {
|
|
336
|
+
if (options === void 0) { options = {}; }
|
|
337
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
338
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
339
|
+
return __generator(this, function (_a) {
|
|
340
|
+
switch (_a.label) {
|
|
341
|
+
case 0:
|
|
342
|
+
// verify required parameter 'code' is not null or undefined
|
|
343
|
+
(0, common_1.assertParamExists)('updateFinancialAccount', 'code', code);
|
|
344
|
+
// verify required parameter 'updateFinancialAccountBodyDto' is not null or undefined
|
|
345
|
+
(0, common_1.assertParamExists)('updateFinancialAccount', 'updateFinancialAccountBodyDto', updateFinancialAccountBodyDto);
|
|
346
|
+
localVarPath = "/accountingservice/v1/financial-accounts/{code}"
|
|
347
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
348
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
349
|
+
if (configuration) {
|
|
350
|
+
baseOptions = configuration.baseOptions;
|
|
351
|
+
baseAccessToken = configuration.accessToken;
|
|
352
|
+
}
|
|
353
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
354
|
+
localVarHeaderParameter = {};
|
|
355
|
+
localVarQueryParameter = {};
|
|
356
|
+
// authentication bearer required
|
|
357
|
+
// http bearer authentication required
|
|
358
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
359
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
360
|
+
];
|
|
361
|
+
case 1:
|
|
362
|
+
// authentication bearer required
|
|
363
|
+
// http bearer authentication required
|
|
364
|
+
_a.sent();
|
|
365
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
366
|
+
if (authorizationValue) {
|
|
367
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
368
|
+
}
|
|
369
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
370
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
371
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
372
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
373
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFinancialAccountBodyDto, localVarRequestOptions, configuration);
|
|
374
|
+
return [2 /*return*/, {
|
|
375
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
376
|
+
options: localVarRequestOptions,
|
|
377
|
+
}];
|
|
378
|
+
}
|
|
379
|
+
});
|
|
380
|
+
});
|
|
381
|
+
},
|
|
318
382
|
};
|
|
319
383
|
};
|
|
320
384
|
exports.FinancialAccountsApiAxiosParamCreator = FinancialAccountsApiAxiosParamCreator;
|
|
@@ -326,7 +390,7 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
326
390
|
var localVarAxiosParamCreator = (0, exports.FinancialAccountsApiAxiosParamCreator)(configuration);
|
|
327
391
|
return {
|
|
328
392
|
/**
|
|
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.financial-accounts.create\"
|
|
393
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
330
394
|
* @summary Create the Financial Account
|
|
331
395
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
332
396
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -395,11 +459,11 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
395
459
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
460
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
461
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
462
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
399
463
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
400
464
|
* @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, description, functionalCategory, type</i>
|
|
401
465
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
466
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
403
467
|
* @param {*} [options] Override http request option.
|
|
404
468
|
* @throws {RequiredError}
|
|
405
469
|
*/
|
|
@@ -416,6 +480,28 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
416
480
|
});
|
|
417
481
|
});
|
|
418
482
|
},
|
|
483
|
+
/**
|
|
484
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
485
|
+
* @summary Update the Financial Account
|
|
486
|
+
* @param {string} code Unique identifier for the object.
|
|
487
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
488
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
489
|
+
* @param {*} [options] Override http request option.
|
|
490
|
+
* @throws {RequiredError}
|
|
491
|
+
*/
|
|
492
|
+
updateFinancialAccount: function (code, updateFinancialAccountBodyDto, authorization, options) {
|
|
493
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
494
|
+
var localVarAxiosArgs;
|
|
495
|
+
return __generator(this, function (_a) {
|
|
496
|
+
switch (_a.label) {
|
|
497
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateFinancialAccount(code, updateFinancialAccountBodyDto, authorization, options)];
|
|
498
|
+
case 1:
|
|
499
|
+
localVarAxiosArgs = _a.sent();
|
|
500
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
501
|
+
}
|
|
502
|
+
});
|
|
503
|
+
});
|
|
504
|
+
},
|
|
419
505
|
};
|
|
420
506
|
};
|
|
421
507
|
exports.FinancialAccountsApiFp = FinancialAccountsApiFp;
|
|
@@ -427,7 +513,7 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
427
513
|
var localVarFp = (0, exports.FinancialAccountsApiFp)(configuration);
|
|
428
514
|
return {
|
|
429
515
|
/**
|
|
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.financial-accounts.create\"
|
|
516
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
431
517
|
* @summary Create the Financial Account
|
|
432
518
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
433
519
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -466,17 +552,29 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
466
552
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
467
553
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
468
554
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
555
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
470
556
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
471
557
|
* @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, description, functionalCategory, type</i>
|
|
472
558
|
* @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
|
-
* @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, status, isControlAccount, functionalCategory</i>
|
|
559
|
+
* @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, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
474
560
|
* @param {*} [options] Override http request option.
|
|
475
561
|
* @throws {RequiredError}
|
|
476
562
|
*/
|
|
477
563
|
listFinancialAccounts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
478
564
|
return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
479
565
|
},
|
|
566
|
+
/**
|
|
567
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
568
|
+
* @summary Update the Financial Account
|
|
569
|
+
* @param {string} code Unique identifier for the object.
|
|
570
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
571
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
572
|
+
* @param {*} [options] Override http request option.
|
|
573
|
+
* @throws {RequiredError}
|
|
574
|
+
*/
|
|
575
|
+
updateFinancialAccount: function (code, updateFinancialAccountBodyDto, authorization, options) {
|
|
576
|
+
return localVarFp.updateFinancialAccount(code, updateFinancialAccountBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
577
|
+
},
|
|
480
578
|
};
|
|
481
579
|
};
|
|
482
580
|
exports.FinancialAccountsApiFactory = FinancialAccountsApiFactory;
|
|
@@ -492,7 +590,7 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
492
590
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
493
591
|
}
|
|
494
592
|
/**
|
|
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.financial-accounts.create\"
|
|
593
|
+
* 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. A bank-category account may also name the connected bank account it books, via linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display. **Required Permissions** \"accounting-management.financial-accounts.create\"
|
|
496
594
|
* @summary Create the Financial Account
|
|
497
595
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
498
596
|
* @param {*} [options] Override http request option.
|
|
@@ -540,6 +638,18 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
540
638
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
541
639
|
return (0, exports.FinancialAccountsApiFp)(this.configuration).listFinancialAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
542
640
|
};
|
|
641
|
+
/**
|
|
642
|
+
* Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only. **Required Permissions** \"accounting-management.financial-accounts.update\"
|
|
643
|
+
* @summary Update the Financial Account
|
|
644
|
+
* @param {FinancialAccountsApiUpdateFinancialAccountRequest} requestParameters Request parameters.
|
|
645
|
+
* @param {*} [options] Override http request option.
|
|
646
|
+
* @throws {RequiredError}
|
|
647
|
+
* @memberof FinancialAccountsApi
|
|
648
|
+
*/
|
|
649
|
+
FinancialAccountsApi.prototype.updateFinancialAccount = function (requestParameters, options) {
|
|
650
|
+
var _this = this;
|
|
651
|
+
return (0, exports.FinancialAccountsApiFp)(this.configuration).updateFinancialAccount(requestParameters.code, requestParameters.updateFinancialAccountBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
652
|
+
};
|
|
543
653
|
return FinancialAccountsApi;
|
|
544
654
|
}(base_1.BaseAPI));
|
|
545
655
|
exports.FinancialAccountsApi = FinancialAccountsApi;
|
|
@@ -202,7 +202,7 @@ export declare class FinancialTransactionsApi extends BaseAPI {
|
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
* @memberof FinancialTransactionsApi
|
|
204
204
|
*/
|
|
205
|
-
getFinancialTransaction(requestParameters: FinancialTransactionsApiGetFinancialTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialTransactionResponseClass, any, {}>>;
|
|
205
|
+
getFinancialTransaction(requestParameters: FinancialTransactionsApiGetFinancialTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialTransactionResponseClass, any, {}, any>>;
|
|
206
206
|
/**
|
|
207
207
|
* This endpoint list financial transactions. **Required Permissions** \"accounting-management.transactions.view\"
|
|
208
208
|
* @summary List financial transactions
|
|
@@ -211,5 +211,5 @@ export declare class FinancialTransactionsApi extends BaseAPI {
|
|
|
211
211
|
* @throws {RequiredError}
|
|
212
212
|
* @memberof FinancialTransactionsApi
|
|
213
213
|
*/
|
|
214
|
-
listFinancialTransactions(requestParameters?: FinancialTransactionsApiListFinancialTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialTransactionsResponseClass, any, {}>>;
|
|
214
|
+
listFinancialTransactions(requestParameters?: FinancialTransactionsApiListFinancialTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialTransactionsResponseClass, any, {}, any>>;
|
|
215
215
|
}
|