Skip to content

Create MemberPayment

Request

Creates a new MemberPayment

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

memberSeqstringrequired

Member Seq

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
memberPayment_Keyinteger, (int32)required

Unique Identifier for this payment for the member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_IDstring, [ 1 .. 20 ] charactersrequired

References Subenrollment.Division_ID value on the parent record.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

group_Coverage_Startstring, (date-time)required

References Subenrollment.Group_Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

group_IDstring, [ 1 .. 20 ] charactersrequired

References Subenrollment.Group_ID value on the parent record.

member_Seqstring, [ 1 .. 2 ] charactersrequired

References Members.Member_Seq value on the parent record.

payment_Amountnumber or null, (double)

Amount of the associated payment.

payment_Datestring or null, (date-time)

Date when the associated payment was processed.

payment_IDstring or null, <= 20 characters

Unique identifier assigned to the associated payment.

payment_Typestring or null, <= 32 characters

Identifies the type associated with the payment.

start_Datestring, (date-time)required

References Subenrollment.Start_Date value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References Members.Subscriber_ID value on the parent record.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/payments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "memberPayment_Key": 0,
    "division_ID": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "group_Coverage_Start": "2019-08-24T14:15:22Z",
    "group_ID": "string",
    "member_Seq": "st",
    "payment_Amount": 0.1,
    "payment_Date": "2019-08-24T14:15:22Z",
    "payment_ID": "string",
    "payment_Type": "string",
    "start_Date": "2019-08-24T14:15:22Z",
    "subscriber_ID": "string",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

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