Skip to content
1 viewer
View

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.

AboutCode

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

Declared views
PageView idRoleRouteOrderParentEntityNavigation
Equipment rentalrental.indexlist/view/rental/list0RentalUnitin navigation
1 row

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.

Rental.Buyout input
FieldTypeRequiredDescriptionAllowed
unit_idrequired
actoroptional
2 rows
Calls and output

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.

Rental.CheckIn input
FieldTypeRequiredDescriptionAllowed
rental_idrequired
meter_inoptional
fuel_in_pctoptional
dirtyoptional
damageoptional
downoptional
actoroptional
7 rows
Calls and output

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.

Rental.CheckOut input
FieldTypeRequiredDescriptionAllowed
unit_idrequired
due_msoptional
daysoptional
expected_useoptional
waiveroptional
deliveryoptional
pickupoptional
terms_hashoptional
nonceoptional
actoroptional
10 rows
Calls and output

Rental.DropOff

The renter leaves the machine at the yard: billing stops and the return obligation stops counting; the owner still checks it in.

Rental.DropOff input
FieldTypeRequiredDescriptionAllowed
rental_idrequired
actoroptional
2 rows
Calls and output

Rental.Fleet

Every unit with its time and dollar utilization, window revenue, payback, service due and purchase price, filterable by owner, class and status.

Rental.Fleet input
FieldTypeRequiredDescriptionAllowed
owneroptional
classoptional
statusoptional
window_daysoptional
4 rows
Calls and output

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.

Rental.FleetUpsert input
FieldTypeRequiredDescriptionAllowed
unit_idoptional
nameoptional
termsoptional
pay_assetoptional
oecoptional
service_intervaloptional
meter_tenthsoptional
fuel_pctoptional
last_service_tenthsoptional
servicedoptional
statusoptional
actoroptional
12 rows
Calls and output

Rental.Get

One rental with the renter's rental rep, or one unit with its rentals and fleet figures.

Rental.Get input
FieldTypeRequiredDescriptionAllowed
rental_idoptional
unit_idoptional
2 rows
Calls and output
  • 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).

Rental.List input
FieldTypeRequiredDescriptionAllowed
owneroptional
renteroptional
unit_idoptional
statusoptional
qoptional
sortoptional
pageoptional
page_sizeoptional
8 rows
Calls and output

Rental.Pay

Pay down the balance a check-in left past the hold (renter = caller).

Rental.Pay input
FieldTypeRequiredDescriptionAllowed
rental_idrequired
amountoptional
actoroptional
3 rows
Calls and output

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.

Rental.Quote input
FieldTypeRequiredDescriptionAllowed
unit_idrequired
out_msoptional
due_msoptional
daysoptional
expected_useoptional
waiveroptional
deliveryoptional
pickupoptional
renteroptional
9 rows
Calls and output

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.

Rental.ReturnDue input
FieldTypeRequiredDescriptionAllowed
rental_idrequired
1 row
Calls and output
  • 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.

Declared storage
  • Authorityhyper
  • Preferred truthhyper
  • App ownerRental
  • SQL projectionnone · DDL declarations: 0
Hyper vertex kinds read
Hyper vertex kinds written
Hyper edge kinds written
  • None declared.
Asset namespaces read
  • cre8/peer
Asset namespaces minted
  • cre8/equipment
  • cre8/peer
Model warnings
  • No model warnings were reported.

Capabilities and dependencies

Depends on
  • Protocol

Structure review · 1

Warnings · 1
  • Rental · warningAn app with pages needs highlights and getting-started steps for its About page. (incomplete_intro)