Statement

Statement

A Statement contains a resume of monthly Transactions inside an Account.

Constructor

new Statement()

Source:

Extends

Methods

(async) delete(id) → {boolean}

Delete specific record.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Returns:
Type:
boolean

When the record is successfuly deleted returns true, otherwise false.

(async) detail(id) → {object}

Get specific record details.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Throws:
Returns:
Type:
object

(async) list(params) → {array}

Get a list of resources.

Overrides:
Source:
Parameters:
Name Type Description
params Object

Receives two parameters.

Name Type Attributes Default Description
limit number <optional>
100

Maximum number of results.

filters Object <optional>
{}

Filters to get custom results.

Throws:
Returns:
Type:
array

List of results.

(async) resume(session, token, link) → {object}

Resume a "pending" session that requires an OTP token. Use this function to resume sessions that returned HTTP 428 status code.

Overrides:
Source:
Parameters:
Name Type Description
session string

UUID4 representation of a "pending" session.

token string

OTP token.

link string

UUID4 representation of the link being used.

Throws:
Returns:
Type:
object

Response.

(async) retrieve(link, account, year, month, options) → {object}

Retrieve statements information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

account string

UUID4 representation of an account Id.

year number

The year you want to retrieve.

month number

The month you want to retrieve.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response

(async) retrieve(link, account, year, month, options) → {object}

Retrieve statements information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

account string

UUID4 representation of an account Id.

year number

The year you want to retrieve.

month number

The month you want to retrieve.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response

Statement

A Statement contains a resume of monthly Transactions inside an Account.

Constructor

new Statement()

Source:

Extends

Methods

(async) delete(id) → {boolean}

Delete specific record.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Returns:
Type:
boolean

When the record is successfuly deleted returns true, otherwise false.

(async) detail(id) → {object}

Get specific record details.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Throws:
Returns:
Type:
object

(async) list(params) → {array}

Get a list of resources.

Overrides:
Source:
Parameters:
Name Type Description
params Object

Receives two parameters.

Name Type Attributes Default Description
limit number <optional>
100

Maximum number of results.

filters Object <optional>
{}

Filters to get custom results.

Throws:
Returns:
Type:
array

List of results.

(async) resume(session, token, link) → {object}

Resume a "pending" session that requires an OTP token. Use this function to resume sessions that returned HTTP 428 status code.

Overrides:
Source:
Parameters:
Name Type Description
session string

UUID4 representation of a "pending" session.

token string

OTP token.

link string

UUID4 representation of the link being used.

Throws:
Returns:
Type:
object

Response.

(async) retrieve(link, account, year, month, options) → {object}

Retrieve statements information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

account string

UUID4 representation of an account Id.

year number

The year you want to retrieve.

month number

The month you want to retrieve.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response

(async) retrieve(link, account, year, month, options) → {object}

Retrieve statements information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

account string

UUID4 representation of an account Id.

year number

The year you want to retrieve.

month number

The month you want to retrieve.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response