State Surcharge

Create StateSurcharge

Creates a new StateSurcharge

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
stateSurcharge_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>
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

procedure_Code
string or null <= 8 characters
state
required
string [ 1 .. 2 ] characters
surcharge
number or null <double>
surcharge_Claim_Max
number or null <double>
surcharge_Threshold
number or null <double>
term_Date
string or null <date-time>
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/state-surcharge
Request samples
{
  • "stateSurcharge_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "procedure_Code": "string",
  • "state": "st",
  • "surcharge": 0.1,
  • "surcharge_Claim_Max": 0.1,
  • "surcharge_Threshold": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List StateSurcharge

Lists all StateSurcharge

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/state-surcharge
Request samples 
Response samples 
No sample
Get StateSurcharge
Gets StateSurcharge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
StateSurcharge_Key
required
integer <int32> 
StateSurcharge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/state-surcharge/{StateSurcharge_Key}
Request samples 
Response samples 
No sample
Update StateSurcharge
Updates a specific StateSurcharge.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
StateSurcharge_Key
required
integer <int32> 
StateSurcharge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
stateSurcharge_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
 
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


 
procedure_Code
string or null  <= 8 characters 
 
state
required
string  [ 1 .. 2 ] characters 
 
surcharge
number or null <double> 
 
surcharge_Claim_Max
number or null <double> 
 
surcharge_Threshold
number or null <double> 
 
term_Date
string or null <date-time> 
 
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/state-surcharge/{StateSurcharge_Key}
Request samples 
{
  • "stateSurcharge_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "procedure_Code": "string",
  • "state": "st",
  • "surcharge": 0.1,
  • "surcharge_Claim_Max": 0.1,
  • "surcharge_Threshold": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete StateSurcharge
Deletes an StateSurcharge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
StateSurcharge_Key
required
integer <int32> 
StateSurcharge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/state-surcharge/{StateSurcharge_Key}
Request samples 
Create or Update Batch StateSurcharge
Create or Update multiple StateSurcharge 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 
stateSurcharge_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
 
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


 
procedure_Code
string or null  <= 8 characters 
 
state
required
string  [ 1 .. 2 ] characters 
 
surcharge
number or null <double> 
 
surcharge_Claim_Max
number or null <double> 
 
surcharge_Threshold
number or null <double> 
 
term_Date
string or null <date-time> 
 
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/state-surcharge-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}