User Amount

Create UserAmount

Creates a new UserAmount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
userAmount_Key
required
integer <int32>

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

claim_Type
required
string [ 1 .. 20 ] characters

Identifies the claim type that the amount limit will be applied to.

detail_Amount
number or null <double>

Identifies the amount limit that will be applied.

detail_Column
required
string [ 1 .. 64 ] characters

Identifies the claim detail that the amount limit will be applied to.

effective_Date
string or null <date-time>

Date when the amount limit becomes/became 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

ex_Code
string or null <= 6 characters

Identifies the Ex Code that will be applied to any adjudicated claim that exceeds the ‘User Limit’.

term_Date
string or null <date-time>

Date when the amount limit expires/expired.

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

user_ID
required
string [ 1 .. 16 ] characters

ID of the User to whom the amount will be applied.

Responses
200

Success

401

Unauthorized

post/users/{userID}/amounts
Request samples
{
  • "userAmount_Key": 0,
  • "claim_Type": "string",
  • "detail_Amount": 0.1,
  • "detail_Column": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List UserAmount

Lists all UserAmount given a specific userID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/users/{userID}/amounts
Request samples 
Response samples 
No sample
Get UserAmount
Gets UserAmount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/users/{userID}/amounts/{userAmountKey}
Request samples 
Response samples 
No sample
Update UserAmount
Updates a specific UserAmount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
claim_Type
required
string  [ 1 .. 20 ] characters 
Identifies the claim type that the amount limit will be applied to.


 
detail_Amount
number or null <double> 
Identifies the amount limit that will be applied.


 
detail_Column
required
string  [ 1 .. 64 ] characters 
Identifies the claim detail that the amount limit will be applied to.


 
effective_Date
string or null <date-time> 
Date when the amount limit becomes/became 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


 
ex_Code
string or null  <= 6 characters 
Identifies the Ex Code that will be applied to any adjudicated claim that exceeds the ‘User Limit’.


 
term_Date
string or null <date-time> 
Date when the amount limit expires/expired.


 
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


 
user_ID
required
string  [ 1 .. 16 ] characters 
ID of the User to whom the amount will be applied.


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/amounts/{userAmountKey}
Request samples 
{
  • "userAmount_Key": 0,
  • "claim_Type": "string",
  • "detail_Amount": 0.1,
  • "detail_Column": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete UserAmount
Deletes an UserAmount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/users/{userID}/amounts/{userAmountKey}
Request samples