Method

rxc-unittypes-get

Description

This method returns all unit types assigned to the logged in user's business. If the business is not within a holding operation, any unit types that are assigned at the operation level are also returned, with a flag of "selected" indicating if the unit type is active for this business.

Parameters

Name Input Value Type Description
business_id Integer (Optional) ID Number of the business to return details for. To return details for multiple businesses, call this method once for each business. Default value is the business of the logged in user.
withdetails Integer (Optional) When non-zero, additional descriptive fields are returned with each unit type record.
withoccupants Integer (Optional) When non-zero, the capacity of each occupant type is also returned.
withpolicies Integer (Optional) When non-zero, the policies of each unit type are also returned.
withappliedtax Integer (Optional) When non-zero, the taxes assigned to each unit type are also returned.
withgridsort Integer (Optional) When non-zero, the unit types will be sorted by their grid position rather than by label.
withappliedmeter Integer (Optional) When non-zero, the meters assigned to each unit type are also returned.
format enumeration (optional) Set this value to "xml" for XML raw formatted output, "xml-clean" for XML tidy formatted output or "json" for JSON formatted output. If not passed, "xml" is used as a default

XML Encoded Request

URL Encoded Request





Result