v1

latestOpenAPI 3.0.1Apache 2.02026-07-13332183.6 KB
KKid

returns allowance balance and allowance transactions

By passing in the appropriate options, you can view allowance balance and allowance transactions for a given user provided that they are within the masterID account of the authenticated user.

get/kkid/allowance

Query parameters

kidUserIdinteger required

userID of the kid

transactionDaysinteger

number of days you wish to search allowance transactions (default is 90 days)

Response

search results matching criteria

successinteger
idinteger
balanceinteger
lastUpdatedstring

Example response

{
  "lastUpdated": "{}",
  "balance": 0,
  "success": 1,
  "allowanceTransaction": [
    {
      "transactionType": "Add",
      "date": {},
      "amount": 10,
      "transactionDescription": "Weekly Allowance for Chores",
      "userId": 1,
      "transactionId": 85
    },
    {
      "transactionType": "Add",
      "date": {},
      "amount": 10,
      "transactionDescription": "Weekly Allowance for Chores",
      "userId": 1,
      "transactionId": 85
    }
  ],
  "id": 24
}