Interface ITermsOfPaymentApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Simplic.Datev.Swagger.Api
Assembly: Simplic.Datev.IO.Swagger.dll
Syntax
public interface ITermsOfPaymentApi : IApiAccessorMethods
| Improve this Doc View SourceClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentGet(String, String, String, String, String, Nullable<Int32>)
Retrieve a list of terms of payment
Declaration
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> |
Remarks
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.
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
Declaration
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> |
Remarks
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.
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
Declaration
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>) |
Remarks
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.
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
Declaration
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> |
Remarks
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.
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
Declaration
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 |
Remarks
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.
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
Declaration
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 |
Remarks
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.
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
Declaration
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) |
Remarks
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.
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
Declaration
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 |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGet(String, String, String, String)
Retrieve a term of payment
Declaration
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 |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetAsync(String, String, String, String)
Retrieve a term of payment
Declaration
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 |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetAsyncWithHttpInfo(String, String, String, String)
Retrieve a term of payment
Declaration
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) |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdGetWithHttpInfo(String, String, String, String)
Retrieve a term of payment
Declaration
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 |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPut(String, String, String, TermOfPayment)
Update/create a specific term of payment
Declaration
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 |
Remarks
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="../../../node/316" target="_blank">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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutAsync(String, String, String, TermOfPayment)
Update/create a specific term of payment
Declaration
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 |
Remarks
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="../../../node/316" target="_blank">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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutAsyncWithHttpInfo(String, String, String, TermOfPayment)
Update/create a specific term of payment
Declaration
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) |
Remarks
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="../../../node/316" target="_blank">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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ClientsClientIdFiscalYearsFiscalYearIdTermsOfPaymentTermOfPaymentIdPutWithHttpInfo(String, String, String, TermOfPayment)
Update/create a specific term of payment
Declaration
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 |
Remarks
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="../../../node/316" target="_blank">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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |