Claim Detail Deductions

Create ClaimDetailDeduction

Creates a new ClaimDetailDeduction

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

Batch Number

batchClaim
required
integer <int32>

Batch Claim

claimSeq
required
string

Claim Seq

adjustmentSeq
required
string

Adjustment Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
batch_Number
required
integer <int32>
batch_Claim
required
integer <int32>
claim_Seq
required
string [ 1 .. 2 ] characters
adjustment_Seq
required
string [ 1 .. 3 ] characters
deduction_Seq
required
integer <int32>
case_Number
string or null <= 64 characters
deduction_Amount
number or null <double>
deduction_Applied
number or null <double>
deduction_Pct
required
boolean
deduction_Type
string or null <= 8 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
pre_Gross
required
boolean
pre_Tax
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions
Request samples
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "claim_Seq": "st",
  • "adjustment_Seq": "str",
  • "deduction_Seq": 0,
  • "case_Number": "string",
  • "deduction_Amount": 0.1,
  • "deduction_Applied": 0.1,
  • "deduction_Pct": true,
  • "deduction_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "pre_Gross": true,
  • "pre_Tax": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimDetailDeduction

Lists all ClaimDetailDeduction for the given batchNumber and batchClaim and claimSeq and adjustmentSeq

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

Batch Number

batchClaim
required
integer <int32>

Batch Claim

claimSeq
required
string

Claim Seq

adjustmentSeq
required
string

Adjustment Seq

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}/details/{claimSeq}/{adjustmentSeq}/deductions
Request samples 
Response samples 
No sample
Get ClaimDetailDeduction
Gets ClaimDetailDeduction


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
claimSeq
required
string
Claim Seq


 
adjustmentSeq
required
string
Adjustment Seq


 
deductionSeq
required
integer <int32> 
Deduction Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions/{deductionSeq}
Request samples 
Response samples 
No sample
Update ClaimDetailDeduction
Updates a specific ClaimDetailDeduction.


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
claimSeq
required
string
Claim Seq


 
adjustmentSeq
required
string
Adjustment Seq


 
deductionSeq
required
integer <int32> 
Deduction Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
batch_Number
required
integer <int32> 
 
batch_Claim
required
integer <int32> 
 
claim_Seq
required
string  [ 1 .. 2 ] characters 
 
adjustment_Seq
required
string  [ 1 .. 3 ] characters 
 
deduction_Seq
required
integer <int32> 
 
case_Number
string or null  <= 64 characters 
 
deduction_Amount
number or null <double> 
 
deduction_Applied
number or null <double> 
 
deduction_Pct
required
boolean
 
deduction_Type
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
pre_Gross
required
boolean
 
pre_Tax
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions/{deductionSeq}
Request samples 
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "claim_Seq": "st",
  • "adjustment_Seq": "str",
  • "deduction_Seq": 0,
  • "case_Number": "string",
  • "deduction_Amount": 0.1,
  • "deduction_Applied": 0.1,
  • "deduction_Pct": true,
  • "deduction_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "pre_Gross": true,
  • "pre_Tax": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimDetailDeduction
Deletes an ClaimDetailDeduction


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
claimSeq
required
string
Claim Seq


 
adjustmentSeq
required
string
Adjustment Seq


 
deductionSeq
required
integer <int32> 
Deduction Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq}/deductions/{deductionSeq}
Request samples 
Create or Update Batch ClaimDetailDeduction
Create or Update multiple ClaimDetailDeduction 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


 
claimSeq
required
string
Claim Seq


 
adjustmentSeq
required
string
Adjustment Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
batch_Number
required
integer <int32> 
 
batch_Claim
required
integer <int32> 
 
claim_Seq
required
string  [ 1 .. 2 ] characters 
 
adjustment_Seq
required
string  [ 1 .. 3 ] characters 
 
deduction_Seq
required
integer <int32> 
 
case_Number
string or null  <= 64 characters 
 
deduction_Amount
number or null <double> 
 
deduction_Applied
number or null <double> 
 
deduction_Pct
required
boolean
 
deduction_Type
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
pre_Gross
required
boolean
 
pre_Tax
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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