Divisions

The information in this document is currently in BETA and subject to change.

The Divisions resource represents a collection of divisions that represent the originating organisation. Divisions within an organisation are distinguished by a range of custom preferences and are linked to differing Participants resources. Division may appear in a flat or hierarchical structure; where a division may have a parent division or one, to many, child divisions.

Resource Properties

Scope Parameter	divisions
Location	/divisions
Methods	GET
Default Page Size	50
Max Page Size	200
Default Includes	None

Resource Attributes

Field	Description	Format	Required	Field Type	Notes
timezoneName	The timezone identifier for the Division.	string	true	default	i.e. "Pacific/Auckland"
timezoneOffset	The GMT timezone offset.	integer	true	default
isActive	If the Division is Active	boolean	false	default
taxMonths	The monthly interval at which tax is paid.	integer	false	additional
taxAccountingMethod	The accounting method for Tax.	string	false	additional
invoiceAccountingMethod	The accounting method for Invoicing.	string	true	additional
lockoutTimestamp	The date which prevents prior transactions.	date	false	additional
openingBalanceTimestamp	The date of the Division's opening balance.	date	true	additional
emailSignature	The Division's email signature.	string	false	additional
cashAccountingAllocation	Cash account allocation method for the Division.	string	true	additional
invoiceAccountingAllocation	Allocation method of invoicing.	string	true	additional
trustLockoutTimestamp	The lockout date for trust accounting.	date	false	additional
participant	The Participant record	string	true	link
parent	The parent Division - if it exists.	string	false	link

Link Templates

Identifier	Resource	Location Template
divisions.participant	participants	/participants/{divisions.participant}
divisions.parent	divisions	/divisions/{divisions.parent}