Claim Batches

Create ClaimBatches

Creates a new ClaimBatches

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
batch_Number
required
integer <int32>
batch_Type
string or null <= 16 characters
case_Status
string or null <= 8 characters
case_Status_Date
string or null <date-time>
case_Status_Reason
string or null <= 8 characters
case_Status_User
string or null <= 20 characters
current_Phys_Tax_ID
string or null <= 20 characters
default_Claim_Type
string or null <= 20 characters
default_Date
string or null <date-time>
default_Plan_Type
string or null <= 6 characters
default_Plan_Type2
string or null <= 6 characters
default_Plan_Type3
string or null <= 6 characters
description
string or null <= 64 characters
edI_Key
integer or null <int32>
edI_Location
string or null <= 16 characters
edI_Source_File_Name
string or null <= 128 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
member_Seq
string or null <= 2 characters
original_Claim_Count
integer or null <int32>
original_Phys_Tax_ID
string or null <= 20 characters
overpayment_Ex_Code
string or null <= 6 characters
overpayment_Total
number or null <double>
process_By_Disability_Date
required
boolean
reviewed_Date
string or null <date-time>
reviewed_Status
string or null <= 6 characters
reviewed_User
string or null <= 20 characters
status
string or null <= 16 characters
subscriber_ID
string or null <= 9 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
use_Default_Date
required
boolean
Responses
200

Success

401

Unauthorized

post/claim-batches
Request samples
{
  • "batch_Number": 0,
  • "batch_Type": "string",
  • "case_Status": "string",
  • "case_Status_Date": "2019-08-24T14:15:22Z",
  • "case_Status_Reason": "string",
  • "case_Status_User": "string",
  • "current_Phys_Tax_ID": "string",
  • "default_Claim_Type": "string",
  • "default_Date": "2019-08-24T14:15:22Z",
  • "default_Plan_Type": "string",
  • "default_Plan_Type2": "string",
  • "default_Plan_Type3": "string",
  • "description": "string",
  • "edI_Key": 0,
  • "edI_Location": "string",
  • "edI_Source_File_Name": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "original_Claim_Count": 0,
  • "original_Phys_Tax_ID": "string",
  • "overpayment_Ex_Code": "string",
  • "overpayment_Total": 0.1,
  • "process_By_Disability_Date": true,
  • "reviewed_Date": "2019-08-24T14:15:22Z",
  • "reviewed_Status": "string",
  • "reviewed_User": "string",
  • "status": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Default_Date": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimBatches

Lists all ClaimBatches

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-batches
Request samples 
Response samples 
No sample
Get ClaimBatches
Gets ClaimBatches


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
batchNumber
required
integer <int32> 
Batch Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-batches/{batchNumber}
Request samples 
Response samples 
No sample
Update ClaimBatches
Updates a specific ClaimBatches.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
batchNumber
required
integer <int32> 
Batch Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
batch_Number
required
integer <int32> 
 
batch_Type
string or null  <= 16 characters 
 
case_Status
string or null  <= 8 characters 
 
case_Status_Date
string or null <date-time> 
 
case_Status_Reason
string or null  <= 8 characters 
 
case_Status_User
string or null  <= 20 characters 
 
current_Phys_Tax_ID
string or null  <= 20 characters 
 
default_Claim_Type
string or null  <= 20 characters 
 
default_Date
string or null <date-time> 
 
default_Plan_Type
string or null  <= 6 characters 
 
default_Plan_Type2
string or null  <= 6 characters 
 
default_Plan_Type3
string or null  <= 6 characters 
 
description
string or null  <= 64 characters 
 
edI_Key
integer or null <int32> 
 
edI_Location
string or null  <= 16 characters 
 
edI_Source_File_Name
string or null  <= 128 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
member_Seq
string or null  <= 2 characters 
 
original_Claim_Count
integer or null <int32> 
 
original_Phys_Tax_ID
string or null  <= 20 characters 
 
overpayment_Ex_Code
string or null  <= 6 characters 
 
overpayment_Total
number or null <double> 
 
process_By_Disability_Date
required
boolean
 
reviewed_Date
string or null <date-time> 
 
reviewed_Status
string or null  <= 6 characters 
 
reviewed_User
string or null  <= 20 characters 
 
status
string or null  <= 16 characters 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
use_Default_Date
required
boolean
 
Responses 
200
Success


401
Unauthorized


put/claim-batches/{batchNumber}
Request samples 
{
  • "batch_Number": 0,
  • "batch_Type": "string",
  • "case_Status": "string",
  • "case_Status_Date": "2019-08-24T14:15:22Z",
  • "case_Status_Reason": "string",
  • "case_Status_User": "string",
  • "current_Phys_Tax_ID": "string",
  • "default_Claim_Type": "string",
  • "default_Date": "2019-08-24T14:15:22Z",
  • "default_Plan_Type": "string",
  • "default_Plan_Type2": "string",
  • "default_Plan_Type3": "string",
  • "description": "string",
  • "edI_Key": 0,
  • "edI_Location": "string",
  • "edI_Source_File_Name": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "original_Claim_Count": 0,
  • "original_Phys_Tax_ID": "string",
  • "overpayment_Ex_Code": "string",
  • "overpayment_Total": 0.1,
  • "process_By_Disability_Date": true,
  • "reviewed_Date": "2019-08-24T14:15:22Z",
  • "reviewed_Status": "string",
  • "reviewed_User": "string",
  • "status": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Default_Date": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimBatches
Deletes an ClaimBatches


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
batchNumber
required
integer <int32> 
Batch Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-batches/{batchNumber}
Request samples 
Create or Update Batch ClaimBatches
Create or Update multiple ClaimBatches 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 
batch_Number
required
integer <int32> 
 
batch_Type
string or null  <= 16 characters 
 
case_Status
string or null  <= 8 characters 
 
case_Status_Date
string or null <date-time> 
 
case_Status_Reason
string or null  <= 8 characters 
 
case_Status_User
string or null  <= 20 characters 
 
current_Phys_Tax_ID
string or null  <= 20 characters 
 
default_Claim_Type
string or null  <= 20 characters 
 
default_Date
string or null <date-time> 
 
default_Plan_Type
string or null  <= 6 characters 
 
default_Plan_Type2
string or null  <= 6 characters 
 
default_Plan_Type3
string or null  <= 6 characters 
 
description
string or null  <= 64 characters 
 
edI_Key
integer or null <int32> 
 
edI_Location
string or null  <= 16 characters 
 
edI_Source_File_Name
string or null  <= 128 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
member_Seq
string or null  <= 2 characters 
 
original_Claim_Count
integer or null <int32> 
 
original_Phys_Tax_ID
string or null  <= 20 characters 
 
overpayment_Ex_Code
string or null  <= 6 characters 
 
overpayment_Total
number or null <double> 
 
process_By_Disability_Date
required
boolean
 
reviewed_Date
string or null <date-time> 
 
reviewed_Status
string or null  <= 6 characters 
 
reviewed_User
string or null  <= 20 characters 
 
status
string or null  <= 16 characters 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
use_Default_Date
required
boolean
 
Responses 
207
Success


401
Unauthorized


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