GET api/departments?subDepartments={subDepartments}&minorDepartments={minorDepartments}&lesserDepartments={lesserDepartments}&showExternal={showExternal}
Lists all departments
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subDepartments |
List sub departments of departments |
boolean |
Default value is True |
| minorDepartments |
List minor departments of sub departments |
boolean |
Default value is True |
| lesserDepartments |
List lesser departments of minor departments |
boolean |
Default value is True |
| showExternal |
when null, lists all departments when true, Lists all eCommerce departments when false, Lists all departments except eCommerce departments |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
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:23:12.2076319",
"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:23:12.2076319",
"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": "hs/PsVMeWU28B5vv6kVIhg==",
"labelPageLayoutGuid": "b1cfcf86-1e53-4d59-bc07-9befea454886",
"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:23:12.2076319",
"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": "LWFyeRHZAk+oB5M0N/+ReQ==",
"labelPageLayoutGuid": "7972612d-d911-4f02-a807-933437ff9179",
"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:23:12.2076319",
"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": "a8m6f+3Vpk2ZyOj9hu3vaQ==",
"labelPageLayoutGuid": "7fbac96b-d5ed-4da6-99c8-e8fd86edef69",
"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:23:12.2076319",
"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": "AbN3vaq9ZUKerEiHfXiroQ==",
"labelPageLayoutGuid": "bd77b301-bdaa-4265-9eac-48877d78aba1",
"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��h�!8q����[i�?ik��-%�x�3;��T�q�Θ��I���t����~D�d,��)Q�'3B�[ӿ��.Yve'�h?J��J���C��Դ�HM�ぐji��8�$���]L���MU �_$E4(�i(I�m��W�8܋��"�����a�~7_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�\1u��' ' _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="R12d1fda4187447bf" /></Relationships>PK �2�\>�S�� �/ xl/worksheets/sheet1.xml � (� �ZmS9�+.����k
�Z!����Lp������X���<+A�*@Ԛ�Zݣ^��_�{|��.�����PVb8�>��ogO���?Vw���{��ſ���t5@����bx�Z}7-o�e5�>}±���q���F����p~��q��)!�h1}���Q������ZI����tr�Y���K����ix�w;����ӻ�a-ߍ/`8�mЗ�����`�����?����;ꀏ6O?_n�w����������
Y2�97������l��p�8�o��yv����Jja�o~,W��//�,��yj;O��I]9#��:X�������z;_7�E%��&x�������7�ܷ�γ�y + |�
���3�v����o�AX����}3*A)%�;d����i�"�E4L�� R����S\#9%��x~Z�2��d#>*���z�ΰ ��$�wἲ<g��T���-�
�`���@�� eT�l$�Le�A���Z���"�Q�ҽvf�lhE�j_ �X�T������(<z�ʅL%� j��G��£�3�UK�
],�Ԝ�Bی�ծ�����|���-0��T- �J|��>��eZ��T�u�
[�-��xYE��6A���IWY��t!wQ���m�-�9��1�#�JT��)�9�jl��RT�
�. R����^Q� �k�]�,v�l/�(E�m!0ګ�W"#�Rվ
��[0
�b���*�W� �A'G �2���%�}��DN���U�R۾�p�U>/$�R��N^k �)����e��R
� ފ9&�!��Z�Q�:��A7Z�"2��Q�������`�0&W!JQ��i
i�z#"W!jQ's��l��"1�]0����6�.��_�:jR���EԤni2Tx;��;NGMj��� ���g���I�ߺ��I�h�I����m&cGM�F�
*T��ś��&j�ȶ�vw��(3�&�z#&j�@�Ek�
F��m�&j�4�T�B0^!q�����J�I��Ă}JzkT�ɨI��I���x����"j�$W��Zb�s��DM��O�c�v��W��I^yW٨E���h��i�jK*D-Z��؛�����6j�6Z��00��#�X/s��N:�R@k�}�Q�6����b_�%o>v�m�.� _�d0���F)�F��U�x��� �k�B��m�hD%�V�N{[&��(E�l@�L�ϴh%�I���O�
�1v�&G/��l>�9��&{���`�����j�v���h�?\�~������-b�E��[�R�a)��.B���.¤��.¦��]�K']�O���"N��a�Bh=c ��O�{�@������n�d �ܿa�oFm��KB���@�W��{�@�_a�fL��5cCE��9#�kƊ�0\3fBq���5cH $%��\3�Bs��(ό1���8(ό5���x(ό95�q��<3�ԔgƟ���TS��j�3cQMyf<�)όI5�q��<365�gƧ��<f|j�cƧ��<f|j�cƧ��<f|j�c��$<�����!<��Z�&�Z�3�SKyf|j)όO-��<3>��gƧ�����R��چ��]�SM�S�IL:�NAG�7B���@8���N��(9�C��!'���!;:M�$T|L����/��>姟'�iPKiDc���2R�/B��w~����V��0����랱���u�3�p�L�����F��V�$�V4�|衿>��X�p�g���������}���F�g6���]�� �KA���u��來|�1�?O1��<M
��F��ƌ�<�G=G=>N��X����%0�����q��6�y�n|�ԡ9��y��_�y�3��{g.�Ь9�T�d*�a�$�L�@h�j?�f*f:�Ty�q�>9a 4S1��>i�Ji��/��>姟'�i�Ji�b��L�@h�b 4S�wq��?S��u�3v�3�5�º.�p��d��a��fu�����N�O~�������o�c��9�u2U�C
�V�`>�=�o��Z'S���m�e��Tu�
0���L��3f���T������TL�N�껂���LŔ�d*��T}K8-`�1^7S�9c�t2��d�.���L'S1��F��<�O'����|��.6��������PK �2�\�)Q� P xl/_rels/workbook.xml.rels � (� ���n� @���R'���K�4?���X�q$m��C?��P�H-�:t�t�;�������9C��نVEI ����z������z�����#I#jb�+ư30+,��:څYŔ��y�� ��傅�Ao��p����z���u�l��^]8���T 6���;TE�R����[)[��Ңm��gwS�x� ��y&�����z�%\�Uƨ �K�s�����O�5oEY�R��{b7�b�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�\���o� � xl/sharedStrings.xml � (� �W]s7}�L�������?R㌃m�5x�ɴbW`�w���uL;����b�W�4/�=���ӄ<1���F�y� LD2�b�k��oND*b�H�z�5�
���\kC`�нƃ1��VKG,��)3&