SMsmileapi
Incomes

View Income

Changed on

View the user's income by ID.

get/incomes/{id}

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/incomes/{id}
  • Auth
    HTTP basic

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": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "employer": "ABC Corporation",
    "startDate": "2021-06-01",
    "endDate": "2021-06-15",
    "currency": "PHP",
    "frequency": "Annually",
    "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