Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BankAccountsService

Hierarchy

  • BankAccountsService

Index

Constructors

Methods

Constructors

constructor

Methods

delete

  • delete(bankAccountId: string): Promise<any>

get

getBalance

getReport

  • Retrieve a Report for a specific bank account

    Parameters

    • bankAccountId: string

      The bank-account-id for the account the report is to be retrieved.

    • reportId: string

      ID of the report to be retrieved.

    • Default value format: ReportFormat = ReportFormat.JSON
    • Default value locale: ReportLocale = ReportLocale.EN

    Returns Promise<any>

getTurnovers

  • getTurnovers(bankAccountId: string, from?: string, to?: string, onlyNew?: number): Promise<BankAccountTurnovers>

  • Retrieve the turnovers for a specific bank account

    Parameters

    • bankAccountId: string

      The bank-account-id for the account the balance is to be retrieved.

    • Default value from: string = ""

      Filter turnovers by booking_date ().

    • Default value to: string = ""

      Filter turnovers by booking_date ().

    • Default value onlyNew: number = 0

      Filter turnovers by new flag (1 for true, 0 for false)

    Returns Promise<BankAccountTurnovers>

list

listForBankConnection

  • listForBankConnection(connectionId: string, perPage?: number, page?: number): Promise<BankAccountsList>

  • Retrieve the list of all bank accounts for a specific bank connection

    Parameters

    • connectionId: string

      The connection-id of the bank connection to get all bank accounts for

    • Default value perPage: number = 15

      Items per page

    • Default value page: number = 1

      page to display

    Returns Promise<BankAccountsList>

markTurnoversAsSeen

  • markTurnoversAsSeen(bankAccountId: string, upTo?: string): Promise<any>

  • Mark turnovers as seen

    Parameters

    • bankAccountId: string

      The bank-account-id for the account for which the turnovers are to be marked as seen.

    • Default value upTo: string = ""

      Once you set a date, attribute new of all turnovers is set to false until the given date.

    Returns Promise<any>

Generated using TypeDoc