Fee Schedules

Create FeeSched

Creates a new FeeSched

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
fee_Sched
required
string [ 1 .. 8 ] characters

Unique name given to the Fee Scheudle.

always_Use_Schedule
string or null <= 1 characters

This field is currently informational only.

description
string or null <= 50 characters

A short description of the associated Fee Schedule.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

ex_Code
string or null <= 6 characters

Indicates the Ex Code that will be applied to any claim that has been repriced by this ‘Fee Schedule Fee’.

process_Adj_Disc_By_Amount
required
boolean

Indicates Adjustment and Discount information will be processed based on amount highest to lowest rather than detail line. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/fee-schedules
Request samples
{
  • "fee_Sched": "string",
  • "always_Use_Schedule": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "process_Adj_Disc_By_Amount": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FeeSched

Lists all FeeSched

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/fee-schedules
Request samples
Response samples
No sample

Copy Fee Schedule Advanced API

Copy an existing Fee Schedule to a new Fee Schedule.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
old_Fee_Sched
string or null
new_Fee_Sched
string or null
old_Eff_Date
string or null <date-time>
new_Eff_Date
string or null <date-time>
description
string or null
percent_Change
number or null <double>
user_ID
string or null
Responses
200

Success

401

Unauthorized

post/fee-schedule-copy
Request samples
{
  • "old_Fee_Sched": "string",
  • "new_Fee_Sched": "string",
  • "old_Eff_Date": "2019-08-24T14:15:22Z",
  • "new_Eff_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "percent_Change": 0.1,
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Copy Fee Schedule and Adjust Discount Advanced API

Copy an existing Fee Schedule to a new Fee Schedule and adjust the resulting discount in the new Fee Schedule.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
old_Fee_Sched
string or null
new_Fee_Sched
string or null
old_Eff_Date
string or null <date-time>
new_Eff_Date
string or null <date-time>
description
string or null
percent_Change
number or null <double>
user_ID
string or null
Responses
200

Success

401

Unauthorized

post/fee-schedule-copy-adj-disc
Request samples
{
  • "old_Fee_Sched": "string",
  • "new_Fee_Sched": "string",
  • "old_Eff_Date": "2019-08-24T14:15:22Z",
  • "new_Eff_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "percent_Change": 0.1,
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get FeeSched

Gets FeeSched

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
feeSched
required
string

Fee Sched

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/fee-schedules/{feeSched}
Request samples
Response samples
No sample

Update FeeSched

Updates a specific FeeSched.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
feeSched
required
string

Fee Sched

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
fee_Sched
required
string [ 1 .. 8 ] characters

Unique name given to the Fee Scheudle.

always_Use_Schedule
string or null <= 1 characters

This field is currently informational only.

description
string or null <= 50 characters

A short description of the associated Fee Schedule.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

ex_Code
string or null <= 6 characters

Indicates the Ex Code that will be applied to any claim that has been repriced by this ‘Fee Schedule Fee’.

process_Adj_Disc_By_Amount
required
boolean

Indicates Adjustment and Discount information will be processed based on amount highest to lowest rather than detail line. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

put/fee-schedules/{feeSched}
Request samples
{
  • "fee_Sched": "string",
  • "always_Use_Schedule": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "process_Adj_Disc_By_Amount": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete FeeSched

Deletes an FeeSched

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
feeSched
required
string

Fee Sched

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/fee-schedules/{feeSched}
Request samples

Create or Update Batch FeeSched

Create or Update multiple FeeSched at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
fee_Sched
required
string [ 1 .. 8 ] characters

Unique name given to the Fee Scheudle.

always_Use_Schedule
string or null <= 1 characters

This field is currently informational only.

description
string or null <= 50 characters

A short description of the associated Fee Schedule.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

ex_Code
string or null <= 6 characters

Indicates the Ex Code that will be applied to any claim that has been repriced by this ‘Fee Schedule Fee’.

process_Adj_Disc_By_Amount
required
boolean

Indicates Adjustment and Discount information will be processed based on amount highest to lowest rather than detail line. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
207

Success

401

Unauthorized

put/fee-schedules-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}

List Usual and Customary Rates

Lists all UC Rates based on provided criteria.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
claimType
string

Claim Type

serviceDate
string <date-time>

Service Date

zipStart
string

Zip Code From

zipEnd
string

Zip Code Thru

procStart
string

Procedure Code From

procEnd
string

Procedure Code Thru

modifier
string

Modifier

percentile
integer <int32>

Percentile

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/usual-customary-rate
Request samples
Response samples
No sample