Get all provider statements
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[statement] string
Comma separated list of payment period statement UUIDs. e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea
-
filter[name] string
Comma separated list of partial provider statement names. e.g. Scottish Widows
-
filter[reference] string
Comma separated list of partial provider statement references. e.g. SW#324
-
filter[provider] string
Comma separated list of partial provider names or exact provider UUIDs. e.g. Scottish Widows,fb8ca37d-6c5b-4688-bb69-1aacfffb8bea
-
filter[date_from] string
Statement date from in format YYYY-MM-DD e.g. 2022-10-15
-
filter[date_to] string
Statement date from in format YYYY-MM-DD e.g. 2022-12-30
-
filter[amount_from] integer
Total amount of transactions within provider statement to, in pennies e.g. 5000
-
sort string
Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. Negative sign to denote DESC. Defaults to '-created_at'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET /api/v1/provider-statement
curl \
-X GET https://api.plannrcrm.com/api/v1/provider-statement \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"date": "2024-10-16",
"name": "Aviva",
"uuid": "98daaf35-4e5a-4708-bcd6-0ca5089d4d77",
"number": 23,
"origin": "upload",
"filename": "aviva-statement-may.csv",
"provider": {
"name": "AJ Bell",
"slug": "aj-bell",
"uuid": "1deb6e59-ec67-4022-920e-26a716237445",
"created_at": "2024-10-16T11:10:16+01:00",
"updated_at": "2024-10-16T11:10:16+01:00"
},
"reference": "SW#8434",
"statement": {
"name": "01/06/2022 - 30/06/2022",
"uuid": "fa0420e7-1438-44d4-835d-41a7a444436a",
"locked": false,
"end_date": "2022-06-01",
"locked_at": "2024-10-16T11:10:16+01:00",
"locked_by": "App\\Http\\Resources\\AccountResource",
"created_at": "2024-10-16T11:10:16+01:00",
"start_date": "2022-06-30",
"updated_at": "2024-10-16T11:10:16+01:00",
"expectations_count": 6,
"total_expectations": {
"amount": "124585",
"currency": "GBP",
"formatted": "£1,245.85"
},
"statement_transactions": "App\\Http\\Resources\\StatementTransactionResource",
"total_bank_transactions": {
"amount": "125599",
"currency": "GBP",
"formatted": "£1,255.99"
},
"statement_transactions_count": 6,
"total_statement_transactions": {
"amount": "125599",
"currency": "GBP",
"formatted": "£1,255.99"
},
"total_expectation_amount_reconciled_to_bank": {
"amount": "125599",
"currency": "GBP",
"formatted": "£1,255.99"
},
"total_expectation_percentage_reconciled_to_bank": {
"amount": "8570",
"currency": "GBP",
"formatted": "£85.70"
}
},
"created_at": "2024-10-16T11:10:16+01:00",
"updated_at": "2024-10-16T11:10:16+01:00",
"total_amount": {
"amount": "345895",
"currency": "GBP",
"formatted": "£3,458.95"
},
"statement_transactions": [
{
"date": "2024-10-16",
"firm": "App\\Http\\Resources\\FirmResource",
"uuid": "d289cd81-f809-4dfb-afac-fd773d2cf45a",
"reason": "Reason",
"account": "App\\Http\\Resources\\AccountResource",
"category": "initial_fee",
"metadata": {
"client_name": "Gareth Thompson"
},
"provider": "Aviva",
"statement": "App\\Http\\Resources\\StatementResource",
"created_at": "2024-10-16T11:10:16+01:00",
"net_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"updated_at": "2024-10-16T11:10:16+01:00",
"client_name": "Gareth Thompson",
"expectation": "App\\Http\\Resources\\ExpectationResource",
"scheme_name": "Scheme name",
"adviser_name": "Adviser name",
"gross_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"agency_number": "Agency number",
"policy_number": "AVIVA_00001",
"scheme_number": "Scheme number",
"payment_origin": "provider",
"customer_number": "Customer number",
"bank_transactions": "App\\Http\\Resources\\BankTransactionResource",
"product_reference": "Product reference",
"provider_statement": "App\\Http\\Resources\\ProviderStatementResource",
"policy_market_value": "Policy market value",
"sender_id_sib_number": "Sender id sib number",
"transaction_reference": "vxYJNeE4ra"
}
],
"statement_transactions_count": 6,
"reconciled_expectations_amount": {
"amount": "12849",
"currency": "GBP",
"formatted": "£128.49"
},
"reconciled_expectations_percentage": 95.68,
"is_fully_reconciled_to_expectations": true,
"reconciled_bank_transactions_amount": {
"amount": "22985",
"currency": "GBP",
"formatted": "£229.85"
},
"reconciled_bank_transactions_percentage": 95.68
}
]
}