new TransactionsAPI(rest)
This class is used to interact with Transactions in TidyHQ.
Parameters:
| Name | Type | Description |
|---|---|---|
rest | Rest | The rest instance to use for requests. |
- Source
Methods
(async) getTransaction(id, optionsopt) → {Promise.<TidyAPI_V1_Transaction>}
Get a single transaction.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | The ID of the transaction. | ||||||||||
options | object | <optional> | {} | Properties
|
- Source
Returns:
- The transaction.
- Type:
- Promise.<TidyAPI_V1_Transaction>
(async) getTransactions(optionsopt) → {Promise.<TidyAPI_V1_Transactions>}
Get a list of all transactions.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | object | <optional> | {} | Properties
|
- Source
Returns:
- The list of transactions.
- Type:
- Promise.<TidyAPI_V1_Transactions>