TaxReturn

TaxReturn

Retrieve tax returns information from a specific fiscal link.

Constructor

new TaxReturn()

Source:

Extends

Members

(constant) MONTHLY :string

Source:
Type:
  • string

(constant) MONTHLY :string

Source:
Type:
  • string

(constant) YEARLY :string

Source:
Type:
  • string

(constant) YEARLY :string

Source:
Type:
  • string

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

Retrieve tax returns information from a specific fiscal link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

yearDateFrom string

Required year or date from, format is YYYY-MM-DD

yearDateTo string

Required year or date to, format is YYYY-MM-DD.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response

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

Retrieve tax returns information from a specific fiscal link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

yearDateFrom string

Required year or date from, format is YYYY-MM-DD

yearDateTo string

Required year or date to, format is YYYY-MM-DD.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response

TaxReturn

Retrieve tax returns information from a specific fiscal link.

Constructor

new TaxReturn()

Source:

Extends

Members

(constant) MONTHLY :string

Source:
Type:
  • string

(constant) MONTHLY :string

Source:
Type:
  • string

(constant) YEARLY :string

Source:
Type:
  • string

(constant) YEARLY :string

Source:
Type:
  • string

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

Retrieve tax returns information from a specific fiscal link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

yearDateFrom string

Required year or date from, format is YYYY-MM-DD

yearDateTo string

Required year or date to, format is YYYY-MM-DD.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response

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

Retrieve tax returns information from a specific fiscal link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.

yearDateFrom string

Required year or date from, format is YYYY-MM-DD

yearDateTo string

Required year or date to, format is YYYY-MM-DD.

options object

Optional parameters (token, saveData, attachPDF)

Throws:
Returns:
Type:
object

Response