Get a statement

GET /api/v1/statement/{uuid}

Path parameters

Responses

GET /api/v1/statement/{uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/statement/uuid \
 -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) 
{
  "name": "01/06/2022 - 30/06/2022",
  "uuid": "d093c560-7549-4574-ae6c-325f2c92e04b",
  "locked": false,
  "end_date": "2022-06-01",
  "locked_at": "2024-11-20T13:24:03+00:00",
  "locked_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "f553160d-fcbe-4401-b784-f835ebcfd8a3",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00:00"
  },
  "created_at": "2024-11-20T13:24:03+00:00",
  "start_date": "2022-06-30",
  "updated_at": "2024-11-20T13:24:03+00:00",
  "expectations_count": 6,
  "total_expectations": {
    "amount": "124585",
    "currency": "GBP",
    "formatted": "£1,245.85"
  },
  "statement_transactions": [
    {
      "date": "2024-11-20",
      "firm": "App\\Http\\Resources\\FirmResource",
      "uuid": "84d0be26-4ddf-4e46-b9c3-d7581b12c07e",
      "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:03+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:03+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": "5wVFnrY090"
    }
  ],
  "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"
  }
}