Interface IAccountingTransactionKeysApi
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 IAccountingTransactionKeysApi : IApiAccessorMethods
| Improve this Doc View SourceClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGet(String, String, String, String, String, String, Nullable<Int32>)
Retrieve a specific accounting transaction key
Declaration
AccountingTransactionKeys ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGet(string clientId, string fiscalYearId, string accountingTransactionKeysId, string select = null, string filter = 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 | accountingTransactionKeysId | Accounting transaction keys number |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (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) |
| 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 |
|---|---|
| AccountingTransactionKeys | AccountingTransactionKeys |
Remarks
Retrieves a specific accounting transaction key of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<br><br>
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGetAsync(String, String, String, String, String, String, Nullable<Int32>)
Retrieve a specific accounting transaction key
Declaration
Task<AccountingTransactionKeys> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGetAsync(string clientId, string fiscalYearId, string accountingTransactionKeysId, string select = null, string filter = 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 | accountingTransactionKeysId | Accounting transaction keys number |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (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) |
| 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<AccountingTransactionKeys> | Task of AccountingTransactionKeys |
Remarks
Retrieves a specific accounting transaction key of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<br><br>
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGetAsyncWithHttpInfo(String, String, String, String, String, String, Nullable<Int32>)
Retrieve a specific accounting transaction key
Declaration
Task<ApiResponse<AccountingTransactionKeys>> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountingTransactionKeysId, string select = null, string filter = 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 | accountingTransactionKeysId | Accounting transaction keys number |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (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) |
| 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<AccountingTransactionKeys>> | Task of ApiResponse (AccountingTransactionKeys) |
Remarks
Retrieves a specific accounting transaction key of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<br><br>
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGetWithHttpInfo(String, String, String, String, String, String, Nullable<Int32>)
Retrieve a specific accounting transaction key
Declaration
ApiResponse<AccountingTransactionKeys> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysAccountingTransactionKeysIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountingTransactionKeysId, string select = null, string filter = 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 | accountingTransactionKeysId | Accounting transaction keys number |
| System.String | select | Comma separated list of properties to which the results will then be limited. Example: select=id (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) |
| 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<AccountingTransactionKeys> | ApiResponse of AccountingTransactionKeys |
Remarks
Retrieves a specific accounting transaction key of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<br><br>
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGet(String, String, String, String, Nullable<Int32>)
Retrieve a list of accounting transaction keys
Declaration
List<AccountingTransactionKeys> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGet(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<AccountingTransactionKeys> | List<AccountingTransactionKeys> |
Remarks
Retrieve the accounting transaction keys of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<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 Tax Keys will be sorted by accounting transaction key ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting transaction keys that should be skipped. Example: skip=40 | | top | Number of accounting transaction keys that should be read as a result of the request.Example: top=20 | URI examples Retrieving of the first 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10 Retrieving of the next 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGetAsync(String, String, String, String, Nullable<Int32>)
Retrieve a list of accounting transaction keys
Declaration
Task<List<AccountingTransactionKeys>> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGetAsync(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<AccountingTransactionKeys>> | Task of List<AccountingTransactionKeys> |
Remarks
Retrieve the accounting transaction keys of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<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 Tax Keys will be sorted by accounting transaction key ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting transaction keys that should be skipped. Example: skip=40 | | top | Number of accounting transaction keys that should be read as a result of the request.Example: top=20 | URI examples Retrieving of the first 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10 Retrieving of the next 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGetAsyncWithHttpInfo(String, String, String, String, Nullable<Int32>)
Retrieve a list of accounting transaction keys
Declaration
Task<ApiResponse<List<AccountingTransactionKeys>>> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGetAsyncWithHttpInfo(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<AccountingTransactionKeys>>> | Task of ApiResponse (List<AccountingTransactionKeys>) |
Remarks
Retrieve the accounting transaction keys of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<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 Tax Keys will be sorted by accounting transaction key ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting transaction keys that should be skipped. Example: skip=40 | | top | Number of accounting transaction keys that should be read as a result of the request.Example: top=20 | URI examples Retrieving of the first 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10 Retrieving of the next 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGetWithHttpInfo(String, String, String, String, Nullable<Int32>)
Retrieve a list of accounting transaction keys
Declaration
ApiResponse<List<AccountingTransactionKeys>> ClientsClientIdFiscalYearsFiscalYearIdAccountingTransactionKeysGetWithHttpInfo(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<AccountingTransactionKeys>> | ApiResponse of List<AccountingTransactionKeys> |
Remarks
Retrieve the accounting transaction keys of a client/company. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>.<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 Tax Keys will be sorted by accounting transaction key ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting transaction keys that should be skipped. Example: skip=40 | | top | Number of accounting transaction keys that should be read as a result of the request.Example: top=20 | URI examples Retrieving of the first 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10 Retrieving of the next 10 accounting transaction keys:<br> .../accounting-transaction-keys?top=10&skip=10
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |