Global

Methods

(async) authorize(client_id, redirect_uri, hostopt) → {Promise.<string>}

This function is used to authorize the application with TidyHQ and return an access token.

Parameters:

Name	Type	Attributes	Default	Description
`client_id`	string			The client ID of the application.
`redirect_uri`	string			The redirect URI of the application.
`host`	string	<optional>	"https://accounts.tidyhq.com"	The host url of TidyHQ.

Source: src/OAuth.js, line 20

Throws:

If `client_id` or `redirect_uri` are not strings.
Type
TypeError
If `client_id` is not 64 characters long or `redirect_uri` is not a valid URL.
Type
RangeError
For any Axios-related errors, including network issues or invalid responses.
Type
Error

Returns:

- The access token.

Type:: Promise.<string>

(async) authorizeWithPassword(client_id, client_secret, username, password, domain_prefix) → {Promise.<string>}

This function is used to authorize using a username and password.

Parameters:

Name	Type	Description
`client_id`	string	The client ID of the application.
`client_secret`	string	The client secret of the application.
`username`	string	The username of the user.
`password`	string	The password of the user.
`domain_prefix`	string	The domain prefix of the club.

Source: src/OAuth.js, line 47

Throws:

If `client_id`, `client_secret`, `username`, `password`, or `domain_prefix` are not strings.
Type
TypeError
If `client_id` or `client_secret` are not 64 characters long.
Type
RangeError
For any Axios-related errors, including network issues or invalid responses.
Type
Error

Returns:

- The access token.

Type:: Promise.<string>

makeURLParameters(keys, data) → {string}

This function is used to build a string of URL parameters.

Parameters:

Name	Type	Description
`keys`	Array.<string>	The keys of the parameters.
`data`	Record.<string, any>	The data to be used to build the parameters.

Source: src/utils/Builder.js, line 18

Returns:

- The parameters.

Type:: string

Examples

makeURLParameters(["limit", "offset"], { limit: 10, offset: 0 });

makeURLParameters(["ids[]"], { ids: [123, 2] });

makeURLParameters(["filter[[]]"], { filter: [{ custom_field_id: "5f1c674336f2", custom_field_value: "1" }] });

makeURLParameters(["filter_equals[][]"], { filter_equals: { email_address: "test@test.com" } });

(async) requestAccessToken(client_id, client_secret, redirect_uri, code) → {Promise.<string>}

This function is used to request an access token from TidyHQ.

Parameters:

Name	Type	Description
`client_id`	string	The client ID of the application.
`client_secret`	string	The client secret of the application.
`redirect_uri`	string	The redirect URI of the application.
`code`	string	The code returned from the authorize function.

Source: src/OAuth.js, line 82

Throws:

If `client_id`, `client_secret`, `redirect_uri`, or `code` are not strings.
Type
TypeError
If `client_id` or `client_secret` are not 64 characters long or `redirect_uri` is not a valid URL.
Type
RangeError
For any Axios-related errors, including network issues or invalid responses.
Type
Error

Returns:

- The access token.

Type:: Promise.<string>

Type Definitions

TidyAPI_Data

Type:

Object

Properties

Name	Type	Attributes	Description
`message`	string		The message.
`errors`	Object	<optional>	Optional for error responses.

Source: src/types.js, line 984

TidyAPI_EmptyResponse

Type:

Object

Properties

Name	Type	Attributes	Description
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 999

TidyAPI_Response

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	TidyAPI_Data		The payload returned from the request or error information.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 990

TidyAPI_V1_Categories

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Category> \| TidyAPI_Data		The categories.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1026

TidyAPI_V1_Contact

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Contact \| TidyAPI_Data		The contact.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1007

TidyAPI_V1_Contacts

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Contact> \| TidyAPI_Data		The contacts.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1016

TidyAPI_V1_CustomField

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_CustomField \| TidyAPI_Data		The custom field.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1035

TidyAPI_V1_CustomFieldChoice

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_CustomFieldChoice \| TidyAPI_Data		The custom field.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1053

TidyAPI_V1_CustomFieldChoices

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_CustomFieldChoice> \| TidyAPI_Data		The custom fields.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1062

TidyAPI_V1_CustomFields

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_CustomField> \| TidyAPI_Data		The custom fields.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1044

TidyAPI_V1_Deposit

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Deposit \| TidyAPI_Data		The deposit.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1071

TidyAPI_V1_Deposits

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Deposit> \| TidyAPI_Data		The deposits.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1080

TidyAPI_V1_Email

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Email \| TidyAPI_Data		The email.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1089

TidyAPI_V1_Emails

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Email> \| TidyAPI_Data		The emails.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1098

TidyAPI_V1_Event

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Event \| TidyAPI_Data		The event.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1107

TidyAPI_V1_Events

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Event> \| TidyAPI_Data		The events.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1116

TidyAPI_V1_Expense

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Expense \| TidyAPI_Data		The expense.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1125

TidyAPI_V1_Expenses

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Expense> \| TidyAPI_Data		The expenses.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1134

TidyAPI_V1_Group

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Group \| TidyAPI_Data		The group.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1143

TidyAPI_V1_Groups

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Group> \| TidyAPI_Data		The groups.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1152

TidyAPI_V1_Invoice

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Invoice \| TidyAPI_Data		The invoice.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1161

TidyAPI_V1_Invoices

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Invoice> \| TidyAPI_Data		The invoices.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1170

TidyAPI_V1_Meeting

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Meeting \| TidyAPI_Data		The meeting.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1179

TidyAPI_V1_Meetings

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Meeting> \| TidyAPI_Data		The meetings.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1188

TidyAPI_V1_Membership

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Membership \| TidyAPI_Data		The membership.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1215

TidyAPI_V1_MembershipLevel

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_MembershipLevel \| TidyAPI_Data		The membership level.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1197

TidyAPI_V1_MembershipLevels

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_MembershipLevel> \| TidyAPI_Data		The membership levels.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1206

TidyAPI_V1_Memberships

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Membership> \| TidyAPI_Data		The memberships.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1224

TidyAPI_V1_Organization

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Organization \| TidyAPI_Data		The organization.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1233

TidyAPI_V1_OrganizationContacts

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_OrganizationPublicContact> \| TidyAPI_Data		The organizations.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1251

TidyAPI_V1_Organizations

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Organization> \| TidyAPI_Data		The organizations.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1242

TidyAPI_V1_Payment

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Payment \| TidyAPI_Data		The organizations.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1260

TidyAPI_V1_PricingVariation

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_PricingVariation> \| TidyAPI_Data		The membership level pricing variations.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1269

TidyAPI_V1_ShippingOption

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_ShippingOption \| TidyAPI_Data		The shipping option.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1359

TidyAPI_V1_ShippingOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_ShippingOption> \| TidyAPI_Data		The shipping options.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1368

TidyAPI_V1_ShopOrder

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_ShopOrder \| TidyAPI_Data		The shop order.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1377

TidyAPI_V1_ShopOrders

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_ShopOrder> \| TidyAPI_Data		The shop orders.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1386

TidyAPI_V1_ShopProduct

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_ShopProduct \| TidyAPI_Data		The shop product.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1341

TidyAPI_V1_ShopProducts

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_ShopProduct> \| TidyAPI_Data		The shop products.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1350

TidyAPI_V1_SoldTickets

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_SoldTicket> \| TidyAPI_Data		The sold tickets.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1314

TidyAPI_V1_Task

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Task \| TidyAPI_Data		The task.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1278

TidyAPI_V1_Tasks

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Task> \| TidyAPI_Data		The tasks.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1287

TidyAPI_V1_Ticket

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Ticket \| TidyAPI_Data		The ticket.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1296

TidyAPI_V1_Tickets

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Ticket> \| TidyAPI_Data		The tickets.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1305

TidyAPI_V1_Transaction

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V1_Transaction \| TidyAPI_Data		The transaction.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1323

TidyAPI_V1_Transactions

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V1_Transaction> \| TidyAPI_Data		The transactions.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1332

TidyAPI_V2_Contact

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_Contact \| TidyAPI_Data		The contact.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1395

TidyAPI_V2_Contacts

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V2_Contact> \| TidyAPI_Data		The contacts.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1404

TidyAPI_V2_Membership

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_Membership \| TidyAPI_Data		The membership.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1413

TidyAPI_V2_MembershipLevel

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_MembershipLevel \| TidyAPI_Data		The membership level.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1474

TidyAPI_V2_MembershipLevels

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V2_MembershipLevel> \| TidyAPI_Data		The membership levels.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1483

TidyAPI_V2_Memberships

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V2_Membership> \| TidyAPI_Data		The memberships.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1422

TidyAPI_V2_Note

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_Note \| TidyAPI_Data		The note.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1492

TidyAPI_V2_Organization

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_Organization \| TidyAPI_Data		The organization.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1501

TidyAPI_V2_OrganizationRoles

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V2_OrganizationRole> \| TidyAPI_Data		The roles.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1510

TidyAPI_V2_Subscription

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_Subscription \| TidyAPI_Data		The subscription.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1431

TidyAPI_V2_SubscriptionPost

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_SubscriptionPostResponse \| TidyAPI_Data		The subscription and membership response.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1465

TidyAPI_V2_Subscriptions

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V2_Subscription> \| TidyAPI_Data		The subscriptions.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1440

TidyAPI_V2_Webhook

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Tidy_V2_Webhook \| TidyAPI_Data		The webhook.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1519

TidyAPI_V2_Webhooks

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<Tidy_V2_Webhook> \| TidyAPI_Data		The webhooks.
`status`	number		The HTTP status code of the response.
`statusText`	string		The status text (e.g., "OK", "Not Found") of the response.
`success`	boolean		Indicates whether the request was successful.
`message`	string	<optional>	An optional error message, present only in error responses.

Source: src/types.js, line 1528

Tidy_V1_BundleAmount

Type:

Object

Properties

Name	Type	Description
`amount`	string	The amount for the bundle.
`subsequent`	boolean	Whether this amount applies to subsequent members.
`type`	string	The type of member this amount applies to (e.g., "adult", "child").

Source: src/types.js, line 731

Tidy_V1_Category

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the category.
`name`	string	The name of the category.
`description`	string	The description of the category.
`balance`	Object.<string, number>	The balance of the category in various currencies, with currency codes as keys and amounts as values. E.g., { "AUD": -20.0, "USD": 42.0 }.
`created_at`	string	The creation date and time of the category in ISO 8601 format.

Source: src/types.js, line 315

Tidy_V1_Contact

Type:

Object

Properties

Name	Type	Description
`id`	number	Unique identifier for the contact.
`first_name`	string	First name of the contact.
`last_name`	string	Last name of the contact.
`nick_name`	string	Nickname of the contact.
`company`	string	Company name associated with the contact.
`email_address`	string	Email address of the contact.
`phone_number`	string	Phone number of the contact.
`address1`	string	Street address of the contact.
`city`	string	City of the contact.
`state`	string \| null	State of the contact.
`country`	string	Country of the contact.
`postcode`	string	Postcode of the contact.
`gender`	Tidy_V1_ContactGender	Gender of the contact.
`birthday`	string \| null	Birthday of the contact.
`facebook`	string	Facebook profile URL of the contact.
`twitter`	string	Twitter handle of the contact.
`linkedin`	string	LinkedIn profile URL of the contact.
`instagram`	string	Instagram handle of the contact.
`website`	string \| null	Website URL of the contact.
`details`	string \| null	Additional details about the contact.
`subscribed`	boolean	Subscription status of the contact.
`metadata`	string \| null	Metadata associated with the contact.
`created_at`	string	Creation date and time of the contact record.
`updated_at`	string	Last update date and time of the contact record.
`emergency_contact_person`	string \| null	Emergency contact person for the contact.
`emergency_contact_number`	string \| null	Emergency contact number for the contact.
`member_since`	string	Date since the contact is a member.
`is_company`	boolean	Flag indicating if the contact is a company.
`kind`	string	Type of the contact (e.g., person).
`display_name`	string	Display name of the contact.
`contact_id`	number	Secondary identifier for the contact.
`contact_id_number`	string	Contact ID number.
`profile_image`	string \| null	URL to the profile image of the contact.
`status`	string	Status of the contact (e.g., active).
`custom_fields`	Array.<Tidy_V1_CustomField>	Custom fields associated with the contact.
`organization`	Tidy_V1_ContactOrganization	Organization associated with the contact.
`groups`	Array.<Tidy_V1_ContactGroup>	Groups associated with the contact.
`contact_links`	Array.<Tidy_V1_ContactLink>	Links associated with the contact.

Source: src/types.js, line 349

Tidy_V1_ContactCustomFields

A struct of custom field IDs as keys and their values. For dropdown fields, use the dropdown field choice ID as the value.

Type:

Object

Source: src/types.js, line 391

Example

{
  "5b8ff85455e9": true, // Boolean field example
  "91288961b8d7": "2012-01-01", // Date field example
  "280ada4c1dea": "2fbd15a7ff31" // Dropdown field id as a key, dropdown field choice id as a value. Use blank value to empty the field
}

Tidy_V1_ContactGender

Type:

"female" | "male" | "non_binary" | "undisclosed"

Source: src/types.js, line 326

Tidy_V1_ContactGroup

Type:

Object

Properties

Name	Type	Description
`id`	number	Unique identifier for the group.
`label`	string	Label of the group.

Source: src/types.js, line 336

Tidy_V1_ContactLink

Type:

Object

Properties

Name	Type	Description
`contact_id`	number	The contact ID of the linked contact.
`relationship_type`	string	The type of relationship (e.g., "Adult", "Child").

Source: src/types.js, line 330

Tidy_V1_ContactOrganization

Type:

Object

Properties

Name	Type	Description
`id`	string	Unique identifier for the organization.
`name`	string	Name of the organization.
`domain_prefix`	string	Domain prefix of the organization.

Source: src/types.js, line 342

Tidy_V1_ContactParams

Type:

Object

Properties

Name	Type	Attributes	Description
`first_name`	string	<optional>	First name of the contact. Required only on creation.
`last_name`	string	<optional>	Last name of the contact.
`email_address`	string	<optional>	Email address of the contact.
`phone_number`	string	<optional>	Phone number of the contact.
`address1`	string	<optional>	Street address of the contact.
`city`	string	<optional>	City of the contact.
`state`	string	<optional>	State of the contact.
`country`	string	<optional>	Country of the contact.
`postcode`	string	<optional>	Postcode of the contact.
`gender`	Tidy_V1_ContactGender	<optional>	Gender of the contact.
`birthday`	string	<optional>	Birthday of the contact in ISO 8601 format.
`facebook`	string	<optional>	Facebook account name of the contact.
`twitter`	string	<optional>	Twitter account name of the contact.
`details`	string	<optional>	A brief description of the contact.
`custom_fields`	Tidy_V1_ContactCustomFields	<optional>	A struct of custom field IDs as keys and values.

Source: src/types.js, line 402

Tidy_V1_CustomField

Type:

Object

Properties

Name	Type	Attributes	Description
`id`	string		The unique identifier for the custom field.
`title`	string		The title of the custom field.
`type`	Tidy_V1_CustomFieldType		The type of the custom field.
`created_at`	string		The creation date and time of the custom field.
`choices`	Array.<Tidy_V1_CustomFieldChoice>	<optional>	Optional. The choices for the custom field, applicable if the type is "dropdown".

Source: src/types.js, line 427

Tidy_V1_CustomFieldChoice

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the custom field choice.
`title`	string	The title of the custom field choice.
`created_at`	string	The creation date and time of the custom field choice.

Source: src/types.js, line 436

Tidy_V1_CustomFieldType

Type:

"string" | "text" | "dropdown" | "boolean" | "date"

Source: src/types.js, line 423

Tidy_V1_Deposit

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the deposit.
`ref_no`	string	The reference number of the deposit.
`contact_id`	number	The ID of the contact associated with the deposit.
`type`	"deposit"	The type of the transaction.
`name`	string	The name of the deposit.
`description`	string \| null	The description of the deposit.
`category_id`	number	The category ID of the deposit.
`currency`	string	The currency of the deposit amount.
`amount`	number	The amount of the deposit.
`metadata`	string \| null	Additional metadata associated with the deposit.
`status`	Tidy_V1_FinanceStatus	The status of the deposit.
`payments`	Array.<Tidy_V1_Payment>	The payments associated with the deposit.

Source: src/types.js, line 468

Tidy_V1_DepositParams

Type:

Object

Properties

Name	Type	Description
`name`	string	The name of the deposit.
`amount`	number	The amount of the deposit as a decimal.
`paid_date`	string	The date that the deposit was paid in ISO 8601 format.
`category_id`	number	The category of the deposit.
`contact_id`	number	The source of the deposit.

Source: src/types.js, line 484

Tidy_V1_Email

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the email.
`sender_id`	number	The ID of the sender.
`recipient_ids`	Array.<number>	An array of IDs for the recipients.
`way`	"inbound" \| "outbound"	The direction of the email (inbound or outbound).
`type`	"email" \| "group_email"	The type of the email.
`subject`	string	The subject of the email.
`body`	string	The body text of the email.
`scheduled_at`	string \| null	The scheduled send time of the email, if any.
`read`	boolean	Whether the email has been read.
`archived`	boolean	Whether the email has been archived.
`deleted`	boolean	Whether the email has been deleted.
`junk`	boolean	Whether the email has been marked as junk.
`attachments`	Array.<Object>	An array of attachments associated with the email.
`created_at`	string	The creation timestamp of the email.

Source: src/types.js, line 589

Tidy_V1_Event

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the event.
`name`	string	The name of the event.
`location`	string \| null	The location of the event.
`start_at`	string	The start time of the event.
`end_at`	string	The end time of the event.
`body`	string	The body text of the event, which may contain HTML.
`created_at`	string	The creation timestamp of the event.
`category_id`	number	The ID of the category this event belongs to.
`public`	boolean	Whether the event is public.
`image_url`	string	The URL of the event's image.
`public_url`	string	The public URL of the event.
`archived`	boolean	Whether the event has been archived.

Source: src/types.js, line 609

Tidy_V1_EventParams

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	The name of the event. Required only on creation.
`start_at`	string	<optional>	The start date of the event in ISO 8601 format. Required only on creation.
`end_at`	string	<optional>	The end date of the event in ISO 8601 format.
`body`	string	<optional>	The description of the event.
`location`	string	<optional>	The location of the event. [!] There's an error in TidyHQ documentation/API regarding this field.
`archived`	boolean	<optional>	Whether the event is archived or not (accessible via public events page).
`hidden`	boolean	<optional>	Whether the event is hidden or not (showing on public events). When hidden and buying a ticket, certificates and receipts are not sent.
`category_id`	number	<optional>	The ID of the category to assign the event to (defaults to tickets category).

Source: src/types.js, line 625

Tidy_V1_Expense

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the expense.
`ref_no`	string	The reference number of the expense.
`contact_id`	number	The ID of the contact associated with the expense.
`type`	"expense"	The type of the transaction.
`name`	string	The name of the expense.
`description`	string \| null	The description of the expense.
`due_date`	string	The due date of the expense.
`category_id`	number	The category ID of the expense.
`amount`	number	The total amount of the expense.
`amount_paid`	number	The amount that has been paid towards the expense.
`amount_due`	number	The amount that is still due.
`paid`	boolean	Whether the expense has been fully paid or not.
`metadata`	string \| null	Additional metadata associated with the expense.
`status`	Tidy_V1_FinanceStatus	The status of the expense.
`payments`	Array.<Tidy_V1_Payment>	The payments associated with the expense.

Source: src/types.js, line 497

Tidy_V1_ExpenseParams

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string		The name of the expense.
`amount`	number		The amount of the expense.
`due_date`	string		The due date of the expense in ISO 8601 format.
`category_id`	string		The category of the expense.
`contact_id`	string		The source of the expense.
`description`	string	<optional>	The description of the expense.
`metadata`	string	<optional>	The metadata of the expense.

Source: src/types.js, line 516

Tidy_V1_FinanceStatus

Type:

"activated" | "cancelled"

Source: src/types.js, line 453

Tidy_V1_Group

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the group.
`label`	string	The label or name of the group.
`description`	string \| null	The description of the group.
`created_at`	string	The creation timestamp of the group.
`contacts_count`	number	The number of contacts associated with the group.
`logo_image`	string	The URL path to the group's logo image.

Source: src/types.js, line 639

Tidy_V1_Invoice

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the invoice.
`ref_no`	string	The reference number of the invoice.
`contact_id`	number	The ID of the contact associated with the invoice.
`type`	"invoice"	The type of the transaction.
`name`	string	The name of the invoice.
`description`	string \| null	The description of the invoice.
`due_date`	string	The due date of the invoice.
`category_id`	number	The category ID of the invoice.
`amount`	number	The total amount of the invoice.
`amount_paid`	number	The amount that has been paid towards the invoice.
`amount_due`	number	The amount that is still due.
`paid`	boolean	Whether the invoice has been fully paid or not.
`metadata`	string \| null	Additional metadata associated with the invoice.
`status`	Tidy_V1_FinanceStatus	The status of the invoice.
`payments`	Array.<Tidy_V1_Payment>	The payments associated with the invoice.

Source: src/types.js, line 529

Tidy_V1_InvoiceParams

Type:

Object

Properties

Name	Type	Attributes	Description
`reference`	string		The reference of the invoice. e.g. 'Invoice #1234'
`amount`	number		The amount of the invoice expressed as a decimal.
`included_tax_total`	number		The total amount of tax expressed as a decimal.
`pre_tax_amount`	number		The total amount before tax expressed as a decimal.
`due_date`	string		The due date of the invoice in ISO 8601 format.
`category_id`	number		The ID of the category to assign the invoice to.
`contact_id`	number		The ID of the contact to assign the invoice to.
`description`	string	<optional>	The description of the invoice.
`metadata`	string	<optional>	The metadata of the invoice.

Source: src/types.js, line 548

Tidy_V1_Meeting

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the meeting.
`name`	string	The name of the meeting.
`description`	string	The HTML description of the meeting.
`date_at`	string	The date and time of the meeting in ISO 8601 format.
`location_full_address`	string \| null	The full address of the meeting location.
`topics`	Array.<Tidy_V1_MeetingTopic>	An array of topics discussed in the meeting.
`public`	boolean	Whether the meeting is public.
`created_at`	string	The creation timestamp of the meeting in ISO 8601 format.
`schedule_meeting_topics`	Array.<Tidy_V1_MeetingScheduleTopic>	An array of scheduled meeting topics.
`attendees`	Array.<number>	An array of IDs representing the attendees of the meeting.
`apologies`	Array.<number>	An array of IDs representing the people who apologized for not attending the meeting.
`maybe`	Array.<number>	An array of IDs representing the people who might attend the meeting.
`minute_takers`	Array.<number>	An array of IDs representing the minute takers of the meeting.
`chairpersons`	Array.<number>	An array of IDs representing the chairpersons of the meeting.
`public_url`	string	The public URL to access the meeting.

Source: src/types.js, line 651

Tidy_V1_MeetingScheduleTopic

Type:

Object

Properties

Name	Type	Description
`member_id`	number \| null	The ID of the member associated with the scheduled meeting topic.
`category`	Tidy_V1_MeetingTopicCategory	The category of the scheduled meeting topic.
`name`	string	The name of the scheduled meeting topic.
`description`	string	The HTML description of the scheduled meeting topic.
`decision`	string \| null	The decision made regarding the scheduled meeting topic.
`created_at`	string	The creation timestamp of the scheduled meeting topic.
`task`	Tidy_V1_Task \| null	The task associated with the scheduled meeting topic.

Source: src/types.js, line 694

Tidy_V1_MeetingTopic

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the topic.
`name`	string	The name of the topic.
`category`	Tidy_V1_MeetingTopicCategory	The category of the topic.
`schedule_meeting_id`	number	The ID of the scheduled meeting this topic is associated with.
`position`	number	The position of the topic in the meeting.
`duration`	number \| null	The duration of the topic in minutes.
`created_at`	string	The creation timestamp of the topic.
`updated_at`	string	The update timestamp of the topic.
`description`	string	The HTML description of the topic.
`decision`	string \| null	The decision made regarding the topic.
`parent_id`	number \| null	The ID of the parent topic.
`code`	string	A unique hex code identifying the topic.
`deleted_at`	string \| null	The deletion timestamp of the topic.
`member_id`	number \| null	The ID of the member associated with the topic.
`revision`	number	The revision number of the topic.
`last_edited_by_id`	number	The ID of the last member who edited the topic.

Source: src/types.js, line 674

Tidy_V1_MeetingTopicCategory

Type:

"idea" | "info" | "todo"

Source: src/types.js, line 670

Tidy_V1_Membership

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the membership.
`start_date`	string	The start date of the membership in ISO 8601 format.
`end_date`	string	The end date of the membership in ISO 8601 format.
`contact_id`	number	The unique identifier for the contact associated with the membership.
`membership_level_id`	number	The unique identifier for the membership level.
`state`	string	The state of the membership (e.g., "activated").
`membership_id_reference`	number	A reference ID for the membership.
`membership_id`	string	A unique string identifier for the membership.
`membership_level`	Tidy_V1_MembershipLevelSummary	The membership level details.
`subscriptions`	Array.<Tidy_V1_Subscription>	An array of subscriptions associated with the membership.
`adult_members`	Array.<Tidy_V1_MembershipMember>	An array of adult members associated with the membership.
`child_members`	Array.<Tidy_V1_MembershipMember>	An array of child members associated with the membership.
`created_at`	string	The creation timestamp of the membership in ISO 8601 format.

Source: src/types.js, line 775

