Assets Under Management

GET /api/v1/metrics/aum

Get a breakdown of the Assets Under Management for a firm.

Query parameters

  • filter[agency_in_your_name] boolean

    Filter the AUM to only include plans that are in the firm's name. False = all, true = only plans with agency in your name

application/json

Body

  • date date

    The date which you would like to run the key metric from.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      The Assets Under Management calculations for a firm on the current date or the date submitted.
      data.total: Total of all investment, pension, cash plans.

      abstract_types
      data.abstract_types.assets: Total of all assets.
      data.abstract_types.liabilities: Total of all liabilities.
      data.abstract_types.protection: Total of all protection.

      plan_types
      data.plan_types.annuity: Total of all annuities.
      data.plan_types.cash_account: Total of all cash plans.
      data.plan_types.fixed_asset: Total of all fixed asset plans.
      data.plan_types.general_insurance: Total of all fixed general insurance assets.
      data.plan_types.group_protection: Total of all fixed group protection assets.
      data.plan_types.investment: Total of all investment plans.
      data.plan_types.loan_credit: Total of all loan credit plans.
      data.plan_types.mortgage: Total of all mortgage plans.
      data.plan_types.pension: Total of all pension plans.
      data.protection_policy.pension: Total of all protection policy plans.

      Additional properties are allowed.
GET /api/v1/metrics/aum 
curl \
 -X GET https://api.plannrcrm.com/api/v1/metrics/aum \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"date":"2023-01-01"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "date": "2023-01-01"
}
Response examples (200) 
{
  "data": [
    {
      "data": {
        "total": {
          "amount": {
            "example": "1234567",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£12,345.67",
            "description": "Money amount formatted with currency"
          }
        },
        "plan_types": {
          "annuity": {
            "amount": {
              "example": "1234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£12,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "pension": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "mortgage": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "investment": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "fixed_asset": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "loan_credit": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "cash_account": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "group_protection": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "general_insurance": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "protection_policy": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          }
        },
        "abstract_types": {
          "assets": {
            "amount": {
              "example": "1234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£12,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "protection": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          },
          "liabilities": {
            "amount": {
              "example": "234567",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£2,345.67",
              "description": "Money amount formatted with currency"
            }
          }
        }
      },
      "date": "2023-06-30",
      "metric": "aum",
      "requested_at": "2023-07-01 12:30:45"
    }
  ]
}