Premium Invoice Adjustments

Create PremInvoiceAdjustment

Creates a new PremInvoiceAdjustment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
invoiceAdjustment_Key
required
integer <int32>
adjustment_Amount
number or null <double>
adjustment_Comment
string or null <= 512 characters
adjustment_PremRate_Key
integer or null <int32>
adjustment_Reason
integer or null <int32>
adjustment_Received
number or null <double>
auto_Adjust
required
boolean
avoid_Retro
required
boolean
division_ID
string or null <= 20 characters
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
group_ID
string or null <= 20 characters
invoice_Key
integer or null <int32>
min_Max_Adjust
required
boolean
negative_Adjustment
required
boolean
premRate_Key
integer or null <int32>
retro_Adjustment_Invoice_Key
integer or null <int32>
selfAdmin_Adj
required
boolean
subscriber_ID
string or null <= 9 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
use_Premium
required
boolean
volume
number or null <double>
Responses
200

Success

401

Unauthorized

post/premium-invoice-adjustments
Request samples
{
  • "invoiceAdjustment_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Comment": "string",
  • "adjustment_PremRate_Key": 0,
  • "adjustment_Reason": 0,
  • "adjustment_Received": 0.1,
  • "auto_Adjust": true,
  • "avoid_Retro": true,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "invoice_Key": 0,
  • "min_Max_Adjust": true,
  • "negative_Adjustment": true,
  • "premRate_Key": 0,
  • "retro_Adjustment_Invoice_Key": 0,
  • "selfAdmin_Adj": true,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Premium": true,
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremInvoiceAdjustment

Lists all PremInvoiceAdjustment. Provide invoiceKey query parameter to filter by invoice. Omit the invoiceKey query parameter to filter by unassigned.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
invoiceKey
integer <int32>

Invoice Key

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-invoice-adjustments
Request samples 
Response samples 
No sample
Get PremInvoiceAdjustment
Gets PremInvoiceAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceAdjustmentKey
required
integer <int32> 
InvoiceAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoice-adjustments/{invoiceAdjustmentKey}
Request samples 
Response samples 
No sample
Update PremInvoiceAdjustment
Updates a specific PremInvoiceAdjustment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceAdjustmentKey
required
integer <int32> 
InvoiceAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoiceAdjustment_Key
required
integer <int32> 
 
adjustment_Amount
number or null <double> 
 
adjustment_Comment
string or null  <= 512 characters 
 
adjustment_PremRate_Key
integer or null <int32> 
 
adjustment_Reason
integer or null <int32> 
 
adjustment_Received
number or null <double> 
 
auto_Adjust
required
boolean
 
avoid_Retro
required
boolean
 
division_ID
string or null  <= 20 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
string or null  <= 20 characters 
 
invoice_Key
integer or null <int32> 
 
min_Max_Adjust
required
boolean
 
negative_Adjustment
required
boolean
 
premRate_Key
integer or null <int32> 
 
retro_Adjustment_Invoice_Key
integer or null <int32> 
 
selfAdmin_Adj
required
boolean
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
use_Premium
required
boolean
 
volume
number or null <double> 
 
Responses 
200
Success


401
Unauthorized


put/premium-invoice-adjustments/{invoiceAdjustmentKey}
Request samples 
{
  • "invoiceAdjustment_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Comment": "string",
  • "adjustment_PremRate_Key": 0,
  • "adjustment_Reason": 0,
  • "adjustment_Received": 0.1,
  • "auto_Adjust": true,
  • "avoid_Retro": true,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "invoice_Key": 0,
  • "min_Max_Adjust": true,
  • "negative_Adjustment": true,
  • "premRate_Key": 0,
  • "retro_Adjustment_Invoice_Key": 0,
  • "selfAdmin_Adj": true,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Premium": true,
  • "volume": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremInvoiceAdjustment
Deletes an PremInvoiceAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceAdjustmentKey
required
integer <int32> 
InvoiceAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-invoice-adjustments/{invoiceAdjustmentKey}
Request samples 
Create or Update Batch PremInvoiceAdjustment
Create or Update multiple PremInvoiceAdjustment 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 
invoiceAdjustment_Key
required
integer <int32> 
 
adjustment_Amount
number or null <double> 
 
adjustment_Comment
string or null  <= 512 characters 
 
adjustment_PremRate_Key
integer or null <int32> 
 
adjustment_Reason
integer or null <int32> 
 
adjustment_Received
number or null <double> 
 
auto_Adjust
required
boolean
 
avoid_Retro
required
boolean
 
division_ID
string or null  <= 20 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
string or null  <= 20 characters 
 
invoice_Key
integer or null <int32> 
 
min_Max_Adjust
required
boolean
 
negative_Adjustment
required
boolean
 
premRate_Key
integer or null <int32> 
 
retro_Adjustment_Invoice_Key
integer or null <int32> 
 
selfAdmin_Adj
required
boolean
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
use_Premium
required
boolean
 
volume
number or null <double> 
 
Responses 
207
Success


401
Unauthorized


put/premium-invoice-adjustments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}