post https://sandbox-api.helix.q2.com/customerRelationship/archive
Archive a customer relationship. Note: if primaryCustomerId
is a business customer then relatedCustomerId
will lose all access/entitlements to primaryCustomerId
's accounts
Use of this endpoint requires approval from Q2 and your bank partner.
Error Codes
Click to expand
Code | Message (en-US) | Notes |
---|---|---|
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
60001 | Customer id {0} is invalid. | |
60002 | Customer id {0} is inactive. | |
60003 | Customer id {0} is not in {1} status. | |
60004 | Customer id {0} is locked. | |
60005 | Customer id {0} is marked as deceased. | |
61400 | Program is not authorized to use this endpoint. Please contact your relationship manager for details. | |
156401 | Invalid relationship to edit. Relationship between PrimaryCustomerId {0} and RelatedCustomerId {1} doesn''t exist. | |
156402 | Can not set a Primary Contact to a record being deactivated | |
156403 | Can not set a Control Person to a record being deactivated | |
156404 | Can not deactivate a current Primary Contact. Create or Update another record as replacement first | |
156405 | Can not deactivate a current Control Person. Create or Update another record as replacement first | |
156406 | Can not disable a Primary Contact directly. Create or Update another record as replacement first | |
156407 | Can not disable a Control Person. Create or Update another record as replacement first |