Get Forecasts for Business Accounts

GET

/public/v3/customers/{customer_id}/insights/current_business

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
financial_credibility_scoreFinancial Credibility ScoresyesFinancial Credibility Scores
affordabilityAffordability ScoreyesAffordability Scores
liquidityLiquidity ScoreyesMultiple liquidity scores for various timespans
financial_forecastFinancial ForecastyesBank balance forecasts for customer accounts

Financial Credibility Scores

ParameterData typeRequired?Description
genericFinancial Credibility ScoreyesGeneric Financial Credibility Score
customFinancial Credibility ScoreyesCalibrated Financial Credibility Score

Affordability Score

ParameterData typeRequired?Description
scoreintegeryesScore
bandstringyesBand

Financial Credibility Score

ParameterData typeRequired?Description
scoreintegeryesScore
bandstringyesBand
reason_codesReason CodeyesReason codes

Liquidity Score

ParameterData typeRequired?Description
scoreintegeryesScore
bandstringyesBand
daysintegeryesDays

Financial Forecast

ParameterData typeRequired?Description
bankBankyesBanks with actual and forecasted balance

Bank

ParameterData typeRequired?Description
namestringyesBank name
slugstringyesBank slug (unique identifier)
is_activebooleanyesDenotes if this bank can currently be used
accountAccountyesArray of bank accounts with actual and predicted balance

Account

ParameterData typeRequired?Description
idintegeryesAccount ID
currencystringyesCurrency code (compatible with ISO 4217)
typestringyesAllowed:(Business, Personal)
numberstringyesAccount number
balanceBalance CollectionyesBalance includes actual and forecasted balance

Balance Collection

ParameterData typeRequired?Description
actualBalanceyesArray of historical balances
forecastBalanceyesArray of predicted balances

Balance

ParameterData typeRequired?Description
amountfloatyesAmount of associated currency
dateintegeryesTimestamp of balance

Reason Code

ParameterData typeRequired?Description
codestringyesReason code
descriptionstringyesReason code description
sentimentstringyesAllowed:(Positive, Negative)

Request example

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}'

Response example:

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.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

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: 781963)