Funding Account

Create FundingAccount

Creates a new FundingAccount

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
account_Key
required
integer <int32>

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

acH_Number_Prefix
string or null <= 8 characters

Identifies the prefix of the ACH number.

acH_Number_Suffix
string or null <= 8 characters

Identifies the suffix of the ACH number.

account_Category
string or null <= 8 characters

Identifies which category the funding account belongs to.

account_Name
string or null <= 64 characters

Name for the funding account.

account_Number
string or null <= 32 characters

Account number of the funding account.

account_Type
string or null <= 8 characters

Identifies the type of funding account. 'Account Types' are configured within 'Accounting Configuration'.

bank_Address1
string or null <= 128 characters

Address line 1 of the funding account's banking institution.

bank_Address2
string or null <= 128 characters

Address line 2 of the funding account's banking institution.

bank_City
string or null <= 32 characters

City of the banking institution's address.

bank_Country_ID
string or null <= 8 characters

Identifies the country that the funding account belongs to.

bank_Name
string or null <= 64 characters

Name of the funding account's banking institution.

bank_State
string or null <= 2 characters

State of the banking institution's address.

bank_Zip
string or null <= 16 characters

Zip Code of the banking institution's address.

cC_Address1
string or null <= 128 characters

Address Line 1 used for the credit card.

cC_Address2
string or null <= 128 characters

Address Line 2 used for the credit card.

cC_City
string or null <= 32 characters

City used for the credit card.

cC_Debit_Credit
string or null <= 8 characters

Identifies the card as either a debit card or credit card.

cC_Exp_Month
integer or null <int32>

Expiration month of the credit card.

cC_Exp_Year
integer or null <int32>

Expiration year of the credit card.

cC_Name_On_Card
string or null <= 128 characters

Identifies the name listed on the credit card.

cC_Number
string or null <= 32 characters

Credit card number.

cC_Sec_Code
integer or null <int32>

Security code used for the credit card.

cC_State
string or null <= 2 characters

State used for the credit card.

cC_Type
string or null <= 16 characters

Identifies the type of credit card used by the funding account.

cC_Zip
string or null <= 16 characters

Zip code used for the credit card.

currency_ID
string or null <= 16 characters

Indicates what current the funding account uses.

default_Check_Stock
integer or null <int32>

Assigns the default check stock for generated checks.

default_Funding_Threshold
integer or null <int32>

Assigns the default funding threshold.

effective_Date
string or null <date-time>

Date when the funding account becomes/became effective.

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

ex_Code
string or null <= 6 characters

Ex Code that will be applied to claims which are funded by this account.

federal_ID
string or null <= 20 characters

Identifies the Federal Tax ID of the funding account.

fractional_Routing_Number
string or null <= 32 characters

Fractional routing number of the funding account.

last_ACH_Number
integer or null <int32>

Number of the last generated ACH transaction from the funding account.

last_Check_Number
integer or null <int64>

Number of the last generated check from the funding account.

micR_Check_Num_Start_Pos
integer or null <int32>

Identifies the starting number for the funding account's Magnietic Ink Character Recognition checks.

micR_Line
string or null <= 128 characters

Identifies the Magnetic Ink Character Recognition line of the funding account's checks.

positive_Pay_Required
boolean or null

Used to determine if a positive payment is required.

routing_Number
string or null <= 32 characters

Routing number of the funding account.

security_Code
string or null <= 8 characters

Identifies the security code of the funding account.

statement_Format_Key
integer or null <int32>

Indicates the format for generated statements.

swift_Code
string or null <= 20 characters

Identifies the swift code of the funding account.

term_Date
string or null <date-time>

Date when the funding account expires/expired.

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

use_ACH_Numbering
required
boolean

Used to determine if checks are numbered by ACH. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/funding-accounts
Request samples
{
  • "account_Key": 0,
  • "acH_Number_Prefix": "string",
  • "acH_Number_Suffix": "string",
  • "account_Category": "string",
  • "account_Name": "string",
  • "account_Number": "string",
  • "account_Type": "string",
  • "bank_Address1": "string",
  • "bank_Address2": "string",
  • "bank_City": "string",
  • "bank_Country_ID": "string",
  • "bank_Name": "string",
  • "bank_State": "st",
  • "bank_Zip": "string",
  • "cC_Address1": "string",
  • "cC_Address2": "string",
  • "cC_City": "string",
  • "cC_Debit_Credit": "string",
  • "cC_Exp_Month": 0,
  • "cC_Exp_Year": 0,
  • "cC_Name_On_Card": "string",
  • "cC_Number": "string",
  • "cC_Sec_Code": 0,
  • "cC_State": "st",
  • "cC_Type": "string",
  • "cC_Zip": "string",
  • "currency_ID": "string",
  • "default_Check_Stock": 0,
  • "default_Funding_Threshold": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "federal_ID": "string",
  • "fractional_Routing_Number": "string",
  • "last_ACH_Number": 0,
  • "last_Check_Number": 0,
  • "micR_Check_Num_Start_Pos": 0,
  • "micR_Line": "string",
  • "positive_Pay_Required": true,
  • "routing_Number": "string",
  • "security_Code": "string",
  • "statement_Format_Key": 0,
  • "swift_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_ACH_Numbering": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingAccount

Lists all FundingAccount

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-accounts
Request samples 
Response samples 
No sample
Get FundingAccount
Gets FundingAccount


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}
Request samples 
Response samples 
No sample
Update FundingAccount
Updates a specific FundingAccount.


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


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
acH_Number_Prefix
string or null  <= 8 characters 
Identifies the prefix of the ACH number.


 
acH_Number_Suffix
string or null  <= 8 characters 
Identifies the suffix of the ACH number.


 
account_Category
string or null  <= 8 characters 
Identifies which category the funding account belongs to.


 
account_Name
string or null  <= 64 characters 
Name for the funding account.


 
account_Number
string or null  <= 32 characters 
Account number of the funding account.


 
account_Type
string or null  <= 8 characters 
Identifies the type of funding account. 'Account Types' are configured within 'Accounting Configuration'.


 
bank_Address1
string or null  <= 128 characters 
Address line 1 of the funding account's banking institution.


 
bank_Address2
string or null  <= 128 characters 
Address line 2 of the funding account's banking institution.


 
bank_City
string or null  <= 32 characters 
City of the banking institution's address.


 
bank_Country_ID
string or null  <= 8 characters 
Identifies the country that the funding account belongs to.


 
bank_Name
string or null  <= 64 characters 
Name of the funding account's banking institution.


 
bank_State
string or null  <= 2 characters 
State of the banking institution's address.


 
bank_Zip
string or null  <= 16 characters 
Zip Code of the banking institution's address.


 
cC_Address1
string or null  <= 128 characters 
Address Line 1 used for the credit card.


 
cC_Address2
string or null  <= 128 characters 
Address Line 2 used for the credit card.


 
cC_City
string or null  <= 32 characters 
City used for the credit card.


 
cC_Debit_Credit
string or null  <= 8 characters 
Identifies the card as either a debit card or credit card.


 
cC_Exp_Month
integer or null <int32> 
Expiration month of the credit card.


 
cC_Exp_Year
integer or null <int32> 
Expiration year of the credit card.


 
cC_Name_On_Card
string or null  <= 128 characters 
Identifies the name listed on the credit card.


 
cC_Number
string or null  <= 32 characters 
Credit card number.


 
cC_Sec_Code
integer or null <int32> 
Security code used for the credit card.


 
cC_State
string or null  <= 2 characters 
State used for the credit card.


 
cC_Type
string or null  <= 16 characters 
Identifies the type of credit card used by the funding account.


 
cC_Zip
string or null  <= 16 characters 
Zip code used for the credit card.


 
currency_ID
string or null  <= 16 characters 
Indicates what current the funding account uses.


 
default_Check_Stock
integer or null <int32> 
Assigns the default check stock for generated checks.


 
default_Funding_Threshold
integer or null <int32> 
Assigns the default funding threshold.


 
effective_Date
string or null <date-time> 
Date when the funding account becomes/became effective.


 
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


 
ex_Code
string or null  <= 6 characters 
Ex Code that will be applied to claims which are funded by this account.


 
federal_ID
string or null  <= 20 characters 
Identifies the Federal Tax ID of the funding account.


 
fractional_Routing_Number
string or null  <= 32 characters 
Fractional routing number of the funding account.


 
last_ACH_Number
integer or null <int32> 
Number of the last generated ACH transaction from the funding account.


 
last_Check_Number
integer or null <int64> 
Number of the last generated check from the funding account.


 
micR_Check_Num_Start_Pos
integer or null <int32> 
Identifies the starting number for the funding account's Magnietic Ink Character Recognition checks.


 
micR_Line
string or null  <= 128 characters 
Identifies the Magnetic Ink Character Recognition line of the funding account's checks.


 
positive_Pay_Required
boolean or null
Used to determine if a positive payment is required.


 
routing_Number
string or null  <= 32 characters 
Routing number of the funding account.


 
security_Code
string or null  <= 8 characters 
Identifies the security code of the funding account.


 
statement_Format_Key
integer or null <int32> 
Indicates the format for generated statements.


 
swift_Code
string or null  <= 20 characters 
Identifies the swift code of the funding account.


 
term_Date
string or null <date-time> 
Date when the funding account expires/expired.


 
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


 
use_ACH_Numbering
required
boolean
Used to determine if checks are numbered by ACH. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/funding-accounts/{accountKey}
Request samples 
{
  • "account_Key": 0,
  • "acH_Number_Prefix": "string",
  • "acH_Number_Suffix": "string",
  • "account_Category": "string",
  • "account_Name": "string",
  • "account_Number": "string",
  • "account_Type": "string",
  • "bank_Address1": "string",
  • "bank_Address2": "string",
  • "bank_City": "string",
  • "bank_Country_ID": "string",
  • "bank_Name": "string",
  • "bank_State": "st",
  • "bank_Zip": "string",
  • "cC_Address1": "string",
  • "cC_Address2": "string",
  • "cC_City": "string",
  • "cC_Debit_Credit": "string",
  • "cC_Exp_Month": 0,
  • "cC_Exp_Year": 0,
  • "cC_Name_On_Card": "string",
  • "cC_Number": "string",
  • "cC_Sec_Code": 0,
  • "cC_State": "st",
  • "cC_Type": "string",
  • "cC_Zip": "string",
  • "currency_ID": "string",
  • "default_Check_Stock": 0,
  • "default_Funding_Threshold": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "federal_ID": "string",
  • "fractional_Routing_Number": "string",
  • "last_ACH_Number": 0,
  • "last_Check_Number": 0,
  • "micR_Check_Num_Start_Pos": 0,
  • "micR_Line": "string",
  • "positive_Pay_Required": true,
  • "routing_Number": "string",
  • "security_Code": "string",
  • "statement_Format_Key": 0,
  • "swift_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_ACH_Numbering": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingAccount
Deletes an FundingAccount


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-accounts/{accountKey}
Request samples 
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
Create or Update Batch FundingAccount
Create or Update multiple FundingAccount 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 
account_Key
required
integer <int32> 
ID of the funding account. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
acH_Number_Prefix
string or null  <= 8 characters 
Identifies the prefix of the ACH number.


 
acH_Number_Suffix
string or null  <= 8 characters 
Identifies the suffix of the ACH number.


 
account_Category
string or null  <= 8 characters 
Identifies which category the funding account belongs to.


 
account_Name
string or null  <= 64 characters 
Name for the funding account.


 
account_Number
string or null  <= 32 characters 
Account number of the funding account.


 
account_Type
string or null  <= 8 characters 
Identifies the type of funding account. 'Account Types' are configured within 'Accounting Configuration'.


 
bank_Address1
string or null  <= 128 characters 
Address line 1 of the funding account's banking institution.


 
bank_Address2
string or null  <= 128 characters 
Address line 2 of the funding account's banking institution.


 
bank_City
string or null  <= 32 characters 
City of the banking institution's address.


 
bank_Country_ID
string or null  <= 8 characters 
Identifies the country that the funding account belongs to.


 
bank_Name
string or null  <= 64 characters 
Name of the funding account's banking institution.


 
bank_State
string or null  <= 2 characters 
State of the banking institution's address.


 
bank_Zip
string or null  <= 16 characters 
Zip Code of the banking institution's address.


 
cC_Address1
string or null  <= 128 characters 
Address Line 1 used for the credit card.


 
cC_Address2
string or null  <= 128 characters 
Address Line 2 used for the credit card.


 
cC_City
string or null  <= 32 characters 
City used for the credit card.


 
cC_Debit_Credit
string or null  <= 8 characters 
Identifies the card as either a debit card or credit card.


 
cC_Exp_Month
integer or null <int32> 
Expiration month of the credit card.


 
cC_Exp_Year
integer or null <int32> 
Expiration year of the credit card.


 
cC_Name_On_Card
string or null  <= 128 characters 
Identifies the name listed on the credit card.


 
cC_Number
string or null  <= 32 characters 
Credit card number.


 
cC_Sec_Code
integer or null <int32> 
Security code used for the credit card.


 
cC_State
string or null  <= 2 characters 
State used for the credit card.


 
cC_Type
string or null  <= 16 characters 
Identifies the type of credit card used by the funding account.


 
cC_Zip
string or null  <= 16 characters 
Zip code used for the credit card.


 
currency_ID
string or null  <= 16 characters 
Indicates what current the funding account uses.


 
default_Check_Stock
integer or null <int32> 
Assigns the default check stock for generated checks.


 
default_Funding_Threshold
integer or null <int32> 
Assigns the default funding threshold.


 
effective_Date
string or null <date-time> 
Date when the funding account becomes/became effective.


 
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


 
ex_Code
string or null  <= 6 characters 
Ex Code that will be applied to claims which are funded by this account.


 
federal_ID
string or null  <= 20 characters 
Identifies the Federal Tax ID of the funding account.


 
fractional_Routing_Number
string or null  <= 32 characters 
Fractional routing number of the funding account.


 
last_ACH_Number
integer or null <int32> 
Number of the last generated ACH transaction from the funding account.


 
last_Check_Number
integer or null <int64> 
Number of the last generated check from the funding account.


 
micR_Check_Num_Start_Pos
integer or null <int32> 
Identifies the starting number for the funding account's Magnietic Ink Character Recognition checks.


 
micR_Line
string or null  <= 128 characters 
Identifies the Magnetic Ink Character Recognition line of the funding account's checks.


 
positive_Pay_Required
boolean or null
Used to determine if a positive payment is required.


 
routing_Number
string or null  <= 32 characters 
Routing number of the funding account.


 
security_Code
string or null  <= 8 characters 
Identifies the security code of the funding account.


 
statement_Format_Key
integer or null <int32> 
Indicates the format for generated statements.


 
swift_Code
string or null  <= 20 characters 
Identifies the swift code of the funding account.


 
term_Date
string or null <date-time> 
Date when the funding account expires/expired.


 
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


 
use_ACH_Numbering
required
boolean
Used to determine if checks are numbered by ACH. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


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