Add new pay item for a user

This API endpoint can add new pay itemto your worker. Before you use this endpoint, you can get pay item name form the endpoint Get pay item by country.

Add new pay item

POST /add-ee-pay-item

Headers

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

Body

Name	Type	Required	Description
customer_id	number		The unique Marco identifier for your company
email	string		Account email of the user
pay_item_name	string		Pay item name You can get pay item name from the API: Data Cloud -> Get pay item by country
pay_item_country	string		Pay item country Country Code Format: "US" (use ISO 3166 Alpha-2 code)
lang	string		Pay Item language Valid value: EN / ZH
effective_date	date		Pay item effective date
end_date	date		Pay item end date
frequency	string		Format as Hourly Daily Weekly Bi-weekly Semi-Monthly Monthly Quarterly Half-Yearly Yearly One-Time
type	string		Format as Gross Net CTC
currency	string		The currency of this pay item
amount	number		The amount of this pay item

Parameter Example

{
  "customer_id": "1",
  "email": "[email protected]",
  "pay_item_name": "Basic Salary",
  "pay_item_country": "US",
  "lang": "EN",
  "effective_date": "2024-08-02",
  "end_date": null,
  "frequency": "Monthly",
  "type": "Gross",
  "currency": "USD",
  "amount": "2000"
}

Response

200

{
    "id": 3661,
    "pay_item": 1864,
    "effective_date": "2024-08-02",
    "end_date": null,
    "gross_net": "Gross",
    "customer_id": 1,
    "value": 2000,
    "currency": "USD",
    "frequency": "Monthly",
    "notes": "",
    "user": 2232,
    "platform_email": "[email protected]"
}

400