Funding Request Claim Remove

Create FundingRequestClaimRemove

Creates a new FundingRequestClaimRemove

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>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

batch_Claim
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

request_Key
required
integer <int32>

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

remove_Date
string or null <date-time>
remove_Reason
string or null <= 256 characters
remove_User
string or null <= 20 characters
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-remove/{batchNumber}/{batchClaim}
Request samples
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "request_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "remove_Date": "2019-08-24T14:15:22Z",
  • "remove_Reason": "string",
  • "remove_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get FundingRequestClaimRemove

Gets FundingRequestClaimRemove

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-remove/{batchNumber}/{batchClaim}
Request samples 
Response samples 
No sample
Update FundingRequestClaimRemove
Updates a specific FundingRequestClaimRemove.


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


 
batch_Claim
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
required
integer <int32> 
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


 
remove_Date
string or null <date-time> 
 
remove_Reason
string or null  <= 256 characters 
 
remove_User
string or null  <= 20 characters 
 
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-remove/{batchNumber}/{batchClaim}
Request samples 
{
  • "batch_Number": 0,
  • "batch_Claim": 0,
  • "request_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "remove_Date": "2019-08-24T14:15:22Z",
  • "remove_Reason": "string",
  • "remove_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingRequestClaimRemove
Deletes an FundingRequestClaimRemove


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-remove/{batchNumber}/{batchClaim}
Request samples 
List FundingRequestClaimRemove
Lists all FundingRequestClaimRemove for the given requestKey


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


 
query Parameters
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.


 
page
integer <int32> 
 Default:  1
Page


 
pageSize
integer <int32> 
 Default:  100
Page Size


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-requests/{requestKey}/claims-remove
Request samples 
Response samples 
No sample
Create or Update Batch FundingRequestClaimRemove
Create or Update multiple FundingRequestClaimRemove 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> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
batch_Claim
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
required
integer <int32> 
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


 
remove_Date
string or null <date-time> 
 
remove_Reason
string or null  <= 256 characters 
 
remove_User
string or null  <= 20 characters 
 
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-remove-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}