Claim Batch Plans

Create ClaimBatchPlan

Creates a new ClaimBatchPlan

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

Batch Number

batchClaim
required
integer <int32>

Batch Claim

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
batch_Number
required
integer <int32>
batch_Claim
required
integer <int32>
plan_ID
required
string [ 1 .. 20 ] characters
Responses
200

Success

401

Unauthorized

post/claim-batches/{batchNumber}/claims/{batchClaim}/plans
Request samples
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "plan_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimBatchPlan

Lists all ClaimBatchPlan for the given batchNumber and batchClaim

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

Batch Number

batchClaim
required
integer <int32>

Batch Claim

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/{batchNumber}/claims/{batchClaim}/plans
Request samples 
Response samples 
No sample
Get ClaimBatchPlan
Gets ClaimBatchPlan


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-batches/{batchNumber}/claims/{batchClaim}/plans/{planID}
Request samples 
Response samples 
No sample
Update ClaimBatchPlan
Updates a specific ClaimBatchPlan.


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
batch_Number
required
integer <int32> 
 
batch_Claim
required
integer <int32> 
 
plan_ID
required
string  [ 1 .. 20 ] characters 
 
Responses 
200
Success


401
Unauthorized


put/claim-batches/{batchNumber}/claims/{batchClaim}/plans/{planID}
Request samples 
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "plan_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimBatchPlan
Deletes an ClaimBatchPlan


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-batches/{batchNumber}/claims/{batchClaim}/plans/{planID}
Request samples 
Create or Update Batch ClaimBatchPlan
Create or Update multiple ClaimBatchPlan at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
batch_Number
required
integer <int32> 
 
batch_Claim
required
integer <int32> 
 
plan_ID
required
string  [ 1 .. 20 ] characters 
 
Responses 
207
Success


401
Unauthorized


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