Interface IAccountingSequencesApi

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 IAccountingSequencesApi : IApiAccessor

Methods

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPost(String, String, AccountingSequence)

Create an accounting sequence

Declaration
ErrorMessage ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPost(string clientId, string fiscalYearId, AccountingSequence accountingSequence)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
AccountingSequence accountingSequence

Accounting sequence

Returns
Type Description
ErrorMessage

ErrorMessage
Remarks

Transferring an accounting sequence containing accounting records to Rechnungswesen (accounting). The accounting records transferred will be made available for processing in the &quot;Stapelverarbeitung&quot; of Rechnungswesen.<br> Exception: Accounting sequences with the record type annual financial statements are not visible in the product Mittelstand Faktura.<br> Using this approach, it is possible to process sequences on an individual basis or attach them to an existing (but not yet comitted) sequence. 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> Accounting period Allocation to an accounting period is performed using &quot;date_from&quot; and &quot;date_to&quot; in the accounting-sequence class. It is important to ensure that both dates for the accounting sequence are within a single accounting period.<br><br> Volume limit for accounting sequences The maximum number of transaction records that can be written per accounting sequence depends on the infrastructure used by the client (e.g. hardware, network, etc.). <br><br> GoBD finalization of accounting sequences The accounting-sequence class features an &quot;is_committed&quot; property to enable accounting sequences to be transmitted with TRUE or FALSE values that indicate finalization status. This flag applies with respect to the entire accounting sequence. With delivery of Rechnungswesen version 8.0x (2019): If no finalization flag is transferred, the accounting sequence will be automatically committed after following an import into the DATEV accounting programs. For more information, please refer to the Info Database, documents 1080636 and 1080697.<br><br> Date specification with time zone The given time zone in the accounting sequence (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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPostAsync(String, String, AccountingSequence)

Create an accounting sequence

Declaration
Task<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPostAsync(string clientId, string fiscalYearId, AccountingSequence accountingSequence)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
AccountingSequence accountingSequence

Accounting sequence

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

Task of ErrorMessage
Remarks

Transferring an accounting sequence containing accounting records to Rechnungswesen (accounting). The accounting records transferred will be made available for processing in the &quot;Stapelverarbeitung&quot; of Rechnungswesen.<br> Exception: Accounting sequences with the record type annual financial statements are not visible in the product Mittelstand Faktura.<br> Using this approach, it is possible to process sequences on an individual basis or attach them to an existing (but not yet comitted) sequence. 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> Accounting period Allocation to an accounting period is performed using &quot;date_from&quot; and &quot;date_to&quot; in the accounting-sequence class. It is important to ensure that both dates for the accounting sequence are within a single accounting period.<br><br> Volume limit for accounting sequences The maximum number of transaction records that can be written per accounting sequence depends on the infrastructure used by the client (e.g. hardware, network, etc.). <br><br> GoBD finalization of accounting sequences The accounting-sequence class features an &quot;is_committed&quot; property to enable accounting sequences to be transmitted with TRUE or FALSE values that indicate finalization status. This flag applies with respect to the entire accounting sequence. With delivery of Rechnungswesen version 8.0x (2019): If no finalization flag is transferred, the accounting sequence will be automatically committed after following an import into the DATEV accounting programs. For more information, please refer to the Info Database, documents 1080636 and 1080697.<br><br> Date specification with time zone The given time zone in the accounting sequence (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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPostAsyncWithHttpInfo(String, String, AccountingSequence)

Create an accounting sequence

Declaration
Task<ApiResponse<ErrorMessage>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPostAsyncWithHttpInfo(string clientId, string fiscalYearId, AccountingSequence accountingSequence)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
AccountingSequence accountingSequence

Accounting sequence

Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<ErrorMessage>>

Task of ApiResponse (ErrorMessage)
Remarks

Transferring an accounting sequence containing accounting records to Rechnungswesen (accounting). The accounting records transferred will be made available for processing in the &quot;Stapelverarbeitung&quot; of Rechnungswesen.<br> Exception: Accounting sequences with the record type annual financial statements are not visible in the product Mittelstand Faktura.<br> Using this approach, it is possible to process sequences on an individual basis or attach them to an existing (but not yet comitted) sequence. 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> Accounting period Allocation to an accounting period is performed using &quot;date_from&quot; and &quot;date_to&quot; in the accounting-sequence class. It is important to ensure that both dates for the accounting sequence are within a single accounting period.<br><br> Volume limit for accounting sequences The maximum number of transaction records that can be written per accounting sequence depends on the infrastructure used by the client (e.g. hardware, network, etc.). <br><br> GoBD finalization of accounting sequences The accounting-sequence class features an &quot;is_committed&quot; property to enable accounting sequences to be transmitted with TRUE or FALSE values that indicate finalization status. This flag applies with respect to the entire accounting sequence. With delivery of Rechnungswesen version 8.0x (2019): If no finalization flag is transferred, the accounting sequence will be automatically committed after following an import into the DATEV accounting programs. For more information, please refer to the Info Database, documents 1080636 and 1080697.<br><br> Date specification with time zone The given time zone in the accounting sequence (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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPostWithHttpInfo(String, String, AccountingSequence)

Create an accounting sequence

Declaration
ApiResponse<ErrorMessage> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesPostWithHttpInfo(string clientId, string fiscalYearId, AccountingSequence accountingSequence)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
AccountingSequence accountingSequence

Accounting sequence

Returns
Type Description
ApiResponse<ErrorMessage>

ApiResponse of ErrorMessage
Remarks

Transferring an accounting sequence containing accounting records to Rechnungswesen (accounting). The accounting records transferred will be made available for processing in the &quot;Stapelverarbeitung&quot; of Rechnungswesen.<br> Exception: Accounting sequences with the record type annual financial statements are not visible in the product Mittelstand Faktura.<br> Using this approach, it is possible to process sequences on an individual basis or attach them to an existing (but not yet comitted) sequence. 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> Accounting period Allocation to an accounting period is performed using &quot;date_from&quot; and &quot;date_to&quot; in the accounting-sequence class. It is important to ensure that both dates for the accounting sequence are within a single accounting period.<br><br> Volume limit for accounting sequences The maximum number of transaction records that can be written per accounting sequence depends on the infrastructure used by the client (e.g. hardware, network, etc.). <br><br> GoBD finalization of accounting sequences The accounting-sequence class features an &quot;is_committed&quot; property to enable accounting sequences to be transmitted with TRUE or FALSE values that indicate finalization status. This flag applies with respect to the entire accounting sequence. With delivery of Rechnungswesen version 8.0x (2019): If no finalization flag is transferred, the accounting sequence will be automatically committed after following an import into the DATEV accounting programs. For more information, please refer to the Info Database, documents 1080636 and 1080697.<br><br> Date specification with time zone The given time zone in the accounting sequence (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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting records of an accounting sequence

Declaration
List<AccountingRecordRead> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsGet(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string select = null, string skip = null, int? top = null, string expand = null)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
System.String accountingSequenceProcessedId

ID of an accounting sequence
System.String select

Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String skip

States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32> top

States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String expand

Parameter that allows reading a resource with subordinate objects. When specifying &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<AccountingRecordRead>

List<AccountingRecordRead>
Remarks

Retrieve a list of accounting records of a specific accounting sequence (prima nota). For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting records will be sorted by accounting record ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting records that should be skipped. Example: skip=40 | | top | Number of accounting records that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting records:<br> .../accounting-records?top=10 Retrieving of the next 10 accounting records:<br> .../accounting-records?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting records of an accounting sequence

Declaration
Task<List<AccountingRecordRead>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsGetAsync(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string select = null, string skip = null, int? top = null, string expand = null)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
System.String accountingSequenceProcessedId

ID of an accounting sequence
System.String select

Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String skip

States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32> top

States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String expand

Parameter that allows reading a resource with subordinate objects. When specifying &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<AccountingRecordRead>>

Task of List<AccountingRecordRead>
Remarks

Retrieve a list of accounting records of a specific accounting sequence (prima nota). For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting records will be sorted by accounting record ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting records that should be skipped. Example: skip=40 | | top | Number of accounting records that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting records:<br> .../accounting-records?top=10 Retrieving of the next 10 accounting records:<br> .../accounting-records?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting records of an accounting sequence

Declaration
Task<ApiResponse<List<AccountingRecordRead>>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string select = null, string skip = null, int? top = null, string expand = null)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
System.String accountingSequenceProcessedId

ID of an accounting sequence
System.String select

Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String skip

States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32> top

States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String expand

Parameter that allows reading a resource with subordinate objects. When specifying &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<AccountingRecordRead>>>

Task of ApiResponse (List<AccountingRecordRead>)
Remarks

Retrieve a list of accounting records of a specific accounting sequence (prima nota). For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting records will be sorted by accounting record ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting records that should be skipped. Example: skip=40 | | top | Number of accounting records that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting records:<br> .../accounting-records?top=10 Retrieving of the next 10 accounting records:<br> .../accounting-records?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting records of an accounting sequence

Declaration
ApiResponse<List<AccountingRecordRead>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsGetWithHttpInfo(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string select = null, string skip = null, int? top = null, string expand = null)
Parameters
Type Name Description
System.String clientId

ID of central client/company
System.String fiscalYearId

ID of the fiscal year
System.String accountingSequenceProcessedId

ID of an accounting sequence
System.String select

Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String skip

States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32> top

States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String expand

Parameter that allows reading a resource with subordinate objects. When specifying &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<AccountingRecordRead>>

ApiResponse of List<AccountingRecordRead>
Remarks

Retrieve a list of accounting records of a specific accounting sequence (prima nota). For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting records will be sorted by accounting record ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting records that should be skipped. Example: skip=40 | | top | Number of accounting records that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting records:<br> .../accounting-records?top=10 Retrieving of the next 10 accounting records:<br> .../accounting-records?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGet(String, String, String, String, String, String)

Retrieve a specific accounting record

Declaration
AccountingRecordRead ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGet(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string recordId, 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 accountingSequenceProcessedId

ID of an accounting sequence
System.String recordId

ID of an accounting record
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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)
Returns
Type Description
AccountingRecordRead

AccountingRecordRead
Remarks

Retrieve a specific accounting record from an accounting sequence.<br><br> For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGetAsync(String, String, String, String, String, String)

Retrieve a specific accounting record

Declaration
Task<AccountingRecordRead> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGetAsync(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string recordId, 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 accountingSequenceProcessedId

ID of an accounting sequence
System.String recordId

ID of an accounting record
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 &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<AccountingRecordRead>

Task of AccountingRecordRead
Remarks

Retrieve a specific accounting record from an accounting sequence.<br><br> For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGetAsyncWithHttpInfo(String, String, String, String, String, String)

Retrieve a specific accounting record

Declaration
Task<ApiResponse<AccountingRecordRead>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string recordId, 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 accountingSequenceProcessedId

ID of an accounting sequence
System.String recordId

ID of an accounting record
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 &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<AccountingRecordRead>>

Task of ApiResponse (AccountingRecordRead)
Remarks

Retrieve a specific accounting record from an accounting sequence.<br><br> For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGetWithHttpInfo(String, String, String, String, String, String)

Retrieve a specific accounting record

Declaration
ApiResponse<AccountingRecordRead> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdAccountingRecordsRecordIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountingSequenceProcessedId, string recordId, 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 accountingSequenceProcessedId

ID of an accounting sequence
System.String recordId

ID of an accounting record
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 &quot;all&quot;, all subordinate objects are loaded (no indication corresponds to &quot;none&quot;). Example: expand=all (optional)
Returns
Type Description
ApiResponse<AccountingRecordRead>

ApiResponse of AccountingRecordRead
Remarks

Retrieve a specific accounting record from an accounting sequence.<br><br> For more information, please refer to the Info Database, document 1004939.<br><br> Retrieving accounting records with subordinate objects By including the parameter expand=all in the URI, the full scope of a accounting records object will be requested. In the standard case, without the expand parameter, the accounting records object will be requested without subordinate objects (additional information, advance payment).<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGet(String, String, String, String)

Retrieve a specific accounting sequence

Declaration
AccountingSequenceRead ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGet(string clientId, string fiscalYearId, string accountingSequenceProcessedId, 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 accountingSequenceProcessedId

ID of an accounting sequence
System.String select

Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
Returns
Type Description
AccountingSequenceRead

AccountingSequenceRead
Remarks

Retrieve a specific accounting sequence (without accounting records).<br><br> For more information, please refer to the Info Database, document 1004939.<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGetAsync(String, String, String, String)

Retrieve a specific accounting sequence

Declaration
Task<AccountingSequenceRead> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGetAsync(string clientId, string fiscalYearId, string accountingSequenceProcessedId, 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 accountingSequenceProcessedId

ID of an accounting sequence
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<AccountingSequenceRead>

Task of AccountingSequenceRead
Remarks

Retrieve a specific accounting sequence (without accounting records).<br><br> For more information, please refer to the Info Database, document 1004939.<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGetAsyncWithHttpInfo(String, String, String, String)

Retrieve a specific accounting sequence

Declaration
Task<ApiResponse<AccountingSequenceRead>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountingSequenceProcessedId, 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 accountingSequenceProcessedId

ID of an accounting sequence
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<AccountingSequenceRead>>

Task of ApiResponse (AccountingSequenceRead)
Remarks

Retrieve a specific accounting sequence (without accounting records).<br><br> For more information, please refer to the Info Database, document 1004939.<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
| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGetWithHttpInfo(String, String, String, String)

Retrieve a specific accounting sequence

Declaration
ApiResponse<AccountingSequenceRead> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedAccountingSequenceProcessedIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountingSequenceProcessedId, 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 accountingSequenceProcessedId

ID of an accounting sequence
System.String select

Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
Returns
Type Description
ApiResponse<AccountingSequenceRead>

ApiResponse of AccountingSequenceRead
Remarks

Retrieve a specific accounting sequence (without accounting records).<br><br> For more information, please refer to the Info Database, document 1004939.<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
| Improve this Doc View Source

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

Retrieve a list of accounting sequences

Declaration
List<AccountingSequenceRead> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedGet(string clientId, string fiscalYearId, string select = 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 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<AccountingSequenceRead>

List<AccountingSequenceRead>
Remarks

Retrieve a list of accounting sequences in the fiscal year. For more information, please refer to the Info Database, document 1004939.<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting sequences will be sorted by accounting sequence ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting sequences that should be skipped. Example: skip=40 | | top | Number of accounting sequences that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting sequences:<br> .../accounting-sequences?top=10 Retrieving of the next 10 accounting sequences:<br> .../accounting-sequences?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting sequences

Declaration
Task<List<AccountingSequenceRead>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedGetAsync(string clientId, string fiscalYearId, string select = 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 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<AccountingSequenceRead>>

Task of List<AccountingSequenceRead>
Remarks

Retrieve a list of accounting sequences in the fiscal year. For more information, please refer to the Info Database, document 1004939.<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting sequences will be sorted by accounting sequence ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting sequences that should be skipped. Example: skip=40 | | top | Number of accounting sequences that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting sequences:<br> .../accounting-sequences?top=10 Retrieving of the next 10 accounting sequences:<br> .../accounting-sequences?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting sequences

Declaration
Task<ApiResponse<List<AccountingSequenceRead>>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = 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 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<AccountingSequenceRead>>>

Task of ApiResponse (List<AccountingSequenceRead>)
Remarks

Retrieve a list of accounting sequences in the fiscal year. For more information, please refer to the Info Database, document 1004939.<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting sequences will be sorted by accounting sequence ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting sequences that should be skipped. Example: skip=40 | | top | Number of accounting sequences that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting sequences:<br> .../accounting-sequences?top=10 Retrieving of the next 10 accounting sequences:<br> .../accounting-sequences?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

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

Retrieve a list of accounting sequences

Declaration
ApiResponse<List<AccountingSequenceRead>> ClientsClientIdFiscalYearsFiscalYearIdAccountingSequencesProcessedGetWithHttpInfo(string clientId, string fiscalYearId, string select = 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 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<AccountingSequenceRead>>

ApiResponse of List<AccountingSequenceRead>
Remarks

Retrieve a list of accounting sequences in the fiscal year. For more information, please refer to the Info Database, document 1004939.<br><br> Filter Filters to condense the scope of the results are not available.<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 accounting sequences will be sorted by accounting sequence ID. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of accounting sequences that should be skipped. Example: skip=40 | | top | Number of accounting sequences that should be read as a result of the request.Example: top=20 | Use multiple data paths It is necessary to know the correct data path to address the correct data stock. If the correct data path cannot be determined in DATEVconnect, the desired data path can be defined by a configuration file to resolve this data path collision. Further information is provided in Info Database, document 1071637. URI examples Retrieving of the first 10 accounting sequences:<br> .../accounting-sequences?top=10 Retrieving of the next 10 accounting sequences:<br> .../accounting-sequences?top=10&skip=10

Exceptions
Type Condition
ApiException

Thrown when fails to make API call