Tidy_V1_MembershipLevel

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the membership level.
`name`	string	The name of the membership level.
`description`	string	The description of the membership level.
`duration`	number	The duration of the membership level.
`unit_period`	Tidy_V1_MembershipLevelUnitPeriod	The unit of period for the duration.
`fixed`	boolean	Whether the membership level has a fixed start date.
`start_at`	string \| null	The start date of the membership level, if fixed.
`enabled`	boolean	Whether the membership level is enabled.
`active_since`	string \| null	The date since the membership level has been active.
`amount`	string	The amount associated with the membership level.
`bundle`	boolean	Whether the membership level is part of a bundle.
`bundle_amounts`	Array.<Tidy_V1_BundleAmount> \| null	The bundle amounts, applicable if the membership level is part of a bundle.
`deleted`	boolean	Whether the membership level is marked as deleted.
`plan_type`	string	The type of plan (e.g., "rolling").
`auto_renew`	boolean	Whether the membership level auto-renews.
`created_at`	string	The creation timestamp of the membership level.

Source: src/types.js, line 711

Tidy_V1_MembershipLevelSummary

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the membership level.
`name`	string	The name of the membership level.
`plan_type`	string	The type of plan (e.g., "rolling").
`auto_renew`	boolean	Whether the membership level auto-renews.

Source: src/types.js, line 798

Tidy_V1_MembershipLevelUnitPeriod

Type:

"day" | "week" | "month" | "year"

Source: src/types.js, line 707

Tidy_V1_MembershipMember

Type:

Object

Properties

Name	Type	Description
`contact_id`	number	The unique identifier for the contact.
`member_since`	string	The date since the contact has been a member in ISO 8601 format.

Source: src/types.js, line 792

Tidy_V1_Organization

Type:

Object

Properties

Name Type Description

id string The unique identifier for the organization.

name string The name of the organization.

domain_prefix string The domain prefix of the organization.

location string The location of the organization.

address string The street address of the organization.

city string The city of the organization.

state string The state of the organization.

postcode string The postcode of the organization.

country string The country of the organization.

phone string The phone number of the organization.

website string The website URL of the organization.

twitter string The Twitter handle of the organization.

facebook string The Facebook profile URL of the organization.

currency string The currency used by the organization.

time_zone string The time zone of the organization.

public_contacts Array.<Tidy_V1_OrganizationPublicContact> The public contacts of the organization.

logo_url Object The URL to the logo of the organization.

plan

Object

The plan of the organization.

Properties

Name	Type	Description
`name`	string	The name of the plan of the organization.
`quota`	Tidy_V1_OrganizationPlanQuota	The quota of the plan for the organization.

parent_organizations Array.<Tidy_V1_OrganizationLink> The parent organizations of the organization.

child_organizations Array.<Tidy_V1_OrganizationLink> The child organizations of the organization.

Source: src/types.js, line 851

Tidy_V1_OrganizationLink

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the organization.
`name`	string	The name of the organization.

Source: src/types.js, line 845

Tidy_V1_OrganizationPlanQuota

Type:

Object

Properties

Name Type Description

emails

Object

The email quota.

Properties

Name	Type	Description
`limit`	Object	The email limit.
`sent`	Object	The number of emails sent.
`count`	Object	The number of emails sent.

contacts

Object

The contacts quota.

Properties

Name	Type	Description
`limit`	Object	The contacts limit.
`count`	Object	The number of contacts.

Source: src/types.js, line 834

Tidy_V1_OrganizationPublicContact

Type:

Object

Properties

Name	Type	Description
`name`	string	The name of the contact.
`position`	string	The position of the contact.
`email`	string	The email address of the contact.
`phone_number`	string	The phone number of the contact.

Source: src/types.js, line 826

Tidy_V1_Payment

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the payment.
`amount`	number	The amount of the payment.
`type`	Tidy_V1_PaymentType	The type of the payment.
`paid_at`	string	The timestamp when the payment was made.
`status`	Tidy_V1_PaymentStatus	The status of the payment.

Source: src/types.js, line 457

Tidy_V1_PaymentStatus

Type:

"paid" | "cancelled"

Source: src/types.js, line 449

Tidy_V1_PaymentType

Type:

"cash" | "card" | "cheque" | "bank" | "other"

Source: src/types.js, line 445

Tidy_V1_PricingVariation

Type:

Object

Properties

Name	Type	Description
`State`	Array.<Tidy_V1_PricingVariationState>	An array of state-specific pricing variations.

Source: src/types.js, line 738

Tidy_V1_PricingVariationAutofillGroup

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the autofill group.
`name`	string	The name of the autofill group.

Source: src/types.js, line 767

Tidy_V1_PricingVariationClub

Type:

Object

Properties

Name	Type	Description
`name`	string	The name of the club for this pricing variation.
`amount`	string	The amount associated with this club.
`destination`	Tidy_V1_PricingVariationDestination	The destination organization details for this club's pricing variation.
`autofill_group`	Tidy_V1_PricingVariationAutofillGroup	The autofill group details associated with this club's pricing variation.

Source: src/types.js, line 752

Tidy_V1_PricingVariationDestination

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the destination.
`type`	string	The type of the destination (e.g., "Organisation").
`name`	string	The name of the destination.

Source: src/types.js, line 760

Tidy_V1_PricingVariationState

Type:

Object

Properties

Name	Type	Description
`name`	string	The name of the state or group for this pricing variation.
`amount`	string	The amount associated with this state or group.
`destination`	Tidy_V1_PricingVariationDestination	The destination organization details for this pricing variation.
`autofill_group`	Tidy_V1_PricingVariationAutofillGroup	The autofill group details associated with this pricing variation.
`Club`	Array.<Tidy_V1_PricingVariationClub>	An array of club-specific pricing variations within the state.

Source: src/types.js, line 743

Tidy_V1_ShippingOption

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the shipping option.
`name`	string	The name of the shipping option.
`description`	string	The description of the shipping option, may include newline characters.
`price`	string	The price of the shipping option.
`category_id`	number	The ID of the category associated with the shipping option.
`address_not_required`	boolean	Indicates whether an address is not required for this shipping option.
`created_at`	string	The creation timestamp of the shipping option, in ISO 8601 format.
`country_codes`	Array.<string>	An array of country codes where the shipping option is available.

Source: src/types.js, line 952

Tidy_V1_ShopOrder

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the shipping order.
`contact_id`	number	The ID of the contact associated with the order.
`number`	string	The order number.
`status`	"awaiting_payment" \| "pending" \| "completed" \| "cancelled"	The status of the order.
`created_at`	string	The creation timestamp of the order, in ISO 8601 format.
`shipping_option_id`	string	The unique identifier for the selected shipping option.
`products`	Array.<Tidy_V1_ShopOrderProduct>	An array of products included in the order.

Source: src/types.js, line 971

