The information in this document is currently in BETA and subject to change.
The Action Types resource represents the type of an action.
Resource Properties
Scope Parameter | actiontypes |
---|---|
Location | /actiontypes |
Methods | GET |
Default Page Size | 50 |
Max Page Size | 200 |
Default Includes | None |
Resource Attributes
Field | Description | Format | Required | Field Type | Restrictions | Notes |
---|---|---|---|---|---|---|
name | The name of the ActionType. | string (50) | true | default | ||
description | The ActionType description. | string (255) | true | default | ||
copyrightHolder | string | false | default | |||
copyrightContact | string | false | default | |||
copyrightEmail | string | false | default | |||
trackActualTime | boolean | false | default | |||
trackBillableTime | boolean | false | default | |||
isForMarketingCampaign | boolean | false | default | |||
isForMarketingEvents | boolean | false | default | |||
isForEmployees | boolean | false | default | . | ||
isForCrm | boolean | false | default | |||
isForDebtCollection | boolean | false | default | |||
isDisabled | boolean | false | default | |||
isBillable | boolean | false | default | |||
enableActionImage | boolean | false | default | |||
defaultEmailSubject | string | false | default | |||
logoFilename | string | false | default | |||
customLogoFilename | string | false | default | |||
customLogoDirectory | string | false | default | |||
customLogoFilesize | integer | false | default | |||
customLogoModifiedTimestamp | timestamp | false | default | |||
templateIdentifier | string | false | default | |||
allowCloseWithOpenInvoice | boolean | false | default | |||
allowInlineCustomizing | boolean | false | default | |||
primaryParticipantType | The primary ParticipantType for the ActionType. | string | true | link | read-only | |
billingPreference | The billing preferences for the ActionType. | string | true | link | Not yet implemented |
Link Templates
Identifier | Resource | Location Template |
---|---|---|
actiontypes.primaryParticipantType | participanttypes | /participanttypes/{actiontypes.primaryParticipantType} |
actiontypes.billingPreference | billingpreferences | /billingpreferences/{actiontypes.billingPreference} |