Class GeneralLedgerAccountsApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

GeneralLedgerAccountsApi

Implements

IGeneralLedgerAccountsApi

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 GeneralLedgerAccountsApi : IGeneralLedgerAccountsApi, IApiAccessor

Constructors

| Improve this Doc View Source

GeneralLedgerAccountsApi(Configuration)

Initializes a new instance of the GeneralLedgerAccountsApi class using Configuration object

Declaration

public GeneralLedgerAccountsApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

GeneralLedgerAccountsApi(String)

Initializes a new instance of the GeneralLedgerAccountsApi class.

Declaration

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

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGet(String, String, String, String)

Retrieve a particular general ledger account Retrieve a specific general ledger account (general ledger-account-id) in the fiscal year. You can only retrieve captioned general ledger accounts or posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values. 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 the general ledger account with the ID (general-ledger-account-id) 10000: .../fiscal-years/20160101/general-ledger-accounts/10000000

Declaration

public GeneralLedgerAccount ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGet(string clientId, string fiscalYearId, string generalLedgerAccountId, 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	generalLedgerAccountId	ID of the general ledger account
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)

Returns

Type	Description
GeneralLedgerAccount	GeneralLedgerAccount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsync(String, String, String, String)

Declaration

public async Task<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsync(string clientId, string fiscalYearId, string generalLedgerAccountId, 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	generalLedgerAccountId	ID of the general ledger account
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<GeneralLedgerAccount>	Task of GeneralLedgerAccount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsyncWithHttpInfo(String, String, String, String)

Declaration

public async Task<ApiResponse<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string generalLedgerAccountId, 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	generalLedgerAccountId	ID of the general ledger account
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<GeneralLedgerAccount>>	Task of ApiResponse (GeneralLedgerAccount)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetWithHttpInfo(String, String, String, String)

Declaration

public ApiResponse<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGeneralLedgerAccountIdGetWithHttpInfo(string clientId, string fiscalYearId, string generalLedgerAccountId, 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	generalLedgerAccountId	ID of the general ledger account
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)

Returns

Type	Description
ApiResponse<GeneralLedgerAccount>	ApiResponse of GeneralLedgerAccount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of general ledger accounts Retrieve an entire list of general ledger accounts for a fiscal year. The list of general ledger accounts includes all captioned general ledger accounts and all posted general ledger accounts without a caption. The general ledger account captions and functions are delivered, but no account values. 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 general ledger accounts will be sorted by account number. |Parameter|Beschreibung | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of general ledger accounts which should be skipped. Example: skip=40 | | top | Number of general ledger accounts which 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 first 10 general ledger accounts: .../general-ledger-accounts?top=10 Retrieving of the next 10 general ledger accounts: .../general-ledger-accounts?top=10&skip=10

Declaration

public List<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGet(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<GeneralLedgerAccount>	List<GeneralLedgerAccount>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetAsync(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<GeneralLedgerAccount>>	Task of List<GeneralLedgerAccount>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<ApiResponse<List<GeneralLedgerAccount>>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetAsyncWithHttpInfo(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<GeneralLedgerAccount>>>	Task of ApiResponse (List<GeneralLedgerAccount>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public ApiResponse<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsGetWithHttpInfo(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<GeneralLedgerAccount>>	ApiResponse of List<GeneralLedgerAccount>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGet(String, String, String)

Retrieve a list of utilized general ledger accounts Retrieve an entire list of utilized general ledger accounts for a fiscal year. The list of general ledger accounts includes all posted and all general ledger accounts with individual caption. The general ledger account captions and functions are delivered, but no account values. Filter Filters to condense the scope of the results are not available. 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 utilized general ledger accounts: .../general-ledger-accounts/utilized

Declaration

public List<GeneralLedgerAccount> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGet(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.Collections.Generic.List<GeneralLedgerAccount>	List<GeneralLedgerAccount>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsync(String, String, String)

Declaration

public async Task<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsync(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<System.Collections.Generic.List<GeneralLedgerAccount>>	Task of List<GeneralLedgerAccount>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsyncWithHttpInfo(String, String, String)

Declaration

public async Task<ApiResponse<List<GeneralLedgerAccount>>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetAsyncWithHttpInfo(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<System.Collections.Generic.List<GeneralLedgerAccount>>>	Task of ApiResponse (List<GeneralLedgerAccount>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetWithHttpInfo(String, String, String)

Declaration

public ApiResponse<List<GeneralLedgerAccount>> ClientsClientIdFiscalYearsFiscalYearIdGeneralLedgerAccountsUtilizedGetWithHttpInfo(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<System.Collections.Generic.List<GeneralLedgerAccount>>	ApiResponse of List<GeneralLedgerAccount>

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

IGeneralLedgerAccountsApi

IApiAccessor