Claim Prompt Pays

Create ClaimPromptPay

Creates a new ClaimPromptPay

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimPromptPay_Key
required
integer <int32>

Unique identifer for each claim prompt pay entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 200 characters

User that first added the record to the system

group_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.

plan_ID
string or null <= 20 characters

Holds the plan the patient is enrolled in and that benefits are assigned.

prompt_Pay_Duration
integer or null <int32>

Holds the length of the duration to define this prompt pay record, as a numeric value only.

prompt_Pay_Duration_Type
string or null <= 16 characters

Defines the type of duration used in configuration. D = Day, M = Month, Y = Year.

tax_ID
string or null <= 32 characters

Holds the Tax_ID (Federal_ID) of the provider for this record.

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

Responses
200

Success

401

Unauthorized

post/claim-prompt-pays
Request samples
{
  • "claimPromptPay_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "prompt_Pay_Duration": 0,
  • "prompt_Pay_Duration_Type": "string",
  • "tax_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimPromptPay

Lists all ClaimPromptPay

SecurityapiKeyAuth and bearerAuth
Request
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/claim-prompt-pays
Request samples 
Response samples 
No sample
Get ClaimPromptPay
Gets ClaimPromptPay


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ClaimPromptPay_Key
required
integer <int32> 
ClaimPromptPay Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-prompt-pays/{ClaimPromptPay_Key}
Request samples 
Response samples 
No sample
Update ClaimPromptPay
Updates a specific ClaimPromptPay.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ClaimPromptPay_Key
required
integer <int32> 
ClaimPromptPay Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimPromptPay_Key
required
integer <int32> 
Unique identifer for each claim prompt pay entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
string or null  <= 20 characters 
The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.


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


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


 
group_ID
string or null  <= 20 characters 
The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.


 
plan_ID
string or null  <= 20 characters 
Holds the plan the patient is enrolled in and that benefits are assigned.


 
prompt_Pay_Duration
integer or null <int32> 
Holds the length of the duration to define this prompt pay record, as a numeric value only.


 
prompt_Pay_Duration_Type
string or null  <= 16 characters 
Defines the type of duration used in configuration. D = Day, M = Month, Y = Year.


 
tax_ID
string or null  <= 32 characters 
Holds the Tax_ID (Federal_ID) of the provider for this record.


 
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


 
Responses 
200
Success


401
Unauthorized


put/claim-prompt-pays/{ClaimPromptPay_Key}
Request samples 
{
  • "claimPromptPay_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "prompt_Pay_Duration": 0,
  • "prompt_Pay_Duration_Type": "string",
  • "tax_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimPromptPay
Deletes an ClaimPromptPay


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ClaimPromptPay_Key
required
integer <int32> 
ClaimPromptPay Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-prompt-pays/{ClaimPromptPay_Key}
Request samples 
Create or Update Batch ClaimPromptPay
Create or Update multiple ClaimPromptPay 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 
claimPromptPay_Key
required
integer <int32> 
Unique identifer for each claim prompt pay entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
string or null  <= 20 characters 
The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.


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


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


 
group_ID
string or null  <= 20 characters 
The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.


 
plan_ID
string or null  <= 20 characters 
Holds the plan the patient is enrolled in and that benefits are assigned.


 
prompt_Pay_Duration
integer or null <int32> 
Holds the length of the duration to define this prompt pay record, as a numeric value only.


 
prompt_Pay_Duration_Type
string or null  <= 16 characters 
Defines the type of duration used in configuration. D = Day, M = Month, Y = Year.


 
tax_ID
string or null  <= 32 characters 
Holds the Tax_ID (Federal_ID) of the provider for this record.


 
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


 
Responses 
207
Success


401
Unauthorized


put/claim-prompt-pays-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}