Get all user's pay items

Use this endpoint to get pay items for all workers. You can filter the currently available pay items using the "filter" parameter.

Get all user's pay items

GET /get-all-ee-pay-item

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Required	Description
customer_id	string		The unique Marco identifier for your company
lang	string		Pay item language Valid value: EN / ZH
filter	json		Add is_active filter to get current used pay items Filter items: is_active: boolean For Example: {"is_active":true}
pagination	json		Each page returns 50 records. By defualt, the first page data is returned. Example: {"page":2}

Parameter Example

{
  "customer_id": "1",
  "lang": "EN",
  "filter": {
    "is_active": false
  },
  "pagination": {
    "page": 2
  }
}

Response

200

{
    "itemsReceived": 8,
    "curPage": 1,
    "nextPage": null,
    "prevPage": null,
    "offset": 0,
    "pageTotal": 1,
    "items": [
        {
            "id": 2771,
            "pay_item": 357,
            "effective_date": "2024-07-01",
            "end_date": null,
            "gross_net": "Net",
            "customer_id": 1,
            "value": 111,
            "currency": "CNY",
            "frequency": "Monthly",
            "notes": "",
            "user": 17,
            "platform_email": "[email protected]"
            "pay_item_name": "Phone Allowance",
            "pay_item_notes": "Phone Allowance"
        },
        {
            "id": 3152,
            "pay_item": 1435,
            "effective_date": "2024-08-01",
            "end_date": null,
            "gross_net": "Gross",
            "customer_id": 1,
            "value": 10000,
            "currency": "CNY",
            "frequency": "Monthly",
            "notes": "",
            "user": 2232,
            "platform_email": "[email protected]",
            "pay_item_name": "Basic Salary",
            "pay_item_notes": "Basic Salary"
        },
        {
            ...
        }
    ]
}

400