Tross
Demo dataBook a demo
DENTRIX-ASCEND

Create carrier plan

Create a plan under an existing carrier, and prove it is on file.

POSThttps://preview.ontross.com/api/integrations/dentrix-ascend/create-carrier-plan
Request Fields
input.insurance_carrier_id
string
required
The carrier this plan belongs to, from fetch-insurance-carriers.
Example
"64000000054227"
input.plan_name
string
required
The plan or employer name, as it will appear on every chart.
Example
"7-Eleven, Inc."
input.address
object
required
Where claims for this plan are sent.
input.address.address1
string
required
Address1
Example
"1 Market St"
input.address.city
string
required
City
Example
"Hoboken"
input.address.state
string
required
Two-letter state code.
Example
"NJ"
Accepted values
ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWY
input.address.zip_code
string
required
Zip code
Example
"07030-1234"
input.group_number
string
The group number, printed on claims.
Example
"724748-043-00403"
input.plan_type
string
Plan type.
Example
"DENTAL"
Default
"DENTAL"
Accepted values
DENTALMEDICAL
input.source_of_payment
string
How the plan is funded.
Example
"COMMERCIAL"
Default
"COMMERCIAL"
Accepted values
COMMERCIALMEDICAIDMEDICARESELF_PAYOTHER
input.renewal_month
string
The month the plan's benefit year renews.
Example
"January"
Default
"January"
Accepted values
JanuaryFebruaryMarchAprilMayJuneJulyAugustSeptemberOctoberNovemberDecember
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 created plan, for attach-coverage and the plan writes.
Example
"64000000922747"
insurance_carrier_id
string
The carrier it was created under.
plan_name
string
The plan name on the record.
group_number
string
The group number on the record.
verified
boolean
True only after the plan was read back from the record.
Example
true
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/dentrix-ascend/create-carrier-plan \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"insurance_carrier_id":"64000000054227","plan_name":"7-Eleven, Inc.","address":{"address1":"1 Market St","city":"Hoboken","state":"NJ","zip_code":"07030-1234"},"group_number":"724748-043-00403","plan_type":"DENTAL","source_of_payment":"COMMERCIAL","renewal_month":"January"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "insurance_carrier_id": "64000000054227",
    "plan_name": "7-Eleven, Inc.",
    "address": {
      "address1": "1 Market St",
      "city": "Hoboken",
      "state": "NJ",
      "zip_code": "07030-1234"
    },
    "group_number": "724748-043-00403",
    "plan_type": "DENTAL",
    "source_of_payment": "COMMERCIAL",
    "renewal_month": "January"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "carrier_insurance_plan_id": "64000000922747",
    "insurance_carrier_id": "string",
    "plan_name": "string",
    "group_number": "string",
    "verified": true
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}