HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Overview

Servers

Mock server

https://docs.heydonto.com/_mock/apis/heydonto/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Site Appointment Types

Operations

Appointment Type

Operations

Brands

Operations

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations

Get list of Billing Information filtered

Request

Security

bearer

Query

withPaymentMethodboolean

Pass true or false (1 or 0) to filter by whether the billing information has a payment method (credit card or bank account)

pagenumber>= 0

Page number (0-based)

Default 0

Example: page=0

pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10

Example: pageSize=10

sortBy[0][field]string

First sort field

Enum"id""clientAccountId""createdAt""updatedAt"

sortBy[0][dir]string

First sort direction

Enum"asc""desc"

sortBy[1][field]string

Second sort field

Enum"id""clientAccountId""createdAt""updatedAt"

sortBy[1][dir]string

Second sort direction

Enum"asc""desc"

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information?page=0&pageSize=10&sortBy%5B0%5D%5Bdir%5D=asc&sortBy%5B0%5D%5Bfield%5D=id&sortBy%5B1%5D%5Bdir%5D=asc&sortBy%5B1%5D%5Bfield%5D=id&withPaymentMethod=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of Billing Information filtered

Bodyapplication/json

dataArray of objects(BillingInformationWithManagerAndAccountDto)required

Array of billing information

data[].idnumberrequired

ID of the billing information

Example: 1

data[].clientAccountIdnumberrequired

ID of the client account

Example: 1

data[].costPerLocationnumberrequired

Cost per location

Example: 100

data[].minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

data[].isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

data[].billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

data[].billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

data[].stripeCustomerIdstring or null

Stripe customer ID

Example: "cus_123456789"

data[].createdAtstring(date-time)required

Creation date

Example: "2024-01-01T00:00:00Z"

data[].stripeSubscriptionIdstring or null

Stripe subscription ID (once a subscription exists)

Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

data[].updatedAtstring(date-time)required

Last update date

Example: "2024-01-01T00:00:00Z"

data[].billingManagerUserobject(BillingManagerUserDto)required

data[].billingManagerUser.userobject(UserDto)required

data[].billingManagerUser.user.emailstringrequired

Example: "john.doe@example.com"

data[].billingManagerUser.user.firstNamestringrequired

Example: "John"

data[].billingManagerUser.user.lastNamestringrequired

Example: "Doe"

data[].clientAccountobject(ClientAccountDto)required

data[].clientAccount.idnumberrequired

Example: 1

data[].clientAccount.titlestringrequired

Example: "Downtown Clinic"

metaobjectrequired

Pagination metadata

meta.pagenumberrequired

Current page number (0-based)

Example: 0

meta.pageSizenumberrequired

Number of items per page

Example: 10

meta.totalnumberrequired

Total number of items

Example: 150

meta.totalPagesnumberrequired

Total number of pages

Example: 15

meta.hasNextbooleanrequired

Whether there is a next page

Example: true

meta.hasPreviousbooleanrequired

Whether there is a previous page

Example: false

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "page": 0,
    "pageSize": 10,
    "total": 150,
    "totalPages": 15,
    "hasNext": true,
    "hasPrevious": false
  }
}

Create new Billing Information

Request

Security

bearer

Bodyapplication/jsonrequired

clientAccountIdnumberrequired

The client account ID

Example: 1

billingManagerUserIdnumberrequired

The billing manager user ID

Example: 1

costPerLocationnumberrequired

Cost per location

Example: 100

minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientAccountId": 1,
    "billingManagerUserId": 1,
    "costPerLocation": 100,
    "minimumBillingLocations": 5,
    "isAutoRenew": true,
    "billingStartDate": "2024-03-17",
    "billingFrequency": "MONTHLY"
  }'

Responses

Billing Information created successfully.

Bodyapplication/json

idnumberrequired

ID of the billing information

Example: 1

clientAccountIdnumberrequired

ID of the client account

Example: 1

costPerLocationnumberrequired

Cost per location

Example: 100

minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

stripeCustomerIdstring or null

Stripe customer ID

Example: "cus_123456789"

createdAtstring(date-time)required

Creation date

Example: "2024-01-01T00:00:00Z"

stripeSubscriptionIdstring or null

Stripe subscription ID (once a subscription exists)

Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

updatedAtstring(date-time)required

Last update date

Example: "2024-01-01T00:00:00Z"

Response

application/json

{
  "id": 1,
  "clientAccountId": 1,
  "costPerLocation": 100,
  "minimumBillingLocations": 5,
  "isAutoRenew": true,
  "billingStartDate": "2024-03-17",
  "billingFrequency": "MONTHLY",
  "stripeCustomerId": "cus_123456789",
  "createdAt": "2024-01-01T00:00:00Z",
  "stripeSubscriptionId": "sub_1RFBYKHGcS3PmRZjUcjG4rYN",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Update Billing Information

Request

Security

bearer

Path

idnumberrequired

Bodyapplication/jsonrequired

costPerLocationnumber

Cost per location

Example: 100

minimumBillingLocationsnumber

Minimum number of billing locations

Example: 5

isAutoRenewboolean

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)

Start date for billing

Example: "2024-03-17"

billingFrequencystring

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "costPerLocation": 100,
    "minimumBillingLocations": 5,
    "isAutoRenew": true,
    "billingStartDate": "2024-03-17",
    "billingFrequency": "MONTHLY"
  }'

Responses

Billing Information updated successfully.

Bodyapplication/json

idnumberrequired

ID of the billing information

Example: 1

clientAccountIdnumberrequired

ID of the client account

Example: 1

costPerLocationnumberrequired

Cost per location

Example: 100

minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

stripeCustomerIdstring or null

Stripe customer ID

Example: "cus_123456789"

createdAtstring(date-time)required

Creation date

