Plan Place Auth

Create PlanPlaceAuth

Creates a new PlanPlaceAuth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Plan_ID
required
string

Plan ID

Place_Code
required
string

Place Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
plan_ID
required
string [ 1 .. 20 ] characters
place_Code
required
string [ 1 .. 4 ] characters
amount_Before_Auth
number or null <double>

Specifies the amount of the associated amount type that is allowed before requiring an authorization.

amount_Type
string or null <= 16 characters

Specifies the amount type (Billed, Allowed, or Payable) that the 'Amount Before Auth' rule will be tied to.

auth_Reqd
required
string = 1 characters

Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

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.

visits_Before_Auth
integer or null <int32>

Specifies the number of visits allowed before an authorization is required.

Responses
200

Success

401

Unauthorized

post/plans/{Plan_ID}/place-auths/{Place_Code}
Request samples
{
  • "plan_ID": "string",
  • "place_Code": "stri",
  • "amount_Before_Auth": 0.1,
  • "amount_Type": "string",
  • "auth_Reqd": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "visits_Before_Auth": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get PlanPlaceAuth

Gets PlanPlaceAuth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Plan_ID
required
string

Plan ID

Place_Code
required
string

Place Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{Plan_ID}/place-auths/{Place_Code}
Request samples 
Response samples 
No sample
Update PlanPlaceAuth
Updates a specific PlanPlaceAuth.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Plan_ID
required
string
Plan ID


 
Place_Code
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
plan_ID
required
string  [ 1 .. 20 ] characters 
 
place_Code
required
string  [ 1 .. 4 ] characters 
 
amount_Before_Auth
number or null <double> 
Specifies the amount of the associated amount type that is allowed before requiring an authorization.


 
amount_Type
string or null  <= 16 characters 
Specifies the amount type (Billed, Allowed, or Payable) that the 'Amount Before Auth' rule will be tied to.


 
auth_Reqd
required
string  = 1 characters 
Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


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


 
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.


 
visits_Before_Auth
integer or null <int32> 
Specifies the number of visits allowed before an authorization is required.


 
Responses 
200
Success


401
Unauthorized


put/plans/{Plan_ID}/place-auths/{Place_Code}
Request samples 
{
  • "plan_ID": "string",
  • "place_Code": "stri",
  • "amount_Before_Auth": 0.1,
  • "amount_Type": "string",
  • "auth_Reqd": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "visits_Before_Auth": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanPlaceAuth
Deletes an PlanPlaceAuth


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Plan_ID
required
string
Plan ID


 
Place_Code
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{Plan_ID}/place-auths/{Place_Code}
Request samples 
List PlanPlaceAuth
Lists all PlanPlaceAuth for the given Plan_ID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Plan_ID
required
string
Plan 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/plans/{Plan_ID}/place-auths
Request samples 
Response samples 
No sample
Create or Update Batch PlanPlaceAuth
Create or Update multiple PlanPlaceAuth 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 
plan_ID
required
string  [ 1 .. 20 ] characters 
 
place_Code
required
string  [ 1 .. 4 ] characters 
 
amount_Before_Auth
number or null <double> 
Specifies the amount of the associated amount type that is allowed before requiring an authorization.


 
amount_Type
string or null  <= 16 characters 
Specifies the amount type (Billed, Allowed, or Payable) that the 'Amount Before Auth' rule will be tied to.


 
auth_Reqd
required
string  = 1 characters 
Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


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


 
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.


 
visits_Before_Auth
integer or null <int32> 
Specifies the number of visits allowed before an authorization is required.


 
Responses 
207
Success


401
Unauthorized


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