Interface IFiscalYearsApi
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 IFiscalYearsApi : IApiAccessorMethods
| Improve this Doc View SourceClientsClientIdFiscalYearsFiscalYearIdGet(String, String, String)
Retrieve a specific fiscal year
Declaration
FiscalYear ClientsClientIdFiscalYearsFiscalYearIdGet(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 |
|---|---|
| FiscalYear | FiscalYear |
Remarks
Retrieve an accounting fiscal year including the accounting master data of a client/company.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsFiscalYearIdGetAsync(String, String, String)
Retrieve a specific fiscal year
Declaration
Task<FiscalYear> ClientsClientIdFiscalYearsFiscalYearIdGetAsync(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<FiscalYear> | Task of FiscalYear |
Remarks
Retrieve an accounting fiscal year including the accounting master data of a client/company.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsFiscalYearIdGetAsyncWithHttpInfo(String, String, String)
Retrieve a specific fiscal year
Declaration
Task<ApiResponse<FiscalYear>> ClientsClientIdFiscalYearsFiscalYearIdGetAsyncWithHttpInfo(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<FiscalYear>> | Task of ApiResponse (FiscalYear) |
Remarks
Retrieve an accounting fiscal year including the accounting master data of a client/company.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsFiscalYearIdGetWithHttpInfo(String, String, String)
Retrieve a specific fiscal year
Declaration
ApiResponse<FiscalYear> ClientsClientIdFiscalYearsFiscalYearIdGetWithHttpInfo(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<FiscalYear> | ApiResponse of FiscalYear |
Remarks
Retrieve an accounting fiscal year including the accounting master data of a client/company.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsGet(String, String, String, String, Nullable<Int32>)
Retrieve a list of fiscal years
Declaration
List<FiscalYear> ClientsClientIdFiscalYearsGet(string clientId, 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 | 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.Collections.Generic.List<FiscalYear> | List<FiscalYear> |
Remarks
Access the accounting fiscal years including the accounting master data of a client/company. The accounting fiscal years will be shown in the form of a list.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsGetAsync(String, String, String, String, Nullable<Int32>)
Retrieve a list of fiscal years
Declaration
Task<List<FiscalYear>> ClientsClientIdFiscalYearsGetAsync(string clientId, 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 | 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<System.Collections.Generic.List<FiscalYear>> | Task of List<FiscalYear> |
Remarks
Access the accounting fiscal years including the accounting master data of a client/company. The accounting fiscal years will be shown in the form of a list.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsGetAsyncWithHttpInfo(String, String, String, String, Nullable<Int32>)
Retrieve a list of fiscal years
Declaration
Task<ApiResponse<List<FiscalYear>>> ClientsClientIdFiscalYearsGetAsyncWithHttpInfo(string clientId, 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 | 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<System.Collections.Generic.List<FiscalYear>>> | Task of ApiResponse (List<FiscalYear>) |
Remarks
Access the accounting fiscal years including the accounting master data of a client/company. The accounting fiscal years will be shown in the form of a list.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |
ClientsClientIdFiscalYearsGetWithHttpInfo(String, String, String, String, Nullable<Int32>)
Retrieve a list of fiscal years
Declaration
ApiResponse<List<FiscalYear>> ClientsClientIdFiscalYearsGetWithHttpInfo(string clientId, 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 | 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<System.Collections.Generic.List<FiscalYear>> | ApiResponse of List<FiscalYear> |
Remarks
Access the accounting fiscal years including the accounting master data of a client/company. The accounting fiscal years will be shown in the form of a list.<br><br> Filter It is currently not possible to filter by the property "taxation_method".<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 |