Billing Cycles

Create BillingCycle

Creates a new BillingCycle

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
billing_Cycle_ID
required
string [ 1 .. 2 ] characters

Unique identifier for the Billing Cycle

cycle_Factor
number or null <double>

Cycle Factor is a multiplier applied to the rate

cycle_Frequency
integer or null <int32>

Cycle Frequency is the number of times the date type occurs

cycle_Type
string or null <= 2 characters

Cycle Type is the date type of the Billing Cycle

description
string or null <= 30 characters

Description of the Billing Cycle

discount_Pct
number or null <double>

No longer in use.

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

individual_Billing
required
boolean

Individual Billing identifies the Billing Cycle for Subscriber level invoices Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

months
integer or null <int32>

Months on invoices with this Billing Cycle

times_Per_Year
integer or null <int32>

No longer in use.

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/billing-cycles
Request samples
{
  • "billing_Cycle_ID": "st",
  • "cycle_Factor": 0.1,
  • "cycle_Frequency": 0,
  • "cycle_Type": "st",
  • "description": "string",
  • "discount_Pct": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "individual_Billing": true,
  • "months": 0,
  • "times_Per_Year": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List BillingCycle

Lists all BillingCycle

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/billing-cycles
Request samples 
Response samples 
No sample
Get BillingCycle
Gets BillingCycle


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
billingCycleID
required
string
Billing Cycle ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/billing-cycles/{billingCycleID}
Request samples 
Response samples 
No sample
Update BillingCycle
Updates a specific BillingCycle.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
billingCycleID
required
string
Billing Cycle ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
billing_Cycle_ID
required
string  [ 1 .. 2 ] characters 
Unique identifier for the Billing Cycle


 
cycle_Factor
number or null <double> 
Cycle Factor is a multiplier applied to the rate


 
cycle_Frequency
integer or null <int32> 
Cycle Frequency is the number of times the date type occurs


 
cycle_Type
string or null  <= 2 characters 
Cycle Type is the date type of the Billing Cycle


 
description
string or null  <= 30 characters 
Description of the Billing Cycle


 
discount_Pct
number or null <double> 
No longer in use.


 
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


 
individual_Billing
required
boolean
Individual Billing identifies the Billing Cycle for Subscriber level invoices  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
months
integer or null <int32> 
Months on invoices with this Billing Cycle


 
times_Per_Year
integer or null <int32> 
No longer in use.


 
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/billing-cycles/{billingCycleID}
Request samples 
{
  • "billing_Cycle_ID": "st",
  • "cycle_Factor": 0.1,
  • "cycle_Frequency": 0,
  • "cycle_Type": "st",
  • "description": "string",
  • "discount_Pct": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "individual_Billing": true,
  • "months": 0,
  • "times_Per_Year": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete BillingCycle
Deletes an BillingCycle


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
billingCycleID
required
string
Billing Cycle ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/billing-cycles/{billingCycleID}
Request samples 
Create or Update Batch BillingCycle
Create or Update multiple BillingCycle 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 
billing_Cycle_ID
required
string  [ 1 .. 2 ] characters 
Unique identifier for the Billing Cycle


 
cycle_Factor
number or null <double> 
Cycle Factor is a multiplier applied to the rate


 
cycle_Frequency
integer or null <int32> 
Cycle Frequency is the number of times the date type occurs


 
cycle_Type
string or null  <= 2 characters 
Cycle Type is the date type of the Billing Cycle


 
description
string or null  <= 30 characters 
Description of the Billing Cycle


 
discount_Pct
number or null <double> 
No longer in use.


 
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


 
individual_Billing
required
boolean
Individual Billing identifies the Billing Cycle for Subscriber level invoices  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
months
integer or null <int32> 
Months on invoices with this Billing Cycle


 
times_Per_Year
integer or null <int32> 
No longer in use.


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