POST Item/Save

Saves the specified Item.

Request Information

URI Parameters

None.

Body Parameters

The Item.

Item

Name	Type	Additional information	Description
ID	integer	None.
Description	string	Required String length: inclusive between 0 and 100
Category	Item Category	None.
Code	string	Required String length: inclusive between 0 and 100
Active	bool	None.
PriceInclusive	decimal	None.
PriceExclusive	decimal	None.
Physical	bool	None.
TaxTypeIdSales	nullable integer	None.	Gets or sets the Tax Type identifier for sales. Only valid Tax Type ids are allowed.
TaxTypeSales	Tax Type	None.
TaxTypeIdPurchases	nullable integer	None.	Gets or sets the Tax Type identifier for purchases. Only valid Tax Type ids are allowed.
TaxTypePurchases	Tax Type	None.
LastCost	decimal	None.
AverageCost	decimal	Read Only / System Generated
QuantityOnHand	nullable decimal	Read Only / System Generated
HasAttachments	nullable bool	None.
HasActivity	bool	Read Only / System Generated
Unit	string	String length: inclusive between 0 and 100
ItemReportingGroupId_Sales	nullable integer	None.	Gets or sets the item reporting group id for sales. Only valid Item Reporting Groups are allowed.
ItemReportingGroupSales	Item Report Group	None.
ItemReportingGroupId_Purchases	nullable integer	None.	Gets or sets the item reporting group id for purchases. Only valid Item Reporting Groups are allowed.
ItemReportingGroupPurchases	Item Report Group	None.
ItemReportingGroupId_Inventory	nullable integer	None.	Gets or sets the item reporting group id for Inventory. Only valid Item Reporting Groups are allowed.
ItemReportingGroupInventory	Item Report Group	None.
ItemReportingGroupId_ItemAdjustments	nullable integer	None.	Gets or sets the item reporting group id for Item Adjustments. Only valid Item Reporting Groups are allowed.
AccountId_ServiceItemRecovery	nullable integer	None.	Gets or sets the Service Item Recovery Account id for Service Item Recovery transactions. Only valid Cost of Sales or Expense accounts are allowed.
ItemReportingGroupItemAdjustments	Item Report Group	None.
AccountServiceItemRecovery	Account	None.
TextUserField1	string	None.
TextUserField2	string	None.
TextUserField3	string	None.
NumericUserField1	nullable decimal	None.
NumericUserField2	nullable decimal	None.
NumericUserField3	nullable decimal	None.
DateUserField1	nullable date	None.
DateUserField2	nullable date	None.
DateUserField3	nullable date	None.
YesNoUserField1	nullable bool	None.
YesNoUserField2	nullable bool	None.
YesNoUserField3	nullable bool	None.
Modified	nullable date	Read Only / System Generated
Created	date	Read Only / System Generated
MajorIndustryCodeId	nullable integer	None.
AdditionalItemPrices	Collection of Additional Item Price	None.
GPPercentage	nullable decimal	None.
GPAmount	nullable decimal	None.
ItemReportingGroupPurchasesName	string	None.
ItemReportingGroupSalesName	string	None.
ItemReportingGroupInventoryName	string	None.
ItemReportingGroupItemAdjustmentsName	string	None.
AccountServiceItemRecoveryName	string	None.
Attachments	Collection of Attachment	Read Only / System Generated
PrescribedGoods	bool	None.
QuantityReserved	nullable decimal	Read Only / System Generated
HasSpecialCountryTaxActivity	bool	None.

Request Formats

application/json, text/json

Sample:

{
  "Description": "sample string 1",
  "Category": {
    "Description": "sample string 1",
    "ID": 2,
    "Modified": "2024-11-15",
    "Created": "2024-11-15"
  },
  "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": "2024-11-15",
    "Modified": "2024-11-15",
    "TaxTypeDefaultUID": "cd91e2c6-a4b5-4288-86b0-75c34d30e921",
    "CompanyId": 9
  },
  "TaxTypeIdPurchases": 1,
  "TaxTypePurchases": {
    "ID": 1,
    "Name": "sample string 2",
    "Percentage": 3.1,
    "IsDefault": true,
    "HasActivity": true,
    "IsManualTax": true,
    "Active": true,
    "Created": "2024-11-15",
    "Modified": "2024-11-15",
    "TaxTypeDefaultUID": "cd91e2c6-a4b5-4288-86b0-75c34d30e921",
    "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "AccountServiceItemRecovery": {
    "Name": "sample string 2",
    "Category": {
      "Comment": "sample string 1",
      "Order": 6,
      "Description": "sample string 7",
      "ID": 8,
      "Modified": "2024-11-15",
      "Created": "2024-11-15"
    },
    "Active": true,
    "Balance": 4.0,
    "Description": "sample string 5",
    "ReportingGroupId": 1,
    "UnallocatedAccount": true,
    "IsTaxLocked": true,
    "Modified": "2024-11-15",
    "Created": "2024-11-15",
    "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": "2024-11-15",
      "Modified": "2024-11-15",
      "TaxTypeDefaultUID": "cd91e2c6-a4b5-4288-86b0-75c34d30e921",
      "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": "2024-11-15",
  "DateUserField2": "2024-11-15",
  "DateUserField3": "2024-11-15",
  "YesNoUserField1": true,
  "YesNoUserField2": true,
  "YesNoUserField3": true,
  "Modified": "2024-11-15",
  "Created": "2024-11-15",
  "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": "70f4cd82-6468-4b4f-8f57-67af5b2b5d75",
      "Data": "QEA="
    },
    {
      "Name": "sample string 1",
      "Size": 2,
      "AttachmentUID": "70f4cd82-6468-4b4f-8f57-67af5b2b5d75",
      "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
    }
  ]
}

