Get Forecasts for Business Accounts
GET
/public/v3/customers/{customer_id}/insights/current_business
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| financial_credibility_score | Financial Credibility Scores | yes | Financial Credibility Scores |
| affordability | Affordability Score | yes | Affordability Scores |
| liquidity | Liquidity Score | yes | Multiple liquidity scores for various timespans |
| financial_forecast | Financial Forecast | yes | Bank balance forecasts for customer accounts |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| generic | Financial Credibility Score | yes | Generic Financial Credibility Score |
| custom | Financial Credibility Score | yes | Calibrated Financial Credibility Score |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| score | integer | yes | Score |
| band | string | yes | Band |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| score | integer | yes | Score |
| band | string | yes | Band |
| reason_codes | Reason Code | yes | Reason codes |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| score | integer | yes | Score |
| band | string | yes | Band |
| days | integer | yes | Days |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| bank | Bank | yes | Banks with actual and forecasted balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| name | string | yes | Bank name |
| slug | string | yes | Bank slug (unique identifier) |
| is_active | boolean | yes | Denotes if this bank can currently be used |
| account | Account | yes | Array of bank accounts with actual and predicted balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| id | integer | yes | Account ID |
| currency | string | yes | Currency code (compatible with ISO 4217) |
| type | string | yes | Allowed:(Business, Personal) |
| number | string | yes | Account number |
| balance | Balance Collection | yes | Balance includes actual and forecasted balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| amount | float | yes | Amount of associated currency |
| date | integer | yes | Timestamp of balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| code | string | yes | Reason code |
| description | string | yes | Reason code description |
| sentiment | string | yes | Allowed:(Positive, Negative) |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/insights/current_business' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
{
"income": {
"currency": "GBP",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
],
"categories": [
{
"name": "Salary",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
]
}
]
},
"expenditure": {
"currency": "GBP",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
],
"categories": [
{
"name": "Hobby",
"fixed_flexible": "fixed",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
]
}
]
},
"financial_patterns": {
"currency": "GBP",
"recurrence": [
{
"description": "Granny's Bakery",
"average_amount": "22.35",
"amount_variance": "0.2",
"transaction_ids": [
"string"
]
}
],
"by_category": [
{
"category": "Groceries & Supplies",
"min": "5.05",
"mean": "8.05",
"max": "15.02",
"variance": "0.5",
"frequency": "15.5",
"continuity": "6",
"recency": "3"
}
]
},
"financial_markers": {
"bank_charges": {
"num_last_3m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_6m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_12m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
}
},
"new_debt_indicator": false,
"credit_repayments": {
"rate_of_change": "0.66",
"pred_next_month": "122.35",
"ratio_to_income": "0.07"
},
"currency": "GBP",
"returned_direct_debits": {
"num_last_3m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_6m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_12m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
}
},
"negative_balance_ratio": 0.5,
"debt_management_indicator": false,
"debit_bank_transfer": {
"rate_of_change": "0.66",
"pred_next_month": "122.35",
"ratio_to_income": "0.07"
},
"summary_averages": {
"average_fixed_exp": 0.5,
"average_flexible_exp": 0.5,
"average_income": 0.5
},
"expense_proportion": {
"fixed_proportion": 0.5,
"flexible_proportion": 0.5
},
"high_cost_short_term_credit_indicator": false,
"profitability_ratio": 0.5,
"recent_account_indicator": false,
"income_proportion": {
"other_income_proportion": 0.5,
"sales_proportion": 0.5,
"services_proportion": 0.5
}
},
"employment": {
"number_of_salaries": "2",
"expected_salary": [
{
"amount": "1220.35",
"expected_pay_date": "1608418799",
"pay_frequency": "monthly"
}
],
"currency": "GBP"
}
}Was this article helpful?
Friendly Score UK Ltd.
84 Brook Street
London W1K 5EH
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)