Interface IAccountingSumsAndBalancesApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Simplic.Datev.Swagger.Api
Assembly: Simplic.Datev.IO.Swagger.dll
Syntax
public interface IAccountingSumsAndBalancesApi : IApiAccessorMethods
| Improve this Doc View SourceClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGet(String, String, String)
Retrieve a specific account from the accounting sums and balances list
Declaration
AccountingSumsAndBalances ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGet(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | accountingSumsAndBalancesId | ID of an account from the accounting sums and balances list |
Returns
| Type | Description |
|---|---|
| AccountingSumsAndBalances | AccountingSumsAndBalances |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsync(String, String, String)
Retrieve a specific account from the accounting sums and balances list
Declaration
Task<AccountingSumsAndBalances> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsync(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | accountingSumsAndBalancesId | ID of an account from the accounting sums and balances list |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AccountingSumsAndBalances> | Task of AccountingSumsAndBalances |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsyncWithHttpInfo(String, String, String)
Retrieve a specific account from the accounting sums and balances list
Declaration
Task<ApiResponse<AccountingSumsAndBalances>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | accountingSumsAndBalancesId | ID of an account from the accounting sums and balances list |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<AccountingSumsAndBalances>> | Task of ApiResponse (AccountingSumsAndBalances) |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetWithHttpInfo(String, String, String)
Retrieve a specific account from the accounting sums and balances list
Declaration
ApiResponse<AccountingSumsAndBalances> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | accountingSumsAndBalancesId | ID of an account from the accounting sums and balances list |
Returns
| Type | Description |
|---|---|
| ApiResponse<AccountingSumsAndBalances> | ApiResponse of AccountingSumsAndBalances |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGet(String, String, String, String, Nullable<Int32>, String)
Retrieve a list of accounting sums and balances
Declaration
List<AccountingSumsAndBalances> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGet(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
| System.String | skip | States how many elements in the total number of items should be skipped. Example: skip=10 (optional) |
| System.Nullable<System.Int32> | top | States the maximum number of elements that should be contained within the total. Example: top=10 (optional) |
| System.String | filter | Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional) |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<AccountingSumsAndBalances> | List<AccountingSumsAndBalances> |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Filter Ohne weitere Angabe von Parametern enthält die Liste den vollen Umfang.<br><br> Filter options The number of results can be limited by using the following filters: - account_number Operators Filter option: account_number | Operators | Beschreibung | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Paging When accessing large quantities of data, it may happen that these cannot be delivered in a single request. In this case, paging has to be used in order to reduce the amount of data in a single request. Please use top and skip for this purpose. The accounting sums and balances will be sorted by account number. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounts from the accounting sums and balances list that should be skipped. Example: skip=40 | | top | Number of accounts from the accounting sums and balances list that should be read as a result of the request. Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the accounting sums and balances list for account number 10000:<br> .../accounting-sums-and-balances?filter=account_number eq 100000000 Retrieving the first 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10 Retrieving the next 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetAsync(String, String, String, String, Nullable<Int32>, String)
Retrieve a list of accounting sums and balances
Declaration
Task<List<AccountingSumsAndBalances>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetAsync(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
| System.String | skip | States how many elements in the total number of items should be skipped. Example: skip=10 (optional) |
| System.Nullable<System.Int32> | top | States the maximum number of elements that should be contained within the total. Example: top=10 (optional) |
| System.String | filter | Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.List<AccountingSumsAndBalances>> | Task of List<AccountingSumsAndBalances> |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Filter Ohne weitere Angabe von Parametern enthält die Liste den vollen Umfang.<br><br> Filter options The number of results can be limited by using the following filters: - account_number Operators Filter option: account_number | Operators | Beschreibung | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Paging When accessing large quantities of data, it may happen that these cannot be delivered in a single request. In this case, paging has to be used in order to reduce the amount of data in a single request. Please use top and skip for this purpose. The accounting sums and balances will be sorted by account number. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounts from the accounting sums and balances list that should be skipped. Example: skip=40 | | top | Number of accounts from the accounting sums and balances list that should be read as a result of the request. Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the accounting sums and balances list for account number 10000:<br> .../accounting-sums-and-balances?filter=account_number eq 100000000 Retrieving the first 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10 Retrieving the next 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetAsyncWithHttpInfo(String, String, String, String, Nullable<Int32>, String)
Retrieve a list of accounting sums and balances
Declaration
Task<ApiResponse<List<AccountingSumsAndBalances>>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
| System.String | skip | States how many elements in the total number of items should be skipped. Example: skip=10 (optional) |
| System.Nullable<System.Int32> | top | States the maximum number of elements that should be contained within the total. Example: top=10 (optional) |
| System.String | filter | Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<System.Collections.Generic.List<AccountingSumsAndBalances>>> | Task of ApiResponse (List<AccountingSumsAndBalances>) |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Filter Ohne weitere Angabe von Parametern enthält die Liste den vollen Umfang.<br><br> Filter options The number of results can be limited by using the following filters: - account_number Operators Filter option: account_number | Operators | Beschreibung | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Paging When accessing large quantities of data, it may happen that these cannot be delivered in a single request. In this case, paging has to be used in order to reduce the amount of data in a single request. Please use top and skip for this purpose. The accounting sums and balances will be sorted by account number. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounts from the accounting sums and balances list that should be skipped. Example: skip=40 | | top | Number of accounts from the accounting sums and balances list that should be read as a result of the request. Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the accounting sums and balances list for account number 10000:<br> .../accounting-sums-and-balances?filter=account_number eq 100000000 Retrieving the first 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10 Retrieving the next 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetWithHttpInfo(String, String, String, String, Nullable<Int32>, String)
Retrieve a list of accounting sums and balances
Declaration
ApiResponse<List<AccountingSumsAndBalances>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
| System.String | skip | States how many elements in the total number of items should be skipped. Example: skip=10 (optional) |
| System.Nullable<System.Int32> | top | States the maximum number of elements that should be contained within the total. Example: top=10 (optional) |
| System.String | filter | Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional) |
Returns
| Type | Description |
|---|---|
| ApiResponse<System.Collections.Generic.List<AccountingSumsAndBalances>> | ApiResponse of List<AccountingSumsAndBalances> |
Remarks
The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts.<br> The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed.<br><br> This evaluation contains current postings and closing entries.<br><br> Filter Ohne weitere Angabe von Parametern enthält die Liste den vollen Umfang.<br><br> Filter options The number of results can be limited by using the following filters: - account_number Operators Filter option: account_number | Operators | Beschreibung | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Paging When accessing large quantities of data, it may happen that these cannot be delivered in a single request. In this case, paging has to be used in order to reduce the amount of data in a single request. Please use top and skip for this purpose. The accounting sums and balances will be sorted by account number. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounts from the accounting sums and balances list that should be skipped. Example: skip=40 | | top | Number of accounts from the accounting sums and balances list that should be read as a result of the request. Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the accounting sums and balances list for account number 10000:<br> .../accounting-sums-and-balances?filter=account_number eq 100000000 Retrieving the first 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10 Retrieving the next 10 accounts from the accounting sums and balances list:<br> .../accounting-sums-and-balances?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |