Adv. Accounting

Claim Refund Advanced API

Process a Claim Refund creating the necessary Backout and Reentry claims and adding Claim Reference values.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
refund_Funding_Key
integer <int32>
claim_Number
integer <int32>
refund_Batch_Number
integer <int32>
reenter_Claim
boolean
backout_Ex_Code
string or null
reentry_Ex_Code
string or null
user_ID
string or null
Responses
202

Accepted for processing

401

Unauthorized

post/accounting-claim-refund
Request samples
{
  • "refund_Funding_Key": 0,
  • "claim_Number": 0,
  • "refund_Batch_Number": 0,
  • "reenter_Claim": true,
  • "backout_Ex_Code": "string",
  • "reentry_Ex_Code": "string",
  • "user_ID": "string"
}

Claim Account Funding Advanced API

Submit a list of Payor/Account information to be funded based on configured parameters. Returns whether there are invalid entries in your list that were skipped during processing.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
generateRequest
integer <int32>
generateFullRequest
integer <int32>
candZeroPay
integer <int32>
genReqEmail
integer <int32>
payor_ID
string or null
account_Key
integer or null <int32>
payor_Name
string or null
payor_Contact
string or null
payor_Fax_Number
string or null
account_Name
string or null
account_Balance
number or null <double>
candidate_Balance
number or null <double>
requested_Balance
number or null <double>
hold_Balance
number or null <double>
hold_Count
integer or null <int32>
Responses
200

Success

401

Unauthorized

post/accounting-fund-request
Request samples
[
  • {
    }
]
Response samples
{
  • "data": true,
  • "error": {
    },
  • "debug": {
    }
}

Void Check Advanced API

Voids an existing Check

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
integer <int32>
reentry_Batch_Number
integer or null <int32>
backout_Ex_Code
string or null
reentry_Ex_Code
string or null
reentry_Provider_ID
string or null
reentry_Subscriber_ID
string or null
reentry_Member_Seq
string or null
user_ID
string or null
Responses
200

Success

401

Unauthorized

