Skip to content

Get cash revenue

Returns the details of a single cash revenue.

Request

GET /api/oauth/v2/resource/cash-revenues/{uuid}

HeaderValue
AuthorizationBearer {access_token}

URL parameters

ParameterTypeRequiredDescription
uuidstringYesUnique ID of the cash revenue

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

Response fields

FieldTypeDescription
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
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/cash-revenues/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope invoices not present
404not_foundCash revenue not found

Offisy GmbH