Provider Rate Adjustments

Create ProviderRateAdjust

Creates a new ProviderRateAdjust

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

providerRateKey
required
integer <int32>

Provider Rate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerRateAdjust_Key
required
integer <int32>

References the ProviderRate.ProviderRate_Key value on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adjust_Pct
number or null <double>

Desired adjustment percentage.

adjust_Repeat
integer or null <int32>

Number of times the adjustment can be repeated before progressing to the next sequence.

adjust_Rule
string or null <= 16 characters

This indicates if a special rule option is being implemented during rate calculation. This is defined between the client and VBA to determine the custom process.

adjust_Seq
required
integer <int32>

Unique sequential identifier. Adjustments will be applied in sequential order. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

providerRate_Key
required
integer <int32>

Unique identifier for this Rate Adjustments configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/providers/{providerId}/rates/{providerRateKey}/adjustments
Request samples
{
  • "providerRateAdjust_Key": 0,
  • "adjust_Pct": 0.1,
  • "adjust_Repeat": 0,
  • "adjust_Rule": "string",
  • "adjust_Seq": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "providerRate_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Provider Rate Adjustments

List Adjustments for a specific Provider Rate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

providerRateKey
required
integer <int32>

Provider Rate Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/providers/{providerId}/rates/{providerRateKey}/adjustments
Request samples 
Response samples 
No sample
Get ProviderRateAdjust
Gets ProviderRateAdjust


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
providerRateAdjustKey
required
integer <int32> 
Provider Rate Adjust Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerId}/rates/{providerRateKey}/adjustments/{providerRateAdjustKey}
Request samples 
Response samples 
No sample
Update ProviderRateAdjust
Updates a specific ProviderRateAdjust.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
providerRateAdjustKey
required
integer <int32> 
Provider Rate Adjust Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerRateAdjust_Key
required
integer <int32> 
References the ProviderRate.ProviderRate_Key value on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjust_Pct
number or null <double> 
Desired adjustment percentage.


 
adjust_Repeat
integer or null <int32> 
Number of times the adjustment can be repeated before progressing to the next sequence.


 
adjust_Rule
string or null  <= 16 characters 
This indicates if a special rule option is being implemented during rate calculation. This is defined between the client and VBA to determine the custom process.


 
adjust_Seq
required
integer <int32> 
Unique sequential identifier. Adjustments will be applied in sequential order. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
providerRate_Key
required
integer <int32> 
Unique identifier for this Rate Adjustments configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerId}/rates/{providerRateKey}/adjustments/{providerRateAdjustKey}
Request samples 
{
  • "providerRateAdjust_Key": 0,
  • "adjust_Pct": 0.1,
  • "adjust_Repeat": 0,
  • "adjust_Rule": "string",
  • "adjust_Seq": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "providerRate_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderRateAdjust
Deletes an ProviderRateAdjust


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
providerRateAdjustKey
required
integer <int32> 
Provider Rate Adjust Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerId}/rates/{providerRateKey}/adjustments/{providerRateAdjustKey}
Request samples 
Update Batch ProviderRateAdjust
Create or Update multiple ProviderRateAdjust.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerRateAdjust_Key
required
integer <int32> 
References the ProviderRate.ProviderRate_Key value on the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjust_Pct
number or null <double> 
Desired adjustment percentage.


 
adjust_Repeat
integer or null <int32> 
Number of times the adjustment can be repeated before progressing to the next sequence.


 
adjust_Rule
string or null  <= 16 characters 
This indicates if a special rule option is being implemented during rate calculation. This is defined between the client and VBA to determine the custom process.


 
adjust_Seq
required
integer <int32> 
Unique sequential identifier. Adjustments will be applied in sequential order. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
providerRate_Key
required
integer <int32> 
Unique identifier for this Rate Adjustments configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/providers/{providerId}/rates/{providerRateKey}/adjustments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}