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 operations.

payment_File
string or null <byte>

A .csv file with headers and the following columns:

  • Payment_Type: Value from the PremPaymentType table (optional)
  • Payment_Batch: Source system batch indicator (optional)
  • Payment_Batch_Seq: Source system batch sequence (optional)
  • Payment_Account: Name of the paying account (required)
  • Payment_ID: Unique identifier for the payment (required)
  • Payment_Date: Date of payment in YYYY-MM-DD format (required)
  • Payment_Amount: Amount of the payment (required)
  • Payment_Name: Name of the payer (required)
  • Group_ID: Group identifier if applicable (optional)
  • Division_ID: Division identifier if applicable (optional)
  • Subscriber_ID: Subscriber identifier if applicable (optional)
  • Payor_ID: Payor ID for created payments (required)
  • Account_Key: Account key for created payments (required)
  • Invoice_Key: Invoice key to apply the payment to (optional)
  • PremRate_Key: Rate key to apply the payment to (optional)
  • PremPayment_Key: Existing payment key to apply the payment to (optional)
payor_ID
string or null

The Payor ID to assign to the created payments.

account_Key
integer <int32>

The Account Key to be assign to the created payments.

create_Invoice_Payments
boolean

Set to true to create invoice payments from the file.

apply_Payments
boolean

Set to true to apply payments to matching invoices.

close_Invoices
boolean

Set to true to close invoices after payment is applied.

only_Close_Satisfied_Invoices
boolean

If true, only fully satisfied invoices will be closed.

user_ID
string or null

ID of the user 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": {
    }
}

Process or Check Invoice Tolerance Advanced API

Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.

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

Invoice Key

query Parameters
amountDue
required
number <double>

Amount Due

verifyOnly
required
boolean

Verify Only

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

post/process-invoice-tolerance/{invoiceKey}
Request samples 
Response samples 
No sample
Undo an Applied Premium Payment Advanced API 
Based on the supplied PremPayment_Key, remove this payment from any invoice it is attached, and then recalc the received on each affected invoice.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/undo-premium-payment/{premPaymentKey}
Request samples 
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