GET Item/Get?includeAdditionalItemPrices={includeAdditionalItemPrices}&includeAttachments={includeAttachments}

Gets a list of Items.

Request Information

This method supports OData queries.

URI Parameters

NameTypeAdditional informationDescription
includeAdditionalItemPrices bool

Default value is False

if set to true Additional Item Prices are included.

includeAttachments bool

Default value is False

if set to true Item Attachments meta data will be included.

Body Parameters

None.

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Item
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Item

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "Description": "sample string 1",
      "Category": {
        "Description": "sample string 1",
        "ID": 2,
        "Modified": "2021-10-19",
        "Created": "2021-10-19"
      },
      "Code": "sample string 2",
      "Active": true,
      "PriceInclusive": 4.0,
      "PriceExclusive": 5.0,
      "Physical": true,
      "TaxTypeIdSales": 1,
      "TaxTypeSales": {
        "ID": 1,
        "Name": "sample string 2",
        "Percentage": 3.1,
        "IsDefault": true,
        "HasActivity": true,
        "IsManualTax": true,
        "Active": true,
        "Created": "2021-10-19",
        "Modified": "2021-10-19",
        "TaxTypeDefaultUID": "a4a51bf0-ae84-42e1-9495-03714b7bbcc9",
        "CompanyId": 9
      },
      "TaxTypeIdPurchases": 1,
      "TaxTypePurchases": {
        "ID": 1,
        "Name": "sample string 2",
        "Percentage": 3.1,
        "IsDefault": true,
        "HasActivity": true,
        "IsManualTax": true,
        "Active": true,
        "Created": "2021-10-19",
        "Modified": "2021-10-19",
        "TaxTypeDefaultUID": "a4a51bf0-ae84-42e1-9495-03714b7bbcc9",
        "CompanyId": 9
      },
      "LastCost": 7.0,
      "AverageCost": 8.0,
      "QuantityOnHand": 1.0,
      "HasAttachments": true,
      "HasActivity": true,
      "Unit": "sample string 10",
      "ItemReportingGroupId_Sales": 1,
      "ItemReportingGroupSales": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "ItemReportingGroupId_Purchases": 1,
      "ItemReportingGroupPurchases": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "ItemReportingGroupId_Inventory": 1,
      "ItemReportingGroupInventory": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "ItemReportingGroupId_ItemAdjustments": 1,
      "AccountId_ServiceItemRecovery": 1,
      "ItemReportingGroupItemAdjustments": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "AccountServiceItemRecovery": {
        "Name": "sample string 2",
        "Category": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        },
        "Active": true,
        "Balance": 4.0,
        "Description": "sample string 5",
        "ReportingGroupId": 1,
        "UnallocatedAccount": true,
        "IsTaxLocked": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "AccountType": 9,
        "HasActivity": true,
        "DefaultTaxTypeId": 1,
        "DefaultTaxType": {
          "ID": 1,
          "Name": "sample string 2",
          "Percentage": 3.1,
          "IsDefault": true,
          "HasActivity": true,
          "IsManualTax": true,
          "Active": true,
          "Created": "2021-10-19",
          "Modified": "2021-10-19",
          "TaxTypeDefaultUID": "a4a51bf0-ae84-42e1-9495-03714b7bbcc9",
          "CompanyId": 9
        },
        "ID": 11
      },
      "TextUserField1": "sample string 12",
      "TextUserField2": "sample string 13",
      "TextUserField3": "sample string 14",
      "NumericUserField1": 1.0,
      "NumericUserField2": 1.0,
      "NumericUserField3": 1.0,
      "DateUserField1": "2021-10-19",
      "DateUserField2": "2021-10-19",
      "DateUserField3": "2021-10-19",
      "YesNoUserField1": true,
      "YesNoUserField2": true,
      "YesNoUserField3": true,
      "Modified": "2021-10-19",
      "Created": "2021-10-19",
      "MajorIndustryCodeId": 1,
      "GPPercentage": 1.0,
      "GPAmount": 1.0,
      "ItemReportingGroupPurchasesName": "sample string 16",
      "ItemReportingGroupSalesName": "sample string 3",
      "ItemReportingGroupInventoryName": "sample string 18",
      "ItemReportingGroupItemAdjustmentsName": "sample string 19",
      "AccountServiceItemRecoveryName": "sample string 20",
      "Attachments": [
        {
          "Name": "sample string 1",
          "Size": 2,
          "AttachmentUID": "848fa9dd-57f0-45ba-96a2-5733a4f34a95",
          "Data": "QEA="
        },
        {
          "Name": "sample string 1",
          "Size": 2,
          "AttachmentUID": "848fa9dd-57f0-45ba-96a2-5733a4f34a95",
          "Data": "QEA="
        }
      ],
      "PrescribedGoods": true,
      "QuantityReserved": 1.0,
      "HasSpecialCountryTaxActivity": true,
      "ID": 23,
      "AdditionalItemPrices": [
        {
          "ID": 1,
          "ItemId": 2,
          "PriceInclusive": 3.0,
          "PriceExclusive": 4.0,
          "AdditionalPriceListId": 5
        },
        {
          "ID": 1,
          "ItemId": 2,
          "PriceInclusive": 3.0,
          "PriceExclusive": 4.0,
          "AdditionalPriceListId": 5
        }
      ]
    },
    {
      "Description": "sample string 1",
      "Category": {
        "Description": "sample string 1",
        "ID": 2,
        "Modified": "2021-10-19",
        "Created": "2021-10-19"
      },
      "Code": "sample string 2",
      "Active": true,
      "PriceInclusive": 4.0,
      "PriceExclusive": 5.0,
      "Physical": true,
      "TaxTypeIdSales": 1,
      "TaxTypeSales": {
        "ID": 1,
        "Name": "sample string 2",
        "Percentage": 3.1,
        "IsDefault": true,
        "HasActivity": true,
        "IsManualTax": true,
        "Active": true,
        "Created": "2021-10-19",
        "Modified": "2021-10-19",
        "TaxTypeDefaultUID": "a4a51bf0-ae84-42e1-9495-03714b7bbcc9",
        "CompanyId": 9
      },
      "TaxTypeIdPurchases": 1,
      "TaxTypePurchases": {
        "ID": 1,
        "Name": "sample string 2",
        "Percentage": 3.1,
        "IsDefault": true,
        "HasActivity": true,
        "IsManualTax": true,
        "Active": true,
        "Created": "2021-10-19",
        "Modified": "2021-10-19",
        "TaxTypeDefaultUID": "a4a51bf0-ae84-42e1-9495-03714b7bbcc9",
        "CompanyId": 9
      },
      "LastCost": 7.0,
      "AverageCost": 8.0,
      "QuantityOnHand": 1.0,
      "HasAttachments": true,
      "HasActivity": true,
      "Unit": "sample string 10",
      "ItemReportingGroupId_Sales": 1,
      "ItemReportingGroupSales": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "ItemReportingGroupId_Purchases": 1,
      "ItemReportingGroupPurchases": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "ItemReportingGroupId_Inventory": 1,
      "ItemReportingGroupInventory": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "ItemReportingGroupId_ItemAdjustments": 1,
      "AccountId_ServiceItemRecovery": 1,
      "ItemReportingGroupItemAdjustments": {
        "ID": 2,
        "Name": "sample string 3",
        "ItemReportingGroupTypeId": 4,
        "ItemReportingGroupType": "sample string 5",
        "ReportingGroupId": 1,
        "AccountCategoryId": 1,
        "AccountCategory": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        }
      },
      "AccountServiceItemRecovery": {
        "Name": "sample string 2",
        "Category": {
          "Comment": "sample string 1",
          "Order": 6,
          "Description": "sample string 7",
          "ID": 8,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        },
        "Active": true,
        "Balance": 4.0,
        "Description": "sample string 5",
        "ReportingGroupId": 1,
        "UnallocatedAccount": true,
        "IsTaxLocked": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "AccountType": 9,
        "HasActivity": true,
        "DefaultTaxTypeId": 1,
        "DefaultTaxType": {
          "ID": 1,
          "Name": "sample string 2",
          "Percentage": 3.1,
          "IsDefault": true,
          "HasActivity": true,
          "IsManualTax": true,
          "Active": true,
          "Created": "2021-10-19",
          "Modified": "2021-10-19",
          "TaxTypeDefaultUID": "a4a51bf0-ae84-42e1-9495-03714b7bbcc9",
          "CompanyId": 9
        },
        "ID": 11
      },
      "TextUserField1": "sample string 12",
      "TextUserField2": "sample string 13",
      "TextUserField3": "sample string 14",
      "NumericUserField1": 1.0,
      "NumericUserField2": 1.0,
      "NumericUserField3": 1.0,
      "DateUserField1": "2021-10-19",
      "DateUserField2": "2021-10-19",
      "DateUserField3": "2021-10-19",
      "YesNoUserField1": true,
      "YesNoUserField2": true,
      "YesNoUserField3": true,
      "Modified": "2021-10-19",
      "Created": "2021-10-19",
      "MajorIndustryCodeId": 1,
      "GPPercentage": 1.0,
      "GPAmount": 1.0,
      "ItemReportingGroupPurchasesName": "sample string 16",
      "ItemReportingGroupSalesName": "sample string 3",
      "ItemReportingGroupInventoryName": "sample string 18",
      "ItemReportingGroupItemAdjustmentsName": "sample string 19",
      "AccountServiceItemRecoveryName": "sample string 20",
      "Attachments": [
        {
          "Name": "sample string 1",
          "Size": 2,
          "AttachmentUID": "848fa9dd-57f0-45ba-96a2-5733a4f34a95",
          "Data": "QEA="
        },
        {
          "Name": "sample string 1",
          "Size": 2,
          "AttachmentUID": "848fa9dd-57f0-45ba-96a2-5733a4f34a95",
          "Data": "QEA="
        }
      ],
      "PrescribedGoods": true,
      "QuantityReserved": 1.0,
      "HasSpecialCountryTaxActivity": true,
      "ID": 23,
      "AdditionalItemPrices": [
        {
          "ID": 1,
          "ItemId": 2,
          "PriceInclusive": 3.0,
          "PriceExclusive": 4.0,
          "AdditionalPriceListId": 5
        },
        {
          "ID": 1,
          "ItemId": 2,
          "PriceInclusive": 3.0,
          "PriceExclusive": 4.0,
          "AdditionalPriceListId": 5
        }
      ]
    }
  ]
}