@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
798 lines • 75.6 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { Account } from '../model/account';
import { AccountProperties } from '../model/accountProperties';
import { AccountsUpsertResponse } from '../model/accountsUpsertResponse';
import { ChartOfAccounts } from '../model/chartOfAccounts';
import { ChartOfAccountsProperties } from '../model/chartOfAccountsProperties';
import { ChartOfAccountsRequest } from '../model/chartOfAccountsRequest';
import { CleardownModuleDetails } from '../model/cleardownModuleDetails';
import { CleardownModuleRequest } from '../model/cleardownModuleRequest';
import { CleardownModuleResponse } from '../model/cleardownModuleResponse';
import { CleardownModuleRule } from '../model/cleardownModuleRule';
import { CleardownModuleRulesUpdatedResponse } from '../model/cleardownModuleRulesUpdatedResponse';
import { DeleteAccountsResponse } from '../model/deleteAccountsResponse';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { GeneralLedgerProfileMapping } from '../model/generalLedgerProfileMapping';
import { GeneralLedgerProfileRequest } from '../model/generalLedgerProfileRequest';
import { GeneralLedgerProfileResponse } from '../model/generalLedgerProfileResponse';
import { Operation } from '../model/operation';
import { PagedResourceListOfAccount } from '../model/pagedResourceListOfAccount';
import { PagedResourceListOfChartOfAccounts } from '../model/pagedResourceListOfChartOfAccounts';
import { PagedResourceListOfCleardownModuleResponse } from '../model/pagedResourceListOfCleardownModuleResponse';
import { PagedResourceListOfCleardownModuleRule } from '../model/pagedResourceListOfCleardownModuleRule';
import { PagedResourceListOfGeneralLedgerProfileResponse } from '../model/pagedResourceListOfGeneralLedgerProfileResponse';
import { PagedResourceListOfPostingModuleResponse } from '../model/pagedResourceListOfPostingModuleResponse';
import { PagedResourceListOfPostingModuleRule } from '../model/pagedResourceListOfPostingModuleRule';
import { PostingModuleDetails } from '../model/postingModuleDetails';
import { PostingModuleRequest } from '../model/postingModuleRequest';
import { PostingModuleResponse } from '../model/postingModuleResponse';
import { PostingModuleRule } from '../model/postingModuleRule';
import { PostingModuleRulesUpdatedResponse } from '../model/postingModuleRulesUpdatedResponse';
import { Property } from '../model/property';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateChartOfAccountsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The definition of the Chart of Accounts. */
chartOfAccountsRequest: ChartOfAccountsRequest;
}
export interface CreateCleardownModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The definition of the Cleardown Module. */
cleardownModuleRequest: CleardownModuleRequest;
}
export interface CreateGeneralLedgerProfileRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. */
code: string;
/** The definition of the General Ledger Profile. */
generalLedgerProfileRequest: GeneralLedgerProfileRequest;
}
export interface CreatePostingModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The definition of the Posting Module. */
postingModuleRequest: PostingModuleRequest;
}
export interface DeleteAccountsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The codes of the accounts to delete. */
requestBody: Array<string>;
/** The delete mode to use. Default value: Soft. Available values: Soft, Hard. */
deleteMode?: 'Soft' | 'Hard';
}
export interface DeleteChartOfAccountsRequestParams {
/** The scope of the Chart of Accounts to be deleted. */
scope: string;
/** The code of the Chart of Accounts to be deleted. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
}
export interface DeleteCleardownModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Cleardown Module to be deleted. */
cleardownModuleCode: string;
}
export interface DeleteGeneralLedgerProfileRequestParams {
/** The scope of the Chart of Accounts for the General Ledger Profile. */
scope: string;
/** The code of the Chart of Accounts for the General Ledger Profile. */
code: string;
/** The Code of the General Ledger Profile. */
generalLedgerProfileCode: string;
}
export interface DeletePostingModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Posting Module to be deleted. */
postingModuleCode: string;
}
export interface GetAccountRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Account. */
accountCode: string;
/** The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified. */
asAt?: string;
/** A list of property keys from the \'Account\' domain to decorate onto the Account. These must take the format {domain}/{scope}/{code}, for example \'Account/Manager/Id\'. If no properties are specified, then no properties will be returned. */
propertyKeys?: Array<string>;
}
export interface GetAccountPropertiesRequestParams {
/** The scope of the Chart of Accounts to update or insert the properties onto. */
scope: string;
/** The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The unique ID of the account to get properties for. */
accountCode: string;
/** The effective datetime or cut label at which to list the Account\'s properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Account\'s properties. Defaults to return the latest version of each property if not specified. */
asAt?: string;
}
export interface GetChartOfAccountsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The effective datetime or cut label at which to retrieve the Chart of Accounts properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the Chart of Accounts definition. Defaults to returning the latest version of the Chart of Accounts definition if not specified. */
asAt?: string;
/** A list of property keys from the \'ChartOfAccounts\' domain to decorate onto the Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example \'ChartOfAccounts/Manager/Id\'. If no properties are specified, then no properties will be returned. */
propertyKeys?: Array<string>;
}
export interface GetChartOfAccountsPropertiesRequestParams {
/** The scope of the chart of accounts to list the properties for. */
scope: string;
/** The code of the chart of accounts to list the properties for. Together with the scope this uniquely identifies the chart of accounts. */
code: string;
/** The effective datetime or cut label at which to list the chart of accounts\' properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the chart of accounts\' properties. Defaults to return the latest version of each property if not specified. */
asAt?: string;
}
export interface GetCleardownModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Cleardown Module. */
cleardownModuleCode: string;
/** The asAt datetime at which to retrieve the Cleardown Module. Defaults to return the latest version of the Cleardown Module if not specified. */
asAt?: string;
}
export interface GetGeneralLedgerProfileRequestParams {
/** The scope of the Chart of Accounts for the General Ledger Profile. */
scope: string;
/** The code of the Chart of Accounts for the General Ledger Profile. */
code: string;
/** The General Ledger Profile Code of the General Ledger Profile. */
generalLedgerProfileCode: string;
/** The asAt datetime at which to retrieve the General Ledger Profile. Defaults to return the latest version of the General Ledger Profile if not specified. */
asAt?: string;
}
export interface GetPostingModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Posting Module. */
postingModuleCode: string;
/** The asAt datetime at which to retrieve the Posting Module. Defaults to return the latest version of the Posting Module if not specified. */
asAt?: string;
}
export interface ListAccountsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The effective datetime or cut label at which to list the TimeVariant properties decorated on Accounts. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified. */
asAt?: string;
/** The pagination token to use to continue listing charts of accounts; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the Account type, specify \"code eq \'001\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of property keys from the \'Account\' domain to decorate onto the Account. These must have the format {domain}/{scope}/{code}, for example \'Account/system/Name\'. */
propertyKeys?: Array<string>;
}
export interface ListChartsOfAccountsRequestParams {
/** The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the charts of accounts. Defaults to returning the latest version of each Chart of Accounts if not specified. */
asAt?: string;
/** The pagination token to use to continue listing charts of accounts; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the Chart of Accounts type, specify \"id.Code eq \'001\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
/** A list of property keys from the \'ChartOfAccounts\' domain to decorate onto each Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example \'ChartOfAccounts/Manager/Id\'. */
propertyKeys?: Array<string>;
}
export interface ListCleardownModuleRulesRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the cleardown module. */
cleardownModuleCode: string;
/** The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. */
asAt?: string;
/** The pagination token to use to continue listing cleardown module rules; this value is returned from the previous call. If a pagination token is provided, the filter and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the rule id, specify \"ruleId eq \'rule 1\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
}
export interface ListCleardownModulesRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Cleardown Modules; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the Cleardown Module status, specify \"status eq \'Active\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
}
export interface ListGeneralLedgerProfilesRequestParams {
/** The scope of the Chart of Accounts */
scope: string;
/** The code of the Chart of Accounts */
code: string;
/** The asAt datetime at which to list the General Ledger Profiles. Defaults to returning the latest version of each General Ledger Profile if not specified. */
asAt?: string;
/** The pagination token to use to continue listing General Ledger Profiles; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the General Ledger profiles type, specify \"type eq \'PeriodBoundary\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
}
export interface ListPostingModuleRulesRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the posting module. */
postingModuleCode: string;
/** The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. */
asAt?: string;
/** The pagination token to use to continue listing posting module rules; this value is returned from the previous call. If a pagination token is provided, the filter and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the rule id, specify \"ruleId eq \'rule 1\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
}
export interface ListPostingModulesRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Posting Modules; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the Posting Module status, specify \"status eq \'Active\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
}
export interface PatchChartOfAccountsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */
operation: Array<Operation>;
}
export interface PatchCleardownModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Cleardown Module to be updated. */
cleardownModuleCode: string;
/** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */
operation: Array<Operation>;
}
export interface PatchPostingModuleRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Posting Module to be updated. */
postingModuleCode: string;
/** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */
operation: Array<Operation>;
}
export interface SetCleardownModuleDetailsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Cleardown Module to be updated. */
cleardownModuleCode: string;
/** The new details for the Cleardown Module. */
cleardownModuleDetails: CleardownModuleDetails;
}
export interface SetCleardownModuleRulesRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Cleardown Module to be updated. */
cleardownModuleCode: string;
/** The new rule set for the Cleardown Module. */
cleardownModuleRule: Array<CleardownModuleRule>;
}
export interface SetGeneralLedgerProfileMappingsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. */
code: string;
/** The code of the General Ledger Profile */
generalLedgerProfileCode: string;
/** The updated General Ledger Profile Mappings, the previous mappings will be wholly replaced with this data. Mappings will be evaluated in the order they are provided. */
generalLedgerProfileMapping: Array<GeneralLedgerProfileMapping>;
}
export interface SetPostingModuleDetailsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Posting Module to be updated. */
postingModuleCode: string;
/** The new details for the Posting Module. */
postingModuleDetails: PostingModuleDetails;
}
export interface SetPostingModuleRulesRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The code of the Posting Module to be updated. */
postingModuleCode: string;
/** The new rule set for the Posting Module. */
postingModuleRule: Array<PostingModuleRule>;
}
export interface UpsertAccountPropertiesRequestParams {
/** The scope of the Chart of Accounts to update or insert the properties onto. */
scope: string;
/** The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The unique ID of the account to create or update properties for. */
accountCode: string;
/** The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"Account/Manager/Id\". */
requestBody?: {
[key: string]: Property;
};
}
export interface UpsertAccountsRequestParams {
/** The scope of the Chart of Accounts. */
scope: string;
/** The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** A list of accounts to be created or updated. */
account: Array<Account>;
}
export interface UpsertChartOfAccountsPropertiesRequestParams {
/** The scope of the Chart of Accounts to update or insert the properties onto. */
scope: string;
/** The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. */
code: string;
/** The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"ChartOfAccounts/Manager/Id\". */
requestBody?: {
[key: string]: Property;
};
}
export declare class ChartOfAccountsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* [EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts
* Create the given Chart of Accounts.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
createChartOfAccounts(requestParameters?: CreateChartOfAccountsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ChartOfAccounts>;
createChartOfAccounts(requestParameters?: CreateChartOfAccountsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ChartOfAccounts>>;
createChartOfAccounts(requestParameters?: CreateChartOfAccountsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ChartOfAccounts>>;
/**
* [EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module
* Create the given Cleardown Module.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
createCleardownModule(requestParameters?: CreateCleardownModuleRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<CleardownModuleResponse>;
createCleardownModule(requestParameters?: CreateCleardownModuleRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<CleardownModuleResponse>>;
createCleardownModule(requestParameters?: CreateCleardownModuleRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<CleardownModuleResponse>>;
/**
* [EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile.
* Create the given General Ledger profile.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
createGeneralLedgerProfile(requestParameters?: CreateGeneralLedgerProfileRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<GeneralLedgerProfileResponse>;
createGeneralLedgerProfile(requestParameters?: CreateGeneralLedgerProfileRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<GeneralLedgerProfileResponse>>;
createGeneralLedgerProfile(requestParameters?: CreateGeneralLedgerProfileRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<GeneralLedgerProfileResponse>>;
/**
* [EXPERIMENTAL] CreatePostingModule: Create a Posting Module
* Create the given Posting Module.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
createPostingModule(requestParameters?: CreatePostingModuleRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PostingModuleResponse>;
createPostingModule(requestParameters?: CreatePostingModuleRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PostingModuleResponse>>;
createPostingModule(requestParameters?: CreatePostingModuleRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PostingModuleResponse>>;
/**
* [EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts
* Delete one or more account from the Chart of Accounts. Soft deletion marks the account as inactive While the Hard deletion is deleting the account. The maximum number of accounts that this method can delete per request is 2,000.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
deleteAccounts(requestParameters?: DeleteAccountsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeleteAccountsResponse>;
deleteAccounts(requestParameters?: DeleteAccountsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeleteAccountsResponse>>;
deleteAccounts(requestParameters?: DeleteAccountsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeleteAccountsResponse>>;
/**
* [EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts
* Delete the given Chart of Accounts.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
deleteChartOfAccounts(requestParameters?: DeleteChartOfAccountsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteChartOfAccounts(requestParameters?: DeleteChartOfAccountsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteChartOfAccounts(requestParameters?: DeleteChartOfAccountsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module.
* Delete the given Cleardown Module.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
deleteCleardownModule(requestParameters?: DeleteCleardownModuleRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteCleardownModule(requestParameters?: DeleteCleardownModuleRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteCleardownModule(requestParameters?: DeleteCleardownModuleRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile.
* Delete the given General Ledger Profile.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
deleteGeneralLedgerProfile(requestParameters?: DeleteGeneralLedgerProfileRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteGeneralLedgerProfile(requestParameters?: DeleteGeneralLedgerProfileRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteGeneralLedgerProfile(requestParameters?: DeleteGeneralLedgerProfileRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] DeletePostingModule: Delete a Posting Module.
* Delete the given Posting Module.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
deletePostingModule(requestParameters?: DeletePostingModuleRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deletePostingModule(requestParameters?: DeletePostingModuleRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deletePostingModule(requestParameters?: DeletePostingModuleRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetAccount: Get Account
* Retrieve the definition of a particular Account which is part of a Chart of Accounts.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getAccount(requestParameters?: GetAccountRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Account>;
getAccount(requestParameters?: GetAccountRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Account>>;
getAccount(requestParameters?: GetAccountRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Account>>;
/**
* [EXPERIMENTAL] GetAccountProperties: Get Account properties
* Get all the properties of a single account.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getAccountProperties(requestParameters?: GetAccountPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AccountProperties>;
getAccountProperties(requestParameters?: GetAccountPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AccountProperties>>;
getAccountProperties(requestParameters?: GetAccountPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AccountProperties>>;
/**
* [EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts
* Retrieve the definition of a particular Chart of Accounts.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getChartOfAccounts(requestParameters?: GetChartOfAccountsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ChartOfAccounts>;
getChartOfAccounts(requestParameters?: GetChartOfAccountsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ChartOfAccounts>>;
getChartOfAccounts(requestParameters?: GetChartOfAccountsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ChartOfAccounts>>;
/**
* [EXPERIMENTAL] GetChartOfAccountsProperties: Get chart of accounts properties
* Get all the properties of a single chart of accounts.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getChartOfAccountsProperties(requestParameters?: GetChartOfAccountsPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ChartOfAccountsProperties>;
getChartOfAccountsProperties(requestParameters?: GetChartOfAccountsPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ChartOfAccountsProperties>>;
getChartOfAccountsProperties(requestParameters?: GetChartOfAccountsPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ChartOfAccountsProperties>>;
/**
* [EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module
* Retrieve the definition of a Cleardown Module complete with its rules.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getCleardownModule(requestParameters?: GetCleardownModuleRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<CleardownModuleResponse>;
getCleardownModule(requestParameters?: GetCleardownModuleRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<CleardownModuleResponse>>;
getCleardownModule(requestParameters?: GetCleardownModuleRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<CleardownModuleResponse>>;
/**
* [EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile.
* Get the given General Ledger Profile.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getGeneralLedgerProfile(requestParameters?: GetGeneralLedgerProfileRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<GeneralLedgerProfileResponse>;
getGeneralLedgerProfile(requestParameters?: GetGeneralLedgerProfileRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<GeneralLedgerProfileResponse>>;
getGeneralLedgerProfile(requestParameters?: GetGeneralLedgerProfileRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<GeneralLedgerProfileResponse>>;
/**
* [EXPERIMENTAL] GetPostingModule: Get a Posting Module
* Retrieve the definition of a Posting Module complete with its rules.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getPostingModule(requestParameters?: GetPostingModuleRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PostingModuleResponse>;
getPostingModule(requestParameters?: GetPostingModuleRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PostingModuleResponse>>;
getPostingModule(requestParameters?: GetPostingModuleRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PostingModuleResponse>>;
/**
* [EXPERIMENTAL] ListAccounts: List Accounts
* List the accounts in a Chart of Accounts
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
listAccounts(requestParameters?: ListAccountsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfAccount>;
listAccounts(requestParameters?: ListAccountsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfAccount>>;
listAccounts(requestParameters?: ListAccountsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PagedResourceListOfAccount>>;
/**
* [EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts
* List all the Charts of Accounts matching particular criteria.
* @param requestParameters
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
listChartsOfAccounts(requestParameters?: ListChartsOfAccountsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transfer