accountsapi.md

fiken › AccountsApi

Class: AccountsApi

Hierarchy

• BaseAPI

  ↳ AccountsApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• getAccount
• getAccountBalance
• getAccountBalanceRaw
• getAccountBalances
• getAccountBalancesRaw
• getAccountRaw
• getAccounts
• getAccountsRaw
• request
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

+ new AccountsApi(configuration: Configuration‹›): AccountsApi

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: AccountsApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

getAccount

▸ getAccount(requestParameters: GetAccountRequest): Promise‹Account›

Retrieves the specified bookkeping account. An account is a string with either four digits, or four digits, a colon and five digits ("reskontro"). Examples: 3020 and 1500:10001

Parameters:

Name	Type
requestParameters	GetAccountRequest

Returns: Promise‹Account›

---

getAccountBalance

▸ getAccountBalance(requestParameters: GetAccountBalanceRequest): Promise‹AccountBalance›

Retrieves the specified bookkeping account and balance for a given date.

Parameters:

Name	Type
requestParameters	GetAccountBalanceRequest

Returns: Promise‹AccountBalance›

---

getAccountBalanceRaw

▸ getAccountBalanceRaw(requestParameters: GetAccountBalanceRequest): Promise‹ApiResponse‹AccountBalance››

Retrieves the specified bookkeping account and balance for a given date.

Parameters:

Name	Type
requestParameters	GetAccountBalanceRequest

Returns: Promise‹ApiResponse‹AccountBalance››

---

getAccountBalances

▸ getAccountBalances(requestParameters: GetAccountBalancesRequest): Promise‹Array‹AccountBalance››

Retrieves the bookkeeping accounts and balances for a given date. An account is a string with either four digits, or four digits, a colon and five digits ("reskontro"). Examples: 3020 and 1500:10001

Parameters:

Name	Type
requestParameters	GetAccountBalancesRequest

Returns: Promise‹Array‹AccountBalance››

---

getAccountBalancesRaw

▸ getAccountBalancesRaw(requestParameters: GetAccountBalancesRequest): Promise‹ApiResponse‹Array‹AccountBalance›››

Retrieves the bookkeeping accounts and balances for a given date. An account is a string with either four digits, or four digits, a colon and five digits ("reskontro"). Examples: 3020 and 1500:10001

Parameters:

Name	Type
requestParameters	GetAccountBalancesRequest

Returns: Promise‹ApiResponse‹Array‹AccountBalance›››

---

getAccountRaw

▸ getAccountRaw(requestParameters: GetAccountRequest): Promise‹ApiResponse‹Account››

Retrieves the specified bookkeping account. An account is a string with either four digits, or four digits, a colon and five digits ("reskontro"). Examples: 3020 and 1500:10001

Parameters:

Name	Type
requestParameters	GetAccountRequest

Returns: Promise‹ApiResponse‹Account››

---

getAccounts

▸ getAccounts(requestParameters: GetAccountsRequest): Promise‹Array‹Account››

Retrieves the bookkeeping accounts for the current year

Parameters:

Name	Type
requestParameters	GetAccountsRequest

Returns: Promise‹Array‹Account››

---

getAccountsRaw

▸ getAccountsRaw(requestParameters: GetAccountsRequest): Promise‹ApiResponse‹Array‹Account›››

Retrieves the bookkeeping accounts for the current year

Parameters:

Name	Type
requestParameters	GetAccountsRequest

Returns: Promise‹ApiResponse‹Array‹Account›››

---

Protected request

▸ request(context: RequestOpts): Promise‹Response›

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

withMiddleware

▸ withMiddleware‹T›(this: T, ...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...middlewares	Middleware[]

Returns: T

---

withPostMiddleware

▸ withPostMiddleware‹T›(this: T, ...postMiddlewares: Array‹Middleware["post"]›): T

Inherited from BaseAPI.withPostMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...postMiddlewares	Array‹Middleware["post"]›

Returns: T

---

withPreMiddleware

▸ withPreMiddleware‹T›(this: T, ...preMiddlewares: Array‹Middleware["pre"]›): T

Inherited from BaseAPI.withPreMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...preMiddlewares	Array‹Middleware["pre"]›

Returns: T