Claim Batch References

Create ClaimBatchReference

Creates a new ClaimBatchReference

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
original_Batch_Number
required
integer <int32>

When one claim must reference another claim, this holds the pointer to the original batch/claim. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

original_Batch_Claim
required
integer <int32>

When one claim must reference another claim, this holds the pointer to the original batch/claim. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

referenced_Batch_Number
required
integer <int32>

When one claim must reference another claim, this holds the pointer to the referenced batch/claim. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

referenced_Batch_Claim
required
integer <int32>

When one claim must reference another claim, this holds the pointer to the referenced batch/claim. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

reference_Type
required
string [ 1 .. 16 ] characters

When one claim must reference another claim, this holds the type of reference being created.

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.

reference_Date
string or null <date-time>

When one claim must reference another claim, this holds the date of that reference being made.

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/claim-batch-references
Request samples
{
  • "original_Batch_Number": 0,
  • "original_Batch_Claim": 0,
  • "referenced_Batch_Number": 0,
  • "referenced_Batch_Claim": 0,
  • "reference_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reference_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimBatchReference

Lists all ClaimBatchReference

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-batch-references
Request samples 
Response samples 
No sample
Get ClaimBatchReference
Gets ClaimBatchReference


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


 
originalBatchClaim
required
integer <int32> 
Original Batch Claim


 
referencedBatchNumber
required
integer <int32> 
Referenced Batch Number


 
referencedBatchClaim
required
integer <int32> 
Referenced Batch Claim


 
referenceType
required
string
Reference Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-batch-references/{originalBatchNumber}/{originalBatchClaim}/{referencedBatchNumber}/{referencedBatchClaim}/{referenceType}
Request samples 
Response samples 
No sample
Update ClaimBatchReference
Updates a specific ClaimBatchReference.


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


 
originalBatchClaim
required
integer <int32> 
Original Batch Claim


 
referencedBatchNumber
required
integer <int32> 
Referenced Batch Number


 
referencedBatchClaim
required
integer <int32> 
Referenced Batch Claim


 
referenceType
required
string
Reference Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
original_Batch_Number
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the original batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
original_Batch_Claim
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the original batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
referenced_Batch_Number
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the referenced batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
referenced_Batch_Claim
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the referenced batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
reference_Type
required
string  [ 1 .. 16 ] characters 
When one claim must reference another claim, this holds the type of reference being created.


 
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.


 
reference_Date
string or null <date-time> 
When one claim must reference another claim, this holds the date of that reference being made.


 
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/claim-batch-references/{originalBatchNumber}/{originalBatchClaim}/{referencedBatchNumber}/{referencedBatchClaim}/{referenceType}
Request samples 
{
  • "original_Batch_Number": 0,
  • "original_Batch_Claim": 0,
  • "referenced_Batch_Number": 0,
  • "referenced_Batch_Claim": 0,
  • "reference_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reference_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimBatchReference
Deletes an ClaimBatchReference


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


 
originalBatchClaim
required
integer <int32> 
Original Batch Claim


 
referencedBatchNumber
required
integer <int32> 
Referenced Batch Number


 
referencedBatchClaim
required
integer <int32> 
Referenced Batch Claim


 
referenceType
required
string
Reference Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-batch-references/{originalBatchNumber}/{originalBatchClaim}/{referencedBatchNumber}/{referencedBatchClaim}/{referenceType}
Request samples 
Create or Update Batch ClaimBatchReference
Create or Update multiple ClaimBatchReference 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 
original_Batch_Number
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the original batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
original_Batch_Claim
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the original batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
referenced_Batch_Number
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the referenced batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
referenced_Batch_Claim
required
integer <int32> 
When one claim must reference another claim, this holds the pointer to the referenced batch/claim.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
reference_Type
required
string  [ 1 .. 16 ] characters 
When one claim must reference another claim, this holds the type of reference being created.


 
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.


 
reference_Date
string or null <date-time> 
When one claim must reference another claim, this holds the date of that reference being made.


 
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/claim-batch-references-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}