Flex Claim Services

Create ClaimFlexService

Creates a new ClaimFlexService

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

ClaimFlex Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimFlexService_Key
required
integer <int32>
amount
number or null <double>
claimFlex_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
ex_Code
string or null <= 6 characters
flex_Description
string or null <= 128 characters
mcc
string or null <= 4 characters
matching_Transaction_ID
string or null <= 10 characters
merchant_Name
string or null <= 50 characters
payment_Reference
string or null <= 25 characters
place_Of_Service
string or null <= 4 characters
procedure_Code
string or null <= 8 characters
service_Date
string or null <date-time>
service_Thru
string or null <date-time>
transaction_Code
string or null <= 8 characters
transaction_Source
string or null <= 4 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/flex-claims/{claimFlexKey}/services
Request samples
{
  • "claimFlexService_Key": 0,
  • "amount": 0.1,
  • "claimFlex_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "flex_Description": "string",
  • "mcc": "stri",
  • "matching_Transaction_ID": "string",
  • "merchant_Name": "string",
  • "payment_Reference": "string",
  • "place_Of_Service": "stri",
  • "procedure_Code": "string",
  • "service_Date": "2019-08-24T14:15:22Z",
  • "service_Thru": "2019-08-24T14:15:22Z",
  • "transaction_Code": "string",
  • "transaction_Source": "stri",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimFlexService

Lists all ClaimFlexService for the given claimFlexKey

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

ClaimFlex 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/flex-claims/{claimFlexKey}/services
Request samples 
Response samples 
No sample
Get ClaimFlexService
Gets ClaimFlexService


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


 
claimFlexServiceKey
required
integer <int32> 
ClaimFlexService Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/flex-claims/{claimFlexKey}/services/{claimFlexServiceKey}
Request samples 
Response samples 
No sample
Update ClaimFlexService
Updates a specific ClaimFlexService.


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


 
claimFlexServiceKey
required
integer <int32> 
ClaimFlexService Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimFlexService_Key
required
integer <int32> 
 
amount
number or null <double> 
 
claimFlex_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
ex_Code
string or null  <= 6 characters 
 
flex_Description
string or null  <= 128 characters 
 
mcc
string or null  <= 4 characters 
 
matching_Transaction_ID
string or null  <= 10 characters 
 
merchant_Name
string or null  <= 50 characters 
 
payment_Reference
string or null  <= 25 characters 
 
place_Of_Service
string or null  <= 4 characters 
 
procedure_Code
string or null  <= 8 characters 
 
service_Date
string or null <date-time> 
 
service_Thru
string or null <date-time> 
 
transaction_Code
string or null  <= 8 characters 
 
transaction_Source
string or null  <= 4 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/flex-claims/{claimFlexKey}/services/{claimFlexServiceKey}
Request samples 
{
  • "claimFlexService_Key": 0,
  • "amount": 0.1,
  • "claimFlex_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "flex_Description": "string",
  • "mcc": "stri",
  • "matching_Transaction_ID": "string",
  • "merchant_Name": "string",
  • "payment_Reference": "string",
  • "place_Of_Service": "stri",
  • "procedure_Code": "string",
  • "service_Date": "2019-08-24T14:15:22Z",
  • "service_Thru": "2019-08-24T14:15:22Z",
  • "transaction_Code": "string",
  • "transaction_Source": "stri",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimFlexService
Deletes an ClaimFlexService


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


 
claimFlexServiceKey
required
integer <int32> 
ClaimFlexService Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/flex-claims/{claimFlexKey}/services/{claimFlexServiceKey}
Request samples 
Create or Update Batch ClaimFlexService
Create or Update multiple ClaimFlexService 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
claimFlexKey
required
integer <int32> 
ClaimFlex Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
claimFlexService_Key
required
integer <int32> 
 
amount
number or null <double> 
 
claimFlex_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
ex_Code
string or null  <= 6 characters 
 
flex_Description
string or null  <= 128 characters 
 
mcc
string or null  <= 4 characters 
 
matching_Transaction_ID
string or null  <= 10 characters 
 
merchant_Name
string or null  <= 50 characters 
 
payment_Reference
string or null  <= 25 characters 
 
place_Of_Service
string or null  <= 4 characters 
 
procedure_Code
string or null  <= 8 characters 
 
service_Date
string or null <date-time> 
 
service_Thru
string or null <date-time> 
 
transaction_Code
string or null  <= 8 characters 
 
transaction_Source
string or null  <= 4 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/flex-claims/{claimFlexKey}/services-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}