PUT api/HealthPlanPurchase

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HealthPlanPurchaseId	integer	None.
PatientAccountId	integer	None.
PatientAccount	PatientAccount	None.
UnitsUsed	integer	None.
Units	integer	None.
AvailableUnits	integer	None.
UnitCost	decimal number	None.
UnitValue	decimal number	None.
UnitSubTotal	decimal number	None.
UnitActualValue	decimal number	None.
PharmacyUnits	integer	None.
PharmacyUnitCost	decimal number	None.
PharmacySubTotal	decimal number	None.
PharmacyActualValue	decimal number	None.
DmeUnits	integer	None.
DmeUnitCost	decimal number	None.
DmeSubTotal	decimal number	None.
DmeActualValue	decimal number	None.
PurchaseTotal	decimal number	None.
PurcahseDate	date	None.
FlexProfileId	string	None.
FlexPaymentTransactionId	string	None.
PayTypeId	integer	None.
UserAccountId	integer	None.
UserAccount	UserAccount	None.
PayType	PayType	None.

Request Formats

application/json, text/json

Sample:

{
  "healthPlanPurchaseId": 1,
  "patientAccountId": 2,
  "patientAccount": {
    "patientAccountId": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "gender": "sample string 4",
    "socialSecurity": "sample string 5",
    "birthDate": "2026-05-06T03:46:19.2741501+02:00",
    "address1": "sample string 7",
    "address2": "sample string 8",
    "country": "sample string 9",
    "city": "sample string 10",
    "province": "sample string 11",
    "postalCode": "sample string 12",
    "phoneNumber": "sample string 13",
    "emailAddress": "sample string 14",
    "isActive": true,
    "healthPlanUnits": 16,
    "healthPlanUnitsUsed": 17,
    "healthPlanUnitValue": 18.0,
    "healthPlanUnitsAvailable": 19,
    "pharmacyAmount": 20.0,
    "pharmacyUsed": 21.0,
    "dmeAmount": 22.0,
    "dmeUsed": 23.0,
    "driverCardBack": "QEA=",
    "azureDriverCardBack": "sample string 24",
    "driverCardBackMimeType": "sample string 25",
    "azureDriverCardBackUrl": "sample string 26",
    "driverCardFront": "QEA=",
    "azureDriverCardFront": "sample string 27",
    "driverCardFrontMimeType": "sample string 28",
    "azureDriverCardFrontUrl": "sample string 29",
    "photo": "QEA=",
    "azurePhoto": "sample string 30",
    "photoMimeType": "sample string 31",
    "azurePhotoUrl": "sample string 32",
    "hasDriverCardBack": true,
    "hasDriverCardFront": true,
    "decryptedSocialSecurity": "sample string 33"
  },
  "unitsUsed": 3,
  "units": 4,
  "availableUnits": 1,
  "unitCost": 1.0,
  "unitValue": 1.0,
  "unitSubTotal": 1.0,
  "unitActualValue": 1.0,
  "pharmacyUnits": 1,
  "pharmacyUnitCost": 1.0,
  "pharmacySubTotal": 1.0,
  "pharmacyActualValue": 1.0,
  "dmeUnits": 1,
  "dmeUnitCost": 1.0,
  "dmeSubTotal": 1.0,
  "dmeActualValue": 1.0,
  "purchaseTotal": 5.0,
  "purcahseDate": "2026-05-06T03:46:19.2801554+02:00",
  "flexProfileId": "sample string 7",
  "flexPaymentTransactionId": "sample string 8",
  "payTypeId": 1,
  "userAccountId": 1,
  "userAccount": {
    "userAccountId": 1,
    "physicianId": 1,
    "employeeId": 1,
    "systemRoleId": 2,
    "emailAddress": "sample string 3",
    "passkey": "sample string 4",
    "displayName": "sample string 5",
    "azureProfilePictureMime": "sample string 6",
    "azureProfilePictureFileName": "sample string 7",
    "azureProfilePictureUrl": "sample string 8",
    "forgotPasswordGuid": "1666cb1a-ada9-4315-a93e-791f1700a5fc",
    "validateAccountGuid": "093e4bbe-ab23-4b49-babd-29aaa3006baa",
    "createdOn": "2026-05-06T03:46:19.2751507+02:00",
    "accountVerifiedOn": "2026-05-06T03:46:19.2751507+02:00",
    "modifiedOn": "2026-05-06T03:46:19.2751507+02:00",
    "lastLoginDate": "2026-05-06T03:46:19.2751507+02:00",
    "isActive": true,
    "securityAnswer": "sample string 10",
    "securityQuestionId": 11,
    "azureSignatureMime": "sample string 12",
    "azureSignatureFilaName": "sample string 13",
    "azureSignatureFileUrl": "sample string 14",
    "securityQuestion": {
      "securityQuestionId": 1,
      "question": "sample string 2",
      "isActive": true
    },
    "systemRole": {
      "systemRoleId": 1,
      "name": "sample string 2"
    }
  },
  "payType": {
    "payTypeId": 1,
    "name": "sample string 2",
    "isVisibleToUser": true,
    "isActive": true,
    "isVisibleToHealthPlanPurchase": true
  }
}

