Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
DebtScheduleConfigs

List debt schedule configs

Returns the debt schedule configurations of a company. Results are ordered by last modification time, most recent first, and paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page. startUpdatedAt (inclusive) and endUpdatedAt (exclusive) filter by last modification time, which is useful for incremental synchronization.

get/debtscheduleconfigs/{companyId}

Path parameters

companyIdstring required

Query parameters

startUpdatedAtstring date-time

Only return configurations last modified on or after this timestamp (inclusive).

Only return configurations last modified on or after this timestamp (inclusive).

endUpdatedAtstring date-time

Only return configurations last modified before this timestamp (exclusive).

Only return configurations last modified before this timestamp (exclusive).

limitinteger

Maximum number of objects to return in the response. Default 10, maximum 50.

Maximum number of objects to return in the response. Default 10, maximum 50.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page of results. null when there are no more pages.

Example response

{
  "data": [
    {
      "config": {
        "outstandingBalance": 100000,
        "grantedBalance": 120000,
        "totalPeriods": 12,
        "taxRate": 0.02,
        "annualInterestRateOrSpread": 0.045
      },
      "debtSchedulePaymentsCalendar": [
        {
          "period": 1,
          "principalPayment": 8333.33,
          "interestPayment": 416.67,
          "totalPayment": 8750
        }
      ]
    }
  ]
}