Configuration

Aforementioned example roles can easily be configured using our services. Firstly, use CreateRole to create an empty role.

Example request for store employees:

{
  "Code": "STORE_EMPLOYEE",
  "Name": "Store Employee",
  "UserType": 1
}

This service then returns an ID, which can then be used in AttachFunctionalitiesToRole as the RoleID. Examples for this service are listed below. Don't forget to replace the RoleID with the ID that was returned by CreateRole.

Scope

Example requests

The following example requests correspond with the role templates as mentioned in the previous chapter.

Store Employee

{
  "RoleID": "x",
  "ScopedFunctionalities": [
    {
      "Functionality": "CashTransactionLedger",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "Commitments",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "ConfirmShipment",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "CustomerInteractionTypes",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "CustomerInteractions",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "CycleCounts",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "Discounts",
      "Scope": 8,
      "RequiresElevation": false
    },
    {
      "Functionality": "Login",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "MoveStock",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "OpenCashDrawer",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "Orders",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "Pricing",
      "Scope": 8,
      "RequiresElevation": false
    },
    {
      "Functionality": "ProductRequirements",
      "Scope": 8,
      "RequiresElevation": false
    },
    {
      "Functionality": "ReleasePaidPickupOrders",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "UserInteractions",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "ApplyManualDiscount",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "Refund",
      "Scope": 1,
      "RequiresElevation": false
    },
    {
      "Functionality": "Refunds",
      "Scope": 1,
      "RequiresElevation": false
    },
    {
      "Functionality": "PickIdentificationPin",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "ReceivePurchaseOrderShipment",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "ReceiveShipments",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "ShipmentReceipts",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "Shipments",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "Sales",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "StockReplenishments",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "ReturnOrdersWithoutOriginalOrder",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "ExemptOrderFromTax",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "FullStockCount",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "FullStockCountLabel",
      "Scope": 31,
      "RequiresElevation": false
    },
    {
      "Functionality": "UserFields",
      "Scope": 8,
      "RequiresElevation": false
    },
    {
      "Functionality": "UserRequirements",
      "Scope": 8,
      "RequiresElevation": false
    },
    {
      "Functionality": "ReturnOrder",
      "Scope": 0,
      "RequiresElevation": false
    },
    {
      "Functionality": "Infrastructure",
      "Scope": 8,
      "RequiresElevation": false
    },
    {
      "Functionality": "InterbranchOrders",
      "Scope": 31,
      "RequiresElevation": false
    }
  ]
}

(Assistant) Store Manager

{
  "RoleID": "x",
  "ScopedFunctionalities": [
    {
        "Functionality": "CashDeposits",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "CashExpenses",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "CashJournals",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "CashTransactionLedger",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "Commitments",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "ConfirmShipment",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "CustomerInteractionTypes",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "CustomerInteractions",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "CycleCounts",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "DashboardData",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "Discounts",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "ExportPayroll",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ExternalLogin",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "FinancialEvents",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "FinancialPeriodClosing",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "FinancialPeriodOpening",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "FinancialPeriods",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "Login",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "MoveCash",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "MoveStock",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "OpenCashDrawer",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "Orders",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "OrganizationUnitSupplierData",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "OrganizationUnitSuppliers",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "OrganizationUnits",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "Pricing",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "ProductRequirements",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "ReleasePaidPickupOrders",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "Replenishments",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "SupplierProducts",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "UserInteractions",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "ZonedCycleCountAllowManualCorrections",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ZonedCycleCounts",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ApplyManualDiscount",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "Refund",
        "Scope": 1,
        "RequiresElevation": false
    },
    {
        "Functionality": "Refunds",
        "Scope": 1,
        "RequiresElevation": false
    },
    {
        "Functionality": "PickIdentificationPin",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ReceivePurchaseOrderShipment",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ReceiveShipments",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ShipmentReceipts",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "Shipments",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "Sales",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "StockReplenishments",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "ReturnOrdersWithoutOriginalOrder",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ExemptOrderFromTax",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "TaxRates",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "Infrastructure",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "InterbranchOrders",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "AdjustStock",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "FullStockCount",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "FullStockCountLabel",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "FinancialPeriodArchive",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "UserFields",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "OrderLinePriceCorrection",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "UnitPriceCorrectionReasons",
        "Scope": 31,
        "RequiresElevation": false
    },
    {
        "Functionality": "UserRequirements",
        "Scope": 8,
        "RequiresElevation": false
    },
    {
        "Functionality": "VerifyOrder",
        "Scope": 0,
        "RequiresElevation": false
    },
    {
        "Functionality": "ReturnOrder",
        "Scope": 0,
        "RequiresElevation": false
    }
  ]
}