Class AccountPostingsApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

AccountPostingsApi

Implements

IAccountPostingsApi

IApiAccessor

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Simplic.Datev.Swagger.Api

Assembly: Simplic.Datev.IO.Swagger.dll

Syntax

public class AccountPostingsApi : IAccountPostingsApi, IApiAccessor

Constructors

| Improve this Doc View Source

AccountPostingsApi(Configuration)

Initializes a new instance of the AccountPostingsApi class using Configuration object

Declaration

public AccountPostingsApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

AccountPostingsApi(String)

Initializes a new instance of the AccountPostingsApi class.

Declaration

public AccountPostingsApi(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration	An instance of the Configuration

| Improve this Doc View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

| Improve this Doc View Source

AddDefaultHeader(String, String)

Add default header.

Declaration

[Obsolete("AddDefaultHeader is deprecated, please use Configuration.AddDefaultHeader instead.")]
public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGet(String, String, String, String, String)

Retrieve a specific account posting Retrieve a specific account posting for general ledger/subledger accounts for a fiscal year. Postings with error flags or postings that are flagged as posting proposals are not transferred. Note: Fee required feature. The reauired license can be ordered in the DATEV shop. Retrieving account postings with subordinate objects By including the parameter expand=all in the URI, the full scope of account postings with any existing additional information, advance payment and open item information will be requested. In the standard case, without the expand parameter, the account postings object will be requested without subordinate objects. 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 specific account posting: .../account-postings/509_59_1_2_2

Declaration

public AccountPostings ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGet(string clientId, string fiscalYearId, string accountPostingsId, 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	accountPostingsId	ID of an account posting
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
AccountPostings	AccountPostings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGetAsync(String, String, String, String, String)

Declaration

public async Task<AccountPostings> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGetAsync(string clientId, string fiscalYearId, string accountPostingsId, 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	accountPostingsId	ID of an account posting
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<AccountPostings>	Task of AccountPostings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGetAsyncWithHttpInfo(String, String, String, String, String)

Declaration

public async Task<ApiResponse<AccountPostings>> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGetAsyncWithHttpInfo(string clientId, string fiscalYearId, string accountPostingsId, 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	accountPostingsId	ID of an account posting
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<AccountPostings>>	Task of ApiResponse (AccountPostings)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGetWithHttpInfo(String, String, String, String, String)

Declaration

public ApiResponse<AccountPostings> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsAccountPostingsIdGetWithHttpInfo(string clientId, string fiscalYearId, string accountPostingsId, 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	accountPostingsId	ID of an account posting
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<AccountPostings>	ApiResponse of AccountPostings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGet(String, String, String, String, String)

Retrieve an account postings list Retrieve an account postings list for general ledger/subledger accounts for a fiscal year. Postings with error flags or postings that are flagged as posting proposals are not transferred. Note: Fee required feature. The reauired license can be ordered in the DATEV shop. Streaming This resource supports streaming. The use of streaming is recommended as there can be large amounts of data. Limitations to normal requests: <ul> <li>Error messages will not be displayed for the time being</li> </ul> Retrieving account postings with subordinate objects By including the parameter expand=all in the URI, the full scope of account postings with any existing additional information, advance payment and open item information will be requested. In the standard case, without the expand parameter, the account postings object will be requested without subordinate objects. Filter If no further parameters are entered, the list contains its full scope. Filter options The number of results can be limited by using the following filters: - account_number - date - accounting_reason Operators Filter option: account_number, date | Operators | Description | |:- -- -- -- -- -:|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | eq | Equal | | ge | Greater than or equal | | le | Less than or equal | Filter option: accounting_reason | Operators | 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 all account postings: .../account-postings Retrieving all account postings with the account number 20000: .../account-postings?filter=account_number eq 200000000 Retrieving all account postings with account numbers ranging from 20000 to 29999: .../account-postings?filter=account_number ge 200000000 and account_number le 299999999

Declaration

public List<AccountPostings> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGet(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<AccountPostings>	List<AccountPostings>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGetAsync(String, String, String, String, String)

Declaration

public async Task<List<AccountPostings>> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGetAsync(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<AccountPostings>>	Task of List<AccountPostings>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGetAsyncWithHttpInfo(String, String, String, String, String)

Declaration

public async Task<ApiResponse<List<AccountPostings>>> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGetAsyncWithHttpInfo(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<AccountPostings>>>	Task of ApiResponse (List<AccountPostings>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGetWithHttpInfo(String, String, String, String, String)

Declaration

public ApiResponse<List<AccountPostings>> ClientsClientIdFiscalYearsFiscalYearIdAccountPostingsGetWithHttpInfo(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<AccountPostings>>	ApiResponse of List<AccountPostings>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

DefaultHeader()

Gets the default header.

Declaration

[Obsolete("DefaultHeader is deprecated, please use Configuration.DefaultHeader instead.")]
public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	Dictionary of HTTP header

| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

| Improve this Doc View Source

SetBasePath(String)

Sets the base path of the API client.

Declaration

[Obsolete("SetBasePath is deprecated, please do 'Configuration.ApiClient = new ApiClient(\"http://new-path\")' instead.")]
public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IAccountPostingsApi

IApiAccessor