Skip to content

Create PremInvoiceSubscriberDetail

Request

Creates a new PremInvoiceSubscriberDetail

Security
apiKeyAuth and bearerAuth
Path
invoiceKeyinteger, (int32)required

Invoice Key

groupIDstringrequired

Group ID

divisionIDstringrequired

Division ID

subscriberIDstringrequired

Subscriber ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
invoice_Keyinteger, (int32)required
group_IDstring, [ 1 .. 20 ] charactersrequired
division_IDstring, [ 1 .. 20 ] charactersrequired
subscriber_IDstring, [ 1 .. 20 ] charactersrequired
premRate_Keyinteger, (int32)required
dist_Volumenumber or null, (double)
entry_Datestring, (date-time)
entry_Userstring or null, <= 20 characters
payee_IDstring or null, <= 20 characters
premiumnumber or null, (double)
premium_Receivednumber or null, (double)
premium_Waivedbooleanrequired
update_Datestring, (date-time)
update_Userstring or null, <= 20 characters
volumenumber or null, (double)
curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "invoice_Key": 0,
    "group_ID": "string",
    "division_ID": "string",
    "subscriber_ID": "string",
    "premRate_Key": 0,
    "dist_Volume": 0.1,
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "payee_ID": "string",
    "premium": 0.1,
    "premium_Received": 0.1,
    "premium_Waived": true,
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string",
    "volume": 0.1
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}