post
https://sandbox-api.helix.q2.com/account/removeEntitlement
Remove a customer's access to a business account.
WarningUse of this endpoint requires approval from Q2 and your bank of record.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 60001 | {customerType} {customerId} is invalid. | |
| 60002 | {customerType} {customerId} is inactive. | |
| 60003 | {customerType} {customerId} is not in a {statusDescription} status. | |
| 60004 | {customerType} {customerId} is locked. | |
| 60005 | {customerType} {customerId} is marked as deceased. | |
| 195100 | requestingCustomerId '0' has insufficient entitlement on accountId | |
| 195101 | Program is not authorized to use this endpoint. Please contact your relationship manager for details. | |
| 195102 | accountId '0' must be a business account | |
| 195103 | accountId '0' is currently in '1' status and entitlements cannot be removed. Please refer to API documentation. | |
| 195104 | accountId '0' is currently locked and entitlements cannot be removed. | |
| 195105 | requestingCustomerId is required | |
| 195106 | accountId is required | |
| 195107 | targetCustomerId is required | |
| 195109 | Invalid accountId | |
| 195112 | {customerIdDescription} '{customerId}' is invalid. | |
| 195113 | {customerIdDescription} '{customerId}' is inactive. | |
| 195115 | {customerIdDescription} '{customerId}' is marked as deceased. | |
| 195116 | {customerIdDescription} '{customerId}' is not in verified status. | |
| 195117 | {customerIdDescription} '{customerId}' must have an active customer relationship to the business customer who owns the account. | |
| 195119 | targetCustomerId '{targetCustomerId}' does not have an existing entitlement to accountId '{accountId}' | |
| 195122 | targetCustomerId '{targetCustomerId}' can not be the business customer. |