Contract overview
A contract holds the text of an agreement that Lia turns into a document for an order. This API returns Lia’s global contracts, which apply to every company. A company can also have its own version of a contract; company versions are not returned here.
Each contract has a contract_type, and at most one contract of each type is enabled at a time.
serviceholds the terms of use. When you create an order, thesignatureobject (the customer’s IP address and user agent) is recorded as the customer’s acceptance of the enabledservicecontract.prepaymentsholds the financing contract. After the down payment of an order with a financed payment configuration is paid, Lia generates the order’s financing contract from this text, filling its placeholders with the order’s data.
Contract schema
| Field | Description | Type |
|---|---|---|
| id | Unique identifier (UUID) | String |
| contract_type | Contract type. Can be service, prepayments or installment | String |
| description | The contract text. It can contain HTML markup and placeholders written as %<name>s, which Lia fills with the order’s data when it generates the document; %% stands for a literal %. This API returns the text with its placeholders unfilled | String |
| addendum | Text appended after the description when the document is generated. An empty string when there is none | String |
| availability | Contract availability status. Can be enabled (the contract in use for its type) or disabled | String |
| created_at | Indicates when the record was created in ISO8601 format | String |
| updated_at | Indicates when the record was last updated in ISO8601 format | String |