REST DocumentationEmployeesGET List an employee's internal rates

List an employee’s internal rates

Returns the paginated list of internal (cost) rates recorded for the given employee. The page size is set with limit.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/employees/{username}/internal-rates
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees/{username}/internal-rates' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

  • Name
    username
    Type
    string
    Description

    The employee username

Query parameters

  • Name
    limit
    Type
    integer, nullable
    Description

    The number of records per page, 1 to 200. Defaults to 15.

  • Name
    page
    Type
    integer, nullable
    Description

    The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "start_date": "2024-01-15T00:00:00.000000Z",
      "internal_rate": 1.5,
      "note": "Familienurlaub",
      "monthly_rate": 1.5,
      "internal_rate_resets": 1.5,
      "rate_type": {
        "id": 1,
        "name": "hourly rate"
      },
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

  • Name
    id
    Type
    integer
    Description

    Unique identifier of the internal rate.

  • Name
    employee_id
    Type
    string
    Description

    Username of the employee this internal rate applies to.

  • Name
    start_date
    Type
    string (date-time)
    Description

    Calendar day this internal rate takes effect from.

  • Name
    internal_rate
    Type
    number, nullable
    Description

    Internal (cost) rate charged for the employee’s time.

  • Name
    note
    Type
    string, nullable
    Description

    Free-text note attached to the internal rate.

  • Name
    monthly_rate
    Type
    number, nullable
    Description

    Fixed monthly rate, used instead of the hourly rate when applicable.

  • Name
    internal_rate_resets
    Type
    number, nullable
    Description

    Interval at which the internal rate resets (e.g. monthly, yearly).

  • Name
    rate_type
    Type
    object, nullable
    Description

    Whether the rate is charged hourly or as a fixed monthly amount.

  • Name
    rate_type.id
    Type
    integer
    Description

    The stored value. Compare against this, not against name.

  • Name
    rate_type.name
    Type
    string
    Description

    The human-readable label, delivered in the tenant’s language. Do not parse it.

    One of: "hourly rate", "daily rate"

  • Name
    created
    Type
    string (date-time), nullable
    Description

    Timestamp the internal rate was created.

  • Name
    modified
    Type
    string (date-time), nullable
    Description

    Timestamp the internal rate was last modified.

Generated from the OpenAPI specification — edit the source code, not this page.