Money

Every invoice, with the contact and unit resolved

One page of the invoices on file, in primary key order, each carrying the name it was raised against and the unit it belongs to, so a list needs no second lookup. limit caps a page and offset moves the window, so a client reads the lot a page at a time until offset + invoices.length reaches total. collection is measured over every invoice falling due this month, never over the page. structuredRef is the key automatic reconciliation matches a bank line on. Every amount is integer cents.

get/api/v1/invoices

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/invoices
  • Auth: API key in cookie better-auth.session_token

Query parameters

limitinteger

How many invoices to return. 1–1000, default 50. The store caps a page at 200, and the limit in the response says what it actually gave.

offsetinteger

How many invoices to skip before counting limit. Default 0. Page with offset = offset + limit until it reaches total.

Response

Invoices and this month’s collection status.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.