DENTRIX-ASCEND
Set benefit amounts
Record what this patient has met and used, and prove the record took it.
POSThttps://preview.ontross.com/api/integrations/dentrix-ascend/set-benefit-amounts
Request Fields
input.patient_id
string
requiredPatient chart identifier.
Example
"64000004467586"input.patient_insurance_plan_id
string
requiredThe patient's coverage record identifier, as returned by fetch-patients.
Example
"64999999731842"input.benefit_year
integer
requiredWhich benefit year to write. The record keeps the current and the previous year; any other year is refused rather than created.
Example
2026input.amounts
array
requiredThe amounts to record. Categories not listed are left as they are.
input.amounts[].category
string
requiredWhich deductible or maximum this amount is for.
Example
"basic_annual_deductible_met"Accepted values
preventive_annual_deductible_metpreventive_lifetime_deductible_metbasic_annual_deductible_metbasic_lifetime_deductible_metmajor_annual_deductible_metmajor_lifetime_deductible_metortho_annual_deductible_metortho_lifetime_deductible_metindividual_annual_maximum_usedortho_lifetime_maximum_usedimplant_annual_maximum_usedimplant_lifetime_maximum_usedinput.amounts[].amount
number
requiredThe amount, in the plan's currency.
Example
25auth_id
string
requiredSaved 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
patient_insurance_plan_id
string
The coverage that was written.
benefit_year
integer
The benefit year written.
Example
2026verified
boolean
True only after every amount was read back and matched; an unconfirmed write raises instead.
Example
trueamounts
object
Every category as the record now holds it, after the write.
Code
curl --request POST \
--url https://preview.ontross.com/api/integrations/dentrix-ascend/set-benefit-amounts \
--header 'X-API-Key: REPLACE_KEY_VALUE' \
--header 'content-type: application/json' \
--data '{"input":{"patient_id":"64000004467586","patient_insurance_plan_id":"64999999731842","benefit_year":2026,"amounts":[{"category":"basic_annual_deductible_met","amount":25}]},"auth_id":"auth_uuid_here"}'Request BODY
{
"input": {
"patient_id": "64000004467586",
"patient_insurance_plan_id": "64999999731842",
"benefit_year": 2026,
"amounts": [
{
"category": "basic_annual_deductible_met",
"amount": 25
}
]
},
"auth_id": "auth_uuid_here"
}Response BODY
{
"id": "string",
"workflow_id": "string",
"auth_id": "string",
"status": "string",
"input": {},
"output": {
"patient_insurance_plan_id": "string",
"benefit_year": 2026,
"verified": true,
"amounts": {
"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"
}