Skip to content
Bottle

List invoices

GET
/invoices
curl --request GET \
  --url 'https://example.com/invoices?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&orderId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&status=sent&overdue=true&limit=50&offset=0' \
  --cookie bottle.session_token=<bottle.session_token>

Newest first. Invoices raised for one order paid online, and on each customer’s billing cycle for deliveries on account, cylinder hire and deposits credited back.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 80 characters
customerId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

orderId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

status
string
Allowed values: sent paid void
overdue
string
Allowed values: true false
limit
integer
default: 50 >= 1 <= 200
offset
integer | null
0

Responses

Section titled “Responses”

200

Section titled “200”

Invoices

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
customerId
required

UUID v7

string format: uuid
customerName
required
string | null
billToAddress
required
Array<string>
orderId
required

UUID v7

string | null format: uuid
number
required
string
status
required
string
Allowed values: sent paid void
periodFrom
required
string | null format: date
periodTo
required
string | null format: date
issuedOn
required
string format: date
dueOn
required
string format: date
netPence
required
integer
vatPence
required
integer
totalPence
required
integer
lines
required
Array<object>
object
id
required

UUID v7

string format: uuid
productId
required

UUID v7

string | null format: uuid
description
required
string
quantity
required
number
unitPrice
required
integer
vatRate
required
integer
netPence
required
integer
paymentLink
required
string | null format: uri
paidAt
required
string | null format: date-time
paidVia
required
string | null
Allowed values: stripe cash transfer card office
cashTakenPence
required
integer
sentAt
required
string | null format: date-time
createdAt
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "number": "INV-0042",
      "status": "sent",
      "lines": [
        {
          "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ],
      "paidVia": "stripe"
    }
  ]
}

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