Provider Benefit Admin Fees

Create Provider Benefit Admin Fee

Creates a new ProviderBenefitAdmin Fee

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

benefit_Code
required
string [ 1 .. 50 ] characters

Benefit code required for adjudication matching.

effective_Date
required
string <date-time>

Start of the range of acceptable service dates for the admin fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.

admin_Column
string or null <= 64 characters

Defines what the fee percentage is taken from. This field is only used when the fee is a percentage.

admin_Fee
number or null <double>

Specifies the admin fee amount.

admin_Pct
required
boolean

Indicates that the associated fee is percentage based. 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 first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

network_ID
string or null <= 50 characters

This field is currently informational only.

term_Date
string or null <date-time>

End of the range of acceptable service dates for the admin fee.

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/provider/{providerId}/benefit-admin-fees
Request samples
{
  • "provider_ID": "string",
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "admin_Column": "string",
  • "admin_Fee": 0.1,
  • "admin_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "network_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Provider Benefit Admin Fees

List All Benefit Admin Fees for a given Provider

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/provider/{providerId}/benefit-admin-fees
Request samples 
Response samples 
No sample
Get ProviderBenefitAdmin
Gets ProviderBenefitAdmin


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
benefitCode
required
string
Benefit Code


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider/{providerId}/benefit-admin-fees/{benefitCode}/{effectiveDate}
Request samples 
Response samples 
No sample
Update ProviderBenefitAdmin
Updates a specific ProviderBenefitAdmin.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
benefitCode
required
string
Benefit Code


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
benefit_Code
required
string  [ 1 .. 50 ] characters 
Benefit code required for adjudication matching.


 
effective_Date
required
string <date-time> 
Start of the range of acceptable service dates for the admin fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
admin_Column
string or null  <= 64 characters 
Defines what the fee percentage is taken from. This field is only used when the fee is a percentage.


 
admin_Fee
number or null <double> 
Specifies the admin fee amount.


 
admin_Pct
required
boolean
Indicates that the associated fee is percentage based. 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 first added to the system.


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


 
network_ID
string or null  <= 50 characters 
This field is currently informational only.


 
term_Date
string or null <date-time> 
End of the range of acceptable service dates for the admin fee.


 
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/provider/{providerId}/benefit-admin-fees/{benefitCode}/{effectiveDate}
Request samples 
{
  • "provider_ID": "string",
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "admin_Column": "string",
  • "admin_Fee": 0.1,
  • "admin_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "network_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderBenefitAdmin
Deletes an ProviderBenefitAdmin


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
benefitCode
required
string
Benefit Code


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider/{providerId}/benefit-admin-fees/{benefitCode}/{effectiveDate}
Request samples 
Update Batch ProviderBenefitAdmin
Updates a multiple ProviderBenefitAdmin.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
benefit_Code
required
string  [ 1 .. 50 ] characters 
Benefit code required for adjudication matching.


 
effective_Date
required
string <date-time> 
Start of the range of acceptable service dates for the admin fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
admin_Column
string or null  <= 64 characters 
Defines what the fee percentage is taken from. This field is only used when the fee is a percentage.


 
admin_Fee
number or null <double> 
Specifies the admin fee amount.


 
admin_Pct
required
boolean
Indicates that the associated fee is percentage based. 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 first added to the system.


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


 
network_ID
string or null  <= 50 characters 
This field is currently informational only.


 
term_Date
string or null <date-time> 
End of the range of acceptable service dates for the admin fee.


 
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/provider/{providerId}/benefit-admin-fees-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}