---
updatedAt: 2026-04-27T15:52:51.000Z
agentTools:
siteIndex: https://developer.paylocity.com/llms.txt
projectIndex: https://developer.paylocity.com/integrations/llms.txt
---
# Get Earning by Earning Code and Start Date
Get Earnings returns the single earning with the provided earning code and start date for the selected employee.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "WebLink API",
"description": "For documentation about this API, please visit https://developer.paylocity.com/integrations/reference/weblink-overview",
"contact": {
"email": "webservices@paylocity.com"
},
"version": "v2"
},
"servers": [
{
"url": "https://dc1demogw.paylocity.com/api"
}
],
"paths": {
"/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}": {
"get": {
"tags": [
"Earnings"
],
"summary": "Get Earning by Earning Code and Start Date",
"description": "Get Earnings returns the single earning with the provided earning code and start date for the selected employee.",
"x-explorer-enabled": false,
"operationId": "Get Earning by Earning Code and Start Date",
"parameters": [
{
"name": "companyId",
"in": "path",
"description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n **Allowable Values:**\r\n 9 char max",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employeeId",
"in": "path",
"description": "The Paylocity Employee ID. This is a unique value per Paylocity Company ID.\r\n**Allowable Values:**\r\n10 char max",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "earningCode",
"in": "path",
"description": "Earning Code",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "startDate",
"in": "path",
"description": "Start Date",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/earning"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "The employee does not exist, or the specified earningCode-startDate combination does not exist",
"content": {}
},
"429": {
"description": "Too Many Requests",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
}
}
}
}
}
},
"security": [
{
"paylocity_auth": [
"WebLinkAPI"
]
}
]
}
}
},
"components": {
"schemas": {
"error": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The name of the field, or property in the request message that contains an error."
},
"message": {
"type": "string",
"description": "The error message."
},
"options": {
"type": "array",
"description": "A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code associated with this option."
},
"description": {
"type": "string",
"description": "The description of the option."
}
},
"description": "The error option model"
}
},
"path": {
"type": "string",
"description": "The JSON path of the field, or property, that contains an error in the request message."
}
},
"description": "The error model"
},
"earning": {
"required": [
"earningCode",
"startDate"
],
"type": "object",
"properties": {
"agency": {
"type": "string",
"description": "Third-party agency associated with earning. Must match Company setup.
Max length: 10"
},
"amount": {
"type": "number",
"description": "Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%).
Decimal(12,2)"
},
"annualMaximum": {
"type": "number",
"description": "Year to Date dollar amount not to be exceeded for an earning in the calendar year. Used only with company driven maximums.
Decimal(12,2)"
},
"calculationCode": {
"type": "string",
"description": "Defines how earnings are calculated. Common values are *% (percentage of gross), flat (flat dollar amount)*. Defaulted to the Company setup calcCode for earning.
Max length: 20"
},
"costCenter1": {
"type": "string",
"description": "Cost Center associated with earning. Must match Company setup.
Max length: 10"
},
"costCenter2": {
"type": "string",
"description": "Cost Center associated with earning. Must match Company setup.
Max length: 10"
},
"costCenter3": {
"type": "string",
"description": "Cost Center associated with earning. Must match Company setup.
Max length: 10"
},
"earningCode": {
"type": "string",
"description": "Earning code. Must match Company setup.
Max length: 10"
},
"effectiveDate": {
"type": "string",
"description": "Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD.",
"format": "paylocity-date"
},
"endDate": {
"type": "string",
"description": "Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.",
"format": "paylocity-date"
},
"frequency": {
"type": "string",
"description": "Needed if earning is applied differently from the payroll frequency (one time earning for example).
Max length: 5"
},
"goal": {
"type": "number",
"description": "Dollar amount. The employee earning will stop when the goal amount is reached.
Decimal(12,2)"
},
"hoursOrUnits": {
"type": "number",
"description": "The value is used in conjunction with the Rate field. When entering Group Term Life Insurance (GTL), it should contain the full amount of the group term life insurance policy.
Decimal(12,2)"
},
"isSelfInsured": {
"type": "boolean",
"description": "Used for ACA. If not entered, defaulted to Company earning setup."
},
"jobCode": {
"type": "string",
"description": "Job code associated with earnings. Must match Company setup.
Max length: 20"
},
"miscellaneousInfo": {
"type": "string",
"description": "Information to print on the check stub if agency is set up for this earning.
Max length: 50"
},
"paidTowardsGoal": {
"type": "number",
"description": "Amount already paid to employee toward goal.
Decimal(12,2)"
},
"payPeriodMaximum": {
"type": "number",
"description": "Maximum amount of the earning on a single paycheck.
Decimal(12,2)"
},
"payPeriodMinimum": {
"type": "number",
"description": "Minimum amount of the earning on a single paycheck.
Decimal(12,2)"
},
"rate": {
"type": "number",
"description": "Rate is used in conjunction with the hoursOrUnits field.
Decimal(12,2)"
},
"rateCode": {
"type": "string",
"description": "Rate Code applies to additional pay rates entered for an employee. Must match Company setup.
Max length: 10"
},
"startDate": {
"type": "string",
"description": "Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.",
"format": "paylocity-date"
}
},
"additionalProperties": false,
"description": "The employee earning model"
}
},
"securitySchemes": {
"paylocity_auth": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.paylocity.com/IdentityServer/connect/token",
"scopes": {
"WebLinkAPI": "Web Link Api"
}
}
}
}
}
},
"x-original-swagger-version": "2.0"
}
```