Skip to content
Bottle

Preview scheduled invoices building up

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

A live, unnumbered preview per customer, calculated from the deliveries, cylinder rent and credits currently expected on their next weekly, monthly or quarterly invoice.

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

limit
integer
default: 50 >= 1 <= 200
offset
integer | null
0

Responses

Section titled “Responses”

200

Section titled “200”

Scheduled invoices which currently contain charges or credits

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

UUID v7

string format: uuid
customerName
required
string
billingPeriod
required
string
Allowed values: weekly monthly quarterly
periodFrom
required
string format: date
periodTo
required
string format: date
builtThrough
required
string format: date
issueOn
required
string format: date
orderCount
required
integer
orderIds
required
Array<string>
netPence
required
integer
vatPence
required
integer
totalPence
required
integer
lines
required
Array<object>
object
productId
required

UUID v7

string | null format: uuid
description
required
string
deliveredOn
required
string | null format: date
orderReference
required
string | null
customerReference
required
string | null
<= 100 characters
quantity
required
number
unitPrice
required
integer
priceIncludesVat
required
boolean
vatRate
required
integer
netPence
required
integer
vatPence
required
integer
totalPence
required
integer
total
required
integer

Example 

{
  "items": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "billingPeriod": "weekly",
      "orderIds": [
        "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      ],
      "lines": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ]
}

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