Personal Financial Management (PFM) Account
| Name | Description | Introduced In |
|---|---|---|
| getPFMAccounts | This API allows the user to fetch all the Personal Financial Management (PFM) accounts. | 2020.04 |
| PFMPieChart | This API fetches the data for Pie Chart. | 2021.07 |
| PFMBudgetGraph | This API fetches the data for budget graph. | 2021.07 |
| PFMBarGraph | This API fetches the data for bar graph. | 2021.07 |
| PFMTransactions | This API fetches the transactions that does not fall under any of the categorizes of financial management. | 2021.07 |
| PFMCategory | This API fetches the list of categories of financial management. | 2021.07 |
| updateBulkPFMTransactions | This API maps the transaction to a category for multiple transactions occurring in bulk. | 2021.07 |
| Object Data Models | This Object Data Model describes the parameter name and other attribute details for PFM. |
|
Description: |
This API allows the user to fetch all the Personal Financial Management accounts. |
|
Method: |
POST |
|
URL: |
{base_url}/services/data/v1/PFM/operations/PFMAccounts/getPFMAccounts |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
NA |
|
Response: |
{
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
|
Description: |
This API fetches the data for Pie Chart. |
|
Method: |
GET |
|
URL: |
{base_url}/services/data/v1/PFM/operations/PFMPieChart |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
Not Applicable |
|
Response: |
Parameters cashSpent <Mandatory> Specifies the Cash spent for the month. categoryName <Mandatory> Specifies the name of the Category. cateforyId <Mandatory> Specifies the Catefory ID. monthId <Mandatory> Specifies the month Number. monthName <Mandatory> Specifies the name of the month. totalCashSpent <Mandatory> Specifies the Cash spent for the month. {
"records": [{
"cashSpent": "400.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "720.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "420.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "700.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "570.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "420.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "450.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "720.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "700.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "570.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "570.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "720.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "420.0",
"cateforyId": "1",
"categoryName": "Home",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "180.0",
"cateforyId": "2",
"categoryName": "Utilities",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "500.0",
"cateforyId": "3",
"categoryName": "Financial",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "4",
"categoryName": "Education",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "100.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "70.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "70.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "90.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "90.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "100.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "80.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "70.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "90.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "100.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "90.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "60.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "100.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "70.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "70.0",
"cateforyId": "5",
"categoryName": "Transportation",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "400.0",
"cateforyId": "6",
"categoryName": "Health",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "40.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "20.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "20.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "20.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "20.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "40.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "20.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "40.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "300.0",
"cateforyId": "7",
"categoryName": "Travel",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "210.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "150.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "150.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "210.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "210.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "150.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "150.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "210.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "150.0",
"cateforyId": "8",
"categoryName": "Food",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "40.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "100.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "30.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "20.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "170.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "40.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "30.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "220.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "40.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "100.0",
"cateforyId": "9",
"categoryName": "Uncategorised",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "4",
"monthName": "April",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "5",
"monthName": "May",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "6",
"monthName": "June",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "7",
"monthName": "July",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "8",
"monthName": "August",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "9",
"monthName": "September",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "10",
"monthName": "October",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "11",
"monthName": "November",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "12",
"monthName": "December",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "1",
"monthName": "January",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "2",
"monthName": "February",
"totalCashSpent": "46370.0"
}, {
"cashSpent": "750.0",
"cateforyId": "10",
"categoryName": "Other",
"monthId": "3",
"monthName": "March",
"totalCashSpent": "46370.0"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | NA |
|
Description: |
This API fetches the data for budget graph. |
|
Method: |
GET |
|
URL: |
{base_url}/services/data/v1/PFM/operations/PFMBudgetGraph |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
NA |
|
Response: |
Parameters allocatedAmount <Mandatory> Specifies the amount allocated for the budget. amountSpent <Mandatory> Specifies the total amount spent. budgetId <Mandatory> Specifies the ID of the budget. categoryId <Mandatory> Specifies the Category ID. categoryName <Mandatory> Specifies the name of Category. {
"records": [{
"allocatedAmount": "500",
"amountSpent": "400",
"budgetId": "1",
"categoryId": "1",
"categoryName": "Home"
}, {
"allocatedAmount": "200",
"amountSpent": "180",
"budgetId": "2",
"categoryId": "2",
"categoryName": "Utilities"
}, {
"allocatedAmount": "500",
"amountSpent": "500",
"budgetId": "3",
"categoryId": "3",
"categoryName": "Financial"
}, {
"allocatedAmount": "270",
"amountSpent": "300",
"budgetId": "4",
"categoryId": "4",
"categoryName": "Education"
}, {
"allocatedAmount": "80",
"amountSpent": "100",
"budgetId": "5",
"categoryId": "5",
"categoryName": "Transportation"
}, {
"allocatedAmount": "600",
"amountSpent": "400",
"budgetId": "6",
"categoryId": "6",
"categoryName": "Health"
}, {
"allocatedAmount": "100",
"amountSpent": "40",
"budgetId": "7",
"categoryId": "7",
"categoryName": "Travel"
}, {
"allocatedAmount": "150",
"amountSpent": "170",
"budgetId": "9",
"categoryId": "8",
"categoryName": "Food"
}, {
"allocatedAmount": "500",
"amountSpent": "750",
"budgetId": "10",
"categoryId": "10",
"categoryName": "Other"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): | No error codes |
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
|
Description: |
This API fetches the data for bar graph. |
|
Method: |
GET |
|
URL: |
{base_url}/services/data/v1/PFM/objects/PFMBarGraph |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
Parameters year <Mandatory> Specifies the year for which bar graph data needs to be fetched. ?year=2021 |
|
Response: |
Parameters monthId <Mandatory> Specifies the month number. monthName <Mandatory> Specifies the name of the month. totalCashFlow Specifies an total cash flow in the specified year. {
"records": [
{
"monthId": "1",
"monthName": "January",
"totalCashFlow": "2880.0"
},
{
"monthId": "2",
"monthName": "February",
"totalCashFlow": "3430.0"
},
{
"monthId": "3",
"monthName": "March",
"totalCashFlow": "2870.0"
},
{
"monthId": "4",
"monthName": "April",
"totalCashFlow": "3280.0"
},
{
"monthId": "5",
"monthName": "May",
"totalCashFlow": "2990.0"
},
{
"monthId": "6",
"monthName": "June",
"totalCashFlow": "3160.0"
},
{
"monthId": "7",
"monthName": "July",
"totalCashFlow": "2870.0"
},
{
"monthId": "8",
"monthName": "August",
"totalCashFlow": "3430.0"
},
{
"monthId": "9",
"monthName": "September",
"totalCashFlow": "3280.0"
},
{
"monthId": "10",
"monthName": "October",
"totalCashFlow": "2880.0"
},
{
"monthId": "11",
"monthName": "November",
"totalCashFlow": "2990.0"
},
{
"monthId": "12",
"monthName": "December",
"totalCashFlow": "3130.0"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): | No error codes |
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
|
Description: |
This API fetches the transactions that does not fall under one of the categories of financial management. |
|
Method: |
GET |
|
URL: |
{base_url}/services/data/v1/PFM/operations/PFMTransactions |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
NA |
|
Response: |
Parameters categoryId <Mandatory> Specifies the Category ID. categoryName <Mandatory> Specifies the Category Name. fromAccountName <Mandatory> Specifies the given account name. fromAccountNumber <Mandatory> Specifies the account number. isAnalyzed <Mandatory> Specifies if the data is analysed or not. isMappedToMerchant <Mandatory> Specifies if the category is mapped to merchant. transactionAmount <Mandatory> Specifies the total transaction amount. transactionDate <Mandatory> Specifies the transaction date. transactionDescription <Mandatory> Specifies the description for that transaction. transactionId <Mandatory> Specifies the ID of Transaction. transactionNotes <Mandatory> Specifies the notes for the transaction. toAccountName <Mandatory> Specifies . toAccountNumber <Mandatory> Specifies the sending account number. {
"records": [{
"categoryId": "1",
"categoryName": "Home",
"fromAccountName": "Rewards Savings",
"fromAccountNumber": "8898",
"isAnalyzed": "true",
"isMappedToMerchant": "true",
"transactionAmount": "300.0",
"transactionDate": "2021-07-16T06:13:56Z",
"transactionDescription": "Spent on home utilities",
"transactionId": "1",
"transactionNotes": "home Utilities",
"toAccountName": "john",
"toAccountNumber": "887799098457456"
}]
}
|
| Error Code(s): | No error codes |
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
|
Description: |
This API fetches the list of categories of financial management. |
|
Method: |
GET |
|
URL: |
{base_url}/services/data/v1/PFM/operations/PFMCategory |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
NA |
|
Response: |
Parameters categoryId<Mandatory> Specifies the category ID. categoryName<Mandatory> Specifies the name of category. {
"records": [{
"categoryId": "1",
"categoryName": "Home"
}, {
"categoryId": "2",
"categoryName": "Utilities"
}, {
"categoryId": "3",
"categoryName": "Financial"
}, {
"categoryId": "4",
"categoryName": "Education"
}, {
"categoryId": "5",
"categoryName": "Transportation"
}, {
"categoryId": "6",
"categoryName": "Health"
}, {
"categoryId": "7",
"categoryName": "Travel"
}, {
"categoryId": "8",
"categoryName": "Food"
}, {
"categoryId": "9",
"categoryName": "Uncategorised"
}, {
"categoryId": "10",
"categoryName": "Other"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
No error codes |
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
|
Description: |
This API maps the transaction to a category for multiple transactions occurring in bulk. |
|
Method: |
POST |
|
URL: |
{base_url}/services/data/v1/PFM/operations/PFMTransactions/updateBulkPFMTransaction |
|
Security Level: |
Authorized App User |
|
Header Request: |
X-Kony-Authorization |
|
Body Request: |
NA
{
"pfmtransactionlist": [{\
"transactionId\":\"3\",\"categoryId\":\"3\"}]"
}
|
|
Response: |
{
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
No error codes |
| Enterprise Provider | Temenos Digital |
| Enterprise API |
NA |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
monthId |
String |
Mandatory |
Number of months (ex- 1 for Jan) |
|
monthName |
String |
Mandatory |
Month name |
|
totalCashFlow |
String |
Mandatory |
Total cash |
|
errmsg |
String |
NA |
NA |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
arrangementId |
String |
Mandatory |
id of Consent Arrangement |
|
accountIBAN |
String |
Mandatory |
IBAN account |
|
shortName |
String |
Mandatory |
3rd party provider short name |
|
consentType |
String |
Mandatory |
type of consent |
|
thirdpartyprovider |
String |
Mandatory |
3rd party provider name |
|
validUntil |
String |
Mandatory |
validity date of consent |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
cashSpent |
String |
Mandatory |
Cash spend for month |
|
categoryId |
String |
Mandatory |
Category ID |
| categoryName | String | Mandatory | Name of category |
|
errmsg |
String |
Mandatory |
NA |
|
monthId |
String |
Mandatory |
Number of months (ex- 1 for Jan) |
|
monthName |
String |
Mandatory |
Month name |
|
totalCashSpent |
String |
Mandatory |
Cash spend for month |
|
year |
String |
NA |
Year |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
accountID |
String |
Mandatory |
Account # |
|
accountName |
String |
Mandatory |
Account name |
|
accountType |
String |
Mandatory |
Account type |
|
availableBalance |
String |
Mandatory |
Available balance of account |
|
availablePoints |
String |
NA |
3rd party provider name |
|
bankName |
String |
NA |
NA |
| creditCardNumber | String | NA | NA |
| currencyCode | String | NA | NA |
| currentBalance | String | Mandatory | Current balance of account |
| dueDate | String | NA | NA |
| errmsg | String | NA | NA |
| interestRate | String | NA | NA |
| isPFM | String | Mandatory | Whether account is enabled for PFM |
| lastStatementBalance | String | NA | NA |
| maturityDate | String | NA | NA |
| minimumDue | String | NA | NA |
| nickName | String | Mandatory | PFM account nickname |
| openingDate | String | NA | NA |
| outstandingBalance | String | NA | NA |
| paymentTerm | String | NA | NA |
| principalValue | String | NA | NA |
| success | String | NA | NA |
| supportBillPay | String | NA | NA |
| supportDeposit | String | NA | NA |
| supportTransferFrom | String | NA | NA |
| supportTransferTo | String | NA | NA |
| transactionLimit | String | NA | NA |
| transferLimit | String | NA | NA |
| deviceID | String | NA | NA |
| userName | String | NA | NA |
| totalCreditMonths | String | NA | NA |
| totalDebitsMonth | String | NA | NA |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
fromAccountName |
String |
Mandatory |
From account name |
|
fromAccountNumber |
String |
Mandatory |
From account # |
|
getMonthlyTransactions |
String |
Mandatory |
NA |
|
getUncategorisedCount |
String |
Mandatory |
NA |
|
isAnalyzed |
String |
Mandatory |
NA |
|
isMappedToMerchant |
String |
Mandatory |
NA |
| monthId | String | Mandatory | ID of month (ex- 1 for Jan) |
| success | String | Mandatory | NA |
| transactionAmount | String | Mandatory | Transaction amount |
| transactionDate | String | Mandatory | Transaction date |
| transactionDescription | String | Mandatory | Transaction description |
| transactionId | String | Mandatory | Transaction ID |
| transactionNotes | String | Mandatory | Transaction notes |
| pfmtransactionlist | String | Mandatory | NA |
| toAccountName | String | Mandatory | To account name |
| toAccountNumber | String | Mandatory | To account# |
| year | String | Mandatory | Year |
| sortby | String | Mandatory | NA |
| order | String | Mandatory | NA |
| notes | String | Mandatory | Notes |
| description | String | Mandatory | NA |
| transactionCurrency | String | Mandatory | Transaction currency |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
categoryId |
String |
Mandatory |
ID of category |
|
categoryName |
String |
Mandatory |
Name of category |
|
errmsg |
String |
NA |
NA |
In this topic