...
Resource Properties
| Scope Parameter | roles |
|---|---|
| Location | /roles |
| Methods | GET |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| name | The name given to the system role. | string | true | default | |
| description | A description of the system role. | string | false | default | |
| defaultMonthlyFee | The default monthly fee for system roles of this type. | number | true | additional | |
| defaultMonthlyFeeCurrencyCode | The currency code for the default monthly fee. | string | true | additional | |
| defaultMonthlyFeeNotes | Notes associated with default monthly fee. | string | false | additional | |
| overrideDiscountPercent | The override discount percent for this system role. | number | true | additional | |
| hasAuthority | Indicated if the system role has billing authority by default. | boolean | true | additional | |
| isHeadsUpEnabled | Indicates if the HeadsUp feature is enabled for this system role. | boolean | true | additional | |
| rate | The rates resource associated to this system role. | string | false | link | |
| policy | The policy resource associated to this system role. | string | false | link | Not Yet Implemented. |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| roles.rate | rates | /rates/{roles.rate} |
| roles.policy | policies | /policies/{roles.policy} |