Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Estimated Incomes

List Estimated Incomes

List users' estimated income from contribution- and transaction-based data sources. This data set contains derived income amounts from a variety of sources such as social security contributions, annual salary calculations, and computed earnings from transactions in various platforms.

Estimated Incomes is currently in alpha.

get/eincomes

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.

userIdstring

Filter to those associated with a particular user ID.

sourceIdstring

Filter to those associated with a particular source ID. If we query the link account data, the sourceId is the accountId, If we query the archive data, then the sourceId is the archiveId

startMonthstring

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

endMonthstring

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

Response

Estimated Incomes Response

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": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "month": "2021-06",
        "currency": "PHP",
        "metadata": {
          "itemCreatedAt": "2021-04-14T09:30:24Z",
          "createdAt": "2021-04-14T09:30:24Z",
          "sourceType": "Account"
        }
      }
    ]
  }
}