Retrieve a payslip

GET/hris/{connection_id}/payslip/{id}

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Payslip

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNothe employee (reference to HrisEmployee)
company_idstringNo(reference to HrisCompany)
payment_referencestringNo
payment_typeenumNoValues: DIRECT, CHEQUE, CASH
paid_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystringNo
gross_amountnumberNo
net_amountnumberNo
detailsHrisPayslipDetail[]No
details[].typeenumNoValues: 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
details[].namestringNo
details[].descriptionstringNo
details[].amountnumberYes
details[].employee_amountnumberNo
details[].company_amountnumberNo
details[].hoursnumberNo
details[].rate_amountnumberNopay rate for hourly/unit-based lines
details[].ytd_amountnumberNoyear-to-date amount for this line
details[].is_pre_taxbooleanNo
details[].is_employerbooleanNotrue when this line is paid by the employer (employer tax or contribution)
details[].paycode_idstringNothe hris_paycode for this line
details[].benefit_idstringNo
details[].deduction_idstringNo
details[].original_typestringNointegration pay-code label before normalization
deductionobjectNoThe ID (and optionally name) of the employee deduction (if this detail represents a deduction)
deduction.idstringNo
deduction.created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
deduction.updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
deduction.user_idstringNoemployee ID (reference to HrisEmployee)
deduction.company_idstringNo(reference to HrisCompany)
deduction.benefit_idstringNo
deduction.amountnumberNopercentage or absolute amount (employee's portion)
deduction.typeenumNoValues: FIXED, PERCENTAGE
deduction.coverage_levelenumNoLevel selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other) Values: EMPLOYEE_ONLY, EMPLOYEE_SPOUSE, EMPLOYEE_CHILD, EMPLOYEE_CHILDREN, EMPLOYEE_FAMILY, FAMILY, OTHER
deduction.frequencyenumNoFrequency for this deduction (should always be set, matches IHrisBenefit.frequency) Values: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY
deduction.start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
deduction.end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
deduction.is_activebooleanNo
deduction.notesstringNo
deduction.employer_amountnumberNopercentage or absolute amount (employer's portion/match)
deduction.employer_typeenumNoValues: PERCENTAGE, FIXED
deduction.max_amountnumberNoannual maximum employee amount (always money)
deduction.paycode_idstringNothe hris_paycode (deduction code) this deduction uses
deduction.garnishment_typeenumNoset when this deduction is a court-ordered garnishment Values: CHILD_SUPPORT, TAX_LEVY, STUDENT_LOAN, CREDITOR, BANKRUPTCY, OTHER
payroll_idstringNothe hris_payroll (pay run) this payslip belongs to
group_idstringNothe pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)
typeenumNoValues: REGULAR, OFF_CYCLE, BONUS, CORRECTION, TERMINATION, CONTRACTOR
hoursnumberNototal hours paid on this payslip
employee_tax_amountnumberNototal taxes withheld from the employee
employer_tax_amountnumberNototal employer-paid taxes
deduction_amountnumberNototal employee deductions (pre and post-tax)
employer_contribution_amountnumberNototal employer benefit contributions
gross_ytd_amountnumberNoyear-to-date gross pay as of this payslip
net_ytd_amountnumberNoyear-to-date net pay as of this payslip

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/payslip/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?