Skip to main content
POST
Preview Contract Schedule

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Query Parameters

include_tax
boolean
default:false

Body

application/json
status
enum<string>
required
Available options:
draft,
active,
completed,
terminated,
archived
custom_fields
Custom Fields · object[] | null
memo
string
default:""
Maximum string length: 512
date
string<date>
start_date
string<date>
end_date
string<date> | null
company_id
integer | null
customer_id
integer | null
name
string
default:""
Maximum string length: 128
currency_iso_4217_code
enum<string>
default:USD
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
YER,
ZAR,
ZMW,
ZWL
bill_to_address
string
default:""
billing_address
AddressSchemaIn · object | null
ship_to_address
string
default:""
shipping_address
AddressSchemaIn · object | null
obligations
PerformanceObligationIn · object[]
term_id
integer | null
default_ar_account_id
integer | null
unbilled_receivable_account_id
integer | null
contract_template_id
integer | null
billing_start_date
string<date> | null
billing_frequency
enum<string>
default:monthly
Available options:
one_time,
daily,
weekly,
monthly,
quarterly,
semi_annually,
annually
billing_interval
integer
default:1
Required range: x >= 1
billing_anchor_weekday
integer | null

Optional weekday anchor for weekly billing (0=Monday)

Required range: 0 <= x <= 6
recognition_start_date
string<date> | null
recognition_frequency
enum<string>
default:monthly
Available options:
daily,
weekly,
monthly,
quarterly,
semi_annually,
annually
recognition_interval
integer
default:1
Required range: x >= 1
recognition_anchor_weekday
integer | null

Optional weekday anchor for weekly recognition (0=Monday)

Required range: 0 <= x <= 6
recognition_mode
enum<string>
default:individual
Available options:
individual,
subledger
contract_attachments
AttachmentSchemaOut · object[]
change_orders_attachments
AttachmentSchemaOut · object[]
payment
PaymentSchemaIn · object | null

Schema for payment collection configuration input (matches frontend structure).

prepared_invoices
InvoiceSchemaCreateIn · object[]
revenue_recognitions
RevenueRecognitionSchemaCreateIn · object[]
cutover_date
string<date> | null
prior_recognized_amount
Required range: x >= 0
default_early_termination_fee
Required range: x >= 0
discount_type
enum<string> | null

Type of discount applied to the full contract. Send PERCENTAGE. Fixed contract discounts are not supported.

Available options:
PERCENTAGE,
FIXED
discount_value

Discount percentage for the full contract. For example, send 10 for 10 percent.

Required range: 0 < x <= 100

Response

OK

allocations
ObligationAllocationOut · object[]
required
billing_schedules
ObligationBillingScheduleOut · object[]
required
recognition_schedules
ObligationRecognitionScheduleOut · object[]
required
summary
RevRecSummaryRowOut · object[]
required
metrics
ContractMetricsSchemaOut · object
required
renewed_end_date
string<date> | null
next_renewal_date
string<date> | null
cutover_date
string<date> | null
prior_recognized_amount
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$