Get invoice
Returns the details of a single invoice, including the full list of positions.
Request
GET /api/oauth/v2/resource/invoices/{uuid}
Header
| Header | Value |
|---|---|
Authorization | Bearer {access_token} |
URL parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Unique ID of the invoice |
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"
},
"positions": [
{
"name": "Consultation",
"description": "General consultation",
"quantity": 1,
"net": 50.00,
"gross": 55.00,
"vat": 10
},
{
"name": "Ultrasound",
"description": null,
"quantity": 1,
"net": 50.00,
"gross": 55.00,
"vat": 10
}
]
}
}Response fields
| Field | Type | Description |
|---|---|---|
data.id | string (UUID) | Unique ID of the invoice |
data.sequence | integer | null | Sequential invoice number |
data.formattedSequence | string | null | Formatted invoice number |
data.name | string | null | Name of the invoice |
data.status | string | null | Invoice status |
data.net | number | null | Net amount |
data.subTotal | number | null | Subtotal |
data.gross | number | null | Gross amount |
data.discount | number | null | Discount amount |
data.outstandingBalance | number | null | Outstanding balance |
data.invoicingDate | string | null | Invoice date (YYYY-MM-DD) |
data.paidAt | string | null | Payment date (YYYY-MM-DD) |
data.timeForPayment | string | null | Payment due date (YYYY-MM-DD) |
data.isFullyPaid | boolean | Fully paid |
data.visible | boolean | Invoice visible |
data.comment | string | null | Comment on the invoice |
data.customer | object | null | Assigned customer |
data.customer.id | string (UUID) | Customer ID |
data.customer.firstName | string | First name |
data.customer.lastName | string | Last name |
data.positions | Array | Invoice positions (only in the details endpoint) |
data.positions[].name | string | null | Position name |
data.positions[].description | string | null | Position description |
data.positions[].quantity | number | null | Quantity |
data.positions[].net | number | null | Net amount of the position |
data.positions[].gross | number | null | Gross amount of the position |
data.positions[].vat | number | null | Tax rate in percent |
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/invoices/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
-H "Authorization: Bearer {access_token}"Parameter
Zuerst Token anfordern
Possible errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_client | Invalid or missing access token |
| 403 | insufficient_scope | Scope invoices not present |
| 404 | not_found | Invoice not found |