Claim Transactions

Create ClaimTransaction

Creates a new ClaimTransaction

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
claimTransaction_Key
required
integer <int32>
batch_Claim
integer <int32>
batch_Number
integer <int32>
claim_Status_Category_Code
string or null <= 8 characters
claim_Status_Code
string or null <= 8 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
transaction_Batch_Claim
integer or null <int32>
transaction_Batch_Number
integer or null <int32>
transaction_Claim_Status
string or null <= 8 characters
transaction_Date
required
string <date-time>
transaction_Type
string or null <= 32 characters
transaction_User
required
string [ 1 .. 20 ] characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-batches/{batchNumber}/claims/{batchClaim}/transactions
Request samples
{
  • "claimTransaction_Key": 0,
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "claim_Status_Category_Code": "string",
  • "claim_Status_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "transaction_Batch_Claim": 0,
  • "transaction_Batch_Number": 0,
  • "transaction_Claim_Status": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "transaction_Type": "string",
  • "transaction_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimTransaction

Lists all ClaimTransaction 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}/transactions
Request samples 
Response samples 
No sample
Get ClaimTransaction
Gets ClaimTransaction


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
claimTransactionKey
required
integer <int32> 
ClaimTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-batches/{batchNumber}/claims/{batchClaim}/transactions/{claimTransactionKey}
Request samples 
Response samples 
No sample
Update ClaimTransaction
Updates a specific ClaimTransaction.


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
claimTransactionKey
required
integer <int32> 
ClaimTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimTransaction_Key
required
integer <int32> 
 
batch_Claim
integer <int32> 
 
batch_Number
integer <int32> 
 
claim_Status_Category_Code
string or null  <= 8 characters 
 
claim_Status_Code
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
transaction_Batch_Claim
integer or null <int32> 
 
transaction_Batch_Number
integer or null <int32> 
 
transaction_Claim_Status
string or null  <= 8 characters 
 
transaction_Date
required
string <date-time> 
 
transaction_Type
string or null  <= 32 characters 
 
transaction_User
required
string  [ 1 .. 20 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/claim-batches/{batchNumber}/claims/{batchClaim}/transactions/{claimTransactionKey}
Request samples 
{
  • "claimTransaction_Key": 0,
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "claim_Status_Category_Code": "string",
  • "claim_Status_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "transaction_Batch_Claim": 0,
  • "transaction_Batch_Number": 0,
  • "transaction_Claim_Status": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "transaction_Type": "string",
  • "transaction_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimTransaction
Deletes an ClaimTransaction


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


 
batchClaim
required
integer <int32> 
Batch Claim


 
claimTransactionKey
required
integer <int32> 
ClaimTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-batches/{batchNumber}/claims/{batchClaim}/transactions/{claimTransactionKey}
Request samples 
Create or Update Batch ClaimTransaction
Create or Update multiple ClaimTransaction 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 
claimTransaction_Key
required
integer <int32> 
 
batch_Claim
integer <int32> 
 
batch_Number
integer <int32> 
 
claim_Status_Category_Code
string or null  <= 8 characters 
 
claim_Status_Code
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
transaction_Batch_Claim
integer or null <int32> 
 
transaction_Batch_Number
integer or null <int32> 
 
transaction_Claim_Status
string or null  <= 8 characters 
 
transaction_Date
required
string <date-time> 
 
transaction_Type
string or null  <= 32 characters 
 
transaction_User
required
string  [ 1 .. 20 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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