Skip to content
/
PremInvoice Apply Payment...

PremInvoice Apply Payments by Subscriber and Payor ID

Request

PremInvoice Apply Payments by Subscriber and Payor ID

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
invoice_Keyinteger, (int32)required
subscriber_IDstring or null

Required for: ApplyPaymentSubscriber ApplyPaymentSubscriberPayorID ApplyPaymentSubscriberPlanType ApplyPaymentSelfAdmin Not used for: ApplyPaymentHeaderAdjustment

plan_Typestring or null

Required for: ApplyPaymentSubscriberPlanType Not used for: ApplyPaymentSubscriber ApplyPaymentSubscriberPayorID ApplyPaymentHeaderAdjustment

payor_IDstring or null

Required for: ApplyPaymentSubscriberPayorID Not used for: ApplyPaymentSubscriber ApplyPaymentSubscriberPlanType ApplyPaymentHeaderAdjustment

premPayment_Keyinteger, (int32)required
adjustment_Reasoninteger or null, (int32)

Required for: ApplyPaymentHeaderAdjustment Not used for: ApplyPaymentSubscriber ApplyPaymentSubscriberPayorID ApplyPaymentSubscriberPlanType

payment_Postednumber, (double)required
payment_Posted_Datestring, (date-time)required
user_IDstring, non-emptyrequired
premInvoiceSelfAdminsArray of objects or null

If using the ApplyPaymentSelfAdmin process, you pass in the PremInvoiceSelfAdmins to apply the payment to. For non-self-admin invoices leave this empty

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/premium-invoice-apply-payment-sub-payor_id \
  -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,
    "subscriber_ID": "string",
    "plan_Type": "string",
    "payor_ID": "string",
    "premPayment_Key": 0,
    "adjustment_Reason": 0,
    "payment_Posted": 0.1,
    "payment_Posted_Date": "2019-08-24T14:15:22Z",
    "user_ID": "string",
    "premInvoiceSelfAdmins": [
      {
        "premInvoiceSelfAdmin_Key": 0,
        "age": 0,
        "benefit_Code": "string",
        "dependents": 0,
        "dist_Volume": 0.1,
        "division_ID": "string",
        "entry_Date": "2019-08-24T14:15:22Z",
        "entry_User": "string",
        "groupSelfAdmin_Age": 0,
        "groupSelfAdmin_Dependents": 0,
        "groupSelfAdmin_Dist_Volume": 0.1,
        "groupSelfAdmin_Key": 0,
        "groupSelfAdmin_Members": 0,
        "groupSelfAdmin_Premium": 0.1,
        "groupSelfAdmin_Sex": "s",
        "groupSelfAdmin_Subscribers": 0,
        "groupSelfAdmin_Volume": 0.1,
        "group_ID": "string",
        "invoice_Key": 0,
        "members": 0,
        "plan_ID": "string",
        "premRate_Key": 0,
        "premium": 0.1,
        "premium_Received": 0.1,
        "sex": "s",
        "subscribers": 0,
        "update_Date": "2019-08-24T14:15:22Z",
        "update_User": "string",
        "volume": 0.1
      }
    ]
  }'

Responses

Accepted for processing