Payslips API

3 endpoints, generated from packages/core/openapi/v1.snapshot.json (OpenAPI 3.1.0, contract version 1.0). Conventions for lists, errors, money and authentication are on the API conventions page.

GET/api/v1/payslips

My released payslips, newest first

Access

Permission payslips:read

Responses

200 Success. object

• itemsarray of objectrequired

  • idstring (uuid)required
  • runIdstring (uuid)required
  • titlestringrequired
  • monthstringrequired
  • payDatestring (date)required
  • netCentsintegerrequired

    min -9007199254740991

  • netPayableCentsintegerrequired

    min -9007199254740991

  • runKindenumrequired

    one of "regular", "off_cycle", "adjustment"

  • releasedAtstringrequired
  • revisedbooleanrequired

• 401 session_expired, session_revoked, unauthenticated
• 403 forbidden, mfa_enrolment_required

GET/api/v1/payslips/{payslipId}

One of my released payslips

Access

Permission payslips:read

Parameters

Name	In	Type	Required
payslipId	path	string (uuid)	yes

Responses

200 Success. object

• idstring (uuid)required
• runIdstring (uuid)required
• runKindenumrequired

  one of "regular", "off_cycle", "adjustment"

• offCycleReasonenum or nullrequired

  one of "final_pay", "bonus"

• titlestringrequired
• revisionobject or nullrequired

  • ofRunIdstring (uuid)required
  • previouslyPaidCentsintegerrequired

    min -9007199254740991

• releasedAtstring | nullrequired
• employerobjectrequired

  • legalNamestringrequired
• employeeobjectrequired

  • namestringrequired
  • employeeNumberstringrequired
  • idMaskedstringrequired
  • jobTitlestring | nullrequired
  • departmentstring | nullrequired
• payDatestring (date)required
• periodStartstring (date)required
• periodEndstring (date)required
• basicobject or nullrequired

  • amountCentsintegerrequired

    min -9007199254740991

  • detailstring | nullrequired
  • hourlyobject or nullrequired

    • rateCentsintegerrequired

      min -9007199254740991

    • hoursnumberrequired
• allowancesarray of objectrequired

  • labelstringrequired
  • amountCentsintegerrequired

    min -9007199254740991

  • detailstring | nullrequired
• additionalarray of objectrequired

  • labelstringrequired
  • amountCentsintegerrequired

    min -9007199254740991

  • detailstring | nullrequired
• overtimeobject or nullrequired

  • hoursnumberrequired
  • payCentsintegerrequired

    min -9007199254740991

  • periodsarray of objectrequired

    • labelstringrequired
    • hoursnumberrequired
    • payCentsintegerrequired

      min -9007199254740991

    • periodStartstring (date) or nullrequired
    • periodEndstring (date) or nullrequired
    • differsFromSalaryPeriodbooleanrequired
• deductionsarray of objectrequired

  • labelstringrequired
  • amountCentsintegerrequired

    min -9007199254740991

  • detailstring | nullrequired
  • typeenumrequired

    one of "fixed", "ad_hoc"

• reimbursementsarray of objectrequired

  • labelstringrequired
  • amountCentsintegerrequired

    min -9007199254740991

  • detailstring | nullrequired
• grossCentsintegerrequired

  min -9007199254740991

• totalDeductionsCentsintegerrequired

  min -9007199254740991

• netCentsintegerrequired

  min -9007199254740991

• netPayableCentsintegerrequired

  min -9007199254740991

• employerCpfCentsintegerrequired

  min -9007199254740991

• cpfobject or nullrequired

  • rateTableIdstring | nullrequired
  • rateTableLabelstring | nullrequired
  • ageBandstring | nullrequired
  • residencystringrequired
  • owSubjectCentsintegerrequired

    min -9007199254740991

  • awSubjectCentsintegerrequired

    min -9007199254740991

• shgFundsarray of stringrequired
• ytdobjectrequired

  • yearstringrequired
  • awSubjectCentsintegerrequired

    min -9007199254740991

  • owSubjectCentsintegerrequired

    min -9007199254740991

• 400 validation_failed
• 401 session_expired, session_revoked, unauthenticated
• 403 forbidden, mfa_enrolment_required
• 404 not_found

GET/api/v1/payslips/{payslipId}/pdf

Download one of my released payslips as PDF

Access

Permission payslips:read

Parameters

Name	In	Type	Required
payslipId	path	string (uuid)	yes

Responses

200 Payslip PDF application/pdf

• 400 validation_failed
• 401 session_expired, session_revoked, unauthenticated
• 403 forbidden, mfa_enrolment_required
• 404 not_found