contracts

Append commitment schedule

post/v3/contracts/{id}/commitments/{commitmentId}/schedules

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/commitments/{commitmentId}/schedules
  • Auth: API key in header Authorization

Path parameters

idstring required

Contract Id

commitmentIdstring required

Commitment Id

Request body

startDatestring required

Schedule start date (YYYY-MM-DD, inclusive). Must be the day after the previous schedule's endDate on the commitment.

endDatestring required

Schedule end date (YYYY-MM-DD, inclusive). The last day the schedule covers.

commitmentInterval'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'YEARLY'

Commitment period interval for the schedule

prepaymentScheduleType'FULL_UPFRONT' | 'PER_COMMITMENT_PERIOD' | 'SPLIT_ACROSS_BILLING_PERIODS'

Prepayment schedule type

Response

Schedule appended

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.