Sign in
Archives

list the payslip predictions

List Archive payslip predictions.

get/archives/-/payslips/listPredictions

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

Changed in 3 of the 51 revisions of this API.1110

  • v13bcbeecafbab10See the full diff
    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 415

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 501

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 503

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 504

      response-non-success-status-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v12e8500e069bb1See the full diff
    • ●

      added the new SOCIAL_SECURITY enum value to the data/items/items/allOf[ArchivePayslipMetaData]/metadata/sourceType response property for the response status 200

      response-property-enum-value-added

  • v14f4b86b826321See the full diff
    • ▲

      the response property data/items/items/allOf[ArchivePayslipMetaData]/metadata/sourceType became nullable for the status 200

      response-property-became-nullable

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog