Skip to content

Preview Payment Installments

POST
/quotes/payment-installments

Installment amounts from percentages, and the balance left. Arithmetic over the body.

Reads nothing and writes nothing; persist installments through the create or update quote routes. remaining_cents is the part of total_cents the installments do not cover.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Work out installment amounts from percentages. Mirrors QuotePaymentInstallmentsDTO.

Arithmetic over the body: nothing is read or written.

object
installments
required
Array<object>

One installment of a payment schedule. Mirrors PaymentInstallmentDTO.

due_type is milestone (free-text due_label) or date (ISO date as due_label).

object
amount_cents
required
integer
<= 1000000000
due_label
required
string
<= 200 characters
due_type
required
string
Allowed values: milestone date
id
required
string
>= 1 characters <= 50 characters
percentage
required
Any of:
number
sort_order
required
integer
total_cents
required
integer
<= 1000000000

Responses

200

Successful Response

object
data
required

An open envelope for a quote, template, contact or job result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string