Premium Payments

Process Payment File Advanced API

Import a defined Payment File in .csv format to then have payments created and, optionally, attached to invoices.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payment_File_Format_Key
integer <int32>

Used in both Rate Copy and Rate Change

payment_File
string or null <byte>

This MUST be a .csv file with the following columns (Include Headers with field name): Payment_Type - Use a value from the PremPaymentType table (can be null) Payment_Batch - Source system indicator for the payment batch (can be null) Payment_Batch_Seq - Source system indicator for the payment batch sequence (can be null) Payment_Account - The name of the account that the payment is being made from - required Payment_ID - The unique identifier for the payment - required Payment_Date - The date the payment was made in YYYY-MM-DD format - required Payment_Amount - The amount of the payment - required Payment_Name - The name of the person or entity making the payment - required Group_ID - If this payment is for the entire group, this should be the Group_ID - can be null Division_ID - If this payment is for the entire division, this should be the Division_ID - can be null Subscriber_ID - If this payment is for a specific subscriber, this should be the Subscriber_ID - can be null Payor_ID - The Payor_ID to be set on the created payments - required Account_Key - The Account_Key to be set on the created payments - required Invoice_Key - If this payment is to be applied to a specific invoice, this should be the Invoice_Key - can be null PremRate_Key - If this payment is to be applied to a specific rate, this should be the PremRate_Key - can be null PremPayment_Key - If this payment is to be applied to a specific payment, this should be the PremPayment_Key - can be null

payor_ID
string or null

The Payor to be set on the created payments

account_Key
integer <int32>

The Account to be set on the created payments

create_Invoice_Payments
boolean

Indicates that payments should be created from the payment file

apply_Payments
boolean

Indicates that payments should be applied to invoices

close_Invoices
boolean

Indicates that invoices should be closed after payment is applied

only_Close_Satisfied_Invoices
boolean

Indicates that only fully satisfied invoices should be closed

user_ID
string or null

User ID performing the Payment File import

Responses
200

Success

401

Unauthorized

post/process-payment-file
Request samples
{
  • "payment_File_Format_Key": 0,
  • "payment_File": "string",
  • "payor_ID": "string",
  • "account_Key": 0,
  • "create_Invoice_Payments": true,
  • "apply_Payments": true,
  • "close_Invoices": true,
  • "only_Close_Satisfied_Invoices": true,
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Create PremPayment

Creates a new PremPayment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premPayment_Key
required
integer <int32>
account_Key
integer or null <int32>
division_ID
string or null <= 20 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
funding_Key
integer or null <int32>
group_ID
string or null <= 20 characters
payment_Amount
number or null <double>
payment_Date
string or null <date-time>
payment_ID
string or null <= 64 characters
payment_Name
string or null <= 256 characters
payment_Type
string or null <= 32 characters
payor_ID
string or null <= 20 characters
subscriber_ID
string or null <= 9 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-payments
Request samples
{
  • "premPayment_Key": 0,
  • "account_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Key": 0,
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "payment_Name": "string",
  • "payment_Type": "string",
  • "payor_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremPayment

Lists all PremPayment

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


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-payments/{premPaymentKey}
Request samples 
Response samples 
No sample
Update PremPayment
Updates a specific PremPayment.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premPayment_Key
required
integer <int32> 
 
account_Key
integer or null <int32> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
funding_Key
integer or null <int32> 
 
group_ID
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Date
string or null <date-time> 
 
payment_ID
string or null  <= 64 characters 
 
payment_Name
string or null  <= 256 characters 
 
payment_Type
string or null  <= 32 characters 
 
payor_ID
string or null  <= 20 characters 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-payments/{premPaymentKey}
Request samples 
{
  • "premPayment_Key": 0,
  • "account_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Key": 0,
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "payment_Name": "string",
  • "payment_Type": "string",
  • "payor_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremPayment
Deletes an PremPayment


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-payments/{premPaymentKey}
Request samples 
Create or Update Batch PremPayment
Create or Update multiple PremPayment 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 
premPayment_Key
required
integer <int32> 
 
account_Key
integer or null <int32> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
funding_Key
integer or null <int32> 
 
group_ID
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Date
string or null <date-time> 
 
payment_ID
string or null  <= 64 characters 
 
payment_Name
string or null  <= 256 characters 
 
payment_Type
string or null  <= 32 characters 
 
payor_ID
string or null  <= 20 characters 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/premium-payments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Premium for Payment Application Advanced API 
List Invoice Detail that can have premimum applied based on payment information and applied payment category.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
subscriberID
required
string
Subscriber ID


 
invoiceLevel
required
string
Invoice Level


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/list-apply-payment-category
Request samples 
Response samples 
No sample