Skip to content

Export entitlement ledger rows matching the supplied filters as CSV.

GET
/api/workspace/entitlement-operations/ledger/export
curl --request GET \
--url 'https://example.com/api/workspace/entitlement-operations/ledger/export?Operation=0&EntitlementStatus=0&SourceType=0'
  • None
ModelId
string

Optional entitlement model filter.

PlanId
string

Optional entitlement plan filter.

EntitlementId
string

Optional entitlement id filter.

EntitlementNumber
integer format: int64

Optional human-readable entitlement number filter.

PartyEntityInstanceId
string

Optional owner party instance filter.

ResourceEntityInstanceId
string

Optional resource instance filter.

Operation
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8

Optional ledger movement type.

EntitlementStatus
integer format: int32
Allowed values: 0 1 2 3 4 5 6

Optional current entitlement status filter.

SourceType
integer format: int32
Allowed values: 0 1 2 3 4

Optional source type filter.

RenewalOperationId
string

Optional renewal workflow id filter.

OccurredFromUtc
string format: date-time

Optional inclusive occurrence start.

OccurredToUtc
string format: date-time

Optional inclusive occurrence end.

Search
string

Optional search across entitlement number, ids, plan/model names, owner display, reason, source, and correlation.

Page
integer format: int32

One-based page number.

PageSize
integer format: int32

Requested page size.

access_token
string

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

OK

string format: binary

Bad Request

object
Data

CSV export payload for ledger rows.

object
Content
string format: byte
nullable
FileName
string
nullable
ContentType
string
nullable
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

Forbidden

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties