Claim Batch Life Benefits

Create ClaimBatchLifeBenefit

Creates a new ClaimBatchLifeBenefit

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>
benefit_Code
required
string [ 1 .. 10 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
volume
number or null <double>
Responses
200

Success

401

Unauthorized

post/claim-batches/{batchNumber}/life-benefits
Request samples
{
  • "batch_Number": 0,
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimBatchLifeBenefit

Lists all ClaimBatchLifeBenefit for the given batchNumber

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

Batch Number

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}/life-benefits
Request samples
Response samples
No sample

Get ClaimBatchLifeBenefit

Gets ClaimBatchLifeBenefit

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

Batch Number

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-batches/{batchNumber}/life-benefits/{benefitCode}
Request samples
Response samples
No sample

Update ClaimBatchLifeBenefit

Updates a specific ClaimBatchLifeBenefit.

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

Batch Number

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
batch_Number
required
integer <int32>
benefit_Code
required
string [ 1 .. 10 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
volume
number or null <double>
Responses
200

Success

401

Unauthorized

put/claim-batches/{batchNumber}/life-benefits/{benefitCode}
Request samples
{
  • "batch_Number": 0,
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ClaimBatchLifeBenefit

Deletes an ClaimBatchLifeBenefit

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

Batch Number

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/claim-batches/{batchNumber}/life-benefits/{benefitCode}
Request samples

Create or Update Batch ClaimBatchLifeBenefit

Create or Update multiple ClaimBatchLifeBenefit 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

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
batch_Number
required
integer <int32>
benefit_Code
required
string [ 1 .. 10 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
volume
number or null <double>
Responses
207

Success

401

Unauthorized

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