Skip to content

Create CheckBatch

Request

Creates a new CheckBatch

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
check_Batchinteger, (int32)required

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_Datestring, (date-time)required

Date when the check batch was created.

check_Batch_Exportedbooleanrequired

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_Datestring or null, (date-time)

Date when the check batch was exported.

descriptionstring or null, <= 64 characters

Description of the check batch.

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/check-batches \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}