Class AccountingSumsAndBalancesApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

AccountingSumsAndBalancesApi

Implements

IAccountingSumsAndBalancesApi

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 AccountingSumsAndBalancesApi : IAccountingSumsAndBalancesApi, IApiAccessor

Constructors

| Improve this Doc View Source

AccountingSumsAndBalancesApi(Configuration)

Initializes a new instance of the AccountingSumsAndBalancesApi class using Configuration object

Declaration

public AccountingSumsAndBalancesApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

AccountingSumsAndBalancesApi(String)

Initializes a new instance of the AccountingSumsAndBalancesApi class.

Declaration

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

ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGet(String, String, String)

Retrieve a specific account from the accounting sums and balances list The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts. The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed. This evaluation contains current postings and closing entries. 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 AccountingSumsAndBalances ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGet(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	accountingSumsAndBalancesId	ID of an account from the accounting sums and balances list

Returns

Type	Description
AccountingSumsAndBalances	AccountingSumsAndBalances

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsync(String, String, String)

Declaration

public async Task<AccountingSumsAndBalances> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsync(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	accountingSumsAndBalancesId	ID of an account from the accounting sums and balances list

Returns

Type	Description
System.Threading.Tasks.Task<AccountingSumsAndBalances>	Task of AccountingSumsAndBalances

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsyncWithHttpInfo(String, String, String)

Declaration

public async Task<ApiResponse<AccountingSumsAndBalances>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	accountingSumsAndBalancesId	ID of an account from the accounting sums and balances list

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<AccountingSumsAndBalances>>	Task of ApiResponse (AccountingSumsAndBalances)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetWithHttpInfo(String, String, String)

Declaration

public ApiResponse<AccountingSumsAndBalances> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesAccountingSumsAndBalancesIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountingSumsAndBalancesId)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	accountingSumsAndBalancesId	ID of an account from the accounting sums and balances list

Returns

Type	Description
ApiResponse<AccountingSumsAndBalances>	ApiResponse of AccountingSumsAndBalances

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of accounting sums and balances The list of accounting sums and balances is one of the basic evaluations of accounting and contains the list of the posted accounts. The overview shows the development of values per account for the current fiscal year. The opening balance values, the monthly values (without opening balance), the cumulated monthly values and the total balance are displayed. This evaluation contains current postings and closing entries. Filter Ohne weitere Angabe von Parametern enthält die Liste den vollen Umfang. Filter options The number of results can be limited by using the following filters: - account_number Operators Filter option: account_number | Operators | Beschreibung | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | 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 accounting sums and balances will be sorted by account number. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounts from the accounting sums and balances list that should be skipped. Example: skip=40 | | top | Number of accounts from the accounting sums and balances list that 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. URI examples Retrieving of the accounting sums and balances list for account number 10000: .../accounting-sums-and-balances?filter=account_number eq 100000000 Retrieving the first 10 accounts from the accounting sums and balances list: .../accounting-sums-and-balances?top=10 Retrieving the next 10 accounts from the accounting sums and balances list: .../accounting-sums-and-balances?top=10&skip=10

Declaration

public List<AccountingSumsAndBalances> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGet(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = 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)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)

Returns

Type	Description
System.Collections.Generic.List<AccountingSumsAndBalances>	List<AccountingSumsAndBalances>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<List<AccountingSumsAndBalances>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetAsync(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = 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)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<AccountingSumsAndBalances>>	Task of List<AccountingSumsAndBalances>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<ApiResponse<List<AccountingSumsAndBalances>>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = 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)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<System.Collections.Generic.List<AccountingSumsAndBalances>>>	Task of ApiResponse (List<AccountingSumsAndBalances>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public ApiResponse<List<AccountingSumsAndBalances>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSumsAndBalancesGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string filter = 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)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)

Returns

Type	Description
ApiResponse<System.Collections.Generic.List<AccountingSumsAndBalances>>	ApiResponse of List<AccountingSumsAndBalances>

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

IAccountingSumsAndBalancesApi

IApiAccessor