Skip to content

Create SubscriberReimbursement

Request

Creates a new SubscriberReimbursement

Security
apiKeyAuth and bearerAuth
Path
groupIDstringrequired

Group ID

planIDstringrequired

Plan ID

benefitCodestringrequired

Benefit Code

maxIDstringrequired

Max ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
subscriberReimbursement_Keyinteger, (int32)required

Unique identifier for each remibursement configuration for this Group and Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Codestring, [ 1 .. 10 ] charactersrequired

References BenefitCodes.Benefit_Code value on parent record.

effective_Datestring or null, (date-time)

Effective date of this remibursement configuration.

entry_Datestring, (date-time)

User that first added the record to the system.

entry_Userstring or null, <= 20 characters

Date when the record was first added to the system.

group_IDstring, [ 1 .. 20 ] charactersrequired

References Groups.Group_ID value on parent record.

max_IDstring, [ 1 .. 10 ] charactersrequired

References PlanMaximum.Max_ID value on parent record.

plan_IDstring, [ 1 .. 20 ] charactersrequired

References Plans.Plan_ID value on parent record.

term_Datestring or null, (date-time)

Term Date of this reimbursement configuration.

update_Datestring, (date-time)

User that last updated the record in the system.

update_Userstring or null, <= 20 characters

Date when the record was last updated in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "subscriberReimbursement_Key": 0,
    "benefit_Code": "string",
    "effective_Date": "2019-08-24T14:15:22Z",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "group_ID": "string",
    "max_ID": "string",
    "plan_ID": "string",
    "term_Date": "2019-08-24T14:15:22Z",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

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