---
title: "list the payslip predictions"
method: GET
path: "/archives/-/payslips/listPredictions"
tags: ["Archives"]
---

# list the payslip predictions

`GET /archives/-/payslips/listPredictions`

List Archive payslip predictions.

## Query parameters

- `size` integer
- `cursor` string
- `startDate` string, date
- `endDate` string, date

## Response `200`

OK

- ArchivePayslipPredictionsListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` object
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` ArchivePayslipPredictionQueryResponseData[]
      - `startDate` string, date — Start date of the payslip period, in YYYY-MM-DD format
      - `endDate` string, date — End date of the payslip period, in YYYY-MM-DD format
      - `payDate` string, date — Pay date of the payslip, in YYYY-MM-DD format
      - `currency` 'AFN' | 'DZD' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BHD' | 'THB' | 'PAB' | 'BBD' | 'BYN' | 'BZD' | 'BMD' | 'VES' | 'BOB' | 'BRL' | 'BND' | 'BGN' | 'BIF' | 'CAD' | 'CVE' | 'KYD' | 'GHS' | 'XOF' | 'XAF' | 'XPF' | 'CLP' | 'COP' | 'KMF' | 'CDF' | 'BAM' | 'NIO' | 'CRC' | 'HRK' | 'CZK' | 'GMD' | 'DKK' | 'MKD' | 'DJF' | 'STD' | 'DOP' | 'VND' | 'XCD' | 'EGP' | 'SVC' | 'ETB' | 'EUR' | 'FKP' | 'FJD' | 'HUF' | 'GIP' | 'HTG' | 'PYG' | 'GNF' | 'GYD' | 'HKD' | 'UAH' | 'ISK' | 'INR' | 'IRR' | 'IQD' | 'JMD' | 'JOD' | 'KES' | 'PGK' | 'LAK' | 'EEK' | 'KWD' | 'MWK' | 'AOA' | 'MMK' | 'GEL' | 'LVL' | 'LBP' | 'ALL' | 'HNL' | 'SLL' | 'LRD' | 'LYD' | 'SZL' | 'LTL' | 'LSL' | 'MGA' | 'MYR' | 'TMT' | 'MUR' | 'MZN' | 'MXN' | 'MDL' | 'MAD' | 'NGN' | 'ERN' | 'NAD' | 'NPR' | 'ANG' | 'ILS' | 'RON' | 'TWD' | 'NZD' | 'BTN' | 'KPW' | 'NOK' | 'PEN' | 'MRO' | 'TOP' | 'PKR' | 'MOP' | 'UYU' | 'PHP' | 'GBP' | 'BWP' | 'QAR' | 'GTQ' | 'ZAR' | 'OMR' | 'KHR' | 'MVR' | 'IDR' | 'RUB' | 'RWF' | 'SHP' | 'SAR' | 'RSD' | 'SCR' | 'SGD' | 'SBD' | 'KGS' | 'SOS' | 'TJS' | 'LKR' | 'SDG' | 'SRD' | 'SEK' | 'CHF' | 'SYP' | 'BDT' | 'WST' | 'TZS' | 'KZT' | 'TTD' | 'MNT' | 'TND' | 'TRY' | 'AED' | 'UGX' | 'CLF' | 'USD' | 'UZS' | 'VUV' | 'KRW' | 'YER' | 'JPY' | 'CNY' | 'ZMW' | 'ZWL' | 'PLN' — Currency in 3 character alpha ISO 4217
      - `grossAmount` number — Gross amount
      - `netAmount` number — Net amount
      - `employerName` string — Employer name
      - `employeeName` string — Employee name
      - `ssNumber` string — Employee's Social Security (SS) Number
      - `philHealthNumber` string — Employee's National Health Identification Number
      - `taxNumber` string — Employee's Tax Identification Number
      - `pagIbigNumber` string — Employee's National housing provident fund MID Number
      - `matchResult` object
        - `employeeNameAndIdentificationNumberMatchScore` integer — The match score of the employee's name and all identification numbers. If Smile can not verify it or you disabled verify feature, this value will be null. If mutilple identification numbers have a match score, take the lowest match score.
        - `employeeNameAndSsNumberMatchScore` integer — The match score of the employee name and SS Number. If Smile can not verify it or you disabled verify feature, this value will be null.
        - `employeeNameAndPagIbigNumberMatchScore` integer — The match score of the employee name and National housing provident fund number. If Smile can not verify it or you disabled verify feature, this value will be null.
        - `employeeNameAndPhilHealthNumberMatchScore` integer — The match score of the employee name and National Health number. If Smile can not verify it or you disabled verify feature, this value will be null.
        - `employeeNameAndTaxNumberMatchScore` integer — The match score of the employee name and tax ID number. If Smile can not verify it or you disabled verify feature, this value will be null.
      - `metadata` ObjectReferenceMetadata, required — Metadata related to account-specific data
        - `itemCreatedAt` string, date-time, required — Date and time
        - `createdAt` string, date-time, required — Date and time
        - `accountId` string — The accountId of this object
        - `sourceId` string, required — The ACCOUNT or ARCHIVE ID associated with this object
        - `sourceType` 'ACCOUNT' | 'UPLOAD' | 'ARCHIVE' | 'SOCIAL_SECURITY', nullable, required — Source Type
        - `userId` string, required — The user ID associated with this object
        - `providerId` string, required — The provider ID associated with this object

---

[API](https://skmtc.net/smileapi/apis/smile-api.md) · [All operations](https://skmtc.net/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smileapi/smile-api/versions/d1e0cb5dc33c/schema)