Class AccountingTransactionKeysApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

AccountingTransactionKeysApi

Implements

IAccountingTransactionKeysApi

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 AccountingTransactionKeysApi : IAccountingTransactionKeysApi, IApiAccessor

Constructors

| Improve this Doc View Source

AccountingTransactionKeysApi(Configuration)

Initializes a new instance of the AccountingTransactionKeysApi class using Configuration object

Declaration

public AccountingTransactionKeysApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

AccountingTransactionKeysApi(String)

Initializes a new instance of the AccountingTransactionKeysApi class.

Declaration

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

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

Retrieve a specific accounting transaction key 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>.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of accounting transaction keys 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>. Filter Filters to condense the scope of the results are not available. 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: .../accounting-transaction-keys?top=10 Retrieving of the next 10 accounting transaction keys: .../accounting-transaction-keys?top=10&skip=10

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

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

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

IAccountingTransactionKeysApi

IApiAccessor