Account
This resource represents FasCard system accounts.
Operations
Get account
Returns a list of FasCard system accounts.
Request
Query Parameters
The name of the mobile app. Account Info for current user limited to specific Mobile App.
CAUTION: Using the MobileApp parameter will automatically create any missing SysConfigs tied to that MobileApp that are not already associated with current user. So this call should be done so with discretion and recommended to only be used within app.
Response
[
{
"ID": 364,
"Name": "My Laundromat",
"AccountNum": "F9998",
"Employee": null,
"Scheduled": null,
"AcceptAddValueCredit": true,
"AcceptAddValueMobile": true,
"AcceptApplePay": false,
"AcceptAndroidPay": false,
"AllowMobileMachineStart": true,
"Balance": null,
"Bonus": null,
"LoyaltyPoints": null,
"LoyaltyPointsTarget": 300,
"LoyaltyPointsAward": 3.0,
"FreeStarts": null,
"Discount": null,
"DiscountSource": null,
"LastActivityDate": null,
"LastLocationID": null,
"UserID": 9,
"UserAccountID": null,
"Surcharge": 0.1,
"SurchargeMode": 3,
"AllowNotifyMachAvail": false,
"MobileApp": null,
"ReportPrivs": null
},
{
"ID": 363,
"Name": "Laundry Wash",
"AccountNum": "F9999",
"Employee": null,
"Scheduled": null,
"AcceptAddValueCredit": true,
"AcceptAddValueMobile": true,
"AcceptApplePay": false,
"AcceptAndroidPay": false,
"AllowMobileMachineStart": true,
"Balance": null,
"Bonus": null,
"LoyaltyPoints": null,
"LoyaltyPointsTarget": 300,
"LoyaltyPointsAward": 3.0,
"FreeStarts": null,
"Discount": null,
"DiscountSource": null,
"LastActivityDate": null,
"LastLocationID": null,
"UserID": 9,
"UserAccountID": null,
"Surcharge": 0.0,
"SurchargeMode": 0,
"AllowNotifyMachAvail": false,
"MobileApp": null,
"ReportPrivs": null
}
]Field Name | Type | Description | Notes |
|---|---|---|---|
| int | Account ID |
|
| string | Account name |
|
| string | Account number |
|
| bool | User is an employee |
|
| bool | User is a scheduled employee |
|
| bool | Add-value by credit allowed |
|
| bool | Apple Pay accepted |
|
| bool | Android Pay accepted |
|
| bool | Allow mobile start of machine |
|
| Decimal | Account balance ($) |
|
| Decimal | Account bonus ($) |
|
| int | Loyalty points | May be NULL if n/a |
| int | Loyalty points target | May be NULL if Loyalty Points feature not active |
| Decimal | Loyalty points award | May be NULL if Loyalty Points feature not active |
| int | Free start credits | May be NULL if n/a |
| float | User discount | May be NULL if n/a |
| string | User discount source |
|
| DateTime | Date/time of last activity (UTC) |
|
| int | Location Rec ID of last activity |
|
| int | User Rec ID |
|
| int | UserAccount Rec ID |
|
| float | Location surcharge | May be NULL if n/a |
| int | Location surcharge mode | May be NULL if n/a BitMask field (can combine multiple options e.g. 3 = Vend + AddValue) 0 = None |
| bool | Allow push notifications for machine availability |
|
| Mobile App Data | Mobile App Data | Field Name: Name Type: string Description: Name of MobileApp Notes: |
| string | Report privileges | Only applicable for Employee account Represented as string containing 0's or 1's with each character correlated with specific report on 1-based index 1 = All reports (overrides individual privs) |
| int | UserAccount privileges | Only applicable for Employee account BitMask field of access privileges |