Tidy_V1_ShopOrderProduct

Type:

Object

Properties

Name	Type	Description
`product_id`	string	The unique identifier for the product.
`variant_id`	string \| null	The unique identifier for the variant of the product, null if not applicable.
`quantity`	number	The quantity of the product ordered.

Source: src/types.js, line 964

Tidy_V1_ShopProduct

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the product.
`name`	string	The name of the product.
`description`	string	The HTML description of the product.
`permalink`	string	A unique permalink for the product.
`sell_price`	string	The selling price of the product.
`cost_price`	string	The cost price of the product.
`sell_category_id`	number	The ID of the selling category.
`cost_category_id`	number	The ID of the cost category.
`quantity`	number \| null	The quantity available, null for unlimited.
`created_at`	string	The creation timestamp of the product.
`status`	"draft" \| "published"	The status of the product
`visible_to`	"admin" \| "group" \| "public"	Who can see the product.
`images`	Array.<string>	An array of URLs to images of the product.
`variants`	Array.<Tidy_V1_ShopProductVariant>	An array of variants of the product.

Source: src/types.js, line 934

Tidy_V1_ShopProductVariant

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the variant.
`name`	string	The name of the variant.
`quantity`	number \| null	The quantity available for the variant, null for unlimited.
`created_at`	string	The creation timestamp of the variant, in ISO 8601 format.

Source: src/types.js, line 926

Tidy_V1_SoldTicket

Type:

Object

Properties

Name	Type	Description
`contact_id`	number	The ID of the contact who purchased the ticket.
`ticket_id`	string	The unique identifier for the ticket purchased.
`created_at`	string	The timestamp when the ticket was sold, in ISO 8601 format.
`code`	string	A unique code associated with the sold ticket.

Source: src/types.js, line 916

Tidy_V1_Subscription

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the subscription.
`start_date`	string	The start date of the subscription.
`end_date`	string	The end date of the subscription.
`status`	string	The status of the subscription (e.g., "Active", "Expired"). [!] Add all possible values.
`variations`	Array.<Tidy_V1_Variation>	An array of variations associated with the subscription.

Source: src/types.js, line 806

Tidy_V1_Task

Type:

Object

Properties

Name	Type	Description
`id`	number	The unique identifier for the task.
`title`	string	The title of the task.
`description`	string \| null	The description of the task.
`due_date`	string	The due date of the task in ISO 8601 format.
`created_at`	string	The creation timestamp of the task.
`recurrence`	Tidy_V1_TaskRecurrence \| null	The recurrence pattern of the task, if any.
`contact_id`	number \| null	The ID of the contact associated with the task, if any.

Source: src/types.js, line 879

Tidy_V1_TaskRecurrence

Type:

Object

Properties

Name	Type	Description
`type`	"daily" \| "weekly" \| "monthly" \| "yearly"	The type of the recurrence
`every`	number	The interval of the recurrence.
`end_date`	string \| null	The end date of the recurrence in ISO 8601 format, if any.
`week_day_numbers`	Array.<string>	An array of week day numbers (as strings) that the recurrence falls on (indexed 0 from Monday to 6 on Sunday)
`day_of_month`	number \| null	The day of the month the recurrence falls on.
`month`	number \| null	The month the recurrence falls on.

Source: src/types.js, line 890

Tidy_V1_Ticket

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the ticket.
`name`	string	The name of the ticket.
`amount`	string	The price of the ticket in decimal string format.
`initial_quantity`	number \| null	The initial quantity of tickets available, null for unlimited.
`quantity_sold`	number	The number of tickets sold.
`maximum_purchase`	number \| null	The maximum number of tickets one can purchase, null for unlimited.
`sales_end`	string \| null	The end date and time of ticket sales in ISO 8601 format.
`members_only`	boolean	Whether the ticket is available to members only.
`membership_level_id`	number \| null	The ID of the membership level required to purchase the ticket, if members_only is true.
`created_at`	string	The creation timestamp of the ticket.

Source: src/types.js, line 902

Tidy_V1_Transaction

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the transaction.
`category_id`	number	The ID of the category associated with the transaction.
`category_name`	string	The name of the category associated with the transaction.
`currency`	string	The currency code for the transaction amount.
`paid_at`	string	The timestamp when the transaction was paid, in ISO 8601 format.
`contact_id`	number	The ID of the contact associated with the transaction.
`contact_name`	string	The display name of the contact associated with the transaction.
`payment_type`	Tidy_V1_PaymentType	The type of payment used for the transaction.
`surcharge`	boolean	Indicates whether a surcharge was applied to the transaction.
`amount`	number	The total amount of the transaction.
`fee`	number	The fee associated with the transaction, if any.
`status`	Tidy_V1_PaymentStatus	The status of the transaction.
`items`	Array.<Tidy_V1_TransactionItem>	An array of items associated with the transaction.

Source: src/types.js, line 570

Tidy_V1_TransactionItem

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the item.
`quantity`	string	The quantity of the item.
`type`	"deposit" \| "expense" \| "invoice"	The type of transaction.

Source: src/types.js, line 563

Tidy_V1_Variation

Type:

Object

Properties

Name	Type	Description
`question`	string	The question related to the variation.
`answer`	string	The answer to the question.
`price`	string	The price associated with the variation.
`destination`	Tidy_V1_PricingVariationDestination	The destination details for the variation.
`autofill_group`	Tidy_V1_PricingVariationAutofillGroup	The autofill group details for the variation.

Source: src/types.js, line 815

Tidy_V2_Contact

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique alphanumeric identifier for the contact.
`contact_id_reference`	number	Reference to the contact ID in V1 API.
`first_name`	string	First name of the contact.
`last_name`	string	Last name of the contact.
`nick_name`	string	Nickname of the contact.
`company`	string	Company name associated with the contact.
`email_address`	string	Email address of the contact.
`phone_number`	string	Phone number of the contact.
`address1`	string	Street address of the contact.
`city`	string	City of the contact.
`state`	string \| null	State of the contact.
`country`	string	Country of the contact.
`postcode`	string	Postcode of the contact.
`gender`	string	Gender of the contact.
`birthday`	string \| null	Birthday of the contact.
`facebook`	string	Facebook profile URL of the contact.
`twitter`	string	Twitter handle of the contact.
`linkedin`	string	LinkedIn profile URL of the contact.
`instagram`	string	Instagram handle of the contact.
`website`	string \| null	Website URL of the contact.
`details`	string \| null	Additional details about the contact.
`subscribed`	boolean	Subscription status of the contact.
`metadata`	string \| null	Metadata associated with the contact.
`created_at`	string	Creation date and time of the contact record.
`updated_at`	string	Last update date and time of the contact record.
`initials`	string	Initials of the contact.
`emergency_contact_person`	string \| null	Emergency contact person for the contact.
`emergency_contact_number`	string \| null	Emergency contact number for the contact.
`member_since`	string	Date since the contact is a member.
`is_company`	boolean	Flag indicating if the contact is a company.
`kind`	string	Type of the contact (e.g., person).
`display_name`	string	Display name of the contact.
`contact_id_number`	string	Contact ID number.
`profile_image`	string \| null	URL to the profile image of the contact.
`status`	string	Status of the contact (e.g., active).
`organization`	Tidy_V2_ContactOrganization	Organization associated with the contact.
`groups`	Array.<Tidy_V2_ContactGroup>	Groups associated with the contact.
`contact_links`	Array.<Tidy_V2_ContactLink>	Links associated with the contact.
`notes`	Array.<Tidy_V2_Note>	Notes associated with the contact.

