Class: InvoicesAPI

new InvoicesAPI(rest)

This class is used to interact with Invoices in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/Invoices.js, line 15

Methods

(async) addPayment(invoiceID, optionsopt) → {Promise.<TidyAPI_V1_Payment>}

This function is used to add a payment to an invoice.

Parameters:

Name Type Attributes Description

invoiceID string The ID of the invoice.

options

object

The options to create the payment with. At least one option is required that isn't the access_token.

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`amount`	number	<optional>	The amount of the payment expressed as a decimal.
`payment_type`	Tidy_V1_PaymentType	<optional>	The type of payment.
`date`	string	<optional>	The date of the payment in ISO 8601 format.

Source: src/Invoices.js, line 92

Returns:

- The newly created payment.

Type:: Promise.<TidyAPI_V1_Payment>

(async) createInvoice(invoice, optionsopt) → {Promise.<TidyAPI_V1_Invoice>}

Create a new invoice.

Parameters:

Name Type Attributes Default Description

invoice Tidy_V1_InvoiceParams The invoice to create.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Invoices.js, line 66

Returns:

- The newly created invoice.

Type:: Promise.<TidyAPI_V1_Invoice>

(async) deleteInvoice(invoiceID, optionsopt) → {Promise.<TidyAPI_Response>}

Delete an invoice.

Parameters:

Name Type Attributes Default Description

invoiceID string The ID of the invoice.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Invoices.js, line 111

Returns:

- Success or failure.

Type:: Promise.<TidyAPI_Response>

(async) getInvoice(invoiceID, optionsopt) → {Promise.<TidyAPI_V1_Invoice>}

Get a single invoice from TidyHQ.

Parameters:

Name Type Attributes Default Description

invoiceID string The ID of the invoice to get

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Invoices.js, line 54

Returns:

- An invoice.

Type:: Promise.<TidyAPI_V1_Invoice>

(async) getInvoices(optionsopt) → {Promise.<TidyAPI_V1_Invoices>}

Get a list of invoices from TidyHQ.

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	number	<optional>	The maximum number of invoices to return.
`offset`	number	<optional>	The number of invoices to skip.
`status`	"activated" \| "cancelled" \| "all"	<optional>	The status of the invoice.
`updated_since`	string	<optional>	The timestamp of the last update in ISO 8601 format.

Source: src/Invoices.js, line 35

Returns:

- An array of invoices.

Type:: Promise.<TidyAPI_V1_Invoices>