Claim Payments

Create ClaimPayment

Creates a new ClaimPayment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimPayment_Key
required
integer <int32>

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

account_Key
integer or null <int32>

Account of the Payment

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_Key
integer or null <int32>

Funding record of the Payment

payment_Amount
number or null <double>

Amount of the Payment

payment_Date
string or null <date-time>

Date of the Payment

payment_Name
string or null <= 256 characters

Name of the Payment

payment_Type
string or null <= 32 characters

Type of the Payment

payor_ID
string or null <= 20 characters

Unique identifier for the Payor

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/claim-payments
Request samples
{
  • "claimPayment_Key": 0,
  • "account_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Key": 0,
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_Name": "string",
  • "payment_Type": "string",
  • "payor_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimPayment

Lists all ClaimPayment

SecurityapiKeyAuth and bearerAuth
Request
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/claim-payments
Request samples 
Response samples 
No sample
Get ClaimPayment
Gets ClaimPayment


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-payments/{claimPaymentKey}
Request samples 
Response samples 
No sample
Update ClaimPayment
Updates a specific ClaimPayment.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimPayment_Key
required
integer <int32> 
Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account of the Payment


 
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_Key
integer or null <int32> 
Funding record of the Payment


 
payment_Amount
number or null <double> 
Amount of the Payment


 
payment_Date
string or null <date-time> 
Date of the Payment


 
payment_Name
string or null  <= 256 characters 
Name of the Payment


 
payment_Type
string or null  <= 32 characters 
Type of the Payment


 
payor_ID
string or null  <= 20 characters 
Unique identifier for the Payor


 
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/claim-payments/{claimPaymentKey}
Request samples 
{
  • "claimPayment_Key": 0,
  • "account_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Key": 0,
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_Name": "string",
  • "payment_Type": "string",
  • "payor_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimPayment
Deletes an ClaimPayment


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-payments/{claimPaymentKey}
Request samples 
Create or Update Batch ClaimPayment
Create or Update multiple ClaimPayment 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 
claimPayment_Key
required
integer <int32> 
Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account of the Payment


 
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_Key
integer or null <int32> 
Funding record of the Payment


 
payment_Amount
number or null <double> 
Amount of the Payment


 
payment_Date
string or null <date-time> 
Date of the Payment


 
payment_Name
string or null  <= 256 characters 
Name of the Payment


 
payment_Type
string or null  <= 32 characters 
Type of the Payment


 
payor_ID
string or null  <= 20 characters 
Unique identifier for the Payor


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