Create a provider statement

POST /api/v1/provider-statement

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

statement_uuid string Required

Payment period statement UUID
provider_uuid string Required

Provider UUID
date date Required

Statement date
name string

Optional title to name the provider statement. If null an auto generated name will be created as provider name and statement date.
reference string

Statement reference given by provider

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- number integer
  
  Provider statement number
- name string
  
  Provider name
- date string
  
  Provider statement date
- reference string
  
  provider statement reference given by provider
- filename string
  
  Filename if uploaded by CSV or automatically from EDI
- origin string
  
  how the provider statement was created. Values are edi, manual, upload and auto
- provider object
  
  Provider
  
  Hide provider attributes Show provider attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
- statement object
  
  Statement
  
  Hide statement attributes Show statement attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  start_date string
  
  end_date string
  
  locked boolean
  
  locked_at string
  
  locked_by string
  
  total_expectations object
  
  Hide total_expectations attributes Show total_expectations attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_statement_transactions object
  
  Hide total_statement_transactions attributes Show total_statement_transactions attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_bank_transactions object
  
  Hide total_bank_transactions attributes Show total_bank_transactions attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_expectation_amount_reconciled_to_bank object
  
  Hide total_expectation_amount_reconciled_to_bank attributes Show total_expectation_amount_reconciled_to_bank attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  total_expectation_percentage_reconciled_to_bank object
  
  Hide total_expectation_percentage_reconciled_to_bank attributes Show total_expectation_percentage_reconciled_to_bank attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  expectations_count integer
  
  statement_transactions_count integer
  
  statement_transactions string
- statement_transactions_count integer
  
  Total number of statement transactions within provider statement
- statement_transactions array[object]
  
  Statement transactions within provider statement
  
  Hide statement_transactions attributes Show statement_transactions attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  client_name string
  
  transaction_reference string
  
  policy_number string
  
  date string
  
  gross_amount object
  
  Hide gross_amount attributes Show gross_amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  net_amount object
  
  Hide net_amount attributes Show net_amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  category string
  
  payment_origin string
  
  agency_number string
  
  product_reference string
  
  adviser_name string
  
  sender_id_sib_number string
  
  reason string
  
  scheme_name string
  
  scheme_number string
  
  customer_number string
  
  policy_market_value string
  
  provider string
  
  provider_statement string
  
  metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  client_name string
  
  expectation string
  
  bank_transactions string
  
  statement string
  
  account string
  
  firm string
- total_amount object
  
  Total amount of all statement transactions within this provider statement
  
  Hide total_amount attributes Show total_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- reconciled_expectations_amount object
  
  Total amount reconciled against expectations
  
  Hide reconciled_expectations_amount attributes Show reconciled_expectations_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- reconciled_expectations_percentage number
  
  Total percentage reconciled against expectations
- reconciled_bank_transactions_amount object
  
  Total amount reconciled against bank transactions
  
  Hide reconciled_bank_transactions_amount attributes Show reconciled_bank_transactions_amount attributes object
  
  amount string
  
  currency string
  
  formatted string
- reconciled_bank_transactions_percentage number
  
  Total percentage reconciled against bank transactions
- is_fully_reconciled_to_expectations boolean
  
  Returns if all statement transactions are fully reconciled to expectations

POST /api/v1/provider-statement

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/provider-statement' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"statement_uuid":"bcae77f8-b776-4824-9768-2b289aaea535","provider_uuid":"368c0c7c-7bb8-416b-bbbc-90d78c48108f","date":"2025-08-27","name":"Aviva Statement #3894","reference":"SW#8434"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "statement_uuid": "bcae77f8-b776-4824-9768-2b289aaea535",
  "provider_uuid": "368c0c7c-7bb8-416b-bbbc-90d78c48108f",
  "date": "2025-08-27",
  "name": "Aviva Statement #3894",
  "reference": "SW#8434"
}

Response examples (201)

{
  "date": "2025-08-27",
  "name": "Aviva",
  "uuid": "4b5d87d8-551c-4adb-b71d-af9aa4a01a46",
  "number": 23,
  "origin": "upload",
  "filename": "aviva-statement-may.csv",
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "666eef41-e03b-495c-a9bb-069a4be7908f",
    "created_at": "2025-08-27T17:31:27+01:00",
    "updated_at": "2025-08-27T17:31:27+01:00"
  },
  "reference": "SW#8434",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "bd55dd42-4d23-40e7-b8bc-9f92de19c956",
    "locked": false,
    "end_date": "2022-06-01",
    "locked_at": "2025-08-27T17:31:27+01:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-08-27T17:31:27+01:00",
    "start_date": "2022-06-30",
    "updated_at": "2025-08-27T17:31:27+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": "2025-08-27T17:31:27+01:00",
  "updated_at": "2025-08-27T17:31:27+01:00",
  "total_amount": {
    "amount": "345895",
    "currency": "GBP",
    "formatted": "£3,458.95"
  },
  "statement_transactions": [
    {
      "date": "2025-08-27",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "8673b1a4-e3d2-4dae-a62a-682a64c49cfc",
      "reason": "Reason",
      "account": "App\\Http\\Resources\\AccountResource",
      "category": "initial_fee",
      "metadata": {
        "client_name": "Gareth Thompson"
      },
      "provider": "Aviva",
      "statement": "App\\Http\\Resources\\StatementResource",
      "created_at": "2025-08-27T17:31:27+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": "2025-08-27T17:31:27+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": "PFXIK77kr7"
    }
  ],
  "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
}