User Amount Procedure

Create UserAmountProcedure

Creates a new UserAmountProcedure

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
userAmountProcedure_Key
required
integer <int32>

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

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_From
string or null <= 8 characters

Identifies the starting procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area.

procedure_Thru
string or null <= 8 characters

Identifies the ending procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area.

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

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.

Responses
200

Success

401

Unauthorized

post/users/{userID}/amounts/{userAmountKey}/procedures
Request samples
{
  • "userAmountProcedure_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "procedure_From": "string",
  • "procedure_Thru": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "userAmount_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List UserAmountProcedure

Lists all UserAmountProcedure given a specific userAmountKey,userAmountProcedureKey

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}/procedures
Request samples 
Response samples 
No sample
Get UserAmountProcedure
Gets UserAmountProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
userAmountProcedureKey
required
integer <int32> 
UserAmountProcedure Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
userAmountProcedureKey
required
integer <int32> 
UserAmountProcedure Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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_From
string or null  <= 8 characters 
Identifies the starting procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area.


 
procedure_Thru
string or null  <= 8 characters 
Identifies the ending procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area.


 
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


 
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.


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/amounts/{userAmountKey}/procedures/{userAmountProcedureKey}
Request samples 
{
  • "userAmountProcedure_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "procedure_From": "string",
  • "procedure_Thru": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "userAmount_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete UserAmountProcedure
Deletes an UserAmountProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
userAmountProcedureKey
required
integer <int32> 
UserAmountProcedure Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/users/{userID}/amounts/{userAmountKey}/procedures/{userAmountProcedureKey}
Request samples 
Create or Update Batch UserAmountProcedure
Create or Update multiple UserAmountProcedure 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
userID
required
string
User ID


 
userAmountKey
required
integer <int32> 
UserAmount Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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_From
string or null  <= 8 characters 
Identifies the starting procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area.


 
procedure_Thru
string or null  <= 8 characters 
Identifies the ending procedure code of the acceptable procedure code range. ‘Amount Limits’ can be further defined by a range of procedure codes. Selecting an ‘Amount Limits’ line will populate any existing procedure code limits for that line within this area.


 
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


 
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.


 
Responses 
207
Success


401
Unauthorized


put/users/{userID}/amounts/{userAmountKey}/procedures-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}