Billing

Billing Refund Advanced API

Generate the necessary Billing adjustments for an Invoice refund and create a Distribution if needed.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
invoice_Key
integer or null <int32>
group_ID
string or null
division_ID
string or null
subscriber_ID
string or null
premRate_Key
integer or null <int32>
amount
number or null <double>
amount_Received
number or null <double>
volume
number or null <double>
payee_Level
string or null
payor_ID
string or null
account_Key
integer or null <int32>
premPayment_Key
integer or null <int32>
refund_Amount
number or null <double>
payment_ID
string or null
payment_Name
string or null
invoice_Level
string or null
user_ID
string or null
Responses
202

Accepted for processing

401

Unauthorized

post/billing-refund
Request samples
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "premRate_Key": 0,
  • "amount": 0.1,
  • "amount_Received": 0.1,
  • "volume": 0.1,
  • "payee_Level": "string",
  • "payor_ID": "string",
  • "account_Key": 0,
  • "premPayment_Key": 0,
  • "refund_Amount": 0.1,
  • "payment_ID": "string",
  • "payment_Name": "string",
  • "invoice_Level": "string",
  • "user_ID": "string"
}

Billing Auto-Apply Advanced API

Auto Apply Payment based on specified configuration options.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
invoice_Key
integer <int32>
premPayment_Key
integer <int32>
payment_Posted
number or null <double>
payment_Posted_Date
string or null <date-time>
payment_ID
string or null
received_Date
string <date-time>
autoApplyOption
integer <int32>
autoApplyAdjustmentOption
integer <int32>
autoApplyCategories
Array of strings or null
autoApplySubscribers
Array of strings or null
Responses
202

Accepted for processing

401

Unauthorized

post/billing-auto-apply
Request samples
{
  • "invoice_Key": 0,
  • "premPayment_Key": 0,
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "autoApplyOption": 0,
  • "autoApplyAdjustmentOption": 0,
  • "autoApplyCategories": [
    ],
  • "autoApplySubscribers": [
    ]
}

Billing Apply Payment Category Advanced API

Using the ListPremApplyPaymentCategory Operation to get a list of payments and additional configuration, have On Accout and PremPayment information updated.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
file_Type
string or null
posted_Date
string <date-time>
received_Date
string <date-time>
posted_Amount
number <double>
user_ID
string or null
write_Off_When_In_Tolerance_Range
boolean
object (PremPayment)
Array of objects or null (PremApplyPaymentCategoryResult)
Responses
202

Accepted for processing

401

Unauthorized

post/billing-apply-payment-category
Request samples
{
  • "file_Type": "string",
  • "posted_Date": "2019-08-24T14:15:22Z",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "posted_Amount": 0.1,
  • "user_ID": "string",
  • "write_Off_When_In_Tolerance_Range": true,
  • "payment": {
    },
  • "applyPayments": [
    ]
}