Interface IVariousAddressesApi

Represents a collection of functions to interact with the API endpoints

Retrieve a list of various addresses

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)

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

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

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a list of various addresses

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)

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

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

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a list of various addresses

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)

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

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

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a list of various addresses

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)

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

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

Type	Condition
ApiException	Thrown when fails to make API call

Create a new various address

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

Type	Description
ErrorMessage	ErrorMessage

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.

Type	Condition
ApiException	Thrown when fails to make API call

Create a new various address

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

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

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.

Type	Condition
ApiException	Thrown when fails to make API call

Create a new various address

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

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

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.

Type	Condition
ApiException	Thrown when fails to make API call

Create a new various address

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

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

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.

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a specific various address

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)

Type	Description
VariousAddress	VariousAddress

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.

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a specific various address

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)

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

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.

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a specific various address

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)

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

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.

Type	Condition
ApiException	Thrown when fails to make API call

Retrieve a specific various address

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)

Type	Description
ApiResponse<VariousAddress>	ApiResponse of VariousAddress

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.

Inherited Members

Namespace: Simplic.Datev.Swagger.Api

Assembly: Simplic.Datev.IO.Swagger.dll

Syntax

Methods

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

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPost(String, String, VariousAddress)

Declaration

Parameters

Returns

Remarks

Exceptions

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostAsync(String, String, VariousAddress)

Declaration

Parameters

Returns

Remarks

Exceptions

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostAsyncWithHttpInfo(String, String, VariousAddress)

Declaration

Parameters

Returns

Remarks

Exceptions

ClientsClientIdFiscalYearsFiscalYearIdVariousAddressesPostWithHttpInfo(String, String, VariousAddress)

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions

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

Declaration

Parameters

Returns

Remarks

Exceptions