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 Department| Name | 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": "2026-04-03T06:20:00.6446368",
"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": "2026-04-03T06:20:00.6446368",
"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": "TRVTgfbe20S1XUBxWR9uQw==",
"labelPageLayoutGuid": "8153154d-def6-44db-b55d-4071591f6e43",
"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": "2026-04-03T06:20:00.6446368",
"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": "uSDeu0cGN0KAMGbhGOFuvg==",
"labelPageLayoutGuid": "bbde20b9-0647-4237-8030-66e118e16ebe",
"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": "2026-04-03T06:20:00.6446368",
"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": "+32pzx3HTESx4nQEa6JvQQ==",
"labelPageLayoutGuid": "cfa97dfb-c71d-444c-b1e2-74046ba26f41",
"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": "2026-04-03T06:20:00.6446368",
"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": "BvZ5s7jCsE2LahqOVZcrng==",
"labelPageLayoutGuid": "b379f606-c2b8-4db0-8b6a-1a8e55972b9e",
"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 �2�\���~� 5 xl/workbook.xml � (� ����0��&�C��ȏ)��x��}��6Ж�5���H�yۙ��v�hl�4�#�k�ۂ
1WT�Nf@=�Zc�I�3m+k�L�V�=���,���N��ѕ��
�qѫ~E)����!|n��8�EN�Vw6 [C�7��~�(�AaA+�@��ܚ��)����{�B�eQ��I�W�;{�q��.�PK �2�\���� � [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
�2�\�Ϻ' ' _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="Rf715997aa4fe47bc" /></Relationships>PK �2�\FY�˳ �/ xl/worksheets/sheet1.xml � (� �ZmS9�+.����k
�Z!����Lp������X���<+A��@�5+��G-��_�{|��.�����PVb8�>��ogO���?Vw���{��ſ���t5@����bx�Z}7-o�e5�>}�gw���d�?.���ww���������i5RB��b�0Y�����K��Z����v3�LJ�R�����`�v��׳,�w��Z�_�p0:�۠/g��e���z)�����8���
v�m�~��N�&?V����ٷ��d6cn������l��p�8�o����vu�?���*D��X��_^�Y��/��v�ڍ��rFh!u��;�?�����v�nƋJ�M�B)me�x�o^�n�gw�@V �F���g���]{�� ���?�o��f8T�RJ\w�L?lLJ7�.Eԋh*��k-��
!Sa��FrJT!p���e*D��F|*T�I����K�aAF�Ih��yex0�h���'[�N�zg��
ʨ@�HP��*\�
V�(�+E,�
�{��(@�(Є�0B*/��e*D �F�^T`n=X�B���T�5T�C
K�Qř
Q��%A�.�kN{�mF�j��Z�OVm,��A�F *hW��n�8p�V���nm��Ay�u2^VQ��MPE�Fy�U�:i� -]�mAT�j5B[apΠ}Ln��o�AJtN��!���B�H�ԡ�|��A�"��p>��B��A�"4R��B;i���^�� JT�(2.�(l����^)�
�l�����/C� ��a x�['P��*D)�m�^8 �*�D)Bz&�5 �d �R���[�Ɨt�R���cUG)�D��hQ�hLȬBG)�v�R�J�Ø\�(E�ڻ)���녈\��E��[��ڊ���w�P����`��*0�ImQ����Pi�\���&�K�`�Cp�3�CԤ�o]EԤN4�[�W���6���&M�I����Imu�5id[����P��
Q�F��5i�ݢ��� Yȶh5iM*L�y11����VvוF��+#�R �>�e2j�$}��,&o�έ"j�$G��Zb�s��DM��O�c�v��W��I^yV٨E���Z����w�ڒ
Q�6I��co����좍Z��1��xy��e�BԢ�I�U�h��7P�h�#�+�%Yr�;�m�(�x�`�ǥ�R�������F��-�F)��=FT2`o��$��e���R��]����^�L�vQ�����
�O����09z�g���d59�[̟��c�����o����V����`����\��"�]�L�u*Ev�"~�"t�8�"L�8�"l�x�E�q�E��)�a�����V�` ��3Bx��@���0���j/��OB����v�f�Fؽd ��/��{�@�������vkƄ��[36T�ߚ3"!�f���5cF �p\3�Br�X�5cJ 4-���(ό3���X(ό7��̘SS�wj�3cOMyf��)όA5�q��<3Քgƣ��̘TS��j�3cSCyf|j�cƧ��<f|j�cƧ��<f|j�cƧ��<�M���!<�����i��<3>��gƧ�����R��Z�3�SKyf|j)όO-��mxa�ۥ8դ8�Ĥ���tdS~c ��a�
��ߙ�d����<�}r�@�,>0��ӄOB���!y��)��l֧���d8
j�Cј�d���T������_�e���������b�i�����Uϳ�g_�3��g.���E1����>��V8�>I��h(��C}���c��9�u"X�K
�V�`>����!�5�\8������b<M@_
�\`�0��|'m���y�a��iRH�7z?3��4G�l��8)Occ6O���k�F�>ǍO�d���d��S�����I��������9�B3�$SA����M�@3��������4S�!�y��<䄁�L�@h�J���*yH3U~�g=��)?�<N3U�f*�8�T�f*B3U~����3U_W=Ϯ{�}�ϰ�0��:�� sX�)�Y]�hu��꓄�n�>�{�����:���%N��0��^r����Z'S̠�m�e��Tu�
0���L��3f���T������TL�N��;����LŔ�d*��T}S8-`�1^7S�9c�t2��d�.���L'S1��F��<�O'����|��.6��������PK �2�\�
�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;q;�M7l)p�I�ؖmJ9[=R�P�J�����h~OO��|���ޖ���u�V
dI
U��I�
���T�n�9�,|�pr2����ޛ5�����h�*tm�CjGjDw#�<MKjc�3��j�?D=S�Ϻ;/��`z���$�rvD��O��[Ȓ@��8��(V+�`�W�>L������;�d�.2�mU"�-�*#�����p��).Gj�lq�X_�y��75z��/PK �2�\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK �2�\�� � xl/sharedStrings.xml � (� �W]s7}�L������ �S㌃m�5x�ɴbW`�w���uL;����b�W�4/�=�g�҄<2����q�� LD2�b�o�-��ND*b�H���
�
���LkC`���ƽ1��VKG�,��)3&