SMsmileapi
Archives

list the payslip predictions

Changed on

List Archive payslip predictions.

get/archives/-/payslips/listPredictions

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/archives/-/payslips/listPredictions
  • Auth
    HTTP basic

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

startDatestring date
Example:2021-04-01

Filter by creation date, start of date range (YYYY-MM-DD)

endDatestring date
Example:2021-04-21

Filter by creation date, end of date range (YYYY-MM-DD)

Response

OK

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

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "currency": "PHP",
        "metadata": {
          "itemCreatedAt": "2021-04-14T09:30:24Z",
          "createdAt": "2021-04-14T09:30:24Z",
          "sourceType": "Account"
        }
      }
    ]
  }
}

Changes

  • v13bcbeecafbabRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • v12e8500e069bbRevision changes
    • warning

      added the new SOCIAL_SECURITY enum value to the //////// response property for the response status