Skip to content
Bottle

The rent cylinders out are running at

GET
/stock/rent
curl --request GET \
  --url https://example.com/stock/rent \
  --cookie bottle.session_token=<bottle.session_token>

Every cylinder customers hold today, at its rent, as a monthly figure before VAT: what is billed on a weekly, monthly or quarterly invoice, and what is held by customers invoiced per delivery who pay no rent. A projection that assumes today’s holdings stay.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Rent running now

Media typeapplication/json
object
monthlyPence
required
integer
chargedPence
required
integer
unchargedPence
required
integer
cylinders
required
integer
customers
required
integer
byGasType
required
Array<object>
object
key
required
string
name
required
string
colour
required
string | null
cylinders
required
integer
monthlyPence
required
integer
holders
required
Array<object>
object
customerId
required

UUID v7

string format: uuid
name
required
string
cylinders
required
integer
monthlyPence
required
integer
billingPeriod
required
string | null
Allowed values: weekly monthly quarterly
Example
{
  "holders": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "billingPeriod": "weekly"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}