Check Batches

Create CheckBatch

Creates a new CheckBatch

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
check_Batch
required
integer <int32>

ID of the check batch. 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.

check_Batch_Date
required
string <date-time>

Date when the check batch was created.

check_Batch_Exported
required
boolean

Indicates that the check batch has been exported. Note: The database will apply a default value of False 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 False to meet the API requirements and ensure that the functionality occurs as expected.

check_Batch_Exported_Date
string or null <date-time>

Date when the check batch was exported.

description
string or null <= 64 characters

Description of the check batch.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date 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/check-batches
Request samples
{
  • "check_Batch": 0,
  • "check_Batch_Date": "2019-08-24T14:15:22Z",
  • "check_Batch_Exported": true,
  • "check_Batch_Exported_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CheckBatch

Lists all CheckBatch

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/check-batches
Request samples 
Response samples 
No sample
Get CheckBatch
Gets CheckBatch


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkBatch
required
integer <int32> 
Check Batch


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/check-batches/{checkBatch}
Request samples 
Response samples 
No sample
Update CheckBatch
Updates a specific CheckBatch.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkBatch
required
integer <int32> 
Check Batch


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
check_Batch
required
integer <int32> 
ID of the check batch.  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.


 
check_Batch_Date
required
string <date-time> 
Date when the check batch was created.


 
check_Batch_Exported
required
boolean
Indicates that the check batch has been exported.  Note: The database will apply a default value of False 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 False to meet the API requirements and ensure that the functionality occurs as expected.


 
check_Batch_Exported_Date
string or null <date-time> 
Date when the check batch was exported.


 
description
string or null  <= 64 characters 
Description of the check batch.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date 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/check-batches/{checkBatch}
Request samples 
{
  • "check_Batch": 0,
  • "check_Batch_Date": "2019-08-24T14:15:22Z",
  • "check_Batch_Exported": true,
  • "check_Batch_Exported_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CheckBatch
Deletes an CheckBatch


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkBatch
required
integer <int32> 
Check Batch


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/check-batches/{checkBatch}
Request samples 
Create or Update Batch CheckBatch
Create or Update multiple CheckBatch 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 
check_Batch
required
integer <int32> 
ID of the check batch.  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.


 
check_Batch_Date
required
string <date-time> 
Date when the check batch was created.


 
check_Batch_Exported
required
boolean
Indicates that the check batch has been exported.  Note: The database will apply a default value of False 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 False to meet the API requirements and ensure that the functionality occurs as expected.


 
check_Batch_Exported_Date
string or null <date-time> 
Date when the check batch was exported.


 
description
string or null  <= 64 characters 
Description of the check batch.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date 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/check-batches-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
CheckBatch CheckEdit
Runs all configured check edits based on Check Batch and returns the results of those edits.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkBatch
required
integer <int32> 
Check Batch


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


put/check-batches-check-edit/{checkBatch}
Request samples 
Response samples 
No sample