Creates a contract

post

https://api.rillet.com/contracts

Rillet supports two contract scope types: FULL and REVENUE_RECOGNITION_ONLY. The selected scope determines how the invoices are created and what information the user needs to provide.

The FULL scope is used when contract invoices are generated and sent directly from Rillet. In this case, Rillet automatically assigns the invoice numbers.

The REVENUE_RECOGNITION_ONLY scope is intended for situations where contracts and invoices are issued from another system and only need to be recorded in Rillet for accounting purposes. In this workflow, users must provide the invoice numbers manually. Other fields can be populated based on the data imported from the external system.

For example, if your organization issues invoices through an external billing platform but tracks financials in Rillet, you should select REVENUE_RECOGNITION_ONLY. If Rillet handles the entire invoicing and sending process, choose the FULL scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

close_date

date

required

start_date

date

required

end_date

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

customer_id

uuid

required

subsidiary_id

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.

purchase_order_number

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.

scope

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultError