POST api/customer/{id}/adjustBalance
Adjust customer card value, to return available spending $ after void
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
card identifier |
string |
Required |
Body Parameters
CardAdjustment object
CardAdjustmentName | Description | Type | Additional information |
---|---|---|---|
Amount |
Loyalty points to reverse in a void (used as provided) |
integer |
None. |
SaleIdentifier |
Sale Identifier of the referenced sale, where there is one |
string |
None. |
IdempotentID |
The byte[16] representation of the idempotent id |
Collection of byte |
None. |
IdempotentGuid |
Idempotent identifier |
globally unique identifier |
None. |
Offline |
Whether action is offline or not (offline as per POS), defaults to true |
boolean |
None. |
Description |
Description of reason for adjustment, only used in audit logs |
string |
Deprecated. |
Reason |
Manual or Automatic adjustment, 0 for automatic (eg. pos-system), 1 for manual (eg. staff adjust) 2 for expired |
LoyaltyPointsReason |
None. |
Request Formats
application/json, text/json
Sample:
{ "amount": 1, "saleIdentifier": "sample string 2", "idempotentID": "j/U+kitpzUuHLFdyMOZpug==", "idempotentGuid": "923ef58f-692b-4bcd-872c-577230e669ba", "offline": true, "description": "sample string 4", "reason": 1 }
application/xml, text/xml
Sample:
<CardAdjustment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Customers"> <Amount>1</Amount> <Description>sample string 4</Description> <IdempotentGuid>923ef58f-692b-4bcd-872c-577230e669ba</IdempotentGuid> <IdempotentID>j/U+kitpzUuHLFdyMOZpug==</IdempotentID> <Offline>true</Offline> <Reason>1</Reason> <SaleIdentifier>sample string 2</SaleIdentifier> </CardAdjustment>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Boolean value indicating success
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK &