openapi: 3.2.0
info:
description: Documentation for the Moneyhub data API.
Authentication is via bearer token.
title: Moneyhub Data Standard Financial Statements API
version: 2.0.0
x-build-sha: 5d5191d
servers:
- url: https://api.moneyhub.co.uk/v2.0
security:
- Bearer: []
tags:
- name: standard-financial-statements
paths:
/standard-financial-statements/{reportId}:
get:
summary: Get an existing standard financial statement for a user
description: Requires **standard_financial_statement:read** scope.
parameters:
- description: The Report Id
in: path
name: reportId
required: true
x-example: 0b4e6488-6de0-420c-8f56-fee665707d57
schema:
type: string
format: uuid
responses:
'200':
description: Successful Standard Financial Statement Response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/StandardFinancialStatement'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
type: object
'401':
description: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Unsuccessful Response - Forbidden - Invalid scopes
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unsuccessful Response - Resource Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- standard-financial-statements
/standard-financial-statements:
get:
summary: List of metadata for all standard financial statements for a user
description: Requires **standard_financial_statement:read** scope.
parameters:
- description: The total number of records to retrieve
in: query
name: limit
schema:
type: integer
maximum: 1000
minimum: 0
- description: The offset at which to start retrieving records
in: query
name: offset
schema:
type: integer
maximum: 1000000000
minimum: 0
responses:
'200':
description: Successful Standard Financial Statement Response
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/StandardFinancialStatementsMetadata'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
type: object
'401':
description: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Unsuccessful Response - Forbidden - Invalid scopes
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unsuccessful Response - Resource Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- standard-financial-statements
post:
summary: Request standard financial statement for a user
description: Requires **standard_financial_statement:write** and **standard_financial_statement:read** scopes.
responses:
'200':
description: Successful Standard Financial Statement Response
content:
application/json:
schema:
properties:
data:
additionalProperties: false
properties:
id:
description: The standard financial statement ID
type: string
status:
description: Whether the report is 'complete', 'pending' or 'failed'. This will always be 'pending' when using this endpoint.
type: string
enum:
- pending
required:
- id
- status
type: object
links:
$ref: '#/components/schemas/Links'
meta:
type: object
type: object
'401':
description: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Unsuccessful Response - Forbidden - Invalid scopes
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unsuccessful Response - Resource Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- standard-financial-statements
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StandardFinancialStatementsPost'
components:
schemas:
Links:
additionalProperties: false
properties:
next:
description: The url to retrieve the next page of results from
format: uri
type: string
prev:
description: The url to retrieve the previous page of results from
format: uri
type: string
self:
description: The url of the current resource(s)
format: uri
type: string
required:
- self
type: object
StandardFinancialStatementsMetadata:
additionalProperties: false
type: object
properties:
createdAt:
description: The timestamp at which the standard financial statement was generated
type: string
requestedAt:
description: The timestamp at which the standard financial statement was requested
type:
- string
- 'null'
id:
description: The standard financial statement ID
type: string
status:
description: Whether the standard financial statement is 'complete', 'pending' or 'failed'.
type: string
enum:
- pending
- complete
- failed
statusDetails:
description: Additional information about the status of the standard financial statement (if applicable)
type: object
additionalProperties: true
properties:
message:
description: A message describing the status of the standard financial statement, e.g. an error if the standard financial statement status is 'failed'
type: string
example:
createdAt: '2022-01-01T00:00:00Z'
requestedAt: '2021-12-31T23:00:00Z'
id: d372d09b-f50a-4114-9c83-687828fa8ac2
status: complete
required:
- id
StandardFinancialStatement:
type: object
additionalProperties: false
required:
- createdAt
- id
- version
- '2.1'
- currency
properties:
createdAt:
description: The timestamp at which the report was generated
type: string
id:
description: The report id
type: string
version:
description: The standard financial schema version used as defined by the Money Advice Service
type: string
enum:
- '2.1'
currency:
description: The currency used for all amounts in the standard financial statement
type: string
'2.1':
description: The contents of the standard financial statement in version 2.1 schema. Will be present only if version property is equal to 2.1
type: object
required:
- vehicles
- housing-tenure
- client-employment-status
properties:
vehicles:
description: The number of vehicles in the household
type: integer
housing-tenure:
description: The predicted category of housing tenure
type: string
enum:
- Owner
- Mortgage
- Living with parents
- Tenant - private sector
- Tenant - social
- Other
client-employment-status:
description: The predicted category of employment
type: string
enum:
- Full-time
- Part-time
- Unemployed
- Not working due to illness / disability
- Self-employed
- Retired
- Carer
- Student
- Other
monthly-income:
description: The categorised monthly values for credit transactions
type: object
properties:
earnings:
description: The monthly values for earnings income categories
type: object
required:
- client-salary-or-wages
- other-earnings
properties:
client-salary-or-wages:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-earnings:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
benefits:
description: The monthly values for benefits income categories
type: object
required:
- tax-credits-universal-credit
- jobseekers-allowance-contribution-based
- income-support
- working-tax-credit
- child-tax-credit
- child-benefit
- employment-support-allowance
- disability-benefits
- carers-allowance
- other-benefits
properties:
tax-credits-universal-credit:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
jobseekers-allowance-contribution-based:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
income-support:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
working-tax-credit:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
child-tax-credit:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
child-benefit:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
employment-support-allowance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
disability-benefits:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
carers-allowance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-benefits:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
pensions:
description: The monthly values for pensions income categories
type: object
required:
- state-pensions
- private-work-pensions
- pension-credit
properties:
state-pensions:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
private-work-pensions:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
pension-credit:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-income:
description: The monthly values for other income categories
type: object
required:
- maintenance-child-support
- boarders-lodgers
- student-loans-grants
- other-other-income
properties:
maintenance-child-support:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
boarders-lodgers:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
student-loans-grants:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-other-income:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
monthly-outgoings:
description: The categorised monthly values for debit transactions
type: object
properties:
fixed-costs:
description: The categorised monthly values for costs which are fixed
type: object
properties:
home-contents:
description: The monthly values for home and contents cost categories
type: object
required:
- rent
- ground-rent-service-charges
- mortgage
- secured-loans
- council-tax-rates
- appliance-furniture-rental
- tv-licence
properties:
rent:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
ground-rent-service-charges:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
mortgage:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
secured-loans:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
council-tax-rates:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
appliance-furniture-rental:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
tv-licence:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
utilities:
description: The monthly values for utilities cost categories
type: object
required:
- gas
- other-utilities-expenditure
properties:
gas:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-utilities-expenditure:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
water:
description: The monthly values for water cost categories
type: object
required:
- water-supply
properties:
water-supply:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
care-health:
description: The monthly values for care and health cost categories
type: object
required:
- childcare-costs
- child-maintenance-child-support
- prescriptions-medicines
- dentistry-opticians
- other-care-health
properties:
childcare-costs:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
child-maintenance-child-support:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
prescriptions-medicines:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
dentistry-opticians:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-care-health:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
transport-travel:
description: The monthly values for transport and travel cost categories
type: object
required:
- public-transport
- car-insurance
- road-tax
- mot-ongoing-maintenance
- breakdown-cover
- fuel-parking-toll-road-charges
- other-transport-travel
properties:
public-transport:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
car-insurance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
road-tax:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
mot-ongoing-maintenance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
breakdown-cover:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
fuel-parking-toll-road-charges:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-transport-travel:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
school:
description: The monthly values for school cost categories
type: object
required:
- school-uniform
- other-school
properties:
school-uniform:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-school:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
pensions-insurance:
description: The monthly values for pensions and insurance cost categories
type: object
required:
- pension-payments
- life-insurance
- buildings-contents-insurance
- health-insurance
- other-pensions-insurances
properties:
pension-payments:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
life-insurance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
buildings-contents-insurance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
health-insurance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-pensions-insurances:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
professional:
description: The monthly values for professional cost categories
type: object
required:
- professional-courses
- professional-fees
properties:
professional-courses:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
professional-fees:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-essential:
description: The monthly values for other essential cost categories
type: object
properties:
other-essential-costs:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
flexible-costs:
description: The categorised monthly values for costs which are flexible
type: object
properties:
communications-leisure:
description: The monthly values for communications and leisure cost categories
type: object
required:
- home-phone-internet-tv
- mobile-phone
- hobbies-leisure-sport
- gifts
- newspapers-magazines-stationery-postage
- other-communications-leisure
properties:
home-phone-internet-tv:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
mobile-phone:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
hobbies-leisure-sport:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
gifts:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
newspapers-magazines-stationery-postage:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-communications-leisure:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
food-housekeeping:
description: The monthly values for food and housekeeping cost categories
type: object
required:
- groceries
- alcohol
- smoking-products
- vet-bills-pet-insurance
- house-repairs-maintenance
- other-food-housekeeping
properties:
groceries:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
alcohol:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
smoking-products:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
vet-bills-pet-insurance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
house-repairs-maintenance:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-food-housekeeping:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
personal:
description: The monthly values for personal cost categories
type: object
required:
- clothing-footwear
- hairdressing
- toiletries
- other-personal
properties:
clothing-footwear:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
hairdressing:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
toiletries:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
other-personal:
description: The monthly amount
type: object
properties:
monthly-amount:
description: The minimum, mean and maximum monthly amount
type: object
additionalProperties: false
properties:
min:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
max:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
mean:
additionalProperties: false
type: object
properties:
value:
description: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
example: -2323
type: integer
majorUnits:
description: The positive major units of the value, based on the values currency, eg. pounds for GBP.
example: 23
type: integer
minorUnits:
description: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
example: 23
type: integer
currency:
description: The currency of the amount
example: GBP
type: string
required:
- value
- currency
required:
- min
- max
- mean
example:
createdAt: '2025-02-14T12:00:00Z'
id: fc25a8d9-f298-45dc-a234-66c41d594c7d
currency: GBP
version: '2.1'
'2.1':
vehicles: 2
housing-tenure: Mortgage
client-employment-status: Full-time
monthly-income:
earnings:
client-salary-or-wages:
monthly-amount:
min:
value: 300000
majorUnits: 3000
minorUnits: 0
currency: GBP
max:
value: 500000
majorUnits: 5000
minorUnits: 0
currency: GBP
mean:
value: 400000
majorUnits: 4000
minorUnits: 0
currency: GBP
other-earnings:
monthly-amount:
min:
value: 30000
majorUnits: 300
minorUnits: 0
currency: GBP
max:
value: 50000
majorUnits: 500
minorUnits: 0
currency: GBP
mean:
value: 40000
majorUnits: 400
minorUnits: 0
currency: GBP
benefits:
tax-credits-universal-credit:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
jobseekers-allowance-contribution-based:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
income-support:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
working-tax-credit:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
child-tax-credit:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
child-benefit:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
employment-support-allowance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
disability-benefits:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
carers-allowance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-benefits:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
pensions:
state-pensions:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
private-work-pensions:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
pension-credit:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-income:
maintenance-child-support:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
boarders-lodgers:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
student-loans-grants:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-other-income:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
monthly-outgoings:
fixed-costs:
home-contents:
rent:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
ground-rent-service-charges:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
mortgage:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
secured-loans:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
council-tax-rates:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
appliance-furniture-rental:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
tv-licence:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
utilities:
gas:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-utilities-expenditure:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
water:
water-supply:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
care-health:
childcare-costs:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
child-maintenance-child-support:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
prescriptions-medicines:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
dentistry-opticians:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-care-health:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
transport-travel:
public-transport:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
car-insurance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
road-tax:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
mot-ongoing-maintenance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
breakdown-cover:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
fuel-parking-toll-road-charges:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-transport-travel:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
school:
school-uniform:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-school:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
pensions-insurance:
pension-payments:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
life-insurance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
buildings-contents-insurance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
health-insurance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-pensions-insurances:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
professional:
professional-courses:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
professional-fees:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-essential:
other-essential-costs:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
flexible-costs:
communications-leisure:
home-phone-internet-tv:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
mobile-phone:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
hobbies-leisure-sport:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
gifts:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
newspapers-magazines-stationery-postage:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-communications-leisure:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
food-housekeeping:
groceries:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
alcohol:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
smoking-products:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
vet-bills-pet-insurance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
house-repairs-maintenance:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-food-housekeeping:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
personal:
clothing-footwear:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
hairdressing:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
toiletries:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
other-personal:
monthly-amount:
min:
value: 5000
majorUnits: 50
minorUnits: 0
currency: GBP
max:
value: 10000
majorUnits: 100
minorUnits: 0
currency: GBP
mean:
value: 20000
majorUnits: 200
minorUnits: 0
currency: GBP
StandardFinancialStatementsPost:
additionalProperties: false
type: object
properties:
externalUserId:
description: Your reference ID for the user or individual standard financial statement. The same value could be assigned to all statements created as part of the same collections lifecycle, for example
type: string
name:
description: The full name of the user to whom the standard financial statement application applies
type: string
email:
description: The email address of the user to whom the standard financial statement applies
type: string
example:
externalUserId: AGENCYNAME-123
name: Joe Bloggs
email: joe.blogss@example.com
Error:
additionalProperties: false
properties:
code:
description: The error code
type: string
message:
description: The error message
type: string
correlationId:
description: Id that identifies the request and can be used to ask for more details related to the error
type: string
id:
description: Id of the resource
type: string
userId:
description: UserId of the resource
type: string
required:
- code
type: object
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header