Template

This class defines a Template.

A Template is a pre-configured setup for [[Books]] and associated Google Sheets that provides users with a starting point for specific accounting or financial management needs.

Extends

• Resource<bkper.Template>

Constructors

Constructor

new Template(json?, config?): Template;

Parameters

Parameter	Type
json?	Template
config?	Config

Returns

Template

Overrides

Resource<bkper.Template>.constructor

Properties

payload

payload: Template;

The underlying payload data for this resource

Inherited from

Resource.payload

Methods

getBookId()

getBookId(): string | undefined;

Gets the bookId of the [[Book]] associated with the Template.

Returns

string | undefined

The bookId of the Book associated with the Template

---

getBookLink()

getBookLink(): string | undefined;

Gets the link of the [[Book]] associated with the Template.

Returns

string | undefined

The link of the Book associated with the Template

---

getCategory()

getCategory(): string | undefined;

Gets the category of the Template.

Returns

string | undefined

The Template’s category. Example: “PERSONAL”, “BUSINESS”, etc

---

getDescription()

getDescription(): string | undefined;

Gets the description of the Template.

Returns

string | undefined

The Template’s description

---

getImageUrl()

getImageUrl(): string | undefined;

Gets the url of the image of the Template.

Returns

string | undefined

The url of the Template’s image

---

getName()

getName(): string | undefined;

Gets the name of the Template.

Returns

string | undefined

The Template’s name

---

getSheetsLink()

getSheetsLink(): string | undefined;

Gets the link of the Google Sheets spreadsheet associated with the Template.

Returns

string | undefined

The link of the Google Sheets spreadsheet associated with the Template

---

getTimesUsed()

getTimesUsed(): number;

Gets the times the Template has been used.

Returns

number

The number of times the Template has been used

---

json()

json(): Template;

Gets an immutable copy of the JSON payload for this resource.

Returns

Template

An immutable copy of the json payload

Inherited from

Resource.json