Equipment rental reference
1 page, 11 routes, 11 connections and 9 CLI commands, generated from the declarations of Rental without reading storage or running anything.
Code · 0 files
No ingested source sits in a crate named for this app. Either its crate has not been ingested, or the app's name does not match its crate.
Pages · 1
| Page | View id | Role | Route | Order | Parent | Entity | Navigation |
|---|---|---|---|---|---|---|---|
| Equipment rental | rental.index | list | /view/rental/list | 0 | RentalUnit | in navigation |
Connections · 11
Rental.Buyout
Buy an available unit under its purchase option (buyer = caller): the purchase price less the purchase-option credit the buyer's own rentals of it earned, paid to the owner, and the title moves to the buyer.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| unit_id | required | |||
| actor | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/buyoutHTTP route
- rental buyoutCLI command
Rental.CheckIn
Check a rental in (owner = caller) with the meter, fuel, cleaning and damage readings. One commit settles the hold to the owner, refunds what the invoice did not use, mints rental rep for an on-time undamaged return or slashes it per day late, and mints the machine's use (cre8/equipment/{class}/{measure}) to the owner.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| rental_id | required | |||
| meter_in | optional | |||
| fuel_in_pct | optional | |||
| dirty | optional | |||
| damage | optional | |||
| down | optional | |||
| actor | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/check-inHTTP route
- rental check-inCLI command
Rental.CheckOut
Check a unit out (renter = caller) in one all-or-nothing commit: reserve the estimate plus a rep-scaled deposit and schedule Rental.ReturnDue at the due time. A terms_hash the renter accepted must still be the unit's.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| unit_id | required | |||
| due_ms | optional | |||
| days | optional | |||
| expected_use | optional | |||
| waiver | optional | |||
| delivery | optional | |||
| pickup | optional | |||
| terms_hash | optional | |||
| nonce | optional | |||
| actor | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/checkoutHTTP route
- rental checkoutCLI command
Rental.DropOff
The renter leaves the machine at the yard: billing stops and the return obligation stops counting; the owner still checks it in.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| rental_id | required | |||
| actor | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/drop-offHTTP route
- rental drop-offCLI command
Rental.Fleet
Every unit with its time and dollar utilization, window revenue, payback, service due and purchase price, filterable by owner, class and status.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| owner | optional | |||
| class | optional | |||
| status | optional | |||
| window_days | optional |
- Output keyrental.result
- Classificationroute_handler
- GET /rental/fleetHTTP route
- rental fleetCLI command
Rental.FleetUpsert
List a unit (owner = caller) under canonical cre8.rental.v1 terms, or change one you own: terms, pay asset, original equipment cost, service interval, meter, fuel, status. The terms text is hashed onto the unit; rentals already out keep the terms they went out under.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| unit_id | optional | |||
| name | optional | |||
| terms | optional | |||
| pay_asset | optional | |||
| oec | optional | |||
| service_interval | optional | |||
| meter_tenths | optional | |||
| fuel_pct | optional | |||
| last_service_tenths | optional | |||
| serviced | optional | |||
| status | optional | |||
| actor | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/fleet/upsertHTTP route
- rental list-unitCLI command
Rental.Get
One rental with the renter's rental rep, or one unit with its rentals and fleet figures.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| rental_id | optional | |||
| unit_id | optional |
- Output keyrental.result
- Classificationroute_handler
- POST /rental/getHTTP route
Rental.List
Rentals, filterable by owner, renter, unit and status. With page or page_size: one page under the pagination envelope, searchable with q, ordered by sort (newest, status or due).
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| owner | optional | |||
| renter | optional | |||
| unit_id | optional | |||
| status | optional | |||
| q | optional | |||
| sort | optional | |||
| page | optional | |||
| page_size | optional |
- Output keyrental.result
- Classificationroute_handler
- GET /rental/listHTTP route
- rental listCLI command
Rental.Pay
Pay down the balance a check-in left past the hold (renter = caller).
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| rental_id | required | |||
| amount | optional | |||
| actor | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/payHTTP route
- rental payCLI command
Rental.Quote
Price a rental of a unit without committing: the invoice at the due time with the expected meter use, the deposit at the renter's rental rep, and the hold a check-out would reserve.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| unit_id | required | |||
| out_ms | optional | |||
| due_ms | optional | |||
| days | optional | |||
| expected_use | optional | |||
| waiver | optional | |||
| delivery | optional | |||
| pickup | optional | |||
| renter | optional |
- Output keyrental.result
- Classificationreal
- POST /rental/quoteHTTP route
- rental quoteCLI command
Rental.ReturnDue
The return obligation: inside the grace it answers not overdue and retries; past it, a rental still out slashes the renter's rental rep a point per started day late, once.
| Field | Type | Required | Description | Allowed |
|---|---|---|---|---|
| rental_id | required |
- Output keyrental.result
- Classificationreal
- POST /rental/return-dueHTTP route
CLI commands · 9
rental buyout
Buy a unit under its purchase option
rental buyout {"unit_id":"unit-..."}rental check-in
Check a unit in and bill it
rental check-in {"rental_id":"rent-...","meter_in":1290,"fuel_in_pct":75}rental checkout
Check a unit out (reserves the hold, schedules the return)
rental checkout {"unit_id":"unit-...","due_ms":1799020800000,"waiver":true}rental drop-off
Mark a unit dropped off at the yard
rental drop-off {"rental_id":"rent-..."}rental fleet
Fleet utilization, payback and service
rental fleet
rental list
List rentals
rental list
rental list-unit
List or update a unit under canonical rental terms
rental list-unit {"name":"CAT 308 mini excavator","oec":14000000,"terms":{"class":"excavator.mini","day":38000,"grace_minutes":59,"meter":"hours"}}rental pay
Pay the balance a hold did not cover
rental pay {"rental_id":"rent-..."}rental quote
Price a rental window without holding anything
rental quote {"unit_id":"unit-...","out_ms":1798761600000,"in_ms":1799020800000}Schema and data model
Declared storage and kinds. Linked kinds open their app pages.
- Authorityhyper
- Preferred truthhyper
- App ownerRental
- SQL projectionnone · DDL declarations: 0
- RentalRecord
- RentalUnit
- RentalRecord
- RentalUnit
- None declared.
- cre8/peer
- cre8/equipment
- cre8/peer
- No model warnings were reported.
Capabilities and dependencies
- Protocol
Structure review · 1
- Rental · warningAn app with pages needs highlights and getting-started steps for its About page. (incomplete_intro)