Skip to content

List cash revenues

Returns a paginated list of all cash revenues of the company.

Request

GET /api/oauth/v2/resource/cash-revenues

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",
      "date": "2026-06-01",
      "receiptNumber": 7,
      "formattedReceiptNumber": "BE-2026-0007",
      "revenue": 55.00,
      "isStorno": false,
      "paymentType": "cash",
      "type": "income",
      "amountGiven": 60.00,
      "cachePaymentMethod": null,
      "stornoMessage": null,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      },
      "invoice": {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
      }
    }
  ],
  "meta": {
    "total": 64,
    "offset": 0,
    "limit": 50
  }
}

Response fields

FieldTypeDescription
dataArrayList of cash revenues
data[].idstring (UUID)Unique ID of the cash revenue
data[].datestring | nullDate of the cash revenue (YYYY-MM-DD)
data[].receiptNumberinteger | nullSequential receipt number
data[].formattedReceiptNumberstring | nullFormatted receipt number
data[].revenuenumber | nullRevenue amount
data[].isStornobooleanReversal entry
data[].paymentTypestring | nullPayment type
data[].typestring | nullType of cash revenue
data[].amountGivennumber | nullAmount given by customer
data[].cachePaymentMethodstring | nullCached payment method
data[].stornoMessagestring | nullReversal reason
data[].customerobject | nullAssigned customer
data[].customer.idstring (UUID)Customer ID
data[].customer.firstNamestringFirst name
data[].customer.lastNamestringLast name
data[].invoiceobject | nullLinked invoice (UUID reference only)
data[].invoice.idstring (UUID)UUID of the linked invoice
meta.totalintegerTotal number of cash revenues
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/cash-revenues?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