Tross
Demo dataBook a demo
DENTRIX-ASCEND

Set plan benefits

Set a carrier plan's own deductibles and maximums.

POSThttps://preview.ontross.com/api/integrations/dentrix-ascend/set-plan-benefits
Request Fields
input.carrier_insurance_plan_id
string
required
The carrier plan, shared by every patient attached to it.
Example
"64000000451392"
input.benefits
array
required
The amounts to set. Fields not listed are left as they are.
input.benefits[].field
string
required
Which deductible or maximum to set.
Example
"individual_annual_maximum"
Accepted values
preventive_individual_annual_deductiblepreventive_family_annual_deductiblepreventive_individual_lifetime_deductiblebasic_individual_annual_deductiblebasic_family_annual_deductiblebasic_individual_lifetime_deductiblemajor_individual_annual_deductiblemajor_family_annual_deductiblemajor_individual_lifetime_deductibleortho_individual_annual_deductibleortho_individual_lifetime_deductibleindividual_annual_maximumfamily_annual_maximumortho_lifetime_maximumimplant_annual_maximumimplant_lifetime_maximum
input.benefits[].amount
number
required
The amount, or null to clear it.
Example
1500
input.benefit_year
integer
required
Which benefit year to write. The plan keeps the current and the previous year; any other is refused rather than created.
Example
2026
input.allow_maximum_mismatch
boolean
Write an annual maximum that contradicts the maximum stated in the plan's own name. Off by default: a mismatch usually means the patient is on the wrong plan tier, and re-attaching them is the fix -- editing the plan would corrupt it for everyone genuinely on that tier.
Example
false
Default
false
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
carrier_insurance_plan_id
string
The plan that was written.
benefit_year
integer
The benefit year written.
Example
2026
verified
boolean
True only after every amount was read back and matched.
Example
true
benefits
object
Every benefit field as the plan now holds it.
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/dentrix-ascend/set-plan-benefits \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"carrier_insurance_plan_id":"64000000451392","benefits":[{"field":"individual_annual_maximum","amount":1500}],"benefit_year":2026,"allow_maximum_mismatch":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "carrier_insurance_plan_id": "64000000451392",
    "benefits": [
      {
        "field": "individual_annual_maximum",
        "amount": 1500
      }
    ],
    "benefit_year": 2026,
    "allow_maximum_mismatch": false
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "carrier_insurance_plan_id": "string",
    "benefit_year": 2026,
    "verified": true,
    "benefits": {
      "property1": 0,
      "property2": 0
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}