Class FiscalYearsApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

FiscalYearsApi

Implements

IFiscalYearsApi

IApiAccessor

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Simplic.Datev.Swagger.Api

Assembly: Simplic.Datev.IO.Swagger.dll

Syntax

public class FiscalYearsApi : IFiscalYearsApi, IApiAccessor

Constructors

| Improve this Doc View Source

FiscalYearsApi(Configuration)

Initializes a new instance of the FiscalYearsApi class using Configuration object

Declaration

public FiscalYearsApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

FiscalYearsApi(String)

Initializes a new instance of the FiscalYearsApi class.

Declaration

public FiscalYearsApi(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration	An instance of the Configuration

| Improve this Doc View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

| Improve this Doc View Source

AddDefaultHeader(String, String)

Add default header.

Declaration

[Obsolete("AddDefaultHeader is deprecated, please use Configuration.AddDefaultHeader instead.")]
public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGet(String, String, String)

Retrieve a specific fiscal year Retrieve an accounting fiscal year including the accounting master data of a client/company. Filter It is currently not possible to filter by the property "taxation_method". 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.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGetAsync(String, String, String)

Declaration

public async 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGetAsyncWithHttpInfo(String, String, String)

Declaration

public async 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGetWithHttpInfo(String, String, String)

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsGet(String, String, String, String, Nullable<Int32>)

Retrieve a list of fiscal years 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. Filter It is currently not possible to filter by the property "taxation_method". 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.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsGetAsync(String, String, String, String, Nullable<Int32>)

Declaration

public async 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsGetAsyncWithHttpInfo(String, String, String, String, Nullable<Int32>)

Declaration

public async 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>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsGetWithHttpInfo(String, String, String, String, Nullable<Int32>)

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

DefaultHeader()

Gets the default header.

Declaration

[Obsolete("DefaultHeader is deprecated, please use Configuration.DefaultHeader instead.")]
public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	Dictionary of HTTP header

| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

| Improve this Doc View Source

SetBasePath(String)

Sets the base path of the API client.

Declaration

[Obsolete("SetBasePath is deprecated, please do 'Configuration.ApiClient = new ApiClient(\"http://new-path\")' instead.")]
public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IFiscalYearsApi

IApiAccessor