Create Employee Earning

POST

https://api.paylocity.com/apiHub/payroll/v1/companies/:companyId/employees/:employeeId/earnings

POST

/apiHub/payroll/v1/companies/:companyId/employees/:employeeId/earnings

curl -X POST https://api.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/earnings \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "effectiveFrom": "<dateTime>",
  "effectiveTo": "<dateTime>",
  "amount": "<double>",
  "rate": "<double>",
  "units": "<double>",
  "selfInsured": "<boolean>",
  "calculationCode": "<string>",
  "frequency": "<string>",
  "agency": "<string>",
  "miscellaneousInfo": "<string>",
  "rateCode": "<string>",
  "distribution": {
    "jobCode": "<string>",
    "costCenters": [
      {
        "level": "<integer>",
        "code": "<string>",
        "non__a": {}
      },
      {
        "level": "<integer>",
        "code": "<string>",
        "laborisa82": {}
      }
    ]
  },
  "limits": {
    "goal": "<double>",
    "paidToDate": "<double>",
    "payPeriodMinimum": "<double>",
    "payPeriodMaximum": "<double>",
    "annualMaximum": "<double>"
  },
  "code": "<string>"
}'

200Successful

{}

Summary Description

This function will allow the API user to create a new earning on the employee record.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

employeeIdstringRequired

Request

This endpoint expects an object.

Response

Successful response