getUserRights

Returns a list of users, along with their access rights. See the saveUser for user adding or editing.

Input parameters

Parameter name Description Possible value Required
userID  Optional user ID to retrive one specific user data. Either userID or getCurrentUser can be set, but not both at the same time.  Integer    
getCurrentUser  Set to 1 to get the rights of the current user.  Integer(0 or 1)    

Response

Field name Type Description
userID  Integer    
userName  String    
groupID  Integer  ID of the user group where the user belongs  
maxDiscount  Integer  Max. allowed sales discount  
cardCode  String  Deprecated. This field is always empty.  
rightGiveCustomerCredit  Integer  Right to set customers' credit limits and to deny credit.Possible values: 0,1.  
rightCreateInventoryRegistrations  Integer  Right to create inventory registrations.Possible values: 0,1.  
rightCreateInventoryAmortizations  Integer  Right to create inventory amortizations.Possible values: 0,1.  
rightMakePOSRefunds  Integer  Right to void transactions in POS and accept returns with receipt.Possible values: 0,1.  
rightMakePOSReturnsWithoutReceipt  Integer  Right to accept returns without receipt.Possible values: 0,1.  
rightApplyPromotions  Integer  Right to apply promotions manually or by typing in a coupon code.Possible values: 0,1.  
rightChangePrices  Integer  Right to edit prices on sales invoices.Possible values: 0,1.  
rightEditConfirmedInvoices  Integer  Right to edit confirmed invoices.Possible values: 0,1.  
rightChangeInvoiceDate  Integer  Right to edit the date on sales invoices.Possible values: 0,1.  
rightEditStockAndProductCost  Integer  Right to edit stock and product cost directly on product card.Possible values: 0,1.  
rightChangePricesOnPurchaseOrders  Integer  Right to edit prices on purchase orders.Possible values: 0,1.  
rightChangeConfirmedPurchaseInvoices  Integer  Right to edit confirmed purchase orders and purchase documents.Possible values: 0,1.  
rightEditPriceOnReturnWithoutReceiptInPOS  Integer  Right to edit item price on return without receipt (Berlin POS only). Possible values: 0,1.  
rightMakeDiscountInPOS  Integer  Right to make discounts in POS (Offline POS only). Possible values: 0,1.

NB!! If API does not return this attribute, assume that the default value is 1.  
rightOpenAndCloseDay  Integer  Right to open / close day (Offline POS only).Possible values: 0,1.

NB!! If API does not return this attribute, assume that the default value is 1.  
rightEditActualReports  Integer  Right to add and edit Actual Reports printout templates. Possible values: 0,1.  
rightAddRewardPoints  Integer  Right to edit customers' reward point amounts. Possible values: 0,1.  
rightPOSManagerOverride  Integer  Indicates that this user is a "store manager"-level employee, and may give manager's approval to POS operations that require it (eg. applying certain promotions or discounts). Possible values: 0,1.  
rightEditRetailChainPriceLists  Integer  Right to create and edit price lists with other types besides "Store Price List". Possible values: 0,1.  
added  Unix timestamp  Creation time.  
addedByUserName  String    
lastModified  Unix timestamp  Last modification time.  
lastModifiedByUserName  String    
warehouses  Array  Keys of the array correspond to warehouse IDs. Each item has the following attributes:

warehouseID

right - possible values: 0,1.  
modules  Array  Keys of the array correspond to names of modules. Each item has the following attributes:

view - possible values: 0,1(added by myself),2(all)

add - possible values: 0,1

edit - possible values: 0,1(added by myself),2(all)

delete - possible values: 0,1(added by myself),2(all)