text/html

Sample:

{"healthPlanPurchaseId":1,"patientAccountId":2,"patientAccount":{"patientAccountId":1,"firstName":"sample string 2","lastName":"sample string 3","gender":"sample string 4","socialSecurity":"sample string 5","birthDate":"2026-05-06T03:46:19.2741501+02:00","address1":"sample string 7","address2":"sample string 8","country":"sample string 9","city":"sample string 10","province":"sample string 11","postalCode":"sample string 12","phoneNumber":"sample string 13","emailAddress":"sample string 14","isActive":true,"healthPlanUnits":16,"healthPlanUnitsUsed":17,"healthPlanUnitValue":18.0,"healthPlanUnitsAvailable":19,"pharmacyAmount":20.0,"pharmacyUsed":21.0,"dmeAmount":22.0,"dmeUsed":23.0,"driverCardBack":"QEA=","azureDriverCardBack":"sample string 24","driverCardBackMimeType":"sample string 25","azureDriverCardBackUrl":"sample string 26","driverCardFront":"QEA=","azureDriverCardFront":"sample string 27","driverCardFrontMimeType":"sample string 28","azureDriverCardFrontUrl":"sample string 29","photo":"QEA=","azurePhoto":"sample string 30","photoMimeType":"sample string 31","azurePhotoUrl":"sample string 32","hasDriverCardBack":true,"hasDriverCardFront":true,"decryptedSocialSecurity":"sample string 33"},"unitsUsed":3,"units":4,"availableUnits":1,"unitCost":1.0,"unitValue":1.0,"unitSubTotal":1.0,"unitActualValue":1.0,"pharmacyUnits":1,"pharmacyUnitCost":1.0,"pharmacySubTotal":1.0,"pharmacyActualValue":1.0,"dmeUnits":1,"dmeUnitCost":1.0,"dmeSubTotal":1.0,"dmeActualValue":1.0,"purchaseTotal":5.0,"purcahseDate":"2026-05-06T03:46:19.2801554+02:00","flexProfileId":"sample string 7","flexPaymentTransactionId":"sample string 8","payTypeId":1,"userAccountId":1,"userAccount":{"userAccountId":1,"physicianId":1,"employeeId":1,"systemRoleId":2,"emailAddress":"sample string 3","passkey":"sample string 4","displayName":"sample string 5","azureProfilePictureMime":"sample string 6","azureProfilePictureFileName":"sample string 7","azureProfilePictureUrl":"sample string 8","forgotPasswordGuid":"1666cb1a-ada9-4315-a93e-791f1700a5fc","validateAccountGuid":"093e4bbe-ab23-4b49-babd-29aaa3006baa","createdOn":"2026-05-06T03:46:19.2751507+02:00","accountVerifiedOn":"2026-05-06T03:46:19.2751507+02:00","modifiedOn":"2026-05-06T03:46:19.2751507+02:00","lastLoginDate":"2026-05-06T03:46:19.2751507+02:00","isActive":true,"securityAnswer":"sample string 10","securityQuestionId":11,"azureSignatureMime":"sample string 12","azureSignatureFilaName":"sample string 13","azureSignatureFileUrl":"sample string 14","securityQuestion":{"securityQuestionId":1,"question":"sample string 2","isActive":true},"systemRole":{"systemRoleId":1,"name":"sample string 2"}},"payType":{"payTypeId":1,"name":"sample string 2","isVisibleToUser":true,"isActive":true,"isVisibleToHealthPlanPurchase":true}}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'UrgentCareExtra.Data.Models.AdjustmentCodeClinic' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'UrgentCareExtra.Data.Models.AdjustmentCodeClinic' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'HealthPlanPurchase'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.