GET api/kpigroup/departments
Gets a list of departments which have not already been used in a KPI Group
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
A list of departments which have NOT been used in a KPI Group previously
Collection of DepartmentName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
Name | string |
Required String length: inclusive between 0 and 60 |
|
Code | string |
Required String length: inclusive between 0 and 20 |
|
SortOrder | integer |
None. |
|
IsLiquor | boolean |
Deprecated. Use only IsTobacco field. |
|
IsTobacco | boolean |
None. |
|
ExcludeTalker | boolean |
None. |
|
ExternalSales | boolean |
None. |
|
SaleGLCode | string |
String length: inclusive between 0 and 50 |
|
COGSGLCode | string |
String length: inclusive between 0 and 50 |
|
AccountingCategoryID | integer |
None. |
|
MaximumMarkdownPercentage |
Maximum markdown amount for products with in this department, i.e. This percent each time |
decimal number |
None. |
AccountingOnly |
Excludes department from reporting |
boolean |
None. |
GenerateExternalID | integer |
None. |
|
UseNonReportableTaxCode |
When set to true, the MyOB accounting integration will use the non reportable tax code when exporting sales for this department. |
boolean |
None. |
MinPLU | integer |
None. |
|
MaxPLU | integer |
None. |
|
ScaleLocation |
Default Location for new Scale PLUs in this Department, can be overridden at Product level |
ScaleLocation |
Relation. This field may not always be loaded or used for updates. |
SubDepartments | Collection of SubDepartment |
Relation. This field may not always be loaded or used for updates. |
|
Stores | Collection of integer |
Relation. This field may not always be loaded or used for updates. |
|
InvestmentBuyOverride |
Store size configuration has been overridden for this department |
boolean |
Relation. This field may not always be loaded or used for updates. |
Updated | date |
None. |
|
SalesMode | SalesMode |
None. |
|
GSTPercent | integer |
None. |
|
CostGSTPercent | integer |
None. |
|
EarnLoyaltyPoints | boolean |
None. |
|
QuantityOverride | boolean |
None. |
|
QuantityRequired | boolean |
None. |
|
AllowDiscounts | boolean |
None. |
|
DiscountDiscounts | boolean |
None. |
|
ItemRecalled | boolean |
None. |
|
NoRefund | boolean |
None. |
|
Active | boolean |
None. |
|
AllowMarkdown | boolean |
None. |
|
DefaultGP | decimal number |
None. |
|
LabelShelfDefault | integer |
None. |
|
LabelTalkerDefault | integer |
None. |
|
LabelSmall | boolean |
None. |
|
Tags | string |
None. |
|
UnitMeasureKind | integer |
None. |
|
FuelItem | boolean |
None. |
|
TrackSerial | boolean |
None. |
|
WarrantyPeriod | integer |
None. |
|
CostCalcMethod | CostCalcMethod |
None. |
|
ProviderName | string |
None. |
|
OverrideHostMargin | boolean |
None. |
|
KeepDescription |
when false, changes to HostDescription should flow to receipt Name. (OverrideHostDescription) |
boolean |
None. |
MSCCommodity | string |
None. |
|
AllowAutoOrder | boolean |
None. |
|
ExcludeFromWebUpdate | boolean |
None. |
|
WebPriceBasedOn | boolean |
None. |
|
LabelFormat | string |
None. |
|
SendToScale | boolean |
None. |
|
LabelPageLayoutG_UID | Collection of byte |
None. |
|
LabelPageLayoutGuid | globally unique identifier |
None. |
|
MinimumAge |
Only a default on the Department table |
integer |
Relation. This field may not always be loaded or used for updates. |
CountryOfOrigin | string |
Relation. This field may not always be loaded or used for updates. |
|
ServiceFeeID |
Only a default on the Department table |
integer |
None. |
EftCode |
Only a default on the Department and SubDepartment table |
integer |
None. |
DefaultPrinter |
Only a default on the Department and SubDepartment table |
string |
String length: inclusive between 0 and 60 |
DefaultPrinterGroup |
Only a default on the Department and SubDepartment table |
string |
String length: inclusive between 0 and 60 |
BuyingLimit |
Buying Limit for Department. Below are possible values NULL=Dept/SubDept Limit will be used 0=Unlimited - Regardless of Dept/SubDept limits +ve integer |
integer |
None. |
BuyingLimitIndependent |
This indicates if buying limit is independent from other limits like Product/PriceGroup. If yes, limit does not count towards other limits like Product/PriceGroup limit. For example, if toilet paper has BuyingLimit=1 and Grocery Dept has BuyingLimit=2 - if true, transaction may have 1xTP and 2xGrocery - if false, 1xTP and 1xGrocery |
boolean |
None. |
BuyingLimitType |
It indicates whether limit applies to category or item |
BuyingLimitType |
None. |
IncludeInDistinctLimit |
It indicates whether this limit includes in distinct store level limit |
boolean |
None. |
DefaultsEmpty | boolean |
None. |
|
MSCCat | MSCCategory |
Relation. This field may not always be loaded or used for updates. |
|
MSCCom | MSCCommodity |
Relation. This field may not always be loaded or used for updates. |
|
MSCDep | MSCDepartment |
Relation. This field may not always be loaded or used for updates. |
|
MSCSubCom | MSCSubCommodity |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
[ { "$id": "1", "id": 1, "name": "sample string 2", "code": "sample string 3", "sortOrder": 4, "isLiquor": true, "isTobacco": true, "excludeTalker": true, "externalSales": true, "saleGLCode": "sample string 9", "cogsglCode": "sample string 10", "accountingCategoryID": 11, "maximumMarkdownPercentage": 12.0, "accountingOnly": true, "generateExternalID": 1, "useNonReportableTaxCode": true, "minPLU": 15, "maxPLU": 16, "scaleLocation": { "$id": "2", "id": 1, "deptNo": 1, "deptCode": "sample string 2", "name": "sample string 3", "enabled": true, "updated": "2025-08-02T23:22:52.8592998", "department": { "$ref": "1" } }, "subDepartments": [ { "$id": "3", "id": 1, "departmentID": 2, "name": "sample string 3", "code": "sample string 4", "departmentCode": "sample string 5", "externalSales": true, "minorDepartments": [ { "$id": "4", "id": 1, "subDepartmentID": 2, "departmentID": 3, "name": "sample string 4", "subDepartmentCode": "sample string 5", "departmentCode": "sample string 6", "code": "sample string 7", "lesserDepartments": [ { "$id": "5", "id": 1, "departmentID": 2, "subDepartmentID": 3, "minorDepartmentID": 4, "name": "sample string 5", "code": "sample string 6", "departmentCode": "sample string 7", "subDepartmentCode": "sample string 8", "minorDepartmentCode": "sample string 9", "updated": "2025-08-02T23:22:52.8592998", "salesMode": 1, "gstPercent": 1, "costGSTPercent": 1, "earnLoyaltyPoints": true, "quantityOverride": true, "quantityRequired": true, "allowDiscounts": true, "discountDiscounts": true, "itemRecalled": true, "noRefund": true, "active": true, "allowMarkdown": true, "defaultGP": 1.1, "labelShelfDefault": 1, "labelTalkerDefault": 1, "labelSmall": true, "tags": "sample string 11", "unitMeasureKind": 1, "fuelItem": true, "trackSerial": true, "warrantyPeriod": 1, "costCalcMethod": 1, "providerName": "sample string 12", "overrideHostMargin": true, "keepDescription": true, "mscCommodity": "sample string 15", "allowAutoOrder": true, "excludeFromWebUpdate": true, "webPriceBasedOn": true, "labelFormat": "sample string 16", "sendToScale": true, "labelPageLayoutG_UID": "689Rq18vhkGFDNFZdMXmoQ==", "labelPageLayoutGuid": "ab51cfeb-2f5f-4186-850c-d15974c5e6a1", "minimumAge": 17, "countryOfOrigin": "sample string 18", "serviceFeeID": 1, "eftCode": 19, "defaultPrinter": "sample string 20", "defaultPrinterGroup": "sample string 21", "buyingLimit": 1, "buyingLimitIndependent": true, "buyingLimitType": 0, "includeInDistinctLimit": true, "defaultsEmpty": false, "mscCat": { "$id": "6", "dept": 1, "category": 2, "name": "sample string 3", "active": true, "mscCommodities": [ { "$id": "7", "dept": 1, "category": 2, "commodity": 3, "name": "sample string 4", "active": true, "mscSubCommodities": [ { "$id": "8", "dept": 1, "category": 2, "commodity": 3, "subCommodity": 4, "name": "sample string 5", "active": true, "subCommodityCode": "sample string 7" }, { "$ref": "8" } ], "commodityCode": "sample string 6" }, { "$ref": "7" } ], "categoryCode": "sample string 5" }, "mscCom": { "$ref": "7" }, "mscDep": { "$id": "9", "dept": 1, "name": "sample string 2", "active": true, "mscCategories": [ { "$ref": "6" }, { "$ref": "6" } ], "deptCode": "sample string 4" }, "mscSubCom": { "$ref": "8" } }, { "$ref": "5" } ], "updated": "2025-08-02T23:22:52.8592998", "salesMode": 1, "gstPercent": 1, "costGSTPercent": 1, "earnLoyaltyPoints": true, "quantityOverride": true, "quantityRequired": true, "allowDiscounts": true, "discountDiscounts": true, "itemRecalled": true, "noRefund": true, "active": true, "allowMarkdown": true, "defaultGP": 1.1, "labelShelfDefault": 1, "labelTalkerDefault": 1, "labelSmall": true, "tags": "sample string 9", "unitMeasureKind": 1, "fuelItem": true, "trackSerial": true, "warrantyPeriod": 1, "costCalcMethod": 1, "providerName": "sample string 10", "overrideHostMargin": true, "keepDescription": true, "mscCommodity": "sample string 13", "allowAutoOrder": true, "excludeFromWebUpdate": true, "webPriceBasedOn": true, "labelFormat": "sample string 14", "sendToScale": true, "labelPageLayoutG_UID": "KiGY/JdWRkOZuO51WFLq7w==", "labelPageLayoutGuid": "fc98212a-5697-4346-99b8-ee755852eaef", "minimumAge": 15, "countryOfOrigin": "sample string 16", "serviceFeeID": 1, "eftCode": 17, "defaultPrinter": "sample string 18", "defaultPrinterGroup": "sample string 19", "buyingLimit": 1, "buyingLimitIndependent": true, "buyingLimitType": 0, "includeInDistinctLimit": true, "defaultsEmpty": false, "mscCat": { "$ref": "6" }, "mscCom": { "$ref": "7" }, "mscDep": { "$ref": "9" }, "mscSubCom": { "$ref": "8" } }, { "$ref": "4" } ], "investmentBuyOverride": true, "updated": "2025-08-02T23:22:52.8592998", "salesMode": 1, "gstPercent": 1, "costGSTPercent": 1, "earnLoyaltyPoints": true, "quantityOverride": true, "quantityRequired": true, "allowDiscounts": true, "discountDiscounts": true, "itemRecalled": true, "noRefund": true, "active": true, "allowMarkdown": true, "defaultGP": 1.1, "labelShelfDefault": 1, "labelTalkerDefault": 1, "labelSmall": true, "tags": "sample string 9", "unitMeasureKind": 1, "fuelItem": true, "trackSerial": true, "warrantyPeriod": 1, "costCalcMethod": 1, "providerName": "sample string 10", "overrideHostMargin": true, "keepDescription": true, "mscCommodity": "sample string 13", "allowAutoOrder": true, "excludeFromWebUpdate": true, "webPriceBasedOn": true, "labelFormat": "sample string 14", "sendToScale": true, "labelPageLayoutG_UID": "vdFG6U2N/EWrPwbm9JXmVQ==", "labelPageLayoutGuid": "e946d1bd-8d4d-45fc-ab3f-06e6f495e655", "minimumAge": 15, "countryOfOrigin": "sample string 16", "serviceFeeID": 1, "eftCode": 17, "defaultPrinter": "sample string 18", "defaultPrinterGroup": "sample string 19", "buyingLimit": 1, "buyingLimitIndependent": true, "buyingLimitType": 0, "includeInDistinctLimit": true, "defaultsEmpty": false, "mscCat": { "$ref": "6" }, "mscCom": { "$ref": "7" }, "mscDep": { "$ref": "9" }, "mscSubCom": { "$ref": "8" } }, { "$ref": "3" } ], "stores": [ 1, 2 ], "investmentBuyOverride": true, "updated": "2025-08-02T23:22:52.8592998", "salesMode": 1, "gstPercent": 1, "costGSTPercent": 1, "earnLoyaltyPoints": true, "quantityOverride": true, "quantityRequired": true, "allowDiscounts": true, "discountDiscounts": true, "itemRecalled": true, "noRefund": true, "active": true, "allowMarkdown": true, "defaultGP": 1.1, "labelShelfDefault": 1, "labelTalkerDefault": 1, "labelSmall": true, "tags": "sample string 19", "unitMeasureKind": 1, "fuelItem": true, "trackSerial": true, "warrantyPeriod": 1, "costCalcMethod": 1, "providerName": "sample string 20", "overrideHostMargin": true, "keepDescription": true, "mscCommodity": "sample string 23", "allowAutoOrder": true, "excludeFromWebUpdate": true, "webPriceBasedOn": true, "labelFormat": "sample string 24", "sendToScale": true, "labelPageLayoutG_UID": "NLGiJCCw90iDZ5isZaKrpg==", "labelPageLayoutGuid": "24a2b134-b020-48f7-8367-98ac65a2aba6", "minimumAge": 25, "countryOfOrigin": "sample string 26", "serviceFeeID": 1, "eftCode": 27, "defaultPrinter": "sample string 28", "defaultPrinterGroup": "sample string 29", "buyingLimit": 1, "buyingLimitIndependent": true, "buyingLimitType": 0, "includeInDistinctLimit": true, "defaultsEmpty": false, "mscCat": { "$ref": "6" }, "mscCom": { "$ref": "7" }, "mscDep": { "$ref": "9" }, "mscSubCom": { "$ref": "8" } }, { "$ref": "1" } ]
application/xml
Sample not available.
text/xml
Sample not available.
text/csv
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK ں[7s� 5 xl/workbook.xml � (� ����0��&�C��Š")��x���V�O�||K�$���~;l6nl��[Mڗ��C�$�w(�Ƃ�;a��!J�$F�Ac��ȑ�3q0� ������X�:� ��V��R�z�C�-�f�d4�u�5D~S,������ *���1Jέ�p��+e�Y� Z�����^{��7#���PK ں[���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK ں[��o' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Re840a91a2806454f" /></Relationships>PK ں[��C� �/ xl/worksheets/sheet1.xml � (� �ZmS9�+.��^GR �Z!����Lp������X���<+A�*��5+��G���_�{|��.�����PVb8�>��ogO���?Vw���{��ſ���t5@����bx�Z}7-o�e5�>}±���q��o�F����p~��q��)!`��>LV������r�R�����b:��,�����d�4<ػ�a�����������z8�mЗ����y���?����oNn��b�u�G���/�ӻɏ������t��~�,�͜���r���q��n8x�����<�]��C%� ��������?�8�e���S�y�T� #� �S���v�~�|��o�����y�Pʀ�o���+� �y���e�5>Q�|f�n;ߵ��!p����~;�7�ueuAJ�������Fڥ�zM[yc�u�k�B�T�)���UV<?#�L��=وO��9)�o�4dT���]8��i����d*D�ɖ }�K �@;�BF�2*P6T��{�Z��]D-Jx��eT�t��(�P��6�@AN�2JP6��V��kP.�L�T����G��£�3�UK� ],�Ԝ��@F�j��Z�OU>�� ���UK��2�n�8�2�@E *�:D<