Example: "2024-01-01T00:00:00Z"

stripeSubscriptionIdstring or null

Stripe subscription ID (once a subscription exists)

Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

updatedAtstring(date-time)required

Last update date

Example: "2024-01-01T00:00:00Z"

Response

application/json

{
  "id": 1,
  "clientAccountId": 1,
  "costPerLocation": 100,
  "minimumBillingLocations": 5,
  "isAutoRenew": true,
  "billingStartDate": "2024-03-17",
  "billingFrequency": "MONTHLY",
  "stripeCustomerId": "cus_123456789",
  "createdAt": "2024-01-01T00:00:00Z",
  "stripeSubscriptionId": "sub_1RFBYKHGcS3PmRZjUcjG4rYN",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Get Billing Information by ID

Request

Security

bearer

Path

idnumberrequired

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Billing Information found.

Bodyapplication/json

idnumberrequired

ID of the billing information

Example: 1

clientAccountIdnumberrequired

ID of the client account

Example: 1

costPerLocationnumberrequired

Cost per location

Example: 100

minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

stripeCustomerIdstring or null

Stripe customer ID

Example: "cus_123456789"

createdAtstring(date-time)required

Creation date

Example: "2024-01-01T00:00:00Z"

stripeSubscriptionIdstring or null

Stripe subscription ID (once a subscription exists)

Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

updatedAtstring(date-time)required

Last update date

Example: "2024-01-01T00:00:00Z"

Response

application/json

{
  "id": 1,
  "clientAccountId": 1,
  "costPerLocation": 100,
  "minimumBillingLocations": 5,
  "isAutoRenew": true,
  "billingStartDate": "2024-03-17",
  "billingFrequency": "MONTHLY",
  "stripeCustomerId": "cus_123456789",
  "createdAt": "2024-01-01T00:00:00Z",
  "stripeSubscriptionId": "sub_1RFBYKHGcS3PmRZjUcjG4rYN",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Delete Stripe customer & local Billing Information

Request

Security

bearer

Path

idnumberrequired

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Stripe customer and Billing Information deleted successfully.

Response

No content

Get Billing Information by Client Account ID

Request

Security

bearer

Path

clientAccountIdnumberrequired

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information/client-account/{clientAccountId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Billing Information found.

Bodyapplication/json

idnumberrequired

ID of the billing information

Example: 1

clientAccountIdnumberrequired

ID of the client account

Example: 1

costPerLocationnumberrequired

Cost per location

Example: 100

minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

stripeCustomerIdstring or null

Stripe customer ID

Example: "cus_123456789"

createdAtstring(date-time)required

Creation date

Example: "2024-01-01T00:00:00Z"

stripeSubscriptionIdstring or null

Stripe subscription ID (once a subscription exists)

Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

updatedAtstring(date-time)required

Last update date

Example: "2024-01-01T00:00:00Z"

Response

application/json

{
  "id": 1,
  "clientAccountId": 1,
  "costPerLocation": 100,
  "minimumBillingLocations": 5,
  "isAutoRenew": true,
  "billingStartDate": "2024-03-17",
  "billingFrequency": "MONTHLY",
  "stripeCustomerId": "cus_123456789",
  "createdAt": "2024-01-01T00:00:00Z",
  "stripeSubscriptionId": "sub_1RFBYKHGcS3PmRZjUcjG4rYN",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Get Billing Information by Client Account ID

Request

Security

bearer

Path

clientAccountIdnumberrequired

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/billing-information/me/client-account/{clientAccountId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Billing Information found.

Bodyapplication/json

idnumberrequired

ID of the billing information

Example: 1

clientAccountIdnumberrequired

ID of the client account

Example: 1

costPerLocationnumberrequired

Cost per location

Example: 100

minimumBillingLocationsnumberrequired

Minimum number of billing locations

Example: 5

isAutoRenewbooleanrequired

Whether auto-renewal is enabled

Example: true

billingStartDatestring(date-time)required

Start date for billing

Example: "2024-03-17"

billingFrequencystringrequired

Billing frequency

Enum"MONTHLY""QUARTERLY""ANNUALLY"

Example: "MONTHLY"

stripeCustomerIdstring or null

Stripe customer ID

Example: "cus_123456789"

createdAtstring(date-time)required

Creation date

Example: "2024-01-01T00:00:00Z"

stripeSubscriptionIdstring or null

Stripe subscription ID (once a subscription exists)

Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

updatedAtstring(date-time)required

Last update date

Example: "2024-01-01T00:00:00Z"

Response

application/json

{
  "id": 1,
  "clientAccountId": 1,
  "costPerLocation": 100,
  "minimumBillingLocations": 5,
  "isAutoRenew": true,
  "billingStartDate": "2024-03-17",
  "billingFrequency": "MONTHLY",
  "stripeCustomerId": "cus_123456789",
  "createdAt": "2024-01-01T00:00:00Z",
  "stripeSubscriptionId": "sub_1RFBYKHGcS3PmRZjUcjG4rYN",
  "updatedAt": "2024-01-01T00:00:00Z"
}

HeyDonto API Documentation (1.0)

Site Appointment Types

Appointment Type

Brands

Dental Practices

Dental Services

Organizations

Practice Management Systems

Sites

Codes

Site Assistants

Periomeasure

Availability

Users

Billing Information

Get list of Billing Information filtered

Request

Responses

Was this helpful?

Create new Billing Information

Request

Responses

Was this helpful?

Update Billing Information

Request

Responses

Was this helpful?

Get Billing Information by ID

Request

Responses

Was this helpful?

Delete Stripe customer & local Billing Information

Request

Responses

Was this helpful?

Get Billing Information by Client Account ID

Request

Responses

Was this helpful?

Get Billing Information by Client Account ID

Request

Responses

Was this helpful?