Funding Deposits

Create FundingDeposit

Creates a new FundingDeposit

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
deposit_Key
required
integer <int32>

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

deposit_Date
string or null <date-time>

Date when the deposit occurred.

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

reconcile_Key
integer or null <int32>

ID of the reconciliation associated with the deposit.

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
Request samples
{
  • "deposit_Key": 0,
  • "deposit_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reconcile_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingDeposit

Lists all FundingDeposit

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-deposits
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": {
    }
}
Get FundingDeposit
Gets FundingDeposit


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-deposits/{depositKey}
Request samples 
Response samples 
No sample
Update FundingDeposit
Updates a specific FundingDeposit.


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


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
deposit_Date
string or null <date-time> 
Date when the deposit occurred.


 
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


 
reconcile_Key
integer or null <int32> 
ID of the reconciliation associated with the deposit.


 
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-deposits/{depositKey}
Request samples 
{
  • "deposit_Key": 0,
  • "deposit_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reconcile_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingDeposit
Deletes an FundingDeposit


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-deposits/{depositKey}
Request samples 
Void FundingDeposit
Deletes an FundingDeposit entry and changes the associated Funding items back to unassigned (not part of any deposit).


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-deposits/{depositKey}/void-deposit
Request samples 
Create or Update Batch FundingDeposit
Create or Update multiple FundingDeposit 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 
deposit_Key
required
integer <int32> 
ID of the funding deposit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
deposit_Date
string or null <date-time> 
Date when the deposit occurred.


 
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


 
reconcile_Key
integer or null <int32> 
ID of the reconciliation associated with the deposit.


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