Response Information

Resource Description

Item

Name	Type	Additional information	Description
ID	integer	None.
Description	string	Required String length: inclusive between 0 and 100
Category	Item Category	None.
Code	string	Required String length: inclusive between 0 and 100
Active	bool	None.
PriceInclusive	decimal	None.
PriceExclusive	decimal	None.
Physical	bool	None.
TaxTypeIdSales	nullable integer	None.	Gets or sets the Tax Type identifier for sales. Only valid Tax Type ids are allowed.
TaxTypeSales	Tax Type	None.
TaxTypeIdPurchases	nullable integer	None.	Gets or sets the Tax Type identifier for purchases. Only valid Tax Type ids are allowed.
TaxTypePurchases	Tax Type	None.
LastCost	decimal	None.
AverageCost	decimal	Read Only / System Generated
QuantityOnHand	nullable decimal	Read Only / System Generated
HasAttachments	nullable bool	None.
HasActivity	bool	Read Only / System Generated
Unit	string	String length: inclusive between 0 and 100
ItemReportingGroupId_Sales	nullable integer	None.	Gets or sets the item reporting group id for sales. Only valid Item Reporting Groups are allowed.
ItemReportingGroupSales	Item Report Group	None.
ItemReportingGroupId_Purchases	nullable integer	None.	Gets or sets the item reporting group id for purchases. Only valid Item Reporting Groups are allowed.
ItemReportingGroupPurchases	Item Report Group	None.
ItemReportingGroupId_Inventory	nullable integer	None.	Gets or sets the item reporting group id for Inventory. Only valid Item Reporting Groups are allowed.
ItemReportingGroupInventory	Item Report Group	None.
ItemReportingGroupId_ItemAdjustments	nullable integer	None.	Gets or sets the item reporting group id for Item Adjustments. Only valid Item Reporting Groups are allowed.
AccountId_ServiceItemRecovery	nullable integer	None.	Gets or sets the Service Item Recovery Account id for Service Item Recovery transactions. Only valid Cost of Sales or Expense accounts are allowed.
ItemReportingGroupItemAdjustments	Item Report Group	None.
AccountServiceItemRecovery	Account	None.
TextUserField1	string	None.
TextUserField2	string	None.
TextUserField3	string	None.
NumericUserField1	nullable decimal	None.
NumericUserField2	nullable decimal	None.
NumericUserField3	nullable decimal	None.
DateUserField1	nullable date	None.
DateUserField2	nullable date	None.
DateUserField3	nullable date	None.
YesNoUserField1	nullable bool	None.
YesNoUserField2	nullable bool	None.
YesNoUserField3	nullable bool	None.
Modified	nullable date	Read Only / System Generated
Created	date	Read Only / System Generated
MajorIndustryCodeId	nullable integer	None.
AdditionalItemPrices	Collection of Additional Item Price	None.
GPPercentage	nullable decimal	None.
GPAmount	nullable decimal	None.
ItemReportingGroupPurchasesName	string	None.
ItemReportingGroupSalesName	string	None.
ItemReportingGroupInventoryName	string	None.
ItemReportingGroupItemAdjustmentsName	string	None.
AccountServiceItemRecoveryName	string	None.
Attachments	Collection of Attachment	Read Only / System Generated
PrescribedGoods	bool	None.
QuantityReserved	nullable decimal	Read Only / System Generated
HasSpecialCountryTaxActivity	bool	None.

Response Formats

application/json, text/json

Sample:

{
  "Description": "sample string 1",
  "Category": {
    "Description": "sample string 1",
    "ID": 2,
    "Modified": "2024-11-15",
    "Created": "2024-11-15"
  },
  "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": "2024-11-15",
    "Modified": "2024-11-15",
    "TaxTypeDefaultUID": "c76f0a40-7b53-4560-b7d0-2dd1235d1296",
    "CompanyId": 9
  },
  "TaxTypeIdPurchases": 1,
  "TaxTypePurchases": {
    "ID": 1,
    "Name": "sample string 2",
    "Percentage": 3.1,
    "IsDefault": true,
    "HasActivity": true,
    "IsManualTax": true,
    "Active": true,
    "Created": "2024-11-15",
    "Modified": "2024-11-15",
    "TaxTypeDefaultUID": "c76f0a40-7b53-4560-b7d0-2dd1235d1296",
    "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "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": "2024-11-15",
      "Created": "2024-11-15"
    }
  },
  "AccountServiceItemRecovery": {
    "Name": "sample string 2",
    "Category": {
      "Comment": "sample string 1",
      "Order": 6,
      "Description": "sample string 7",
      "ID": 8,
      "Modified": "2024-11-15",
      "Created": "2024-11-15"
    },
    "Active": true,
    "Balance": 4.0,
    "Description": "sample string 5",
    "ReportingGroupId": 1,
    "UnallocatedAccount": true,
    "IsTaxLocked": true,
    "Modified": "2024-11-15",
    "Created": "2024-11-15",
    "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": "2024-11-15",
      "Modified": "2024-11-15",
      "TaxTypeDefaultUID": "c76f0a40-7b53-4560-b7d0-2dd1235d1296",
      "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": "2024-11-15",
  "DateUserField2": "2024-11-15",
  "DateUserField3": "2024-11-15",
  "YesNoUserField1": true,
  "YesNoUserField2": true,
  "YesNoUserField3": true,
  "Modified": "2024-11-15",
  "Created": "2024-11-15",
  "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": "3afeefc7-493f-4b79-9842-87e009f52438",
      "Data": "QEA="
    },
    {
      "Name": "sample string 1",
      "Size": 2,
      "AttachmentUID": "3afeefc7-493f-4b79-9842-87e009f52438",
      "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
    }
  ]
}