Class VariousAddressesApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

VariousAddressesApi

Implements

IVariousAddressesApi

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 VariousAddressesApi : IVariousAddressesApi, IApiAccessor

Constructors

| Improve this Doc View Source

VariousAddressesApi(Configuration)

Initializes a new instance of the VariousAddressesApi class using Configuration object

Declaration

public VariousAddressesApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

VariousAddressesApi(String)

Initializes a new instance of the VariousAddressesApi class.

Declaration

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

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

Retrieve a list of various addresses Retrieve the various addresses of a client/company. With various addresses, you can edit the addresses of various business partners. These are business partners that do not have their own account, but that are managed with other business partners under a single joint account number. Retrieving various addresses with subordinate objects By including the parameter expand=all in the URI, the full scope of a various addresse object will be requested. In the standard case, without the expand parameter, the various address object will be requested without subordinate objects (bank, address, and communication details). 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. Various addresses will be sorted by address number. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of various addresses that should be skipped. Example: skip=40| | top | Number of various addresses 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 first 10 various addresses: .../various-addresses?top=10 Retrieving of the next 10 various addresses: .../various-addresses?top=10&skip=10

Declaration

public List<VariousAddress> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesGet(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string expand = 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	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<VariousAddress>	List<VariousAddress>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<List<VariousAddress>> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesGetAsync(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string expand = 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	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<VariousAddress>>	Task of List<VariousAddress>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<ApiResponse<List<VariousAddress>>> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string expand = 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	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<VariousAddress>>>	Task of ApiResponse (List<VariousAddress>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public ApiResponse<List<VariousAddress>> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string skip = null, int? top = null, string expand = 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	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<VariousAddress>>	ApiResponse of List<VariousAddress>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPost(String, String, VariousAddress)

Create a new various address A new various address will be created with the next available number (various-address-id). With various addresses, you can edit the addresses of various business partners. These are business partners that do not have their own account, but that are managed with other business partners under a single joint account number. For more information, please refer to the document <a href="../../../node/316" target="_blank">Supplementary information for the interface documentation of DATEVconnect</a>. GoBD finalization of accounting sequences Pursuant to guideline 1 of the principles regarding the proper keeping and retention of books, records, and documents in electronic form and regarding data access (GoBD), changes to the business partner master data (various addresses) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll. Date specification with time zone The given time zone in the various address (for example, addresses and banks, temporary billing blocks) should correspond to the time zone set on the server, since otherwise dates may be deferred. As a rule, the given time zone is the Central European time zone (CET/CEST). It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f). Example: 2016-12-30T00:00:00.000+01:00 If 23:59.59.999 is specified as the exact date and time, depending on the database field, the next day may be displayed due to rounding differences. For example: JSON = 2016-01-01T23:59:59.999+01:00 (01.01.2016) | database = 2016-01-02T00:00.000 +01.00 (02.01.2016) See also the official site of Microsoft: English article: https://technet.microsoft.com/en-us/library/ms187819.aspx German article: https://technet.microsoft.com/de-de/library/ms187819.aspx 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 ErrorMessage ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPost(string clientId, string fiscalYearId, VariousAddress variousAddress)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
VariousAddress	variousAddress	Master data of a various address

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostAsync(String, String, VariousAddress)

Declaration

public async Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostAsync(string clientId, string fiscalYearId, VariousAddress variousAddress)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
VariousAddress	variousAddress	Master data of a various address

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostAsyncWithHttpInfo(String, String, VariousAddress)

Declaration

public async Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostAsyncWithHttpInfo(string clientId, string fiscalYearId, VariousAddress variousAddress)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
VariousAddress	variousAddress	Master data of a various address

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostWithHttpInfo(String, String, VariousAddress)

Declaration

public ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostWithHttpInfo(string clientId, string fiscalYearId, VariousAddress variousAddress)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
VariousAddress	variousAddress	Master data of a various address

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve a specific various address Retrieve a specific various address 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>. Retrieving various addresses with subordinate objects By including the parameter expand=all in the URI, the full scope of a various addresse object will be requested. In the standard case, without the expand parameter, the various addresse object will be requested without subordinate objects (bank, address, and communication details). 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 VariousAddress ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesVariousAddressIdGet(string clientId, string fiscalYearId, string variousAddressId, string select = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	variousAddressId	Various address number
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	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
VariousAddress	VariousAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<VariousAddress> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesVariousAddressIdGetAsync(string clientId, string fiscalYearId, string variousAddressId, string select = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	variousAddressId	Various address number
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	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<VariousAddress>	Task of VariousAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public async Task<ApiResponse<VariousAddress>> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesVariousAddressIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string variousAddressId, string select = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	variousAddressId	Various address number
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	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<VariousAddress>>	Task of ApiResponse (VariousAddress)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Declaration

public ApiResponse<VariousAddress> ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesVariousAddressIdGetWithHttpInfo(string clientId, string fiscalYearId, string variousAddressId, string select = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	variousAddressId	Various address number
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	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<VariousAddress>	ApiResponse of VariousAddress

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

IVariousAddressesApi

IApiAccessor