Funding Request Claims

Create FundingRequestClaim

Creates a new FundingRequestClaim

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

Request Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
batch_Number
required
integer <int32>

Batch number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.

batch_Claim
required
integer <int32>

Claim number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.

request_Key
required
integer <int32>

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

funded
required
boolean

Indicates that the claim has been funded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

funded_Amount
number or null <double>

Amount that was funded.

funded_Date
string or null <date-time>

Date when the claim was funded.

request_Amount
number or null <double>

Amount of 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/{requestKey}/claims
Request samples
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "request_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funded": true,
  • "funded_Amount": 0.1,
  • "funded_Date": "2019-08-24T14:15:22Z",
  • "request_Amount": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingRequestClaim

Lists all FundingRequestClaim for the given requestKey

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

Request 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-requests/{requestKey}/claims
Request samples 
Response samples 
No sample
List FundingRequestClaim Summary
Lists all FundingRequestClaim Summary for the given requestKey.  The Summary view has additional computed fields that are ot present on the FundingRequestClaim object.


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}/claims-summary
Request samples 
Response samples 
No sample
Get FundingRequestClaim
Gets FundingRequestClaim


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


 
batchNumber
required
integer <int32> 
Batch Number


 
batchClaim
required
integer <int32> 
Batch Claim


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-requests/{requestKey}/claims/{batchNumber}/{batchClaim}
Request samples 
Response samples 
No sample
Update FundingRequestClaim
Updates a specific FundingRequestClaim.


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


 
batchNumber
required
integer <int32> 
Batch Number


 
batchClaim
required
integer <int32> 
Batch Claim


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
batch_Number
required
integer <int32> 
Batch number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
batch_Claim
required
integer <int32> 
Claim number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
required
integer <int32> 
ID of the funding request. 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


 
funded
required
boolean
Indicates that the claim has been funded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
funded_Amount
number or null <double> 
Amount that was funded.


 
funded_Date
string or null <date-time> 
Date when the claim was funded.


 
request_Amount
number or null <double> 
Amount of 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}/claims/{batchNumber}/{batchClaim}
Request samples 
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "request_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funded": true,
  • "funded_Amount": 0.1,
  • "funded_Date": "2019-08-24T14:15:22Z",
  • "request_Amount": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingRequestClaim
Deletes an FundingRequestClaim


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


 
batchNumber
required
integer <int32> 
Batch Number


 
batchClaim
required
integer <int32> 
Batch Claim


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-requests/{requestKey}/claims/{batchNumber}/{batchClaim}
Request samples 
Create or Update Batch FundingRequestClaim
Create or Update multiple FundingRequestClaim 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
requestKey
required
integer <int32> 
Request Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
batch_Number
required
integer <int32> 
Batch number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
batch_Claim
required
integer <int32> 
Claim number of the claim associated with the funding request. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
required
integer <int32> 
ID of the funding request. 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


 
funded
required
boolean
Indicates that the claim has been funded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
funded_Amount
number or null <double> 
Amount that was funded.


 
funded_Date
string or null <date-time> 
Date when the claim was funded.


 
request_Amount
number or null <double> 
Amount of 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/{requestKey}/claims-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}