ConnectCloud Developers

The rate table (hr:work:billing)

GET /api/hr/v1/work-rates

Module: HR · operationId: listWorkRates · Tag: Work billing · Auth: access token (Authorization: Bearer <accessToken>)

Responses

  • 200 Rates (application/json)
  • 403 Error (application/json)

Fields of the 200 answer:

  • items (array of WorkRate, required): Rows of the rate table
    • scope (string, required): What the rate applies to; a project rate comes first, then contract, customer, default (one of default, customer, contract, project)
    • createdAt (string (date-time), read-only): When the rate was created
    • flatRateArticle (WorkArticleRef | null): Only on project rows
    • id (string (uuid), read-only): Id of the rate
    • kind (string): Work kind key; empty for every kind
    • label (string): Name shown in the table
    • rate (number, nullable): Net hourly rate; null on a project row that names only the flat-rate article
    • scopeRef (string): The customer or contract id, the project reference (desk:project:<id>); empty for default
    • updatedAt (string (date-time), read-only): When the rate was last changed
    • updatedBy (string, read-only): Who last changed the rate (e-mail)
    • validFrom (string (date), nullable): First work date the rate applies to; null always
    • version (integer): Version for optimistic locking: send the version you read with a change (stale: 409 version_conflict)

Example 200 answer:

{
  "items": [
    {
      "createdAt": "2025-01-08T09:00:00Z",
      "id": "7d9f1b3d-5f7b-4d9f-9b3d-5f7b9d1f3b74",
      "kind": "",
      "label": "Standard",
      "rate": 105,
      "scope": "default",
      "scopeRef": "",
      "updatedAt": "2026-01-02T09:00:00Z",
      "updatedBy": "christina.adler@muster-it.example",
      "validFrom": null,
      "version": 2
    },
    {
      "createdAt": "2025-01-08T09:00:00Z",
      "id": "9f1b3d5f-7b9d-4f1b-9d5f-7b9d1f3b5d75",
      "kind": "onsite",
      "label": "Standard Vor Ort",
      "rate": 115,
      "scope": "default",
      "scopeRef": "",
      "updatedAt": "2025-01-08T09:00:00Z",
      "updatedBy": "christina.adler@muster-it.example",
      "validFrom": null,
      "version": 1
    },
    {
      "createdAt": "2025-12-15T10:00:00Z",
      "id": "3f5b7d9f-1b3d-4f5b-8d9f-1b3d5f7b9d73",
      "kind": "",
      "label": "Kanzlei Hofmann \u0026 Partner",
      "rate": 95,
      "scope": "customer",
      "scopeRef": "1b3d5f7b-9d1f-4b3d-8f5b-9d1f3b5d7f50",
      "updatedAt": "2025-12-15T10:00:00Z",
      "updatedBy": "christina.adler@muster-it.example",
      "validFrom": "2026-01-01",
      "version": 1
    },
    {
      "createdAt": "2026-09-15T14:00:00Z",
      "flatRateArticle": {
        "articleNumber": "DL-PAUSCH-VO",
        "id": "6b8d0f2b-4d6f-4b8d-9f2b-4d6f8b0d2f77",
        "name": "Pauschale Vor-Ort-Einsatz",
        "unit": "Stk"
      },
      "id": "1b3d5f7b-9d1f-4b3d-8f5b-9d1f3b5d7f76",
      "kind": "",
      "label": "PRJ-3 Netzwerkerneuerung Donau Maschinenbau",
      "rate": null,
      "scope": "project",
      "scopeRef": "desk:project:5b7d9f1b-3d5f-4b7d-8f1b-3d5f7b9d1f69",
      "updatedAt": "2026-09-15T14:00:00Z",
      "updatedBy": "christina.adler@muster-it.example",
      "validFrom": null,
      "version": 1
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/hr/v1/work-rates' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI