Skip to content

Get invoice

Returns the details of a single invoice, including the full list of positions.

Request

GET /api/oauth/v2/resource/invoices/{uuid}

HeaderValue
AuthorizationBearer {access_token}

URL parameters

ParameterTypeRequiredDescription
uuidstringYesUnique 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

FieldTypeDescription
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
data.positionsArrayInvoice positions (only in the details endpoint)
data.positions[].namestring | nullPosition name
data.positions[].descriptionstring | nullPosition description
data.positions[].quantitynumber | nullQuantity
data.positions[].netnumber | nullNet amount of the position
data.positions[].grossnumber | nullGross amount of the position
data.positions[].vatnumber | nullTax 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

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

Offisy GmbH