GET v1/search/bunits?searchTerm={searchTerm}&bunitId={bunitId}

Returns a list of business units with names or ERP reference in their contract matching the search term.
If the searchterm is a number, it will also search by business unit ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchTerm		string	Required
bunitId	An optional business unit ID. If specified, the search is only performed on that business unit's descendants.	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SimpleBusinessUnit

Name	Description	Type	Additional information
Id	The business unit ID.	integer	None.
ParentId	The business unit relation's parent ID.	integer	None.
Name	The name of the business unit.	string	None.
GroupName	The name of the group the business unit is a part of	string	None.
SystemId		globally unique identifier	None.
RemoteId		integer	None.
ReportRemotely		boolean	None.
SynchronizeConsumerNames		boolean	None.
BusinessUnits	The business unit's children.	Collection of SimpleBusinessUnit	None.
Tags		Collection of Tag	None.
HasContract		boolean	None.
HasReferral		boolean	None.
InvoiceConsumer		boolean	None.
InvoiceDay	The day of the month customers of this business unit are invoiced. Default value is zero (0) and represents the last day of the month.	integer	None.

Response Formats