POST /api/v1/expectation/calculate
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • chargeable_type string Required

    Chargeable model type to run calculation on. Valid types are: client, plan

    Values are client or plan.

  • chargeable_uuid string(uuid) Required

    Chargeable model UUID to run calculation on.

  • amount integer Required

    Expected net amount to calculate on in pennies.

  • ongoing boolean

    Whether to run the calculation based on ongoing charges. Leave as false for initial charges. Defaults to false.

  • tax_exempt boolean

    Denotes whether the net amount given is tax exempt or not. Defaults to true.

  • tax number(float)

    Custom tax rate to apply to the net amount. Defaults to firm setting or defaults to Plannr setting of 20%.

    Minimum value is 0.0, maximum value is 100.0.

  • seller_uuid string(uuid)

    Select a different adviser to run the calculation again. If not provided a default based on the chargeable model will be selected.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/expectation/calculate 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/expectation/calculate' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"chargeable_type":"client","chargeable_uuid":"e5ba926c-50c2-4da1-93be-55563a76bdfc","amount":12500,"ongoing":false,"tax_exempt":false,"tax":17.5,"seller_uuid":"746f8f94-cfbb-4978-aaa8-32f85be86470"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "chargeable_type": "client",
  "chargeable_uuid": "e5ba926c-50c2-4da1-93be-55563a76bdfc",
  "amount": 12500,
  "ongoing": false,
  "tax_exempt": false,
  "tax": 17.5,
  "seller_uuid": "746f8f94-cfbb-4978-aaa8-32f85be86470"
}
Response examples (401) 
{
  "message": "Unauthenticated."
}