Fixed hourly pays API

Content

Fixed hourly pays collection:

• [GET] index

Single Fixed hourly pay

• [GET] Fixed hourly pay detail
• [POST] Create fixed hourly pay
• [DELETE] Delete fixed hourly pay

Fixed hourly pays collection

Fixed hourly pays index

GET /api/v0/fixed-hourly-pays

Request

Index behaviour	Definition
Paginated by default	No
Sorting	No
Filters	No
Embedded	-

GET /api/v0/fixed-hourly-pays HTTP/1.1
Content-Type: application/json

Response

200 OK

GET /api/v0/fixed-hourly-pays HTTP/1.1
Content-Type: application/json

{
    "items": [
        {
            "id": 4,
            "price": {
                "CZK": {
                    "value": 200,
                    "formatted": "200,00 Kč"
                }
            },
            "valid_from": "2020-12-31T23:00:00.000000Z",
            "valid_to": null,
            "created_at": "2022-11-30T13:18:19+0100",
            "updated_at": "2022-11-30T13:18:19+0100",
            "_links": [
                {
                    "href": "/api/v0/fixed-hourly-pays/4",
                    "rel": "self",
                    "type": "GET"
                }
            ]
        }
    ]
}

---

Fixed hourly pay detail

GET /api/v0/fixed-hourly-pays/{fixed_hourly_pay_id}

Request

Index behaviour	Definition
Paginated by default	No
Sorting	No
Filters	No
Embedded	-

GET /api/v0/fixed-hourly-pays/4 HTTP/1.1
Content-Type: application/json

Response

200 OK

GET /api/v0/fixed-hourly-pays/4 HTTP/1.1
Content-Type: application/json

{
    "id": 2,
    "value": 100,
    "currency_id": "CZK",
    "valid_from": "2020-12-31T23:00:00.000000Z",
    "valid_to": null,
    "created_at": "2022-11-30T16:58:40+0100",
    "updated_at": "2022-11-30T16:58:40+0100",
    "_links": [
        {
            "href": "/api/v0/fixed-hourly-pays/2",
            "rel": "self",
            "type": "GET"
        }
    ]
}

---

Create fixed hourly pay

POST /api/v0/fixed-hourly-pays

Request

Param	Type	Description	Requirements
value	decimal	Amount in currency	Required. Must be minimum 0 digits, max 20 digits
currency_id	string	Currency ID	Required. Must be string of 3 characters
valid_from	date	Date from hourly pay is valid	Required.
valid_to	date	Date to hourly pay is valid	Present. Could be empty. this means that this hourly pay is current.

POST /api/v0/fixed-hourly-pays HTTP/1.1
Content-Type: application/json

Response

200 OK

POST /api/v0/fixed-hourly-pays HTTP/1.1
Content-Type: application/json

{
    "id": 3,
    "value": 100,
    "currency_id": "CZK",
    "valid_from": "2019-12-31T23:00:00.000000Z",
    "valid_to": "2020-12-30T23:00:00.000000Z",
    "created_at": "2022-11-30T17:00:55+0100",
    "updated_at": "2022-11-30T17:00:55+0100",
    "_links": [
        {
            "href": "/api/v0/fixed-hourly-pays/3",
            "rel": "self",
            "type": "GET"
        }
    ]
}

---

Delete fixed hourly pay

DELETE /api/v0/fixed-hourly-pays/1

Request

DELETE /api/v0/fixed-hourly-pays/1 HTTP/1.1
Content-Type: application/json

Response

204 No content