POST api/department/import

Request Information

URI Parameters

None.

Body Parameters

Collection of Department
NameDescriptionTypeAdditional 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.

Request Formats

application/json, text/json

Sample: 
[
  {
    "$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-06-14T06:20:14.2095095",
      "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-06-14T06:20:14.2095095",
                "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": "VD8N5SrGNkObD7SEBsKv8A==",
                "labelPageLayoutGuid": "e50d3f54-c62a-4336-9b0f-b48406c2aff0",
                "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-06-14T06:20:14.2095095",
            "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": "3mZ5P/VAbUChY8S0l2oYYQ==",
            "labelPageLayoutGuid": "3f7966de-40f5-406d-a163-c4b4976a1861",
            "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-06-14T06:20:14.2095095",
        "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": "e37IDa/k6EO19IdXWKKnQg==",
        "labelPageLayoutGuid": "0dc87e7b-e4af-43e8-b5f4-875758a2a742",
        "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-06-14T06:20:14.2095095",
    "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": "DETYsPxXjUepv9lN+46UOQ==",
    "labelPageLayoutGuid": "b0d8440c-57fc-478d-a9bf-d94dfb8e9439",
    "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:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of boolean

Response Formats

application/json, text/json

Sample: 
[
  true,
  true
]

application/xml, text/xml

Sample: 
<ArrayOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <boolean>true</boolean>
  <boolean>true</boolean>
</ArrayOfboolean>

text/csv

Sample:

Sample not available.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample: 
PK�2�ZU�h�5xl/workbook.xml �(�����0D�H�k? &w�M���|�vD>?)]���ٷ#z���ږ}tgB�3hbt)�A6�1�#3�j�5�A��u�$V�5��Ir�:�ʚ�(`���
�V�!���Q��|�aL�͞��0��X�&�s����[/&�jʠ���&�^e��S5y�sMH����%��&��;�PK�2�Z����	�[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�Z�P[`''_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="R491f179bd2c04fc5" /></Relationships>PK�2�Zˇ]e'xl/worksheets/sheet1.xml �(��Q�n� ~�}%��j��T��j�M;lg�85����?�H]��`��c�r{u��@�}%�U&�[�O��{x�ۺ�0�� �p7���h�(N������4qN
��6��ft�IY�VzMl��\�����M%�~�r�zY��e��z���.��
)T]&�)��b��x�����Yª_�C2��N�=}��
�d���8
�1���ytR8}M�d[2�|Y�ٺ`t3FB��\��BO^{M�.N"�gV���1UȦGn�R祺�\^�q�N�'G�y*�"AHU�>��PK�2�Z"���Pxl/_rels/workbook.xml.rels �(���An� E��f_�R�U�l��6��x��؀���ٺ�z��Fj��n�B���f�|�Xoߦ��ɇ���L#�l;���S�%l7�=�Ӎ�.��Ą���A�4aȬ#�:��	c*}��#v�B<r?g�-�.��C�Z���:Md�`�j�1�D�}G���(��#�خ�a�
ZiBRM�r�
0~7�/#�_�k=�)+Q5�"�*Y���L��ڗ�Ӧ�N�x�V,s��|ʂ�������/PK�2�ZЃc'2E
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�Z�/���xl/sharedStrings.xml �(�5�A� �B�nA�h&�@@ڵ����������d2;}Ҧ�X9frp(�9/�V���p��i�[&t�E5��YTO��r՚���R7�\���u�\*����M��9��#��s#qЧ��������~PK-�2�ZU�h�5xl/workbook.xmlPK-�2�Z����	��[Content_Types].xmlPK-
�2�Z�P[`''T_rels/.relsPK-�2�Zˇ]e'�xl/worksheets/sheet1.xmlPK-�2�Z"���P9xl/_rels/workbook.xml.relsPK-�2�ZЃc'2E
xl/styles.xmlPK-�2�Z�/����xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample: 
PK�2�Z�P��5xl/workbook.xml �(�����0��&�C���DR8q���{��4П�5���H�yۙ��v�l��4fD5i_�!؊�
��?:�q��(݋!d���
t �%q0� ������X�:���V��R��x@�-�f�d4�����"�)�`�ERHs5ny�%�������d�Y/��Z��4/���;���w�PK�2�Z����	�[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�ZT?�j''_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="Rc40f18faa11748e8" /></Relationships>PK�2�Zˇ]e'xl/worksheets/sheet1.xml �(��Q�n� ~�}%��j��T��j�M;lg�85����?�H]��`��c�r{u��@�}%�U&�[�O��{x�ۺ�0�� �p7���h�(N������4qN
��6��ft�IY�VzMl��\�����M%�~�r�zY��e��z���.��
)T]&�)��b��x�����Yª_�C2��N�=}��
�d���8
�1���ytR8}M�d[2�|Y�ٺ`t3FB��\��BO^{M�.N"�gV���1UȦGn�R祺�\^�q�N�'G�y*�"AHU�>��PK�2�Z�<h��Pxl/_rels/workbook.xml.rels �(���Mn� F��f_���ɦ�n�\�`[���6g�G��R���.��
�7��4������6����i M4Ҫ�t
\�~���q!���0{��@¼���'�;��m�$B,]Gg!ϢC�1VP�d��IN��C�Z��Lh�`�j�����I�C?���#M"ȓj�)��(6����������w���L�u�]���e}W�^8T���M/���JM�qFmU����FW�b�PK�2�ZЃc'2E
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�Z�/���xl/sharedStrings.xml �(�5�A� �B�nA�h&�@@ڵ����������d2;}Ҧ�X9frp(�9/�V���p��i�[&t�E5��YTO��r՚���R7�\���u�\*����M��9��#��s#qЧ��������~PK-�2�Z�P��5xl/workbook.xmlPK-�2�Z����	�[Content_Types].xmlPK-
�2�ZT?�j''V_rels/.relsPK-�2�Zˇ]e'�xl/worksheets/sheet1.xmlPK-�2�Z�<h��P;xl/_rels/workbook.xml.relsPK-�2�ZЃc'2E
�xl/styles.xmlPK-�2�Z�/����xl/sharedStrings.xmlPK��