Class BusinessPartnersApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

BusinessPartnersApi

Implements

IBusinessPartnersApi

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 BusinessPartnersApi : IBusinessPartnersApi, IApiAccessor

Constructors

BusinessPartnersApi(Configuration)

Initializes a new instance of the BusinessPartnersApi class using Configuration object

Declaration

public BusinessPartnersApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

BusinessPartnersApi(String)

Initializes a new instance of the BusinessPartnersApi class.

Declaration

public BusinessPartnersApi(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

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.

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGet(String, String, String, String, String)

Retrieve a specific creditor Retrieve a creditor of a client/company. A creditor can be retrieved using the required account number (account_number, creditor-id). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors/700000000

Declaration

public Creditor ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGet(string clientId, string fiscalYearId, string creditorId, string select = 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	creditorId	ID of the business partner
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
Creditor	Creditor

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGetAsync(String, String, String, String, String)

Retrieve a specific creditor Retrieve a creditor of a client/company. A creditor can be retrieved using the required account number (account_number, creditor-id). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors/700000000

Declaration

public async Task<Creditor> ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGetAsync(string clientId, string fiscalYearId, string creditorId, string select = 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	creditorId	ID of the business partner
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<Creditor>	Task of Creditor

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGetAsyncWithHttpInfo(String, String, String, String, String)

Retrieve a specific creditor Retrieve a creditor of a client/company. A creditor can be retrieved using the required account number (account_number, creditor-id). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors/700000000

Declaration

public async Task<ApiResponse<Creditor>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string creditorId, string select = 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	creditorId	ID of the business partner
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<Creditor>>	Task of ApiResponse (Creditor)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGetWithHttpInfo(String, String, String, String, String)

Retrieve a specific creditor Retrieve a creditor of a client/company. A creditor can be retrieved using the required account number (account_number, creditor-id). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors/700000000

Declaration

public ApiResponse<Creditor> ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdGetWithHttpInfo(string clientId, string fiscalYearId, string creditorId, string select = 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	creditorId	ID of the business partner
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<Creditor>	ApiResponse of Creditor

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPut(String, String, String, Creditor)

Update/create a specific creditor A business partner can be updated/created using the required account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPut(string clientId, string fiscalYearId, string creditorId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	creditorId	ID of the business partner
Creditor	creditor	Creditor master data

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPutAsync(String, String, String, Creditor)

Update/create a specific creditor A business partner can be updated/created using the required account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPutAsync(string clientId, string fiscalYearId, string creditorId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	creditorId	ID of the business partner
Creditor	creditor	Creditor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPutAsyncWithHttpInfo(String, String, String, Creditor)

Update/create a specific creditor A business partner can be updated/created using the required account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPutAsyncWithHttpInfo(string clientId, string fiscalYearId, string creditorId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	creditorId	ID of the business partner
Creditor	creditor	Creditor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPutWithHttpInfo(String, String, String, Creditor)

Update/create a specific creditor A business partner can be updated/created using the required account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdCreditorsCreditorIdPutWithHttpInfo(string clientId, string fiscalYearId, string creditorId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	creditorId	ID of the business partner
Creditor	creditor	Creditor master data

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of creditors Retrieve the creditors of a client/company. Creditors are the suppliers of a company. Together with the debtiors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;ge date_last_modification&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDDhh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors?filter=account_number eq 700000000 Retrieving the creditors with account numbers ranging from 70000 to 89999:<br> .../creditors?filter=account_number ge 700000000 and account_number le 899999999 Retrieving creditors that have been modified since a stipulated point in time:<br> .../creditors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 creditors:<br> .../creditors?top=10 Retrieving of the next 10 creditors:<br> .../creditors?top=10&skip=10 Retrieving of all creditors with the description beginning with 'Me':<br> .../creditors?filter=startswith(caption,'Me')

Declaration

public List<Creditor> ClientsClientIdFiscalYearsFiscalYearIdCreditorsGet(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of creditors Retrieve the creditors of a client/company. Creditors are the suppliers of a company. Together with the debtiors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;ge date_last_modification&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDDhh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors?filter=account_number eq 700000000 Retrieving the creditors with account numbers ranging from 70000 to 89999:<br> .../creditors?filter=account_number ge 700000000 and account_number le 899999999 Retrieving creditors that have been modified since a stipulated point in time:<br> .../creditors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 creditors:<br> .../creditors?top=10 Retrieving of the next 10 creditors:<br> .../creditors?top=10&skip=10 Retrieving of all creditors with the description beginning with 'Me':<br> .../creditors?filter=startswith(caption,'Me')

Declaration

public async Task<List<Creditor>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsGetAsync(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of creditors Retrieve the creditors of a client/company. Creditors are the suppliers of a company. Together with the debtiors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;ge date_last_modification&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDDhh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors?filter=account_number eq 700000000 Retrieving the creditors with account numbers ranging from 70000 to 89999:<br> .../creditors?filter=account_number ge 700000000 and account_number le 899999999 Retrieving creditors that have been modified since a stipulated point in time:<br> .../creditors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 creditors:<br> .../creditors?top=10 Retrieving of the next 10 creditors:<br> .../creditors?top=10&skip=10 Retrieving of all creditors with the description beginning with 'Me':<br> .../creditors?filter=startswith(caption,'Me')

Declaration

public async Task<ApiResponse<List<Creditor>>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of creditors Retrieve the creditors of a client/company. Creditors are the suppliers of a company. Together with the debtiors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;ge date_last_modification&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDDhh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the creditor with the account number (account_number) 70000:<br> .../creditors?filter=account_number eq 700000000 Retrieving the creditors with account numbers ranging from 70000 to 89999:<br> .../creditors?filter=account_number ge 700000000 and account_number le 899999999 Retrieving creditors that have been modified since a stipulated point in time:<br> .../creditors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 creditors:<br> .../creditors?top=10 Retrieving of the next 10 creditors:<br> .../creditors?top=10&skip=10 Retrieving of all creditors with the description beginning with 'Me':<br> .../creditors?filter=startswith(caption,'Me')

Declaration

public ApiResponse<List<Creditor>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGet(String, String, String)

Retrieve the next available creditor account number Retrieve the next available creditor account number of a client/company. Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available creditor account number (account_number):<br> .../creditors/next-available Retrieving the next available creditor account number (account_number) starting at 80000:<br> .../creditors/next-available?start-at=800000000

Declaration

public NextAvailable ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGet(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

Type	Description
NextAvailable	NextAvailable

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGetAsync(String, String, String)

Retrieve the next available creditor account number Retrieve the next available creditor account number of a client/company. Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available creditor account number (account_number):<br> .../creditors/next-available Retrieving the next available creditor account number (account_number) starting at 80000:<br> .../creditors/next-available?start-at=800000000

Declaration

public async Task<NextAvailable> ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGetAsync(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGetAsyncWithHttpInfo(String, String, String)

Retrieve the next available creditor account number Retrieve the next available creditor account number of a client/company. Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available creditor account number (account_number):<br> .../creditors/next-available Retrieving the next available creditor account number (account_number) starting at 80000:<br> .../creditors/next-available?start-at=800000000

Declaration

public async Task<ApiResponse<NextAvailable>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGetWithHttpInfo(String, String, String)

Retrieve the next available creditor account number Retrieve the next available creditor account number of a client/company. Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available creditor account number (account_number):<br> .../creditors/next-available Retrieving the next available creditor account number (account_number) starting at 80000:<br> .../creditors/next-available?start-at=800000000

Declaration

public ApiResponse<NextAvailable> ClientsClientIdFiscalYearsFiscalYearIdCreditorsNextAvailableGetWithHttpInfo(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

Type	Description
ApiResponse<NextAvailable>	ApiResponse of NextAvailable

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPost(String, String, Creditor)

Create a new creditor with the next available account number A creditor is created using the next available account number. Please note: It is not possible to create creditors of a tax consultant (marked with a &quot;K&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;700000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ClientsClientIdFiscalYearsFiscalYearIdCreditorsPost(string clientId, string fiscalYearId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Creditor	creditor	Creditor master data

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPostAsync(String, String, Creditor)

Create a new creditor with the next available account number A creditor is created using the next available account number. Please note: It is not possible to create creditors of a tax consultant (marked with a &quot;K&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;700000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdCreditorsPostAsync(string clientId, string fiscalYearId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Creditor	creditor	Creditor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPostAsyncWithHttpInfo(String, String, Creditor)

Create a new creditor with the next available account number A creditor is created using the next available account number. Please note: It is not possible to create creditors of a tax consultant (marked with a &quot;K&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;700000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsPostAsyncWithHttpInfo(string clientId, string fiscalYearId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Creditor	creditor	Creditor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPostWithHttpInfo(String, String, Creditor)

Create a new creditor with the next available account number A creditor is created using the next available account number. Please note: It is not possible to create creditors of a tax consultant (marked with a &quot;K&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;700000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdCreditorsPostWithHttpInfo(string clientId, string fiscalYearId, Creditor creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Creditor	creditor	Creditor master data

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPut(String, String, List<Creditor>)

Update/create a list of creditors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the properties &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 BatchResponseMessage ClientsClientIdFiscalYearsFiscalYearIdCreditorsPut(string clientId, string fiscalYearId, List<Creditor> creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Creditor>	creditor	Creditor master data

Returns

Type	Description
BatchResponseMessage	BatchResponseMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPutAsync(String, String, List<Creditor>)

Update/create a list of creditors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the properties &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<BatchResponseMessage> ClientsClientIdFiscalYearsFiscalYearIdCreditorsPutAsync(string clientId, string fiscalYearId, List<Creditor> creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Creditor>	creditor	Creditor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPutAsyncWithHttpInfo(String, String, List<Creditor>)

Update/create a list of creditors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the properties &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ApiResponse<BatchResponseMessage>> ClientsClientIdFiscalYearsFiscalYearIdCreditorsPutAsyncWithHttpInfo(string clientId, string fiscalYearId, List<Creditor> creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Creditor>	creditor	Creditor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdCreditorsPutWithHttpInfo(String, String, List<Creditor>)

Update/create a list of creditors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the properties &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Creditors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Creditors are the suppliers of a company. Together with the debitors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ApiResponse<BatchResponseMessage> ClientsClientIdFiscalYearsFiscalYearIdCreditorsPutWithHttpInfo(string clientId, string fiscalYearId, List<Creditor> creditor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Creditor>	creditor	Creditor master data

Returns

Type	Description
ApiResponse<BatchResponseMessage>	ApiResponse of BatchResponseMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGet(String, String, String, String, String)

Retrieve a specific debitor Retrieve a debitor (debitor) of a client/company. A debitor is retrieved using the required account number (debitor-id, account_number). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors/100000000

Declaration

public Debitor ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGet(string clientId, string fiscalYearId, string debitorId, string select = 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	debitorId	ID of the business partner
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
Debitor	Debitor

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGetAsync(String, String, String, String, String)

Retrieve a specific debitor Retrieve a debitor (debitor) of a client/company. A debitor is retrieved using the required account number (debitor-id, account_number). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors/100000000

Declaration

public async Task<Debitor> ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGetAsync(string clientId, string fiscalYearId, string debitorId, string select = 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	debitorId	ID of the business partner
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<Debitor>	Task of Debitor

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGetAsyncWithHttpInfo(String, String, String, String, String)

Retrieve a specific debitor Retrieve a debitor (debitor) of a client/company. A debitor is retrieved using the required account number (debitor-id, account_number). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors/100000000

Declaration

public async Task<ApiResponse<Debitor>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string debitorId, string select = 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	debitorId	ID of the business partner
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<Debitor>>	Task of ApiResponse (Debitor)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGetWithHttpInfo(String, String, String, String, String)

Retrieve a specific debitor Retrieve a debitor (debitor) of a client/company. A debitor is retrieved using the required account number (debitor-id, account_number). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors/100000000

Declaration

public ApiResponse<Debitor> ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdGetWithHttpInfo(string clientId, string fiscalYearId, string debitorId, string select = 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	debitorId	ID of the business partner
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<Debitor>	ApiResponse of Debitor

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPut(String, String, String, Debitor)

Update/create a specific debitor A business partner can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPut(string clientId, string fiscalYearId, string debitorId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	debitorId	ID of the business partner
Debitor	debitor	Debitor master data

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPutAsync(String, String, String, Debitor)

Update/create a specific debitor A business partner can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPutAsync(string clientId, string fiscalYearId, string debitorId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	debitorId	ID of the business partner
Debitor	debitor	Debitor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPutAsyncWithHttpInfo(String, String, String, Debitor)

Update/create a specific debitor A business partner can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPutAsyncWithHttpInfo(string clientId, string fiscalYearId, string debitorId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	debitorId	ID of the business partner
Debitor	debitor	Debitor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPutWithHttpInfo(String, String, String, Debitor)

Update/create a specific debitor A business partner can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. With the PUT command, the business partner will be completely overwritten. We therefore recommend that you perform a GET request of the business partner being updated beforehand in order to prevent master data from being overwritten. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdDebitorsDebitorIdPutWithHttpInfo(string clientId, string fiscalYearId, string debitorId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	debitorId	ID of the business partner
Debitor	debitor	Debitor master data

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of debitors Retrieve the debitors of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;date_last_modification ge 2017-01-01&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDThh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors?filter=account_number eq 100000000 Retrieving the debitors with account numbers ranging from 10000 to 29999:<br> .../debitors?filter=account_number ge 100000000 and account_number le 299999999 Retrieving debitors that have been modified since a stipulated point in time:<br> .../debitors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 debitors:<br> .../debitors?top=10 Retrieving of the next 10 debitors:<br> .../debitors?top=10&skip=10 Retrieving of all debitors with the description beginning with 'Me':<br> .../debitors?filter=startswith(caption,'Me')

Declaration

public List<Debitor> ClientsClientIdFiscalYearsFiscalYearIdDebitorsGet(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of debitors Retrieve the debitors of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;date_last_modification ge 2017-01-01&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDThh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors?filter=account_number eq 100000000 Retrieving the debitors with account numbers ranging from 10000 to 29999:<br> .../debitors?filter=account_number ge 100000000 and account_number le 299999999 Retrieving debitors that have been modified since a stipulated point in time:<br> .../debitors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 debitors:<br> .../debitors?top=10 Retrieving of the next 10 debitors:<br> .../debitors?top=10&skip=10 Retrieving of all debitors with the description beginning with 'Me':<br> .../debitors?filter=startswith(caption,'Me')

Declaration

public async Task<List<Debitor>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsGetAsync(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of debitors Retrieve the debitors of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;date_last_modification ge 2017-01-01&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDThh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors?filter=account_number eq 100000000 Retrieving the debitors with account numbers ranging from 10000 to 29999:<br> .../debitors?filter=account_number ge 100000000 and account_number le 299999999 Retrieving debitors that have been modified since a stipulated point in time:<br> .../debitors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 debitors:<br> .../debitors?top=10 Retrieving of the next 10 debitors:<br> .../debitors?top=10&skip=10 Retrieving of all debitors with the description beginning with 'Me':<br> .../debitors?filter=startswith(caption,'Me')

Declaration

public async Task<ApiResponse<List<Debitor>>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of debitors Retrieve the debitors of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> Retrieving business partners with subordinate objects By including the parameter expand=all in the URI, the full scope of a business partner object will be requested. In the standard case, without the expand parameter, the business partner object will be requested without subordinate objects (bank, address, and communication details).<br><br> Retrieving a delta of business partners, starting from a defined point in time Using the filter &quot;date_last_modification&quot;, synchronization scenarios can be achieved. By including the &quot;date_last_modification ge 2017-01-01&quot; filter in the URI, all business partners can be requested who have been modified since the date entered. The &quot;date_last_modification&quot; filter is entered in the format &quot;date-time&quot;: YYYY-MM-DDThh:mm:ss.sTZD<br> Please note that the milliseconds are ignored during the request, whereas the time zone is relevant.<br><br> Filter If no further parameters are entered, the list contains its full scope.<br><br> Filter options The number of results can be limited by using the following filters: - account_number - business_partner_number - caption - date_last_modification Operators Filter option: account_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | | startswith | Starts with | | contains | Contains | Filter option: caption | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | startswith | Starts with | | contains | Contains | Filter option: business_partner_number | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter option: date_last_modification | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | ge | Greater than or equal | Filter combinations Filters can be combined using the operator &quot;and&quot;.<br><br> 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 business partners will be sorted by account number. For a consistent result, it is recommended that no new business partners be written during the retrieval process. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of business partners that should be skipped. Example: skip=40 | | top | Number of business partners 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.<br><br> URI examples Retrieving the debitor with the account number (account_number) 10000:<br> .../debitors?filter=account_number eq 100000000 Retrieving the debitors with account numbers ranging from 10000 to 29999:<br> .../debitors?filter=account_number ge 100000000 and account_number le 299999999 Retrieving debitors that have been modified since a stipulated point in time:<br> .../debitors?filter=date_last_modification ge 2016-09-01T12:23:45 Retrieving of the first 10 debitors:<br> .../debitors?top=10 Retrieving of the next 10 debitors:<br> .../debitors?top=10&skip=10 Retrieving of all debitors with the description beginning with 'Me':<br> .../debitors?filter=startswith(caption,'Me')

Declaration

public ApiResponse<List<Debitor>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = 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	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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGet(String, String, String)

Retrieve the next available debitor account number Retrieve the next available debitor account number of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available debitor account number:<br> .../debitors/next-available Retrieving the next available debitor account number (account_number) starting at 30000:<br> .../debitors/next-available?start-at=300000000

Declaration

public NextAvailable ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGet(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

Type	Description
NextAvailable	NextAvailable

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGetAsync(String, String, String)

Retrieve the next available debitor account number Retrieve the next available debitor account number of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available debitor account number:<br> .../debitors/next-available Retrieving the next available debitor account number (account_number) starting at 30000:<br> .../debitors/next-available?start-at=300000000

Declaration

public async Task<NextAvailable> ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGetAsync(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGetAsyncWithHttpInfo(String, String, String)

Retrieve the next available debitor account number Retrieve the next available debitor account number of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available debitor account number:<br> .../debitors/next-available Retrieving the next available debitor account number (account_number) starting at 30000:<br> .../debitors/next-available?start-at=300000000

Declaration

public async Task<ApiResponse<NextAvailable>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGetWithHttpInfo(String, String, String)

Retrieve the next available debitor account number Retrieve the next available debitor account number of a client/company. Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> 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.<br><br> URI examples Retrieving the next available debitor account number:<br> .../debitors/next-available Retrieving the next available debitor account number (account_number) starting at 30000:<br> .../debitors/next-available?start-at=300000000

Declaration

public ApiResponse<NextAvailable> ClientsClientIdFiscalYearsFiscalYearIdDebitorsNextAvailableGetWithHttpInfo(string clientId, string fiscalYearId, string startAt = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	startAt	Starting point for the search for the next available account number. (optional)

Returns

Type	Description
ApiResponse<NextAvailable>	ApiResponse of NextAvailable

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPost(String, String, Debitor)

Create a new debitor with the next available account number A debitor is created using the next available account number. Please note: It is not possible to create debitors of an organization (marked with a &quot;K&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;100000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ClientsClientIdFiscalYearsFiscalYearIdDebitorsPost(string clientId, string fiscalYearId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Debitor	debitor	Debitor master data

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPostAsync(String, String, Debitor)

Create a new debitor with the next available account number A debitor is created using the next available account number. Please note: It is not possible to create debitors of an organization (marked with a &quot;K&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;100000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdDebitorsPostAsync(string clientId, string fiscalYearId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Debitor	debitor	Debitor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPostAsyncWithHttpInfo(String, String, Debitor)

Create a new debitor with the next available account number A debitor is created using the next available account number. Please note: It is not possible to create debitors of an organization (marked with a &quot;K&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;100000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsPostAsyncWithHttpInfo(string clientId, string fiscalYearId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Debitor	debitor	Debitor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPostWithHttpInfo(String, String, Debitor)

Create a new debitor with the next available account number A debitor is created using the next available account number. Please note: It is not possible to create debitors of an organization (marked with a &quot;K&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. It is not possible to create a business partner with an account number of your choice (account_number) using the POST command. The PUT command may be used to create a business partner with a specific account number (account_number, e.g. &quot;100000000&quot;, technical length). For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdDebitorsPostWithHttpInfo(string clientId, string fiscalYearId, Debitor debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
Debitor	debitor	Debitor master data

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPut(String, String, List<Debitor>)

Update/create a list of debitors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 BatchResponseMessage ClientsClientIdFiscalYearsFiscalYearIdDebitorsPut(string clientId, string fiscalYearId, List<Debitor> debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Debitor>	debitor	Debitor master data

Returns

Type	Description
BatchResponseMessage	BatchResponseMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPutAsync(String, String, List<Debitor>)

Update/create a list of debitors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<BatchResponseMessage> ClientsClientIdFiscalYearsFiscalYearIdDebitorsPutAsync(string clientId, string fiscalYearId, List<Debitor> debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Debitor>	debitor	Debitor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPutAsyncWithHttpInfo(String, String, List<Debitor>)

Update/create a list of debitors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 async Task<ApiResponse<BatchResponseMessage>> ClientsClientIdFiscalYearsFiscalYearIdDebitorsPutAsyncWithHttpInfo(string clientId, string fiscalYearId, List<Debitor> debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Debitor>	debitor	Debitor master data

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdDebitorsPutWithHttpInfo(String, String, List<Debitor>)

Update/create a list of debitors A list of business partners can be updated/created using the desired account number (fill the property &quot;id&quot; with the desired account number, the property &quot;account_number&quot; must remain empty). A maximum of 500 business partners can be included in the list. Important: In order to create/update a list of business partners, the header &quot;Content-Type: application/merge-patch+json&quot; has to be submitted with the request. Please note: Debitors of a tax consultant (marked with a &quot;K&quot;) are individualized for the client/company when they are updated (marked with a &quot;I&quot;). Debitors are the customers of a company. Together with the creditors, they constitute the business partners of a company. By transferring a list of business partners, only the business partners whose account number is specified are changed. This means that the existing list is not replaced by the transfer. Example: 1, 2, and 3 exist. 1 and 3 are transferred in a list. These are updated, the 2 remains unaffected. The information of the specified business partners is overwritten with the PUT command in its entirety, as known from an individual update. The PUT command may also be used to create a new business partner with a desired account number. For more information, please refer to the document <a href=&quot;../../../node/316&quot; target=&quot;_blank&quot;>Supplementary information for the interface documentation of DATEVconnect</a>.<br><br> GoBD guidelines 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 (debitors and creditors) will be logged in Rechnungswesen. A log of all import activities can be retrieved within Rechnungswesen under: Bestand | Importieren | Importprotokoll.<br><br> Date specification with time zone The given time zone in the business partner (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).<br><br> It is recommended that the time is set in this specific format 00:00:00.000 (hh:mm:ss.f).<br> Example: 2016-12-30T00:00:00.000+01:00<br> 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)<br><br> See also the official site of Microsoft:<br> English article: https://technet.microsoft.com/en-us/library/ms187819.aspx <br> German article: https://technet.microsoft.com/de-de/library/ms187819.aspx <br><br> 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 ApiResponse<BatchResponseMessage> ClientsClientIdFiscalYearsFiscalYearIdDebitorsPutWithHttpInfo(string clientId, string fiscalYearId, List<Debitor> debitor)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.Collections.Generic.List<Debitor>	debitor	Debitor master data

Returns

Type	Description
ApiResponse<BatchResponseMessage>	ApiResponse of BatchResponseMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

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

IBusinessPartnersApi

IApiAccessor