/
User account value request

User account value request

This resource represents an adjustment to the user account value.

Operations

Add value to user account

Request to add values to a specific user account associated with specified AccountID

Requirements:  Account Admin or 'Loyalty Accounts' privilege

Raw Body must be provided with request details.  Response will be returned as User Account GET.

Request

Request body

Name

Type

Description

Notes

Name

Type

Description

Notes

TransType

int

Transaction type

Only accepted:

2 = Add Value
3 = Adjust Value

TransSubType

int

Transaction sub-type

Only accepted:

TransType

TransSubType

2 (Add Value)

2 = Cash To Employee

3 (Adjust Value)

0 = Admin adjustment
3 = Refund

 

Balance

Decimal

Balance to set or add

Do not include if not updating

Bonus

Decimal

Bonus to set or add

Do not include if not updating

LoyaltyPoints

int

Loyalty Points to set or add

Do not include if not updating

FreeStarts

int

Free Starts to set or add

Do not include if not updating

Cash

Decimal

Cash to employee

Only used for AddValue.CashToEmployee type

SetExactValue

bool

Flag whether to set values(true) or add to values(false)

Only used for AdjustValue.Admin type

LocationID

int

Location Rec ID of purchase location

Only used for AddValue.CashToEmployee

AdditionalInfo

string

Optional notes or description

 

Example requests

{ "TransType": 3, "TransSubType": 0, "LoyaltyPoints": 100, "FreeStarts": 2, "AdditionalInfo": "This is an admin adjustment via API" }
{ "TransType": 3, "TransSubType": 3, "Balance": 20, "AdditionalInfo": "This is a refund adjustment via API" }
{ "TransType": 2, "TransSubType": 2, "Cash": 10, "LocationID": 2 "AdditionalInfo": "This is a CashToEmployee add via API" }

POST /api/UserAccount/{accountID}/{userAccountID}