Skip to main content
POST
/
quantlib
/
scheduling
/
schedule
/
generate
Generate Schedule
curl --request POST \
  --url https://finceptbackend.share.zrok.io/quantlib/scheduling/schedule/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "effective_date": "2024-01-15",
  "termination_date": "2026-01-15",
  "frequency": "Semi-Annual",
  "calendar": "Weekend",
  "adjustment": "Modified Following",
  "stub": "Short Front"
}
'
{
  "success": true,
  "data": {
    "effective_date": "2024-01-15",
    "termination_date": "2026-01-15",
    "frequency": "Semi-Annual",
    "total_periods": 4,
    "periods": [
      {
        "start_date": "2024-01-15",
        "end_date": "2024-07-15",
        "payment_date": "2024-07-15"
      },
      {
        "start_date": "2024-07-15",
        "end_date": "2025-01-15",
        "payment_date": "2025-01-15"
      },
      {
        "start_date": "2025-01-15",
        "end_date": "2025-07-15",
        "payment_date": "2025-07-15"
      },
      {
        "start_date": "2025-07-15",
        "end_date": "2026-01-15",
        "payment_date": "2026-01-15"
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your key at https://finceptbackend.share.zrok.io/auth/register

Body

application/json
​
effective_date
string<date>
required

Start date of the schedule (issue date) in ISO format (YYYY-MM-DD)

Example:

"2024-01-15"

​
termination_date
string<date>
required

End date of the schedule (maturity date) in ISO format (YYYY-MM-DD)

Example:

"2026-01-15"

​
frequency
enum<string>
default:Semi-Annual

Payment frequency. Determines how often coupon/interest payments occur

Available options:
Annual,
Semi-Annual,
Quarterly,
Monthly
Example:

"Semi-Annual"

​
calendar
enum<string>
default:Weekend

Calendar for business day adjustments

Available options:
US,
UK,
TARGET,
Japan,
Weekend
Example:

"Weekend"

​
adjustment
enum<string>
default:Modified Following

Business day adjustment convention for payment dates

Available options:
Following,
Modified Following,
Preceding,
Modified Preceding,
Unadjusted
Example:

"Modified Following"

​
stub
enum<string>
default:Short Front

Stub period convention if the schedule doesn't divide evenly

Available options:
Short Front,
Short Back,
Long Front,
Long Back
Example:

"Short Front"

Response

Successful Response

​
success
boolean
Example:

true

​
data
object