Funding Reconciliation Disbursements

Create FundingReconcileDisbursed

Creates a new FundingReconcileDisbursed

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.

check_ID
required
integer <int32>

ID of the check being used for the disbursement. 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

selected
required
boolean

Indicates if the check was selected. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

List FundingReconcileDisbursed

Lists all FundingReconcileDisbursed for the given reconcileKey

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

Reconcile Key

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/{reconcileKey}/disbursements
Request samples 
Response samples 
No sample
Get FundingReconcileDisbursed
Gets FundingReconcileDisbursed


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


 
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-reconciliations/{reconcileKey}/disbursements/{checkID}
Request samples 
Response samples 
No sample
Update FundingReconcileDisbursed
Updates a specific FundingReconcileDisbursed.


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


 
checkID
required
integer <int32> 
Check ID


 
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.


 
check_ID
required
integer <int32> 
ID of the check being used for the disbursement. 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


 
selected
required
boolean
Indicates if the check was selected. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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}/disbursements/{checkID}
Request samples 
{
  • "reconcile_Key": 0,
  • "check_ID": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "selected": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingReconcileDisbursed
Deletes an FundingReconcileDisbursed


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


 
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-reconciliations/{reconcileKey}/disbursements/{checkID}
Request samples 
Create or Update Batch FundingReconcileDisbursed
Create or Update multiple FundingReconcileDisbursed at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
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.


 
check_ID
required
integer <int32> 
ID of the check being used for the disbursement. 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


 
selected
required
boolean
Indicates if the check was selected. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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