Interface IGeneralLedgerAccountsApi
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 IGeneralLedgerAccountsApi : IApiAccessorMethods
| Improve this Doc View SourceClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGet(String, String, String, String)
Retrieve a particular general ledger account
Declaration
GeneralLedgerAccount ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGet(string clientId, string fiscalYearId, string generalLedgerAccountId, string select = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | generalLedgerAccountId | ID of the general ledger account |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
Returns
| Type | Description |
|---|---|
| GeneralLedgerAccount | GeneralLedgerAccount |
Remarks
Retrieve a specific general ledger account (general ledger-account-id) in the fiscal year. You can only retrieve captioned general ledger accounts or posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<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.<br><br> URI examples Retrieving the general ledger account with the ID (general-ledger-account-id) 10000:<br> .../fiscal-years/20160101/general-ledger-accounts/10000000
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsync(String, String, String, String)
Retrieve a particular general ledger account
Declaration
Task<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsync(string clientId, string fiscalYearId, string generalLedgerAccountId, string select = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | generalLedgerAccountId | ID of the general ledger account |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GeneralLedgerAccount> | Task of GeneralLedgerAccount |
Remarks
Retrieve a specific general ledger account (general ledger-account-id) in the fiscal year. You can only retrieve captioned general ledger accounts or posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<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.<br><br> URI examples Retrieving the general ledger account with the ID (general-ledger-account-id) 10000:<br> .../fiscal-years/20160101/general-ledger-accounts/10000000
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsyncWithHttpInfo(String, String, String, String)
Retrieve a particular general ledger account
Declaration
Task<ApiResponse<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string generalLedgerAccountId, string select = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | generalLedgerAccountId | ID of the general ledger account |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<GeneralLedgerAccount>> | Task of ApiResponse (GeneralLedgerAccount) |
Remarks
Retrieve a specific general ledger account (general ledger-account-id) in the fiscal year. You can only retrieve captioned general ledger accounts or posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<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.<br><br> URI examples Retrieving the general ledger account with the ID (general-ledger-account-id) 10000:<br> .../fiscal-years/20160101/general-ledger-accounts/10000000
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetWithHttpInfo(String, String, String, String)
Retrieve a particular general ledger account
Declaration
ApiResponse<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetWithHttpInfo(string clientId, string fiscalYearId, string generalLedgerAccountId, string select = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clientId | ID of central client/company |
| System.String | fiscalYearId | ID of the fiscal year |
| System.String | generalLedgerAccountId | ID of the general ledger account |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (optional) |
Returns
| Type | Description |
|---|---|
| ApiResponse<GeneralLedgerAccount> | ApiResponse of GeneralLedgerAccount |
Remarks
Retrieve a specific general ledger account (general ledger-account-id) in the fiscal year. You can only retrieve captioned general ledger accounts or posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<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.<br><br> URI examples Retrieving the general ledger account with the ID (general-ledger-account-id) 10000:<br> .../fiscal-years/20160101/general-ledger-accounts/10000000
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGet(String, String, String, String, Nullable<Int32>)
Retrieve a list of general ledger accounts
Declaration
List<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGet(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = 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) |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<GeneralLedgerAccount> | List<GeneralLedgerAccount> |
Remarks
Retrieve an entire list of general ledger accounts for a fiscal year. The list of general ledger accounts includes all captioned general ledger accounts and all posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<br><br> 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 general ledger accounts will be sorted by account number. |Parameter|Beschreibung | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of general ledger accounts which should be skipped. Example: skip=40 | | top | Number of general ledger accounts which 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.<br><br> URI examples Retrieving of the first 10 general ledger accounts:<br> .../general-ledger-accounts?top=10 Retrieving of the next 10 general ledger accounts:<br> .../general-ledger-accounts?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetAsync(String, String, String, String, Nullable<Int32>)
Retrieve a list of general ledger accounts
Declaration
Task<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetAsync(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = 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) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.List<GeneralLedgerAccount>> | Task of List<GeneralLedgerAccount> |
Remarks
Retrieve an entire list of general ledger accounts for a fiscal year. The list of general ledger accounts includes all captioned general ledger accounts and all posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<br><br> 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 general ledger accounts will be sorted by account number. |Parameter|Beschreibung | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of general ledger accounts which should be skipped. Example: skip=40 | | top | Number of general ledger accounts which 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.<br><br> URI examples Retrieving of the first 10 general ledger accounts:<br> .../general-ledger-accounts?top=10 Retrieving of the next 10 general ledger accounts:<br> .../general-ledger-accounts?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetAsyncWithHttpInfo(String, String, String, String, Nullable<Int32>)
Retrieve a list of general ledger accounts
Declaration
Task<ApiResponse<List<GeneralLedgerAccount>>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = 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) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<System.Collections.Generic.List<GeneralLedgerAccount>>> | Task of ApiResponse (List<GeneralLedgerAccount>) |
Remarks
Retrieve an entire list of general ledger accounts for a fiscal year. The list of general ledger accounts includes all captioned general ledger accounts and all posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<br><br> 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 general ledger accounts will be sorted by account number. |Parameter|Beschreibung | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of general ledger accounts which should be skipped. Example: skip=40 | | top | Number of general ledger accounts which 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.<br><br> URI examples Retrieving of the first 10 general ledger accounts:<br> .../general-ledger-accounts?top=10 Retrieving of the next 10 general ledger accounts:<br> .../general-ledger-accounts?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetWithHttpInfo(String, String, String, String, Nullable<Int32>)
Retrieve a list of general ledger accounts
Declaration
ApiResponse<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = 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) |
Returns
| Type | Description |
|---|---|
| ApiResponse<System.Collections.Generic.List<GeneralLedgerAccount>> | ApiResponse of List<GeneralLedgerAccount> |
Remarks
Retrieve an entire list of general ledger accounts for a fiscal year. The list of general ledger accounts includes all captioned general ledger accounts and all posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<br><br> 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 general ledger accounts will be sorted by account number. |Parameter|Beschreibung | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of general ledger accounts which should be skipped. Example: skip=40 | | top | Number of general ledger accounts which 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.<br><br> URI examples Retrieving of the first 10 general ledger accounts:<br> .../general-ledger-accounts?top=10 Retrieving of the next 10 general ledger accounts:<br> .../general-ledger-accounts?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGet(String, String, String)
Retrieve a list of utilized general ledger accounts
Declaration
List<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGet(string clientId, string fiscalYearId, string select = 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) |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<GeneralLedgerAccount> | List<GeneralLedgerAccount> |
Remarks
Retrieve an entire list of utilized general ledger accounts for a fiscal year. The list of general ledger accounts includes all posted and all general ledger accounts with individual caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<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.<br><br> URI examples Retrieving of the utilized general ledger accounts:<br> .../general-ledger-accounts/utilized
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsync(String, String, String)
Retrieve a list of utilized general ledger accounts
Declaration
Task<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsync(string clientId, string fiscalYearId, string select = 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) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.List<GeneralLedgerAccount>> | Task of List<GeneralLedgerAccount> |
Remarks
Retrieve an entire list of utilized general ledger accounts for a fiscal year. The list of general ledger accounts includes all posted and all general ledger accounts with individual caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<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.<br><br> URI examples Retrieving of the utilized general ledger accounts:<br> .../general-ledger-accounts/utilized
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsyncWithHttpInfo(String, String, String)
Retrieve a list of utilized general ledger accounts
Declaration
Task<ApiResponse<List<GeneralLedgerAccount>>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = 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) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<System.Collections.Generic.List<GeneralLedgerAccount>>> | Task of ApiResponse (List<GeneralLedgerAccount>) |
Remarks
Retrieve an entire list of utilized general ledger accounts for a fiscal year. The list of general ledger accounts includes all posted and all general ledger accounts with individual caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<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.<br><br> URI examples Retrieving of the utilized general ledger accounts:<br> .../general-ledger-accounts/utilized
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetWithHttpInfo(String, String, String)
Retrieve a list of utilized general ledger accounts
Declaration
ApiResponse<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetWithHttpInfo(string clientId, string fiscalYearId, string select = 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) |
Returns
| Type | Description |
|---|---|
| ApiResponse<System.Collections.Generic.List<GeneralLedgerAccount>> | ApiResponse of List<GeneralLedgerAccount> |
Remarks
Retrieve an entire list of utilized general ledger accounts for a fiscal year. The list of general ledger accounts includes all posted and all general ledger accounts with individual caption. The general ledger account captions and functions are delivered, but no account values.<br><br> Filter Filters to condense the scope of the results are not available.<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.<br><br> URI examples Retrieving of the utilized general ledger accounts:<br> .../general-ledger-accounts/utilized
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |