Funding

Create Funding

Creates a new Funding

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
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
Request samples
{
  • "funding_Key": 0,
  • "account_Key": 0,
  • "cleared_Amount": 0.1,
  • "cleared_Date": "2019-08-24T14:15:22Z",
  • "deposit_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Status": "string",
  • "funding_Type": "string",
  • "issue_Amount": 0.1,
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "issue_ID": "string",
  • "issue_Name": "string",
  • "issue_Type": "string",
  • "payor_ID": "string",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Funding

Lists all Funding

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/funding
Request samples 
Response samples 
No sample
Get Funding
Gets Funding


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


get/funding/{fundingKey}
Request samples 
Response samples 
No sample
Update Funding
Updates a specific Funding.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
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


put/funding/{fundingKey}
Request samples 
{
  • "funding_Key": 0,
  • "account_Key": 0,
  • "cleared_Amount": 0.1,
  • "cleared_Date": "2019-08-24T14:15:22Z",
  • "deposit_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Status": "string",
  • "funding_Type": "string",
  • "issue_Amount": 0.1,
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "issue_ID": "string",
  • "issue_Name": "string",
  • "issue_Type": "string",
  • "payor_ID": "string",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Funding
Deletes an Funding


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding/{fundingKey}
Request samples 
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": {
    }
}
Create or Update Batch Funding
Create or Update multiple Funding 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 
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 
207
Success


401
Unauthorized


put/funding-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}