Rentals

Contract

Rental contract.

Schemas: ContractDto

{
  "id": "id_8f2a1c",
  "contractNumber": "string",
  "status": "draft",
  "operativeStatus": "pending",
  "signed": true,
  "signedAt": "2026-09-01T08:00:00Z",
  "contactId": "string",
  "orderId": "string",
  "orderNumber": "string",
  "projectId": "string",
  "contractDate": "2026-09-01T08:00:00Z",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "grossPrice": "1234.50",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A rental contract with its document status (status) and its signature status (operativeStatus), which move separately: validating a contract does not sign it. It points to the order, the contact and the project it belongs to. The legal clauses and the tax snapshot of the customer are not published. Contracts are bounded to the subscription that owns the key.

Attributes

idstring

Unique contract identifier.

contractNumberstring | null

Contract number, for example "C260001"; null while it is a draft.

statusstring

Document status.

Available options: draft, validated, voided

operativeStatusstring

Signature status.

Available options: pending, signed, cancelled

signedboolean

true if the contract is recorded as signed. This is what decides whether the equipment can go out.

signedAtstring<date-time> | null

Signature date in ISO 8601 UTC; null if not signed.

contactIdstring | null

Customer identifier; null in drafts without a customer.

orderIdstring | null

Associated order; null if it has none.

orderNumberstring | null

Number of the associated order; null if it has none.

projectIdstring | null

Associated project; null if it has none.

contractDatestring<date-time> | null

Contract date in ISO 8601 UTC; null if not set.

startDatestring<date-time> | null

Start of validity in ISO 8601 UTC; null if not applicable.

endDatestring<date-time> | null

End of validity in ISO 8601 UTC; null if not applicable.

grossPricestring | null

Total amount including taxes as a decimal string "1234.50"; null if not applicable.

Limits: pattern ^-?\d+\.\d{2}$

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

Values

status: draft, validated, voided
operativeStatus: pending, signed, cancelled

Returned by

GET /api/v1/contracts — List contracts
GET /api/v1/contracts/{contractId} — Get a contract

Modified by

POST /api/v1/contracts/{contractId}/validate — Validate a contract
POST /api/v1/contracts/{contractId}/sign — Record the signature of a contract
POST /api/v1/contracts/{contractId}/void — Void a contract
POST /api/v1/contracts/{contractId}/cancel — Cancel a contract operatively

Was this page helpful?

Example

Attributes

Values

Returned by

Modified by