Funding Reconciliation On Statements

Create FundingReconcileOnStatement

Creates a new FundingReconcileOnStatement

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

Reconcile Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
on_Statement_Key
required
integer <int32>

ID of the reconciliation offset. 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

issue_Amount
number or null <double>

Offset amount used for the funding reconciliation.

issue_Date
string or null <date-time>

Date when the associated issue was created.

issue_ID
string or null <= 32 characters

ID of the issue associated with the funding reconciliation.

issue_Type
string or null <= 32 characters

Issue Type' associated with the funding reconciliation. 'Funding Issue Types' are configured within 'Accounting Configuration'.

payor_ID
string or null <= 20 characters

ID of the Payor being used for the associated reconciliation.

reconcile_Key
required
integer <int32>

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

reconcile_Type
string or null <= 32 characters

Indicates whether the associated offset is a credit or a debit.

selected
required
boolean

Indicates that this offest will be applied to the current reconciliation when the User selects 'Update'. 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}/on-statements
Request samples
{
  • "on_Statement_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "issue_Amount": 0.1,
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "issue_ID": "string",
  • "issue_Type": "string",
  • "payor_ID": "string",
  • "reconcile_Key": 0,
  • "reconcile_Type": "string",
  • "selected": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingReconcileOnStatement

Lists all FundingReconcileOnStatement 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}/on-statements
Request samples 
Response samples 
No sample
Get FundingReconcileOnStatement
Gets FundingReconcileOnStatement


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


 
onStatementKey
required
integer <int32> 
On Statement Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-reconciliations/{reconcileKey}/on-statements/{onStatementKey}
Request samples 
Response samples 
No sample
Update FundingReconcileOnStatement
Updates a specific FundingReconcileOnStatement.


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


 
onStatementKey
required
integer <int32> 
On Statement Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
on_Statement_Key
required
integer <int32> 
ID of the reconciliation offset. 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


 
issue_Amount
number or null <double> 
Offset amount used for the funding reconciliation.


 
issue_Date
string or null <date-time> 
Date when the associated issue was created.


 
issue_ID
string or null  <= 32 characters 
ID of the issue associated with the funding reconciliation.


 
issue_Type
string or null  <= 32 characters 
Issue Type' associated with the funding reconciliation. 'Funding Issue Types' are configured within 'Accounting Configuration'.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor being used for the associated reconciliation.


 
reconcile_Key
required
integer <int32> 
ID of the reconciliation associated with the offset. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reconcile_Type
string or null  <= 32 characters 
Indicates whether the associated offset is a credit or a debit.


 
selected
required
boolean
Indicates that this offest will be applied to the current reconciliation when the User selects 'Update'. 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}/on-statements/{onStatementKey}
Request samples 
{
  • "on_Statement_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "issue_Amount": 0.1,
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "issue_ID": "string",
  • "issue_Type": "string",
  • "payor_ID": "string",
  • "reconcile_Key": 0,
  • "reconcile_Type": "string",
  • "selected": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingReconcileOnStatement
Deletes an FundingReconcileOnStatement


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


 
onStatementKey
required
integer <int32> 
On Statement Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-reconciliations/{reconcileKey}/on-statements/{onStatementKey}
Request samples 
Create or Update Batch FundingReconcileOnStatement
Create or Update multiple FundingReconcileOnStatement 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 
on_Statement_Key
required
integer <int32> 
ID of the reconciliation offset. 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


 
issue_Amount
number or null <double> 
Offset amount used for the funding reconciliation.


 
issue_Date
string or null <date-time> 
Date when the associated issue was created.


 
issue_ID
string or null  <= 32 characters 
ID of the issue associated with the funding reconciliation.


 
issue_Type
string or null  <= 32 characters 
Issue Type' associated with the funding reconciliation. 'Funding Issue Types' are configured within 'Accounting Configuration'.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor being used for the associated reconciliation.


 
reconcile_Key
required
integer <int32> 
ID of the reconciliation associated with the offset. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reconcile_Type
string or null  <= 32 characters 
Indicates whether the associated offset is a credit or a debit.


 
selected
required
boolean
Indicates that this offest will be applied to the current reconciliation when the User selects 'Update'. 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}/on-statements-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}