Class ClientsApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

ClientsApi

Implements

IClientsApi

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 ClientsApi : IClientsApi, IApiAccessor

Constructors

| Improve this Doc View Source

ClientsApi(Configuration)

Initializes a new instance of the ClientsApi class using Configuration object

Declaration

public ClientsApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

ClientsApi(String)

Initializes a new instance of the ClientsApi class.

Declaration

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

ClientsClientIdGet(String, String, String)

Retrieve a specific client/company Access a specific client/company within the scope of Rechnungswesen (accounting). Clients and companies are managed over several years. Retrieving clients with subordinate objects By including the parameter expand=all in the URI, the full scope of client objects will be requested. In the standard case, without the expand parameter, the client object will be requested without subordinate objects (company data).

Declaration

public AccountingClient ClientsClientIdGet(string clientId, string select = null, string expand = 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	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

Type	Description
AccountingClient	AccountingClient

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdGetAsync(String, String, String)

Declaration

public async Task<AccountingClient> ClientsClientIdGetAsync(string clientId, string select = null, string expand = 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	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdGetAsyncWithHttpInfo(String, String, String)

Declaration

public async Task<ApiResponse<AccountingClient>> ClientsClientIdGetAsyncWithHttpInfo(string clientId, string select = null, string expand = 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	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdGetWithHttpInfo(String, String, String)

Declaration

public ApiResponse<AccountingClient> ClientsClientIdGetWithHttpInfo(string clientId, string select = null, string expand = 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	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

Type	Description
ApiResponse<AccountingClient>	ApiResponse of AccountingClient

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of clients/companies Retrieving all clients/companies within the scope of Rechnungswesen (accounting). The clients/companies are managed over several years and are shown in the form of a list. Retrieving clients with subordinate objects By including the parameter expand=all in the URI, the full scope of client objects will be requested. In the standard case, without the expand parameter, the client object will be requested without subordinate objects (company data). Additional functionality by header When using multiple data pathes, the use of following header is recommended: - accept: multipart/mixed, application/json When one or more data paths are not adapted for the current version, besides the user data an additional message will be added in the response. Example: json [ { \"name\":\"Musterholz GmbH\", \"number\":55003, \"id\":\"53dbd677-c477-4a4d-bde0-a6db187abb5e\" }, { \"name\":\"Testholz GmbH\", \"number\":55004, \"id\":\"3c15fa1e-003d-4131-9518-0cd58b104d34\" } ] json [ { \"error\":\"REW11041\", \"error_description\":\"Die angeforderten Daten konnten nicht (vollständig) geliefert werden, da nicht alle Datenpfade auf dem aktuellen Versionsstand sind. Starten Sie die Datenanpassung im Installations-Manager. Detaillierte Informationen hierzu finden Sie in Dokument 'https://apps.datev.de/knowledge/help/search?q=9215997'.\", \"request_id\":\"80a2f2ae-dd39-456d-a355-cd6c656194f5\", \"additional_messages\": }, { \"id\":\"REW11041\", \"description\":\"Die angeforderten Daten konnten nicht (vollständig) geliefert werden, da nicht alle Datenpfade auf dem aktuellen Versionsstand sind. Starten Sie die Datenanpassung im Installations-Manager. Detaillierte Informationen hierzu finden Sie in Dokument 'https://apps.datev.de/knowledge/help/search?q=9215997'.\", \"severity\":\"Information\" } ]

Declaration

public List<AccountingClient> ClientsGet(string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
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)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<List<AccountingClient>> ClientsGetAsync(string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
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)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<ApiResponse<List<AccountingClient>>> ClientsGetAsyncWithHttpInfo(string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
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)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public ApiResponse<List<AccountingClient>> ClientsGetWithHttpInfo(string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
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)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

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

IClientsApi

IApiAccessor