Rate groups
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all rate groups, filtered by unique identifiers and other filters. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/rateGroups/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
RateGroupIds
array of string
optional, max 1000 items
ServiceIds
array of string
optional, max 1000 items
ExternalIdentifiers
array of string
optional, max 1000 items
UpdatedUtc
optional, max length 3 months
ActivityStates
optional
Whether to return only active, only deleted or both records.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
RateGroups
required, max 1000 items
The filtered rate groups.
Cursor
string
optional
Id
string
required
Unique identifier of the rate group.
ServiceId
string
required
IsActive
boolean
required
Whether the rate group is still active.
CreatedUtc
string
required
Creation date and time of the rate group in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the rate group in UTC timezone in ISO 8601 format.
Ordering
integer
required
Ordering of the rate group.
Names
required
All translations of the name.
ShortNames
optional
All translations of the short name.
Descriptions
optional
All translations of the description.
ExternalIdentifier
string
optional, max length 255 characters
Identifier of the rate group from external system.
Unique identifiers of the . Required if ServiceIds filter is not provided.
Unique identifiers of the . Required if RateGroupIds filter is not provided.
Identifiers of from external systems.
array of
array of
Unique identifier of the last and hence oldest rate group returned. This can be used in in a subsequent request to fetch the next batch of older rate groups.
Unique identifier of the the rate group belongs to.