POST

Customer.Appointments.InsuranceAmount

Return insurance_price / insurance_customer_price for an appointment type + insurance company (same as dashboard get_insurance_company_amount_by_app_type / AppointmentCoupon.InsuranceAmount).

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Runs the Customer.Appointments.InsuranceAmount function and returns JSON.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

  • Requires Customer.Login token. Staff AppointmentCoupon.InsuranceAmount also accepts customer tokens.

Required Parameters

NameTypeSampleExplanation
appointment_type_id
post
int697Aliases: appointments_type_id, appo_type_id.
insurance
post
int2Aliases: insurance_id, coupon_insurance_company.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Customer.Appointments.InsuranceAmount",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "appointment_type_id": "697",
        "insurance": "2"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Appointments.InsuranceAmount",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Appointments.InsuranceAmount"
}

Endpoint

POST /app/Customer.Appointments.InsuranceAmount
POST https://{user}.bull36.com/app/Customer.Appointments.InsuranceAmount
POST https://{domain}/app/Customer.Appointments.InsuranceAmount

Sample Output

{
    "success": 1,
    "amount": 100,
    "left_amount": 50
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('appointment_type_id', '697');
body.set('insurance', '2');

const res = await fetch('/app/Customer.Appointments.InsuranceAmount', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "No insurance price configured for this appointment type"
}