Subscriber Premium Rate Splits

Create SubscriberPremRateSplit

Creates a new SubscriberPremRateSplit

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberPremRateSplit_Key
required
integer <int32>

Unqiue identiferi for each Premium Rate split configured for this subscriber. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amount
required
number <double>

Specifies the amount of the rate split. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amount_Pct
required
boolean

Identifies that the rate split is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
required
string <date-time>

Date when the associated rate split becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

invoice_Level
required
string = 1 characters

Identifies at which level the rate split will be invoiced.

premRate_Key
required
integer <int32>

References PremRate.PremRate_Key value on the referenced record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

split_Rule
string or null <= 16 characters

Identifies the rule, or how, the the rate split will be applied.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Subscribers.Subscriber_ID value on the parent record.

term_Date
string or null <date-time>

Date when the associated rate split expires/expired.

update_Date
string <date-time>

Date when 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/subscribers/{subscriberID}/premium-rate-splits
Request samples
{
  • "subscriberPremRateSplit_Key": 0,
  • "amount": 0.1,
  • "amount_Pct": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Level": "s",
  • "premRate_Key": 0,
  • "split_Rule": "string",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberPremRateSplit

Lists all SubscriberPremRateSplit for the given subscriberID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

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/subscribers/{subscriberID}/premium-rate-splits
Request samples 
Response samples 
No sample
Create or Update Batch SubscriberPremRateSplit
Create or Update multiple SubscriberPremRateSplit at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriberPremRateSplit_Key
required
integer <int32> 
Unqiue identiferi for each Premium Rate split configured for this subscriber. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
amount
required
number <double> 
Specifies the amount of the rate split. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
amount_Pct
required
boolean
Identifies that the rate split is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date when the associated rate split becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
invoice_Level
required
string  = 1 characters 
Identifies at which level the rate split will be invoiced.


 
premRate_Key
required
integer <int32> 
References PremRate.PremRate_Key value on the referenced record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
split_Rule
string or null  <= 16 characters 
Identifies the rule, or how, the the rate split will be applied.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
term_Date
string or null <date-time> 
Date when the associated rate split expires/expired.


 
update_Date
string <date-time> 
Date when 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/subscribers/{subscriberID}/premium-rate-splits-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get SubscriberPremRateSplit
Gets SubscriberPremRateSplit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subscriberPremRateSplitKey
required
integer <int32> 
SubscriberPremRateSplit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/premium-rate-splits/{subscriberPremRateSplitKey}
Request samples 
Response samples 
No sample
Update SubscriberPremRateSplit
Updates a specific SubscriberPremRateSplit.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subscriberPremRateSplitKey
required
integer <int32> 
SubscriberPremRateSplit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberPremRateSplit_Key
required
integer <int32> 
Unqiue identiferi for each Premium Rate split configured for this subscriber. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
amount
required
number <double> 
Specifies the amount of the rate split. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
amount_Pct
required
boolean
Identifies that the rate split is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date when the associated rate split becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
invoice_Level
required
string  = 1 characters 
Identifies at which level the rate split will be invoiced.


 
premRate_Key
required
integer <int32> 
References PremRate.PremRate_Key value on the referenced record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
split_Rule
string or null  <= 16 characters 
Identifies the rule, or how, the the rate split will be applied.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
term_Date
string or null <date-time> 
Date when the associated rate split expires/expired.


 
update_Date
string <date-time> 
Date when 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/subscribers/{subscriberID}/premium-rate-splits/{subscriberPremRateSplitKey}
Request samples 
{
  • "subscriberPremRateSplit_Key": 0,
  • "amount": 0.1,
  • "amount_Pct": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Level": "s",
  • "premRate_Key": 0,
  • "split_Rule": "string",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberPremRateSplit
Deletes an SubscriberPremRateSplit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subscriberPremRateSplitKey
required
integer <int32> 
SubscriberPremRateSplit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/premium-rate-splits/{subscriberPremRateSplitKey}
Request samples