Funding Reconciliations

Create FundingReconcile

Creates a new FundingReconcile

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reconcile_Key
required
integer <int32>

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

account_Key
required
integer <int32>

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

begin_Balance
number or null <double>

Beginning balance of the reconciliation

begin_Date
string or null <date-time>

Beginning Date of the reconciliation.

electronic_Statement
required
boolean

Indicates that the associated reconciliation has an electronic statement. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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_Date
required
string <date-time>

Date when the reconciliation occurred. Note: This field is marked as NOT NULL in the database and therefore required by the API.

reconcile_Status
string or null <= 32 characters

Most recent status of the reconciliation. 'Reconcile Statuses' are configured within 'Accounting Configuration'.

reconcile_User
required
string [ 1 .. 32 ] characters

User associated with the reconciliation

statement_Balance
number or null <double>

Balance of the reconciliation statement

statement_Date
string or null <date-time>

Date when the statement associated with the reconciliation was submitted.

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-reconciliations
Request samples
{
  • "reconcile_Key": 0,
  • "account_Key": 0,
  • "begin_Balance": 0.1,
  • "begin_Date": "2019-08-24T14:15:22Z",
  • "electronic_Statement": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reconcile_Date": "2019-08-24T14:15:22Z",
  • "reconcile_Status": "string",
  • "reconcile_User": "string",
  • "statement_Balance": 0.1,
  • "statement_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingReconcile

Lists all FundingReconcile

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-reconciliations
Request samples
Response samples
No sample

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 FundingReconcile

Gets FundingReconcile

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
reconcileKey
required
integer <int32>

Reconcile Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/funding-reconciliations/{reconcileKey}
Request samples
Response samples
No sample

Update FundingReconcile

Updates a specific FundingReconcile.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
reconcileKey
required
integer <int32>

Reconcile Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reconcile_Key
required
integer <int32>

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

account_Key
required
integer <int32>

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

begin_Balance
number or null <double>

Beginning balance of the reconciliation

begin_Date
string or null <date-time>

Beginning Date of the reconciliation.

electronic_Statement
required
boolean

Indicates that the associated reconciliation has an electronic statement. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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_Date
required
string <date-time>

Date when the reconciliation occurred. Note: This field is marked as NOT NULL in the database and therefore required by the API.

reconcile_Status
string or null <= 32 characters

Most recent status of the reconciliation. 'Reconcile Statuses' are configured within 'Accounting Configuration'.

reconcile_User
required
string [ 1 .. 32 ] characters

User associated with the reconciliation

statement_Balance
number or null <double>

Balance of the reconciliation statement

statement_Date
string or null <date-time>

Date when the statement associated with the reconciliation was submitted.

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-reconciliations/{reconcileKey}
Request samples
{
  • "reconcile_Key": 0,
  • "account_Key": 0,
  • "begin_Balance": 0.1,
  • "begin_Date": "2019-08-24T14:15:22Z",
  • "electronic_Statement": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reconcile_Date": "2019-08-24T14:15:22Z",
  • "reconcile_Status": "string",
  • "reconcile_User": "string",
  • "statement_Balance": 0.1,
  • "statement_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete FundingReconcile

Deletes an FundingReconcile

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
reconcileKey
required
integer <int32>

Reconcile Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/funding-reconciliations/{reconcileKey}
Request samples

Create or Update Batch FundingReconcile

Create or Update multiple FundingReconcile 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
reconcile_Key
required
integer <int32>

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

account_Key
required
integer <int32>

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

begin_Balance
number or null <double>

Beginning balance of the reconciliation

begin_Date
string or null <date-time>

Beginning Date of the reconciliation.

electronic_Statement
required
boolean

Indicates that the associated reconciliation has an electronic statement. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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_Date
required
string <date-time>

Date when the reconciliation occurred. Note: This field is marked as NOT NULL in the database and therefore required by the API.

reconcile_Status
string or null <= 32 characters

Most recent status of the reconciliation. 'Reconcile Statuses' are configured within 'Accounting Configuration'.

reconcile_User
required
string [ 1 .. 32 ] characters

User associated with the reconciliation

statement_Balance
number or null <double>

Balance of the reconciliation statement

statement_Date
string or null <date-time>

Date when the statement associated with the reconciliation was submitted.

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