post/checks/{checkID}/void
Request samples
{
  • "check_ID": 0,
  • "reentry_Batch_Number": 0,
  • "backout_Ex_Code": "string",
  • "reentry_Ex_Code": "string",
  • "reentry_Provider_ID": "string",
  • "reentry_Subscriber_ID": "string",
  • "reentry_Member_Seq": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get Name and Address Information Advanced API

Using Send Check To and a dynamic Pay To ID, get the delivery information for a potential check.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
send_Check_To
required
string non-empty
pay_To_ID
required
string non-empty
subscriber_ID
string or null
member_Seq
string or null
name_On_Check
string or null
address_On_Check
string or null
address2_On_Check
string or null
city_On_Check
string or null
state_On_Check
string or null
zip_On_Check
string or null
country_ID_On_Check
string or null
name_On_Address
string or null
Responses
200

Success

401

Unauthorized

post/checks-name-on-check
Request samples
{
  • "send_Check_To": "string",
  • "pay_To_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "name_On_Check": "string",
  • "address_On_Check": "string",
  • "address2_On_Check": "string",
  • "city_On_Check": "string",
  • "state_On_Check": "string",
  • "zip_On_Check": "string",
  • "country_ID_On_Check": "string",
  • "name_On_Address": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Process Checks Advanced API

Initiates the process of Check Processing. If the request is valid, the system will generate the necessary actions to process checks and respond with a success status code of 202 Accepted, along with the generated process key.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
posted_Date
string or null <date-time>
user_ID
string or null
Array of objects or null (ProcessCheckOption)
Responses
202

Accepted for processing, returns the generated process key

401

Unauthorized

post/checks-process
Request samples
{
  • "posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "process_Check_Options": [
    ]
}
Response samples
{
  • "data": 0,
  • "error": {
    },
  • "debug": {
    }
}

Undo Void Check Advanced API

Undo a previously voided check by Check ID. Returns the VBAProcess Key for log review and verification.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
checkId
required
integer <int32>

Check ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
202

Accepted for processing, returns the generated process key

401

Unauthorized

post/checks-undo-void
Request samples 
Response samples 
No sample
Hold Funds Advanced API 
Lower the existing funding item by the hold amount and create a new funding for the hold amount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
fundingKey
required
integer <int32> 
Funding Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: multipart/form-data
holdAmount
required
number <double> 
 
Responses 
200
Success


401
Unauthorized


post/funding/{fundingKey}/hold
Request samples 
Response samples 
No sample
Reacllocate Funds Advanced API 
Change the Payor ID and Account Key of an existing funding item.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
fundingKey
required
integer <int32> 
Funding Key


 
payorId
required
string
Payor ID


 
accountKey
required
integer <int32> 
Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


put/funding/{fundingKey}/payors/{payorId}/accounts/{accountKey}/reallocate
Request samples 
Response samples 
No sample
Void Funds Advanced API 
Void an existing funding item.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
fundingKey
required
integer <int32> 
Funding Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


put/funding/{fundingKey}/void
Request samples 
Response samples 
No sample
Transfer Funds Advanced API 
Transfer funds from one account to another.  Additionally, can auto-create a premium distribution if a Funding_Key of 0 is sent.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
fundingKey
required
integer <int32> 
Funding Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payor_ID
string or null
 
account_Key
integer or null <int32> 
 
issue_Amount
number or null <double> 
 
issue_Type
string or null
 
issue_ID
string or null
 
issue_Name
string or null
 
issue_Date
string or null <date-time> 
 
received_Date
string or null <date-time> 
 
funding_Type
string or null
 
transfer_Funding_Type
string or null
 
transfer_Payor_ID
string or null
 
transfer_Account_Key
integer or null <int32> 
 
create_Check
boolean
 
expense_Type
string or null
 
payee_ID
string or null
 
user_ID
string or null
 
Responses 
200
Success


401
Unauthorized


put/funding/{fundingKey}/transfer
Request samples 
{
  • "payor_ID": "string",
  • "account_Key": 0,
  • "issue_Amount": 0.1,
  • "issue_Type": "string",
  • "issue_ID": "string",
  • "issue_Name": "string",
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "funding_Type": "string",
  • "transfer_Funding_Type": "string",
  • "transfer_Payor_ID": "string",
  • "transfer_Account_Key": 0,
  • "create_Check": true,
  • "expense_Type": "string",
  • "payee_ID": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get FundingAccount Balance Advanced API 
Gets FundingAccount balance details


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
accountKey
required
integer <int32> 
Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-accounts/{accountKey}/account-balance
Request samples 
Response samples 
No sample
Add Funding to Deposit Advanced API 
Creates Funding items and attaches them to an existing Deposit.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
depositKey
required
integer <int32> 
Deposit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
funding_Key
required
integer <int32> 
ID of the Funding record.  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.


 
account_Key
integer or null <int32> 
ID of the funding account.


 
cleared_Amount
number or null <double> 
Amount that was Cleared.


 
cleared_Date
string or null <date-time> 
Date the Amount was Cleared.


 
deposit_Key
integer or null <int32> 
ID of the Deposit.


 
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


 
funding_Status
string or null  <= 32 characters 
Status of the Funding.


 
funding_Type
string or null  <= 32 characters 
Type of the Funding.


 
issue_Amount
number or null <double> 
Amount Issued of the Funding record.


 
issue_Date
string or null <date-time> 
Date of the Issue.


 
issue_ID
string or null  <= 32 characters 
ID of the Issue.


 
issue_Name
string or null  <= 64 characters 
Name of the Issue.


 
issue_Type
string or null  <= 32 characters 
The transaction type of the Issue Amount.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor associated with the Funding record.


 
received_Date
string or null <date-time> 
Date Funding was Received.


 
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/funding-deposits/{depositKey}/add-funding
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Add Reconciliation Advanced API 
Creates a new FundingReconcile along with attaching any Checks/Deposits identified.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reconcile_Key
integer or null <int32> 
 
account_Key
integer <int32> 
 
begin_Date
string or null <date-time> 
 
begin_Balance
number or null <double> 
 
statement_Date
string or null <date-time> 
 
statement_Balance
number or null <double> 
 
user_ID
string or null
 
Array of objects or null (ElectronicStatement) 
 
Responses 
200
Success


401
Unauthorized


post/funding-reconciliation-add
Request samples 
{
  • "reconcile_Key": 0,
  • "account_Key": 0,
  • "begin_Date": "2019-08-24T14:15:22Z",
  • "begin_Balance": 0.1,
  • "statement_Date": "2019-08-24T14:15:22Z",
  • "statement_Balance": 0.1,
  • "user_ID": "string",
  • "electronic_Statements": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Reconcile Funds Advanced API 
Reconcile all Deposits, Checks, and Funding associated with this Reconciliation as well as creating offset debits and credits.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reconcile_Key
integer or null <int32> 
 
account_Key
integer <int32> 
 
begin_Date
string or null <date-time> 
 
begin_Balance
number or null <double> 
 
statement_Date
string or null <date-time> 
 
statement_Balance
number or null <double> 
 
user_ID
string or null
 
Array of objects or null (ElectronicStatement) 
 
Responses 
200
Success


401
Unauthorized


post/funding-reconciliation-reconcile-funds
Request samples 
{
  • "reconcile_Key": 0,
  • "account_Key": 0,
  • "begin_Date": "2019-08-24T14:15:22Z",
  • "begin_Balance": 0.1,
  • "statement_Date": "2019-08-24T14:15:22Z",
  • "statement_Balance": 0.1,
  • "user_ID": "string",
  • "electronic_Statements": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get PayorAccount Balance Advanced API 
Gets PayorAccount Balance details


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payor-accounts/{payorAccountKey}/account-balance
Request samples 
Response samples 
No sample