Group State Surcharge

Create GroupStateSurcharge

Creates a new GroupStateSurcharge

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupId
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupStateSurcharge_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 when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

group_ID
required
string [ 1 .. 20 ] characters
state
required
string [ 1 .. 2 ] characters
term_Date
string or null <date-time>
update_Date
string <date-time>

Date when 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/groups/{groupId}/state-surcharges
Request samples
{
  • "groupStateSurcharge_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupStateSurcharge

Lists all GroupStateSurcharge for the given groupId

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupId
required
string

Group ID

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/groups/{groupId}/state-surcharges
Request samples 
Response samples 
No sample
Get GroupStateSurcharge
Gets GroupStateSurcharge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupId
required
string
Group ID


 
groupStateSurchargeKey
required
integer <int32> 
GroupStateSurcharge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupId}/state-surcharges/{groupStateSurchargeKey}
Request samples 
Response samples 
No sample
Update GroupStateSurcharge
Updates a specific GroupStateSurcharge.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupId
required
string
Group ID


 
groupStateSurchargeKey
required
integer <int32> 
GroupStateSurcharge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupStateSurcharge_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 when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
group_ID
required
string  [ 1 .. 20 ] characters 
 
state
required
string  [ 1 .. 2 ] characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
Date when 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/groups/{groupId}/state-surcharges/{groupStateSurchargeKey}
Request samples 
{
  • "groupStateSurcharge_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupStateSurcharge
Deletes an GroupStateSurcharge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupId
required
string
Group ID


 
groupStateSurchargeKey
required
integer <int32> 
GroupStateSurcharge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupId}/state-surcharges/{groupStateSurchargeKey}
Request samples 
Create or Update Batch GroupStateSurcharge
Create or Update multiple GroupStateSurcharge at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupId
required
string
 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupStateSurcharge_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 when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
group_ID
required
string  [ 1 .. 20 ] characters 
 
state
required
string  [ 1 .. 2 ] characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
Date when 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/groups/{groupId}/state-surcharges-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}