Skip to main content
GET
Retrieve forecast types

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

successful operation

amountOrDatePropertyRestrictedForUser
boolean
required

A boolean indicating whether the amount or date property is restricted for the user.

amountProperty
string
required

The property used to represent the amount in the forecast, specified as a string.

createdAt
string<date-time>
required

The date and time when the forecast type was created, in ISO 8601 format.

createdAtTimestamp
integer<int64>
required

An integer representing the timestamp of creation, in milliseconds since the Unix epoch.

createdBy
integer<int32>
required

An integer representing the ID of the user who created the forecast type.

dateProperty
string
required

The property used to represent the date in the forecast, specified as a string.

defaultType
boolean
required

A boolean indicating whether this forecast type is the default.

forecastName
string
required

The name of the forecast type, represented as a string.

forecastTypeId
integer<int64>
required

An integer identifier for the forecast type.

id
string
required

A string identifier for the forecast type setting.

objectTypeId
string
required

A string identifier for the object type associated with the forecast.

updatedAt
string<date-time>
required

The date and time when the forecast type was last updated, in ISO 8601 format.

updatedBy
integer<int32>
required

An integer representing the ID of the user who last updated the forecast type.

updatedTimestamp
integer<int64>
required

An integer representing the timestamp of the last update, in milliseconds since the Unix epoch.

amountInHomeCurrencyProperty
string

A string representing the property for the amount in the home currency.

dealSplitProperties
object
weightedAmountInHomeCurrencyProperty
string

A string representing the property for the weighted amount in the home currency.

weightedAmountProperty
string

The property representing the weighted amount, specified as a string.

Last modified on March 31, 2026