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": {
    }
}

Mass Update Claim Funded Status Advanced API

Pass in a list of claims and what Claim_Funded_Status to update that claim to and have it updated in mass without iterating through claim records.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
claim_Number
integer <int32>
claim_Funded_Status
string or null
Responses
202

Accepted for processing

401

Unauthorized

post/accounting-update-claim-funded-status
Request samples
[
  • {
    }
]

Sync and Update Debits and Credits for a Recon Advanced API

Based on submitted details, update the Disbursed and Received tables for cleared items on the selected Reconciliation.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reconcile_Key
integer <int32>
Array of objects or null (Debit)
Array of objects or null (Credit)
Responses
202

Accepted for processing

401

Unauthorized

post/update-recon-credit-debit
Request samples
{
  • "reconcile_Key": 0,
  • "debits": [
    ],
  • "credits": [
    ]
}

Process Receipt File Advanced API

Import a defined Receipt File in .csv format to then have Funding items populated in a response so that they can then be created or modified. This process does not create Funding items but returns the Funding items that should be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
receipt_File_Format_Key
integer <int32>

Not currently in use but in the future may allow custom import formats. Today only the VBA standard import format is supported.

receipt_File
string or null <byte>

A .csv file with headers and the following columns:

  • **Payor_ID - REQUIRED: valid VBASoftware Payor ID
  • **Account_Name - REQUIRED: this is a valid VBASoftware Account name. this must match a single FundingAccount record
  • **Issue_Name - REQUIRED: Issue Name on the receipt
  • **Issue_Type - REQUIRED: Issue Type on the receipt
  • **Issue_ID - REQUIRED: Issue ID on the receipt
  • **Funding_Type - REQUIRED: Funding Type on the receipt
  • **Received_Date - REQUIRED: Received Date on the receipt
  • **Issue_Date - REQUIRED: Issue Date on the receipt
  • **Issue_Amount - REQUIRED: Issue Amount on the receipt
  • **Auto_Create_Deposit - Auto Create Deposit for this receipt.
  • **User_Name - Ignored in VBAPI, this value is overridden to the user performing the actual import
  • **Group_ID - Group ID for information only
  • **Transfer_Payor_ID - Transfer Payor ID for reference only
  • **Transfer_Account_Name - Transfer Account Name for reference only
  • **Transfer_Funding_Type - Transfer Funding Type for reference only
  • **Create_Check - Create Check for information only
  • **Expense_Type - Expense Type for reference only
  • **Payee_Name - Payee Name for reference only
user_ID
string or null
Responses
200

Success

401

Unauthorized

post/process-receipt-file
Request samples
{
  • "receipt_File_Format_Key": 0,
  • "receipt_File": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}