Source: src/types.js, line 46

Tidy_V2_ContactFilterEqualsOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`first_name`	string	<optional>	Filter by the first name.
`last_name`	string	<optional>	Filter by the last name.
`company`	string	<optional>	Filter by the company name.
`email_address`	string	<optional>	Filter by the email address.
`phone_number`	string	<optional>	Filter by the phone number.
`kind`	string	<optional>	Filter by the kind.
`contact_id_number`	string	<optional>	Filter by the contact ID number.

Source: src/types.js, line 89

Tidy_V2_ContactGroup

Type:

Object

Properties

Name	Type	Description
`id`	number	Alphanumeric ID associated with the group.
`label`	string	Label of the group.
`group_id_reference`	string	Reference to the group ID in V1 API.
`description`	string	Description of the group.
`created_at`	string	Creation date and time of the group.
`updated_at`	string	Last update date and time of the group.
`size`	number	Number of contacts within the group.
`image`	string	URL to the image that represents the group.

Source: src/types.js, line 26

Tidy_V2_ContactLink

Type:

Object

Properties

Name	Type	Description
`contact_id`	number	Alphanumeric ID associated with the contact this link is towards.
`relationship_type`	string	The type of relationship (e.g., "Adult", "Child").
`title`	string	The title of the contact link.
`metadata`	string \| null	Optional arbitrary metadata attached to the object.
`created_at`	string	Creation date and time of the contact link.
`updated_at`	string	Last update date and time of the contact link.
`display_name`	string	Humanized version of the type field, suitable for display.
`type`	string	[!] TBA
`contact_id`	string	Alphanumeric (V2) ID associated with the contact this link is towards.

Source: src/types.js, line 13

Tidy_V2_ContactOrganization

Type:

Object

Properties

Name	Type	Description
`id`	string	Unique identifier for the organization.
`name`	string	Name of the organization.
`domain_prefix`	string	Domain prefix of the organization.
`permissions`	Array.<string>	Permissions user has for the organization.

Source: src/types.js, line 38

Tidy_V2_MatchableContact

Type:

Object

Properties

Name	Type	Attributes	Description
`contact_id`	string	<optional>	The unique identifier for the contact.
`email`	string	<optional>	The email address of the contact.
`first_name`	string	<optional>	The first name of the contact.
`last_name`	string	<optional>	The last name of the contact.

Source: src/types.js, line 100

Tidy_V2_Membership

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the membership.
`created_at`	string	The creation date and time of the membership.
`updated_at`	string	The last update date and time of the membership.
`state`	string	The state of the membership.
`status`	string	Human-readable version of the state.
`membership_id_reference`	number	Reference to the membership ID in V1 API.
`auto_renew_on`	boolean	If the membership is set to auto-renew.
`auto_renew`	boolean	If the membership is set to auto-renew.
`membership_level_id`	string	The ID of the membership level.
`contact_id`	string	The ID of the contact associated with the membership.
`adult_members_contact_ids`	Array.<string>	The IDs of the adult members associated with the membership.
`child_members_contact_ids`	Array.<string>	The IDs of the child members associated with the membership.
`start_date`	string	The start date of the membership.
`end_date`	string	The end date of the membership.
`notes`	Array.<Tidy_V2_Note>	The notes associated with the membership.

Source: src/types.js, line 110

Tidy_V2_MembershipLevel

Type:

Object

Properties

Name	Type	Attributes	Description
`id`	string		The unique identifier for the membership level.
`membership_level_id_reference`	number		Reference to the membership level ID in V1 API.
`name`	string		The name of the membership level.
`description`	string		The description of the membership level, may contain HTML.
`duration`	number		The duration of the membership level.
`unit_period`	Tidy_V1_MembershipLevelUnitPeriod		The unit of period for the duration.
`active_since`	string \| null		The date since the membership level is active.
`bundle`	boolean		If the membership level is a bundle.
`plan_type`	string		The type of plan (e.g., rolling).
`auto_renew`	boolean		If the membership level is set to auto-renew.
`allow_renewal`	boolean		If the membership level allows renewal.
`renewable_from_period`	number \| null		The period from which renewal is allowed.
`renewable_for_period`	number \| null		The period for which renewal is allowed.
`start_at`	string \| null		The start date of the membership level.
`created_at`	string		The creation date and time of the membership level.
`updated_at`	string		The last update date and time of the membership level.
`visible`	"anyone" \| "admin" \| "linked" \| "permitted"		Visibility of the membership level.
`amount`	number		The price of the membership level.
`deleted`	boolean		If the membership level is deleted.
`bundle_amounts`	Array.<Tidy_V2_MembershipLevelBundleAmount>	<optional>	The amounts associated with the bundle.

Source: src/types.js, line 206

Tidy_V2_MembershipLevelBundleAmount

Type:

Object

Properties

Name	Type	Description
`amount`	string	The amount for the bundle.
`subsequent`	boolean	Flag indicating if the amount is for subsequent periods.
`type`	string	The type of member the amount applies to (e.g., adult, child).

Source: src/types.js, line 231

Tidy_V2_Note

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the note.
`text`	string	The content of the note.
`created_at`	string	The creation date and time of the note.
`updated_at`	string	The last update date and time of the note.
`author`	Object	The author of the note. [!]

Source: src/types.js, line 240

Tidy_V2_Organization

Type:

Object

Properties

Name Type Description

id string The unique identifier for the organization.

name string The name of the organization.

domain_prefix string The domain prefix of the organization.

location string The location of the organization.

address string The street address of the organization.

city string The city of the organization.

state string The state of the organization.

postcode string The postcode of the organization.

country string The country of the organization.

phone string The phone number of the organization.

