Funding References

Create FundingReference

Creates a new FundingReference

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 request. Note: This field is marked as NOT NULL in the database and therefore required by the API.

funding_Key
required
integer <int32>

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

reference_Type
string or null <= 32 characters

Type of the funding reference.

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}/references
Request samples
{
  • "request_Key": 0,
  • "funding_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reference_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingReference

Lists all FundingReference 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}/references
Request samples 
Response samples 
No sample
Get FundingReference
Gets FundingReference


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


 
fundingKey
required
integer <int32> 
Funding Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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


 
fundingKey
required
integer <int32> 
Funding Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
request_Key
required
integer <int32> 
ID of the request. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
reference_Type
string or null  <= 32 characters 
Type of the funding reference.


 
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}/references/{fundingKey}
Request samples 
{
  • "request_Key": 0,
  • "funding_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reference_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingReference
Deletes an FundingReference


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


 
fundingKey
required
integer <int32> 
Funding Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-requests/{requestKey}/references/{fundingKey}
Request samples 
Create or Update Batch FundingReference
Create or Update multiple FundingReference 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 
request_Key
required
integer <int32> 
ID of the request. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
reference_Type
string or null  <= 32 characters 
Type of the funding reference.


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