Create a provider statement

POST /api/v1/provider-statement

Headers

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

POST /api/v1/provider-statement 
curl \
 -X POST 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}" \
 -d '{"statement_uuid":"87c0e597-5405-4768-a261-abff57882b5f","provider_uuid":"c52fa333-85ae-4da8-bc5a-ebb1ef6ef940","date":"2024-11-20","name":"Aviva Statement #3894","reference":"SW#8434"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "statement_uuid": "87c0e597-5405-4768-a261-abff57882b5f",
  "provider_uuid": "c52fa333-85ae-4da8-bc5a-ebb1ef6ef940",
  "date": "2024-11-20",
  "name": "Aviva Statement #3894",
  "reference": "SW#8434"
}
Response examples (201) 
{
  "date": "2024-11-20",
  "name": "Aviva",
  "uuid": "c3c8ead3-a7b0-4e64-a238-a02ccba463ec",
  "number": 23,
  "origin": "upload",
  "filename": "aviva-statement-may.csv",
  "provider": {
    "name": "AJ Bell",
    "slug": "aj-bell",
    "uuid": "59735d66-485e-4cfa-a964-233244eeafe1",
    "created_at": "2024-11-20T13:24:04+00:00",
    "updated_at": "2024-11-20T13:24:04+00:00"
  },
  "reference": "SW#8434",
  "statement": {
    "name": "01/06/2022 - 30/06/2022",
    "uuid": "265b3317-7fcb-4ea1-a063-cc39aaddcf04",
    "locked": false,
    "end_date": "2022-06-01",
    "locked_at": "2024-11-20T13:24:04+00:00",
    "locked_by": "App\\Http\\Resources\\AccountResource",
    "created_at": "2024-11-20T13:24:04+00:00",
    "start_date": "2022-06-30",
    "updated_at": "2024-11-20T13:24:04+00: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-11-20T13:24:04+00:00",
  "updated_at": "2024-11-20T13:24:04+00:00",
  "total_amount": {
    "amount": "345895",
    "currency": "GBP",
    "formatted": "£3,458.95"
  },
  "statement_transactions": [
    {
      "date": "2024-11-20",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "69bb3999-45c1-491f-ba4e-3cb673b6c262",
      "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-11-20T13:24:04+00: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-11-20T13:24:04+00: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": "twwTjGHwvG"
    }
  ],
  "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
}