Skip to content

List invoices

Returns a paginated list of all invoices of the company. The list contains invoice headers without positions — use the details endpoint to retrieve the full positions list.

Request

GET /api/oauth/v2/resource/invoices

HeaderValue
AuthorizationBearer {access_token}

Query parameters

ParameterTypeRequiredDescription
offsetintegerNoStart position (default: 0, min: 0)
limitintegerNoNumber of results (default: 50, min: 1, max: 200)

Response

Success (200 OK)

json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sequence": 42,
      "formattedSequence": "RE-2026-0042",
      "name": "Invoice for Anna Muster",
      "status": "open",
      "net": 100.00,
      "subTotal": 110.00,
      "gross": 110.00,
      "discount": 0.00,
      "outstandingBalance": 110.00,
      "invoicingDate": "2026-06-01",
      "paidAt": null,
      "timeForPayment": "2026-06-15",
      "isFullyPaid": false,
      "visible": true,
      "comment": null,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      }
    }
  ],
  "meta": {
    "total": 128,
    "offset": 0,
    "limit": 50
  }
}

Response fields

FieldTypeDescription
dataArrayList of invoices
data[].idstring (UUID)Unique ID of the invoice
data[].sequenceinteger | nullSequential invoice number
data[].formattedSequencestring | nullFormatted invoice number
data[].namestring | nullName of the invoice
data[].statusstring | nullInvoice status
data[].netnumber | nullNet amount
data[].subTotalnumber | nullSubtotal
data[].grossnumber | nullGross amount
data[].discountnumber | nullDiscount amount
data[].outstandingBalancenumber | nullOutstanding balance
data[].invoicingDatestring | nullInvoice date (YYYY-MM-DD)
data[].paidAtstring | nullPayment date (YYYY-MM-DD)
data[].timeForPaymentstring | nullPayment due date (YYYY-MM-DD)
data[].isFullyPaidbooleanFully paid
data[].visiblebooleanInvoice visible
data[].commentstring | nullComment on the invoice
data[].customerobject | nullAssigned customer
data[].customer.idstring (UUID)Customer ID
data[].customer.firstNamestringFirst name
data[].customer.lastNamestringLast name
meta.totalintegerTotal number of invoices
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/invoices?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope invoices not present

Offisy GmbH