Interface IClientsApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: Simplic.Datev.Swagger.Api

Assembly: Simplic.Datev.IO.Swagger.dll

Syntax

public interface IClientsApi : IApiAccessor

Methods

| Improve this Doc View Source

ClientsClientIdGet(String, String, String)

Retrieve a specific client/company

Declaration

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

Remarks

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).

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdGetAsync(String, String, String)

Retrieve a specific client/company

Declaration

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdGetAsyncWithHttpInfo(String, String, String)

Retrieve a specific client/company

Declaration

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)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdGetWithHttpInfo(String, String, String)

Retrieve a specific client/company

Declaration

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

Remarks

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

Declaration

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>

Remarks

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\" } ]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of clients/companies

Declaration

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>

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of clients/companies

Declaration

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a list of clients/companies

Declaration

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>

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call