Preview the invoice schedule for a contract

Computes and returns the invoice schedule the given contract would produce, without creating the contract or persisting anything.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
date
required
date
required
date
items
array of objects
required
length ≥ 1
items*
invoicing

Mandatory for contracts with scope different than REVENUE_RECOGNITION_ONLY. For contracts with any nonzero contract-level or item-level minimum commitment, the invoice date resolved from this schedule must equal start_date.

usage_configuration
object

Configuration for contracts with usage products.

external_references
array of objects, unique
external_references
uuid
required
uuid
exchange_rate
object

Optional exchange rate for converting the contract currency to the subsidiary currency. If not provided and the contract currency differs from the subsidiary currency, a system default rate will be used.

string
length ≤ 50

Optional purchase order number. When set, it is copied onto every invoice generated by the contract.

invoice_schedule
object

Optional. Omit to use the fully-computed invoice schedule. When provided, it replaces the FIXED billing layout: submit any set of invoices you choose (split, merge, add, or drop). Rules: for each contract item, the sum of its submitted FIXED line totals must equal its computed contract value (redistribution only); every FIXED line must carry its contract_item_id; invoices must have distinct issue_dates, each within the contract period and outside any closed book-close period; for FIXED lines total_amount must equal unit_amount * quantity, and amounts on discounted lines cannot be changed (they may be regrouped, not re-sliced). USAGE and USAGE_COMMITMENT billing is computed by the system and must not be submitted; it is kept unchanged. Revenue recognition and TCV are unaffected. See ContractInvoiceScheduleItem for the per-line rules.

string
enum
required

The "FULL" scope includes revenue recognition and invoicing handled in Rillet. With the "REVENUE_RECOGNITION_ONLY" scope, invoicing is handled outside Rillet.

Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json