Modifiers

Create Modifier

Creates a new Modifier

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

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

Code identifying the procedure code modifier

effective_Date
string or null <date-time>

Date the modifier becomes effective

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

fee_Percent
number or null <double>

Percentage used when the modifier is applied

modifier_Description
string or null <= 100 characters

Description of the procedure code modifier

term_Date
string or null <date-time>

Date the modifier terminates

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/modifiers
Request samples
{
  • "modifier_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "modifier_Description": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Modifier

Lists all Modifier

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/modifiers
Request samples
Response samples
No sample

Get Modifier

Gets Modifier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
modifierCode
required
string

Modifier Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/modifiers/{modifierCode}
Request samples
Response samples
No sample

Update Modifier

Updates a specific Modifier.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
modifierCode
required
string

Modifier Code

header Parameters
vbasoftware-database
required
string

Target database

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

Code identifying the procedure code modifier

effective_Date
string or null <date-time>

Date the modifier becomes effective

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

fee_Percent
number or null <double>

Percentage used when the modifier is applied

modifier_Description
string or null <= 100 characters

Description of the procedure code modifier

term_Date
string or null <date-time>

Date the modifier terminates

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

put/modifiers/{modifierCode}
Request samples
{
  • "modifier_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "modifier_Description": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete Modifier

Deletes an Modifier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
modifierCode
required
string

Modifier Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/modifiers/{modifierCode}
Request samples

Create or Update Batch Modifier

Create or Update multiple Modifier 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
modifier_Code
required
string [ 1 .. 8 ] characters

Code identifying the procedure code modifier

effective_Date
string or null <date-time>

Date the modifier becomes effective

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

fee_Percent
number or null <double>

Percentage used when the modifier is applied

modifier_Description
string or null <= 100 characters

Description of the procedure code modifier

term_Date
string or null <date-time>

Date the modifier terminates

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
207

Success

401

Unauthorized

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