Income

Income

An Income contains a resume of monthly income Transaction in a Link.

Constructor

new Income()

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, options) → {object}

Retrieve income information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

options object

Optional parameters (saveData, dateFrom, dateTo)

Throws:
Returns:
Type:
object

Response

(async) retrieve(link, options) → {object}

Retrieve income information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

options object

Optional parameters (saveData, dateFrom, dateTo)

Throws:
Returns:
Type:
object

Response

Income

An Income contains a resume of monthly income Transaction in a Link.

Constructor

new Income()

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, options) → {object}

Retrieve income information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

options object

Optional parameters (saveData, dateFrom, dateTo)

Throws:
Returns:
Type:
object

Response

(async) retrieve(link, options) → {object}

Retrieve income information from a specific banking link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

options object

Optional parameters (saveData, dateFrom, dateTo)

Throws:
Returns:
Type:
object

Response