Interface IOpenItemsApi

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

Methods

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGet(String, String, String, String, String)

Retrieve a specific account payable (uncondensed)

Declaration

AccountsPayable ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGet(string clientId, string fiscalYearId, string accountsPayableId, 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	accountsPayableId	ID of the account payable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

Type	Description
AccountsPayable	AccountsPayable

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGetAsync(String, String, String, String, String)

Retrieve a specific account payable (uncondensed)

Declaration

Task<AccountsPayable> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGetAsync(string clientId, string fiscalYearId, string accountsPayableId, 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	accountsPayableId	ID of the account payable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGetAsyncWithHttpInfo(String, String, String, String, String)

Retrieve a specific account payable (uncondensed)

Declaration

Task<ApiResponse<AccountsPayable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountsPayableId, 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	accountsPayableId	ID of the account payable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGetWithHttpInfo(String, String, String, String, String)

Retrieve a specific account payable (uncondensed)

Declaration

ApiResponse<AccountsPayable> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableAccountsPayableIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountsPayableId, 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	accountsPayableId	ID of the account payable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

Type	Description
ApiResponse<AccountsPayable>	ApiResponse of AccountsPayable

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGet(String, String, String, String, String)

Retrieve an accounts payable list (condensed)

Declaration

List<AccountsPayable> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGet(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared payables. Payables comprise all open items entered in accounts payable. Payables that can be condensed will be shown in condensed form. Therefore, the results list may contain both condensed and uncondensed payables. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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 a condensed list of all outstanding accounts payable: .../accounts-payable/condense?filter=is_cleared eq false Retrieving a condensed list of all accounts payable for the creditor with the account number (account_number) 80000: .../accounts-payable/condense?filter=account_number eq 800000000 Retrieving a condensed list of all accounts payable for creditors with account numbers ranging from 80000 to 89999: .../accounts-payable/condense?filter=account_number ge 800000000 and account_number le 899999999

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGetAsync(String, String, String, String, String)

Retrieve an accounts payable list (condensed)

Declaration

Task<List<AccountsPayable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGetAsync(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGetAsyncWithHttpInfo(String, String, String, String, String)

Retrieve an accounts payable list (condensed)

Declaration

Task<ApiResponse<List<AccountsPayable>>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGetWithHttpInfo(String, String, String, String, String)

Retrieve an accounts payable list (condensed)

Declaration

ApiResponse<List<AccountsPayable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableCondenseGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts payable list (uncondensed)

Declaration

List<AccountsPayable> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableGet(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed payables. Payables comprise all open items entered in accounts payable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. Paging enables combinations with the filters "account_number" and "is_cleared". |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items 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 an uncondensed list of all outstanding accounts payable: .../accounts-payable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts payable for the creditor with the account number (account_number) 80000: .../accounts-payable?filter=account_number eq 800000000 Retrieving an uncondensed list of all accounts payable for creditors with account numbers ranging from 80000 to 89999: .../accounts-payable?filter=account_number ge 800000000 and account_number le 899999999 Retrieving an uncondensed list of all cleared accounts payable: .../accounts-payable?filter=is_cleared eq true Retrieving of the first 10 open items: .../accounts-payable?top=10 Retrieving of the next 10 open items: .../accounts-payable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts payable list (uncondensed)

Declaration

Task<List<AccountsPayable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableGetAsync(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed payables. Payables comprise all open items entered in accounts payable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. Paging enables combinations with the filters "account_number" and "is_cleared". |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items 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 an uncondensed list of all outstanding accounts payable: .../accounts-payable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts payable for the creditor with the account number (account_number) 80000: .../accounts-payable?filter=account_number eq 800000000 Retrieving an uncondensed list of all accounts payable for creditors with account numbers ranging from 80000 to 89999: .../accounts-payable?filter=account_number ge 800000000 and account_number le 899999999 Retrieving an uncondensed list of all cleared accounts payable: .../accounts-payable?filter=is_cleared eq true Retrieving of the first 10 open items: .../accounts-payable?top=10 Retrieving of the next 10 open items: .../accounts-payable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts payable list (uncondensed)

Declaration

Task<ApiResponse<List<AccountsPayable>>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed payables. Payables comprise all open items entered in accounts payable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. Paging enables combinations with the filters "account_number" and "is_cleared". |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items 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 an uncondensed list of all outstanding accounts payable: .../accounts-payable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts payable for the creditor with the account number (account_number) 80000: .../accounts-payable?filter=account_number eq 800000000 Retrieving an uncondensed list of all accounts payable for creditors with account numbers ranging from 80000 to 89999: .../accounts-payable?filter=account_number ge 800000000 and account_number le 899999999 Retrieving an uncondensed list of all cleared accounts payable: .../accounts-payable?filter=is_cleared eq true Retrieving of the first 10 open items: .../accounts-payable?top=10 Retrieving of the next 10 open items: .../accounts-payable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts payable list (uncondensed)

Declaration

ApiResponse<List<AccountsPayable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsPayableGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed payables. Payables comprise all open items entered in accounts payable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. Paging enables combinations with the filters "account_number" and "is_cleared". |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items 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 an uncondensed list of all outstanding accounts payable: .../accounts-payable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts payable for the creditor with the account number (account_number) 80000: .../accounts-payable?filter=account_number eq 800000000 Retrieving an uncondensed list of all accounts payable for creditors with account numbers ranging from 80000 to 89999: .../accounts-payable?filter=account_number ge 800000000 and account_number le 899999999 Retrieving an uncondensed list of all cleared accounts payable: .../accounts-payable?filter=is_cleared eq true Retrieving of the first 10 open items: .../accounts-payable?top=10 Retrieving of the next 10 open items: .../accounts-payable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGet(String, String, String, String, String)

Retrieve a specific account receivable (uncondensed)

Declaration

AccountsReceivable ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGet(string clientId, string fiscalYearId, string accountsReceivableId, 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	accountsReceivableId	ID of the account receivable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

Type	Description
AccountsReceivable	AccountsReceivable

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGetAsync(String, String, String, String, String)

Retrieve a specific account receivable (uncondensed)

Declaration

Task<AccountsReceivable> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGetAsync(string clientId, string fiscalYearId, string accountsReceivableId, 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	accountsReceivableId	ID of the account receivable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGetAsyncWithHttpInfo(String, String, String, String, String)

Retrieve a specific account receivable (uncondensed)

Declaration

Task<ApiResponse<AccountsReceivable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountsReceivableId, 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	accountsReceivableId	ID of the account receivable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGetWithHttpInfo(String, String, String, String, String)

Retrieve a specific account receivable (uncondensed)

Declaration

ApiResponse<AccountsReceivable> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableAccountsReceivableIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountsReceivableId, 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	accountsReceivableId	ID of the account receivable
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

Type	Description
ApiResponse<AccountsReceivable>	ApiResponse of AccountsReceivable

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGet(String, String, String, String, String)

Retrieve an accounts receivable list (condensed)

Declaration

List<AccountsReceivable> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGet(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all outstanding and cleared receivables. Receivables comprise all Open Items entered in accounts receivable. Receivables that can be condensed will be shown in condensed form. Therefore, the results list may contain both condensed and uncondensed receivables. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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 a condensed list of all outstanding accounts receivable: .../accounts-receivable/condense?filter=is_cleared eq false Retrieving a condensed list of all accounts receivable for the debitor with the account number (account_number) 20000: .../accounts-receivable/condense?filter=account_number eq 200000000 Retrieving a condensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable/condense?filter=account_number ge 200000000 and account_number le 299999999

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGetAsync(String, String, String, String, String)

Retrieve an accounts receivable list (condensed)

Declaration

Task<List<AccountsReceivable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGetAsync(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all outstanding and cleared receivables. Receivables comprise all Open Items entered in accounts receivable. Receivables that can be condensed will be shown in condensed form. Therefore, the results list may contain both condensed and uncondensed receivables. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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 a condensed list of all outstanding accounts receivable: .../accounts-receivable/condense?filter=is_cleared eq false Retrieving a condensed list of all accounts receivable for the debitor with the account number (account_number) 20000: .../accounts-receivable/condense?filter=account_number eq 200000000 Retrieving a condensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable/condense?filter=account_number ge 200000000 and account_number le 299999999

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGetAsyncWithHttpInfo(String, String, String, String, String)

Retrieve an accounts receivable list (condensed)

Declaration

Task<ApiResponse<List<AccountsReceivable>>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all outstanding and cleared receivables. Receivables comprise all Open Items entered in accounts receivable. Receivables that can be condensed will be shown in condensed form. Therefore, the results list may contain both condensed and uncondensed receivables. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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 a condensed list of all outstanding accounts receivable: .../accounts-receivable/condense?filter=is_cleared eq false Retrieving a condensed list of all accounts receivable for the debitor with the account number (account_number) 20000: .../accounts-receivable/condense?filter=account_number eq 200000000 Retrieving a condensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable/condense?filter=account_number ge 200000000 and account_number le 299999999

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGetWithHttpInfo(String, String, String, String, String)

Retrieve an accounts receivable list (condensed)

Declaration

ApiResponse<List<AccountsReceivable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableCondenseGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all outstanding and cleared receivables. Receivables comprise all Open Items entered in accounts receivable. Receivables that can be condensed will be shown in condensed form. Therefore, the results list may contain both condensed and uncondensed receivables. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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 a condensed list of all outstanding accounts receivable: .../accounts-receivable/condense?filter=is_cleared eq false Retrieving a condensed list of all accounts receivable for the debitor with the account number (account_number) 20000: .../accounts-receivable/condense?filter=account_number eq 200000000 Retrieving a condensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable/condense?filter=account_number ge 200000000 and account_number le 299999999

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts receivable list (uncondensed)

Declaration

List<AccountsReceivable> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableGet(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed items. Receivables comprise all Open Items entered in accounts receivable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items that should be read as a result of the request. Example: top=20 | Please note that the functional connection of the Open Items remains intact. In some cases, more items may be returned than were filtered by top & skip, since these items belong together. Paging enables combinations with the filters "account_number" and "is_cleared". 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 an uncondensed list of all outstanding accounts receivable: .../accounts-receivable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts receivable for the debitor with the account number 20000: .../accounts-receivable?filter=account_number eq 200000000 Retrieving an uncondensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable?filter=account_number ge 200000000 and account_number le 299999999 Retrieving an uncondensed list of all accounts receivable cleared: .../accounts-receivable?filter=is_cleared eq true Retrieving of the first 10 accounts receivable: .../accounts-receivable?top=10 Retrieving of the next 10 accounts receivable: .../accounts-receivable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts receivable list (uncondensed)

Declaration

Task<List<AccountsReceivable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableGetAsync(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed items. Receivables comprise all Open Items entered in accounts receivable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items that should be read as a result of the request. Example: top=20 | Please note that the functional connection of the Open Items remains intact. In some cases, more items may be returned than were filtered by top & skip, since these items belong together. Paging enables combinations with the filters "account_number" and "is_cleared". 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 an uncondensed list of all outstanding accounts receivable: .../accounts-receivable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts receivable for the debitor with the account number 20000: .../accounts-receivable?filter=account_number eq 200000000 Retrieving an uncondensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable?filter=account_number ge 200000000 and account_number le 299999999 Retrieving an uncondensed list of all accounts receivable cleared: .../accounts-receivable?filter=is_cleared eq true Retrieving of the first 10 accounts receivable: .../accounts-receivable?top=10 Retrieving of the next 10 accounts receivable: .../accounts-receivable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts receivable list (uncondensed)

Declaration

Task<ApiResponse<List<AccountsReceivable>>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed items. Receivables comprise all Open Items entered in accounts receivable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items that should be read as a result of the request. Example: top=20 | Please note that the functional connection of the Open Items remains intact. In some cases, more items may be returned than were filtered by top & skip, since these items belong together. Paging enables combinations with the filters "account_number" and "is_cleared". 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 an uncondensed list of all outstanding accounts receivable: .../accounts-receivable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts receivable for the debitor with the account number 20000: .../accounts-receivable?filter=account_number eq 200000000 Retrieving an uncondensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable?filter=account_number ge 200000000 and account_number le 299999999 Retrieving an uncondensed list of all accounts receivable cleared: .../accounts-receivable?filter=is_cleared eq true Retrieving of the first 10 accounts receivable: .../accounts-receivable?top=10 Retrieving of the next 10 accounts receivable: .../accounts-receivable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

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

Retrieve an accounts receivable list (uncondensed)

Declaration

ApiResponse<List<AccountsReceivable>> ClientsClientIdFiscalYearsFiscalYearIdAccountsReceivableGetWithHttpInfo(string clientId, string fiscalYearId, string select = null, string filter = null, string skip = null, int? top = null, string expand = null)

Parameters

Type	Name	Description
System.String	clientId	ID of central client/company
System.String	fiscalYearId	ID of the fiscal year
System.String	select	Comma separated list of properties to which the results will then be limited. Example: select=id (optional)
System.String	filter	Entering a filter expression influences the number of results. Example: filter=is_abc eq true and xy_number eq 10000 (optional)
System.String	skip	States how many elements in the total number of items should be skipped. Example: skip=10 (optional)
System.Nullable<System.Int32>	top	States the maximum number of elements that should be contained within the total. Example: top=10 (optional)
System.String	expand	Parameter that allows reading a resource with subordinate objects. When specifying "all", all subordinate objects are loaded (no indication corresponds to "none"). Example: expand=all (optional)

Returns

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

Remarks

Below, the term "Open Items" in upper case will be used as the umbrella term for all entries in accounts payable and receivable. When referring to the concrete status of "Open Items", the term will appear in lower case (e.g. "open items" or "cleared items"). Retrieve all open and cleared uncondensed items. Receivables comprise all Open Items entered in accounts receivable. Streaming This resource supports streaming. The number of items may differ from the unstreamed request, as the functional context is missing here. Limitations to normal requests: <ul> <li>Properties "open_balance_of_item" and "debit_credit_identifier" are not available</li> <li>Filter on "open_balance_of_item" cannot be applied</li> <li>Use of paging is not supported</li> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving Open Items with subordinate objects By including the parameter expand=all in the URI, the full scope of an Open Item object will be requested. In the standard case, without the expand parameter, the Open Item object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains both open and cleared items. Filter options The number of results can be limited by using the following filters: - account_number - document_field1 - date - due_date - open_balance_of_item - is_cleared Operators Filter option: account_number, date, due_date, open_balance_of_item | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: document_field1, is_cleared | Operator | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | Filter combinations Filters can be combined using the operator "and". 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. |Parameter|Description | |:- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | skip | Number of Open Items that should be skipped. Example: skip=40 | | top | Number of Open Items that should be read as a result of the request. Example: top=20 | Please note that the functional connection of the Open Items remains intact. In some cases, more items may be returned than were filtered by top & skip, since these items belong together. Paging enables combinations with the filters "account_number" and "is_cleared". 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 an uncondensed list of all outstanding accounts receivable: .../accounts-receivable?filter=is_cleared eq false Retrieving an uncondensed list of all accounts receivable for the debitor with the account number 20000: .../accounts-receivable?filter=account_number eq 200000000 Retrieving an uncondensed list of all accounts receivable for debitors with account numbers ranging from 20000 to 29999: .../accounts-receivable?filter=account_number ge 200000000 and account_number le 299999999 Retrieving an uncondensed list of all accounts receivable cleared: .../accounts-receivable?filter=is_cleared eq true Retrieving of the first 10 accounts receivable: .../accounts-receivable?top=10 Retrieving of the next 10 accounts receivable: .../accounts-receivable?top=10&skip=10

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call