Skip to main content
POST
Preview recognition schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ledger_id
string
required

Ledger identifier.

amount
string
required

Deferred amount in minor ledger-currency units.

Pattern: ^\d+(\.\d+)?$
method
enum<string>
required

Recognition method to preview.

Available options:
point_in_time,
over_time
recognition_date
string<date> | null

Recognition date for point-in-time recognition.

window
object | null

Service window for over-time recognition.

granularity
enum<string> | null

Slice granularity for over-time recognition.

Available options:
day,
month,
quarter,
year

Response

200 - application/json
slices
object[]
required

Recognition slices in the preview.

total
string
required

Total amount covered by the preview.