Skip to content

Return one entitlement ledger row.

GET
/api/workspace/entitlement-operations/ledger/{ledgerEntryId}
curl --request GET \
--url https://example.com/api/workspace/entitlement-operations/ledger/example
  • None
ledgerEntryId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Ledger detail row with resource context.

object
Id
string
nullable
EntitlementId
string
nullable
EntitlementNumber
integer format: int64
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
Owner

Compact customer-owned entity instance reference.

object
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
EntityInstanceId
string
nullable
DisplayName
string
nullable
Resources
Array<object>
nullable

Issued resource snapshot shown on entitlement detail.

object
Id
string
nullable
ResourceRoleId
string
nullable
ResourceRoleDisplayName
string
nullable
Resource

Compact customer-owned entity instance reference.

object
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
EntityInstanceId
string
nullable
DisplayName
string
nullable
SortOrder
integer format: int32
Operation
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
EntitlementStatus
integer format: int32
Allowed values: 0 1 2 3 4 5 6
EntitlementEffectiveState
integer format: int32
Allowed values: 0 1 2 3 4 5 6 8
Quantity
number format: double
BalanceAfter
number format: double
nullable
EntitlementLimitId
string
nullable
ReversesLedgerEntryId
string
nullable
RenewalOperationId
string
nullable
ReasonCode
string
nullable
ReasonText
string
nullable
SourceType
integer format: int32
Allowed values: 0 1 2 3 4
SourceData
string
nullable
ActorUserId
string
nullable
Actor

Resolved user or actor display reference for entitlement ledger audit rows.

object
Id

User identifier or stable external actor identifier stored on the ledger row.

string
nullable
DisplayName

Display name resolved from the workspace security cache when available.

string
nullable
Email

User email when available.

string
nullable
AvatarInitials

Avatar initials.

string
nullable
AvatarBackgroundColor

Avatar background color.

string
nullable
AvatarTextColor

Avatar text color.

string
nullable
UserType
integer format: int32
Allowed values: 0 1 2
IsDeleted

Whether the resolved workspace user has been deleted.

boolean
IsMissing

Whether the stored actor identifier no longer resolves to a workspace user.

boolean
OccurredAtUtc
string format: date-time
CorrelationId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Operation": 0,
"EntitlementStatus": 0,
"EntitlementEffectiveState": 0,
"SourceType": 0,
"Actor": {
"UserType": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Ledger detail row with resource context.

object
Id
string
nullable
EntitlementId
string
nullable
EntitlementNumber
integer format: int64
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
Owner

Compact customer-owned entity instance reference.

object
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
EntityInstanceId
string
nullable
DisplayName
string
nullable
Resources
Array<object>
nullable

Issued resource snapshot shown on entitlement detail.

object
Id
string
nullable
ResourceRoleId
string
nullable
ResourceRoleDisplayName
string
nullable
Resource

Compact customer-owned entity instance reference.

object
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
EntityInstanceId
string
nullable
DisplayName
string
nullable
SortOrder
integer format: int32
Operation
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
EntitlementStatus
integer format: int32
Allowed values: 0 1 2 3 4 5 6
EntitlementEffectiveState
integer format: int32
Allowed values: 0 1 2 3 4 5 6 8
Quantity
number format: double
BalanceAfter
number format: double
nullable
EntitlementLimitId
string
nullable
ReversesLedgerEntryId
string
nullable
RenewalOperationId
string
nullable
ReasonCode
string
nullable
ReasonText
string
nullable
SourceType
integer format: int32
Allowed values: 0 1 2 3 4
SourceData
string
nullable
ActorUserId
string
nullable
Actor

Resolved user or actor display reference for entitlement ledger audit rows.

object
Id

User identifier or stable external actor identifier stored on the ledger row.

string
nullable
DisplayName

Display name resolved from the workspace security cache when available.

string
nullable
Email

User email when available.

string
nullable
AvatarInitials

Avatar initials.

string
nullable
AvatarBackgroundColor

Avatar background color.

string
nullable
AvatarTextColor

Avatar text color.

string
nullable
UserType
integer format: int32
Allowed values: 0 1 2
IsDeleted

Whether the resolved workspace user has been deleted.

boolean
IsMissing

Whether the stored actor identifier no longer resolves to a workspace user.

boolean
OccurredAtUtc
string format: date-time
CorrelationId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Operation": 0,
"EntitlementStatus": 0,
"EntitlementEffectiveState": 0,
"SourceType": 0,
"Actor": {
"UserType": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}