hris
paycode

Retrieve a paycode

Changed on
get/hris/{connection_id}/paycode/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/paycode/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Paycode

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

company_idstring

(reference to HrisCompany)

namestring
codestring

the payroll system's code for this item

descriptionstring
type'EARNING' | 'DEDUCTION' | 'TAX' | 'CONTRIBUTION' | 'REIMBURSEMENT'
detail_type'EARNING_SALARY' | 'EARNING_OVERTIME' | 'EARNING_TIP' | 'EARNING_BONUS' | 'EARNING_COMMISSION' | 'EARNING_ADJUSTMENT' | 'EARNING' | 'PRETAX_DEDUCTION' | 'PRETAX_DEDUCTION_HEALTH_INSURANCE' | 'PRETAX_DEDUCTION_RETIREMENT' | 'PRETAX_DEDUCTION_HRA' | 'TAX_FEDERAL' | 'TAX_REGION' | 'TAX_LOCAL' | 'POSTTAX_BENEFIT' | 'POSTTAX_GARNISHMENT' | 'REIMBURSEMENT' | 'EARNING_REGULAR' | 'EARNING_DOUBLE_OVERTIME' | 'EARNING_PTO' | 'EARNING_SICK' | 'EARNING_HOLIDAY' | 'EARNING_SEVERANCE' | 'EARNING_REIMBURSEMENT' | 'TAX_SOCIAL_SECURITY' | 'TAX_MEDICARE' | 'TAX_UNEMPLOYMENT' | 'TAX_EMPLOYER' | 'PRETAX_DEDUCTION_HSA' | 'PRETAX_DEDUCTION_FSA' | 'PRETAX_DEDUCTION_DEPENDENT_CARE' | 'PRETAX_DEDUCTION_COMMUTER' | 'PRETAX_DEDUCTION_DENTAL' | 'PRETAX_DEDUCTION_VISION' | 'POSTTAX_DEDUCTION' | 'POSTTAX_RETIREMENT_ROTH' | 'POSTTAX_LOAN_REPAYMENT' | 'EMPLOYER_CONTRIBUTION' | 'PENSION' | 'EARNING_CASH_IN_LIEU'

the normalized payslip-line type this code produces

is_pre_taxboolean
is_employerboolean
is_activeboolean
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 18cdc3570968Revision changes
    • warning

      added the new EARNING_CASH_IN_LIEU enum value to the response property for the response status