Who owes most

GET

/invoices/owed

const url = 'https://example.com/invoices/owed?limit=10';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/invoices/owed?limit=10' \
  --cookie bottle.session_token=<bottle.session_token>

Unpaid invoices added up by customer, largest first, with how much is past due, and the totals across everybody.

Authorizations

sessionCookie
invoices:read
apiKey
invoices:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

Responses

200

What is owed

application/json

object

items

required

Array<object>

object

customerId

required

UUID v7

string format: uuid

customerName

required

string | null

owedPence

required

integer

overduePence

required

integer

invoices

required

integer

> 0

oldestDueOn

required

string format: date

totalOwedPence

required

integer

totalOverduePence

required

integer

Example

{
  "items": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

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