Check Details

Create ChecksDetail

Creates a new ChecksDetail

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

Check ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
check_ID
required
integer <int32>

ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.

item_Seq
required
integer <int32>

Sequential identifier of the check item. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adjustment
number or null <double>

Adjustment amount for the check line.

admin_Amt
number or null <double>

Admin fee associated with the check line.

amount_Due
number or null <double>

Total amount due for the check.

claim_Number
integer or null <int32>

Number of the claim associated with the check line.

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

interest
number or null <double>

Interest amount associated with the check line.

item_Date
string or null <date-time>

Date when the check line item was received.

item_Description
string or null <= 45 characters

Description of the item associated with the check line.

item_Type
string or null <= 3 characters

Identifies the type of item associated with the check line.

message
string or null <= 50 characters

The message on the check.

processed
string or null <= 1 characters

Indicates tha the check has been processed.

provider_ID
string or null <= 20 characters

ID of the Provider associated with the check line.

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/checks/{checkID}/details
Request samples
{
  • "check_ID": 0,
  • "item_Seq": 0,
  • "adjustment": 0.1,
  • "admin_Amt": 0.1,
  • "amount_Due": 0.1,
  • "claim_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "interest": 0.1,
  • "item_Date": "2019-08-24T14:15:22Z",
  • "item_Description": "string",
  • "item_Type": "str",
  • "message": "string",
  • "processed": "s",
  • "provider_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ChecksDetail

Lists all ChecksDetail for the given checkID

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

Check ID

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/checks/{checkID}/details
Request samples 
Response samples 
No sample
Get ChecksDetail
Gets ChecksDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
itemSeq
required
integer <int32> 
Item Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/checks/{checkID}/details/{itemSeq}
Request samples 
Response samples 
No sample
Update ChecksDetail
Updates a specific ChecksDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
itemSeq
required
integer <int32> 
Item Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
check_ID
required
integer <int32> 
ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
item_Seq
required
integer <int32> 
Sequential identifier of the check item. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjustment
number or null <double> 
Adjustment amount for the check line.


 
admin_Amt
number or null <double> 
Admin fee associated with the check line.


 
amount_Due
number or null <double> 
Total amount due for the check.


 
claim_Number
integer or null <int32> 
Number of the claim associated with the check line.


 
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


 
interest
number or null <double> 
Interest amount associated with the check line.


 
item_Date
string or null <date-time> 
Date when the check line item was received.


 
item_Description
string or null  <= 45 characters 
Description of the item associated with the check line.


 
item_Type
string or null  <= 3 characters 
Identifies the type of item associated with the check line.


 
message
string or null  <= 50 characters 
The message on the check.


 
processed
string or null  <= 1 characters 
Indicates tha the check has been processed.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the check line.


 
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/checks/{checkID}/details/{itemSeq}
Request samples 
{
  • "check_ID": 0,
  • "item_Seq": 0,
  • "adjustment": 0.1,
  • "admin_Amt": 0.1,
  • "amount_Due": 0.1,
  • "claim_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "interest": 0.1,
  • "item_Date": "2019-08-24T14:15:22Z",
  • "item_Description": "string",
  • "item_Type": "str",
  • "message": "string",
  • "processed": "s",
  • "provider_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ChecksDetail
Deletes an ChecksDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
itemSeq
required
integer <int32> 
Item Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/checks/{checkID}/details/{itemSeq}
Request samples 
Create or Update Batch ChecksDetail
Create or Update multiple ChecksDetail 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
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
check_ID
required
integer <int32> 
ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
item_Seq
required
integer <int32> 
Sequential identifier of the check item. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjustment
number or null <double> 
Adjustment amount for the check line.


 
admin_Amt
number or null <double> 
Admin fee associated with the check line.


 
amount_Due
number or null <double> 
Total amount due for the check.


 
claim_Number
integer or null <int32> 
Number of the claim associated with the check line.


 
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


 
interest
number or null <double> 
Interest amount associated with the check line.


 
item_Date
string or null <date-time> 
Date when the check line item was received.


 
item_Description
string or null  <= 45 characters 
Description of the item associated with the check line.


 
item_Type
string or null  <= 3 characters 
Identifies the type of item associated with the check line.


 
message
string or null  <= 50 characters 
The message on the check.


 
processed
string or null  <= 1 characters 
Indicates tha the check has been processed.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the check line.


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