Class TermsOfPaymentApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

TermsOfPaymentApi

Implements

ITermsOfPaymentApi

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 TermsOfPaymentApi : ITermsOfPaymentApi, IApiAccessor

Constructors

TermsOfPaymentApi(Configuration)

Initializes a new instance of the TermsOfPaymentApi class using Configuration object

Declaration

public TermsOfPaymentApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

TermsOfPaymentApi(String)

Initializes a new instance of the TermsOfPaymentApi class.

Declaration

public TermsOfPaymentApi(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.

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

Retrieve a list of terms of payment Retrieve an entire list of terms of payment for a fiscal year.<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 List<TermOfPayment> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentGet(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = 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)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of terms of payment Retrieve an entire list of terms of payment for a fiscal year.<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<List<TermOfPayment>> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentGetAsync(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = 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)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of terms of payment Retrieve an entire list of terms of payment for a fiscal year.<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<List<TermOfPayment>>> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = 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)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Retrieve a list of terms of payment Retrieve an entire list of terms of payment for a fiscal year.<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<List<TermOfPayment>> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = 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)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPost(String, String, TermOfPayment)

Create a new term of payment with the next available number A new term of payment will be created with the next available number (term-of-payment-id). It is not possible to create a term of payment with a number (ID) of your choice using the POST command.<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 ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPost(string clientId, string fiscalYearId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
TermOfPayment	termOfPayment	Term of payment

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPostAsync(String, String, TermOfPayment)

Create a new term of payment with the next available number A new term of payment will be created with the next available number (term-of-payment-id). It is not possible to create a term of payment with a number (ID) of your choice using the POST command.<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> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPostAsync(string clientId, string fiscalYearId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
TermOfPayment	termOfPayment	Term of payment

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPostAsyncWithHttpInfo(String, String, TermOfPayment)

Create a new term of payment with the next available number A new term of payment will be created with the next available number (term-of-payment-id). It is not possible to create a term of payment with a number (ID) of your choice using the POST command.<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>> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPostAsyncWithHttpInfo(string clientId, string fiscalYearId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
TermOfPayment	termOfPayment	Term of payment

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPostWithHttpInfo(String, String, TermOfPayment)

Create a new term of payment with the next available number A new term of payment will be created with the next available number (term-of-payment-id). It is not possible to create a term of payment with a number (ID) of your choice using the POST command.<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> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentPostWithHttpInfo(string clientId, string fiscalYearId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
TermOfPayment	termOfPayment	Term of payment

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGet(String, String, String, String)

Retrieve a term of payment Retrieve a single term of payment in the fiscal year.<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 TermOfPayment ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGet(string clientId, string fiscalYearId, string termOfPaymentId, string select = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)

Returns

Type	Description
TermOfPayment	TermOfPayment

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetAsync(String, String, String, String)

Retrieve a term of payment Retrieve a single term of payment in the fiscal year.<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<TermOfPayment> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetAsync(string clientId, string fiscalYearId, string termOfPaymentId, string select = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetAsyncWithHttpInfo(String, String, String, String)

Retrieve a term of payment Retrieve a single term of payment in the fiscal year.<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<TermOfPayment>> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string termOfPaymentId, string select = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetWithHttpInfo(String, String, String, String)

Retrieve a term of payment Retrieve a single term of payment in the fiscal year.<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<TermOfPayment> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetWithHttpInfo(string clientId, string fiscalYearId, string termOfPaymentId, string select = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)

Returns

Type	Description
ApiResponse<TermOfPayment>	ApiResponse of TermOfPayment

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPut(String, String, String, TermOfPayment)

Update/create a specific term of payment A term of payment is updated/created with a desired number (ID). With the PUT command, the term-ofpayment will be completely overwritten. We recommend that you first perform a GET request for the term of payment that you want to update to prevent master data from being overwritten. The PUT command can also be used to create a new payment term with a desired number (ID). 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.

Declaration

public ErrorMessage ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPut(string clientId, string fiscalYearId, string termOfPaymentId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
TermOfPayment	termOfPayment	Terms of payment

Returns

Type	Description
ErrorMessage	ErrorMessage

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutAsync(String, String, String, TermOfPayment)

Update/create a specific term of payment A term of payment is updated/created with a desired number (ID). With the PUT command, the term-ofpayment will be completely overwritten. We recommend that you first perform a GET request for the term of payment that you want to update to prevent master data from being overwritten. The PUT command can also be used to create a new payment term with a desired number (ID). 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.

Declaration

public async Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutAsync(string clientId, string fiscalYearId, string termOfPaymentId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
TermOfPayment	termOfPayment	Terms of payment

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutAsyncWithHttpInfo(String, String, String, TermOfPayment)

Update/create a specific term of payment A term of payment is updated/created with a desired number (ID). With the PUT command, the term-ofpayment will be completely overwritten. We recommend that you first perform a GET request for the term of payment that you want to update to prevent master data from being overwritten. The PUT command can also be used to create a new payment term with a desired number (ID). 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.

Declaration

public async Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutAsyncWithHttpInfo(string clientId, string fiscalYearId, string termOfPaymentId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
TermOfPayment	termOfPayment	Terms of payment

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutWithHttpInfo(String, String, String, TermOfPayment)

Update/create a specific term of payment A term of payment is updated/created with a desired number (ID). With the PUT command, the term-ofpayment will be completely overwritten. We recommend that you first perform a GET request for the term of payment that you want to update to prevent master data from being overwritten. The PUT command can also be used to create a new payment term with a desired number (ID). 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.

Declaration

public ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutWithHttpInfo(string clientId, string fiscalYearId, string termOfPaymentId, TermOfPayment termOfPayment)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	termOfPaymentId	Term of payment ID
TermOfPayment	termOfPayment	Terms of payment

Returns

Type	Description
ApiResponse<ErrorMessage>	ApiResponse of ErrorMessage

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

ITermsOfPaymentApi

IApiAccessor