Calculate the income splits of an expectation

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

Headers

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

Body Required

  • chargeable_type string Required

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

  • chargeable_uuid string 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 Required

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

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":"plan","chargeable_uuid":"667bca40-a25b-4c4a-93c2-4a606cddc164","amount":12500,"ongoing":false,"tax_exempt":false,"tax":0.0}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "chargeable_type": "plan",
  "chargeable_uuid": "667bca40-a25b-4c4a-93c2-4a606cddc164",
  "amount": 12500,
  "ongoing": false,
  "tax_exempt": false,
  "tax": 0.0
}
Response examples (401) 
{
  "message": "Unauthenticated."
}