Skip to content
Bottle

What was invoiced, month by month

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

Invoices issued between two days, split into goods, rent, deposits and delivery charges, a row per calendar month, with what of it has been paid. Cancelled invoices are left out. Defaults to the last twelve months.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from

First day, inclusive.

string format: date

First day, inclusive.

to

Last day, inclusive.

string format: date

Last day, inclusive.

Responses

Section titled “Responses”

200

Section titled “200”

What was invoiced

Media typeapplication/json
object
from
required
string format: date
to
required
string format: date
months
required
Array<object>
object
goodsPence
required
integer
rentPence
required
integer
depositPence
required
integer
deliveryPence
required
integer
netPence
required
integer
vatPence
required
integer
grossPence
required
integer
invoices
required
integer
month
required
string
totals
required
object
goodsPence
required
integer
rentPence
required
integer
depositPence
required
integer
deliveryPence
required
integer
netPence
required
integer
vatPence
required
integer
grossPence
required
integer
invoices
required
integer
paidPence
required
integer
outstandingPence
required
integer
Example
{
  "months": [
    {
      "month": "2026-09"
    }
  ]
}

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"
    }
  ]
}