Funding Requests

Create FundingRequest

Creates a new FundingRequest

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
request_Key
required
integer <int32>

ID of the funding request. 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 Account associated with the funding request.

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_Format
string or null <= 32 characters

Format of the funding request.

invalid_Request
boolean or null

Indicates that the funding request is invalid.

payor_ID
string or null <= 20 characters

ID of the Payor associated with the funding request.

primary_Contact_Method
string or null <= 32 characters

Method of the funding request.

request_Amount
number or null <double>

Amount of the funding request.

request_Date
required
string <date-time>

Date when the funding request was submitted.

request_Status
string or null <= 32 characters

Indicates the 'Request Status' of the funding request. 'Request Types' are configured within 'Accounting Configuration'.

request_Type
string or null <= 32 characters

Indicates the 'Request Type' of the funding request. 'Request Types' are configured within 'Accounting Configuration'.

request_User
required
string [ 1 .. 32 ] characters

ID of the User who submitted the funding request.

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-requests
Request samples
{
  • "request_Key": 0,
  • "account_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Format": "string",
  • "invalid_Request": true,
  • "payor_ID": "string",
  • "primary_Contact_Method": "string",
  • "request_Amount": 0.1,
  • "request_Date": "2019-08-24T14:15:22Z",
  • "request_Status": "string",
  • "request_Type": "string",
  • "request_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingRequest

Lists all FundingRequest

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-requests
Request samples 
Response samples 
No sample
Get FundingRequest
Gets FundingRequest


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-requests/{requestKey}
Request samples 
Response samples 
No sample
Update FundingRequest
Updates a specific FundingRequest.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
request_Key
required
integer <int32> 
ID of the funding request.  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 Account associated with the funding request.


 
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_Format
string or null  <= 32 characters 
Format of the funding request.


 
invalid_Request
boolean or null
Indicates that the funding request is invalid.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor associated with the funding request.


 
primary_Contact_Method
string or null  <= 32 characters 
Method of the funding request.


 
request_Amount
number or null <double> 
Amount of the funding request.


 
request_Date
required
string <date-time> 
Date when the funding request was submitted.


 
request_Status
string or null  <= 32 characters 
Indicates the 'Request Status' of the funding request. 'Request Types' are configured within 'Accounting Configuration'.


 
request_Type
string or null  <= 32 characters 
Indicates the 'Request Type' of the funding request. 'Request Types' are configured within 'Accounting Configuration'.


 
request_User
required
string  [ 1 .. 32 ] characters 
ID of the User who submitted the funding request.


 
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-requests/{requestKey}
Request samples 
{
  • "request_Key": 0,
  • "account_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Format": "string",
  • "invalid_Request": true,
  • "payor_ID": "string",
  • "primary_Contact_Method": "string",
  • "request_Amount": 0.1,
  • "request_Date": "2019-08-24T14:15:22Z",
  • "request_Status": "string",
  • "request_Type": "string",
  • "request_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingRequest
Deletes an FundingRequest


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-requests/{requestKey}
Request samples 
Create or Update Batch FundingRequest
Create or Update multiple FundingRequest 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 
request_Key
required
integer <int32> 
ID of the funding request.  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 Account associated with the funding request.


 
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_Format
string or null  <= 32 characters 
Format of the funding request.


 
invalid_Request
boolean or null
Indicates that the funding request is invalid.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor associated with the funding request.


 
primary_Contact_Method
string or null  <= 32 characters 
Method of the funding request.


 
request_Amount
number or null <double> 
Amount of the funding request.


 
request_Date
required
string <date-time> 
Date when the funding request was submitted.


 
request_Status
string or null  <= 32 characters 
Indicates the 'Request Status' of the funding request. 'Request Types' are configured within 'Accounting Configuration'.


 
request_Type
string or null  <= 32 characters 
Indicates the 'Request Type' of the funding request. 'Request Types' are configured within 'Accounting Configuration'.


 
request_User
required
string  [ 1 .. 32 ] characters 
ID of the User who submitted the funding request.


 
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-requests-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Satisfy a Funding Request
Satisfies a specific FundingRequest and handles partial request processing.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
request_Key
integer <int32> 
 
funding_Key
integer <int32> 
 
new_Request
boolean
 
user_ID
string or null
 
Array of objects or null (CandidateClaim) 
 
Responses 
200
Success


401
Unauthorized


put/funding-requests/{requestKey}/satisfy
Request samples 
{
  • "request_Key": 0,
  • "funding_Key": 0,
  • "new_Request": true,
  • "user_ID": "string",
  • "candidateClaims": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}