@emilgroup/accounting-sdk 1.34.1-beta.4 → 1.34.1-beta.41
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 +33 -0
- package/README.md +2 -2
- package/api/accounting-configs-api.ts +90 -0
- package/api/booking-entries-api.ts +214 -0
- package/api/commission-account-mappings-api.ts +1191 -0
- package/api/financial-accounts-api.ts +132 -12
- package/api/product-account-mappings-api.ts +1470 -0
- package/api.ts +4 -0
- package/dist/api/accounting-configs-api.d.ts +47 -0
- package/dist/api/accounting-configs-api.js +87 -0
- package/dist/api/booking-entries-api.d.ts +114 -0
- package/dist/api/booking-entries-api.js +186 -0
- package/dist/api/commission-account-mappings-api.d.ts +685 -0
- package/dist/api/commission-account-mappings-api.js +1004 -0
- package/dist/api/financial-accounts-api.d.ts +78 -12
- package/dist/api/financial-accounts-api.js +109 -10
- package/dist/api/product-account-mappings-api.d.ts +851 -0
- package/dist/api/product-account-mappings-api.js +1224 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- 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 +6 -0
- package/dist/models/booking-entry-class.d.ts +19 -0
- package/dist/models/booking-entry-class.js +7 -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 +19 -0
- package/dist/models/create-booking-entry-request-dto.js +7 -0
- package/dist/models/create-financial-account-request-dto.d.ts +12 -0
- 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 +30 -1
- package/dist/models/financial-account-class.js +5 -1
- package/dist/models/financial-transaction-data-dto.d.ts +1 -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 +31 -0
- package/dist/models/index.js +31 -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 +43 -0
- package/dist/models/post-financial-event-request-dto.js +22 -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 +50 -0
- package/dist/models/product-account-mapping-detail-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-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/accounting-config-class.ts +14 -0
- package/models/accounting-config-data-dto-default-account-mappings.ts +6 -0
- package/models/booking-entry-class.ts +20 -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 +22 -0
- package/models/create-financial-account-request-dto.ts +12 -0
- 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 +31 -1
- package/models/financial-transaction-data-dto.ts +1 -0
- package/models/get-activation-snapshot-response-class.ts +31 -0
- package/models/index.ts +31 -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 +52 -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 +56 -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-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 +1 -1
|
@@ -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,7 +346,7 @@ 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.
|
|
@@ -324,4 +381,13 @@ export declare class FinancialAccountsApi extends BaseAPI {
|
|
|
324
381
|
* @memberof FinancialAccountsApi
|
|
325
382
|
*/
|
|
326
383
|
listFinancialAccounts(requestParameters?: FinancialAccountsApiListFinancialAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialAccountsResponseClass, 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, {}>>;
|
|
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.
|
|
@@ -249,11 +249,11 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @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>
|
|
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, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
253
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
254
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, name, financialAccountNumber, description, functionalCategory, type</i>
|
|
255
255
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
256
|
-
* @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>
|
|
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, linkedBankAccountCode, linkedBankAccountIban</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -315,6 +315,59 @@ var FinancialAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
315
315
|
});
|
|
316
316
|
});
|
|
317
317
|
},
|
|
318
|
+
/**
|
|
319
|
+
* 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\"
|
|
320
|
+
* @summary Update the Financial Account
|
|
321
|
+
* @param {string} code Unique identifier for the object.
|
|
322
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
323
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
324
|
+
* @param {*} [options] Override http request option.
|
|
325
|
+
* @throws {RequiredError}
|
|
326
|
+
*/
|
|
327
|
+
updateFinancialAccount: function (code, updateFinancialAccountBodyDto, authorization, options) {
|
|
328
|
+
if (options === void 0) { options = {}; }
|
|
329
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
330
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
331
|
+
return __generator(this, function (_a) {
|
|
332
|
+
switch (_a.label) {
|
|
333
|
+
case 0:
|
|
334
|
+
// verify required parameter 'code' is not null or undefined
|
|
335
|
+
(0, common_1.assertParamExists)('updateFinancialAccount', 'code', code);
|
|
336
|
+
// verify required parameter 'updateFinancialAccountBodyDto' is not null or undefined
|
|
337
|
+
(0, common_1.assertParamExists)('updateFinancialAccount', 'updateFinancialAccountBodyDto', updateFinancialAccountBodyDto);
|
|
338
|
+
localVarPath = "/accountingservice/v1/financial-accounts/{code}"
|
|
339
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
340
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
341
|
+
if (configuration) {
|
|
342
|
+
baseOptions = configuration.baseOptions;
|
|
343
|
+
baseAccessToken = configuration.accessToken;
|
|
344
|
+
}
|
|
345
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
346
|
+
localVarHeaderParameter = {};
|
|
347
|
+
localVarQueryParameter = {};
|
|
348
|
+
// authentication bearer required
|
|
349
|
+
// http bearer authentication required
|
|
350
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
351
|
+
case 1:
|
|
352
|
+
// authentication bearer required
|
|
353
|
+
// http bearer authentication required
|
|
354
|
+
_a.sent();
|
|
355
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
356
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
357
|
+
}
|
|
358
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
359
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
360
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
361
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
362
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFinancialAccountBodyDto, localVarRequestOptions, configuration);
|
|
363
|
+
return [2 /*return*/, {
|
|
364
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
365
|
+
options: localVarRequestOptions,
|
|
366
|
+
}];
|
|
367
|
+
}
|
|
368
|
+
});
|
|
369
|
+
});
|
|
370
|
+
},
|
|
318
371
|
};
|
|
319
372
|
};
|
|
320
373
|
exports.FinancialAccountsApiAxiosParamCreator = FinancialAccountsApiAxiosParamCreator;
|
|
@@ -326,7 +379,7 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
326
379
|
var localVarAxiosParamCreator = (0, exports.FinancialAccountsApiAxiosParamCreator)(configuration);
|
|
327
380
|
return {
|
|
328
381
|
/**
|
|
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\"
|
|
382
|
+
* 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
383
|
* @summary Create the Financial Account
|
|
331
384
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
332
385
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -395,11 +448,11 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
395
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
449
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
450
|
* @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>
|
|
451
|
+
* @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
452
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
400
453
|
* @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
454
|
* @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>
|
|
455
|
+
* @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
456
|
* @param {*} [options] Override http request option.
|
|
404
457
|
* @throws {RequiredError}
|
|
405
458
|
*/
|
|
@@ -416,6 +469,28 @@ var FinancialAccountsApiFp = function (configuration) {
|
|
|
416
469
|
});
|
|
417
470
|
});
|
|
418
471
|
},
|
|
472
|
+
/**
|
|
473
|
+
* 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\"
|
|
474
|
+
* @summary Update the Financial Account
|
|
475
|
+
* @param {string} code Unique identifier for the object.
|
|
476
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
477
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
478
|
+
* @param {*} [options] Override http request option.
|
|
479
|
+
* @throws {RequiredError}
|
|
480
|
+
*/
|
|
481
|
+
updateFinancialAccount: function (code, updateFinancialAccountBodyDto, authorization, options) {
|
|
482
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
483
|
+
var localVarAxiosArgs;
|
|
484
|
+
return __generator(this, function (_a) {
|
|
485
|
+
switch (_a.label) {
|
|
486
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateFinancialAccount(code, updateFinancialAccountBodyDto, authorization, options)];
|
|
487
|
+
case 1:
|
|
488
|
+
localVarAxiosArgs = _a.sent();
|
|
489
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
490
|
+
}
|
|
491
|
+
});
|
|
492
|
+
});
|
|
493
|
+
},
|
|
419
494
|
};
|
|
420
495
|
};
|
|
421
496
|
exports.FinancialAccountsApiFp = FinancialAccountsApiFp;
|
|
@@ -427,7 +502,7 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
427
502
|
var localVarFp = (0, exports.FinancialAccountsApiFp)(configuration);
|
|
428
503
|
return {
|
|
429
504
|
/**
|
|
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\"
|
|
505
|
+
* 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
506
|
* @summary Create the Financial Account
|
|
432
507
|
* @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
|
|
433
508
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -466,17 +541,29 @@ var FinancialAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
466
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
467
542
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
468
543
|
* @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>
|
|
544
|
+
* @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
545
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
471
546
|
* @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
547
|
* @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>
|
|
548
|
+
* @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
549
|
* @param {*} [options] Override http request option.
|
|
475
550
|
* @throws {RequiredError}
|
|
476
551
|
*/
|
|
477
552
|
listFinancialAccounts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
478
553
|
return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
479
554
|
},
|
|
555
|
+
/**
|
|
556
|
+
* 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\"
|
|
557
|
+
* @summary Update the Financial Account
|
|
558
|
+
* @param {string} code Unique identifier for the object.
|
|
559
|
+
* @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto
|
|
560
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
561
|
+
* @param {*} [options] Override http request option.
|
|
562
|
+
* @throws {RequiredError}
|
|
563
|
+
*/
|
|
564
|
+
updateFinancialAccount: function (code, updateFinancialAccountBodyDto, authorization, options) {
|
|
565
|
+
return localVarFp.updateFinancialAccount(code, updateFinancialAccountBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
566
|
+
},
|
|
480
567
|
};
|
|
481
568
|
};
|
|
482
569
|
exports.FinancialAccountsApiFactory = FinancialAccountsApiFactory;
|
|
@@ -492,7 +579,7 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
492
579
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
493
580
|
}
|
|
494
581
|
/**
|
|
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\"
|
|
582
|
+
* 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
583
|
* @summary Create the Financial Account
|
|
497
584
|
* @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
|
|
498
585
|
* @param {*} [options] Override http request option.
|
|
@@ -540,6 +627,18 @@ var FinancialAccountsApi = /** @class */ (function (_super) {
|
|
|
540
627
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
541
628
|
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
629
|
};
|
|
630
|
+
/**
|
|
631
|
+
* 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\"
|
|
632
|
+
* @summary Update the Financial Account
|
|
633
|
+
* @param {FinancialAccountsApiUpdateFinancialAccountRequest} requestParameters Request parameters.
|
|
634
|
+
* @param {*} [options] Override http request option.
|
|
635
|
+
* @throws {RequiredError}
|
|
636
|
+
* @memberof FinancialAccountsApi
|
|
637
|
+
*/
|
|
638
|
+
FinancialAccountsApi.prototype.updateFinancialAccount = function (requestParameters, options) {
|
|
639
|
+
var _this = this;
|
|
640
|
+
return (0, exports.FinancialAccountsApiFp)(this.configuration).updateFinancialAccount(requestParameters.code, requestParameters.updateFinancialAccountBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
641
|
+
};
|
|
543
642
|
return FinancialAccountsApi;
|
|
544
643
|
}(base_1.BaseAPI));
|
|
545
644
|
exports.FinancialAccountsApi = FinancialAccountsApi;
|