website string The website URL of the organization.

twitter string The Twitter handle of the organization.

facebook string The Facebook profile URL of the organization.

currency string The currency used by the organization.

time_zone string The time zone of the organization.

public_contacts Array.<Tidy_V1_OrganizationPublicContact> The public contacts of the organization.

logo_url Object The URL to the logo of the organization.

created_at string The creation date and time of the organization.

updated_at string The last update date and time of the organization.

plan

Object

The plan of the organization.

Properties

Name	Type	Description
`name`	string	The name of the plan of the organization.
`quota`	Tidy_V1_OrganizationPlanQuota	The quota of the plan for the organization.

parent_organizations Array.<Tidy_V1_OrganizationLink> The parent organizations of the organization.

child_organizations Array.<Tidy_V1_OrganizationLink> The child organizations of the organization.

Source: src/types.js, line 251

Tidy_V2_OrganizationRole

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the role.
`name`	string	The name of the role.
`email_address`	string	The email address to contact the members of this role.
`responsibilities`	string	The responsibilities of the role.
`contact_ids`	Array.<string>	The contact IDs associated with the role.
`created_at`	string	The creation date and time of the role.
`updated_at`	string	The last update date and time of the role.

Source: src/types.js, line 279

Tidy_V2_PostSubscriptionParams

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`member`	Tidy_V2_MatchableContact	<optional>		On an individual membership level, change who it belongs to.
`adult`	Array.<Tidy_V2_MatchableContact>	<optional>		For family memberships, changes the associated adults.
`children`	Array.<Tidy_V2_MatchableContact>	<optional>		For family memberships, changes the associated children.
`variations`	Object.<string, string>	<optional>		A object mapping variation ids to variation value ids.
`payment_type`	'paid' \| 'invoice' \| 'pay_now'			Payment status of subscription, note that paid covers partially paid subscriptions.
`payment_method`	Tidy_V1_PaymentType			Required when payment_type is paid, How the paid amount was paid.
`partial_payment_amount`	string	<optional>		When marked as paid, and it's already partially-paid, an amount that has already been paid.
`ref_no`	string	<optional>		When marked as paid, allows overriding the transaction ref for the given paid transaction. If left blank, will be automatically generated.
`due_date`	string	<optional>		When paying by invoice, when said invoice is due.
`send_welcome_mail`	boolean	<optional>	true	Send a membership welcome email.
`send_invoice_mail`	boolean	<optional>		When paying by invoice, should we send an email with invoice details.
`auto_assign_users`	boolean	<optional>	true	When processing contacts on the membership, should we automatically assign (either find existing, or create a new) user for them in Tidy. If users are created, will automatically send an account sign up email as well. For users to be automatically created / assigned, they require all of a first name, last name and an email address.
`auto_renew`	boolean	<optional>		Will set explicitly if the membership should auto renew, if possible. Defaults to use the value set on the membership level, but can overwrite if needed.
`start_date`	string	<optional>		The start date of the membership.
`end_date`	string	<optional>		The end date of the membership.

Source: src/types.js, line 185

Tidy_V2_PricingVariationAutofillGroup

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the autofill group.
`group_id_reference`	number	The reference ID for the group.
`name`	string	The name of the autofill group.

Source: src/types.js, line 178

Tidy_V2_PricingVariationDestination

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the destination.
`type`	string	The type of the destination.
`title`	string	Human-readable version of the type of destination.
`name`	string	The name of the destination.

Source: src/types.js, line 169

Tidy_V2_Subscription

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the subscription.
`state`	string	The state of the subscription.
`status`	string	Human-readable version of the state.
`created_at`	string	The creation date and time of the subscription.
`updated_at`	string	The last update date and time of the subscription.
`start_date`	string	The start date of the subscription.
`end_date`	string	The end date of the subscription.
`membership_id`	string	The ID of the associated membership.
`variations`	Array.<Tidy_V2_Variation>	The variations associated with the subscription.

Source: src/types.js, line 131

Tidy_V2_SubscriptionPostResponse

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the subscription.
`state`	string	The state of the subscription.
`status`	string	Human-readable version of the state.
`created_at`	string	The creation date and time of the subscription.
`updated_at`	string	The last update date and time of the subscription.
`start_date`	string	The start date of the subscription.
`end_date`	string	The end date of the subscription.
`membership_id`	string	The ID of the associated membership.
`variations`	Array.<Tidy_V2_Variation>	The variations associated with the subscription.
`payment_url`	string	When valid, a URL (pre-authed) a user can use to pay for the membership.
`invoice_id`	string	When valid, the ID of the appropriate Invoice to be used with the invoices API.
`membership`	Tidy_V2_Membership	A preview of the membership.

Source: src/types.js, line 1449

Tidy_V2_Variation

Type:

Object

Properties

Name	Type	Description
`visibility`	string	The visibility of the variation.
`price`	string	The price of the variation.
`answer`	Tidy_V2_VariationAnswer	The answer associated with the variation.
`destination`	Tidy_V2_PricingVariationDestination	The destination associated with the variation.
`autofill_group`	Tidy_V2_PricingVariationAutofillGroup	The autofill group associated with the variation.
`question`	Tidy_V2_VariationQuestion	The question associated with the variation.

Source: src/types.js, line 144

Tidy_V2_VariationAnswer

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the answer.
`value`	string	The value of the answer.
`updated_at`	string	The last update date and time of the answer.

Source: src/types.js, line 154

Tidy_V2_VariationQuestion

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the question.
`name`	string	The name of the question.
`required`	boolean	Whether the question is required.
`created_at`	string	The creation date and time of the question.
`updated_at`	string	The last update date and time of the question.

Source: src/types.js, line 161

Tidy_V2_Webhook

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the webhook.
`status`	string	The status of the webhook. [!] TBA add all possible values
`created_at`	string	The creation date and time of the webhook.
`updated_at`	string	The last update date and time of the webhook.
`matching_kind`	string	The kind of events to match for the webhook.
`url`	string	The URL to which the webhook sends data.
`description`	string	A description of the webhook.
`signing_key_b64`	string	The base64 encoded signing key for the webhook.
`allow_state_changes`	boolean	Whether the webhook allows state changes.

Source: src/types.js, line 291

Tidy_V2_WebhookMessage

Type:

Object

Properties

Name	Type	Description
`id`	string	The unique identifier for the webhook message.
`kind`	string	The kind of the event, e.g., "event.ticket.updated".
`object`	string	The type of object of the data, e.g., "event.ticket".
`created`	string	The creation date and time of the webhook message.
`data`	Object	The data of the webhook message.

Source: src/types.js, line 304