Help Page Home - Items
GET Items
Retrieves a list of items.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
| FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
| LastModifiedFromDate | Filter records with LastModifiedDate greater than or equal to a date in UTC (must also specifiy LastModifiedToDate). | date |
None. |
| LastModifiedToDate | Filter records with LastModifiedDate less than or equal to a date in UTC (must also specifiy LastModifiedFromDate). | date |
None. |
| IsActive | Filter records that are either Active (IsActive=true) or Inactive (IsActive=false). | boolean |
None. |
| ItemType | Filter item records by type. | string |
None. |
| SearchMethod | Filter item records by specifying search method to search which can be either 'Contains' or 'StartsWith' and searches on the code or description. | string |
None. |
| SearchText | Filter item records by specifying text to search for in code or description. | string |
None. |
| Page | Specifies the page number of the result set to return. | integer |
None. |
| PageSize | Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified. | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ItemSummaryResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | The list of inventory items. | Collection of ItemSummary |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"Items": [
{
"Id": 12,
"Code": "ABC",
"Description": "Some item",
"Type": "I",
"IsActive": true,
"IsInventoried": false,
"AssetAccountId": 123,
"IsSold": true,
"SaleIncomeAccountId": 789,
"SaleTaxCodeId": 112,
"SaleCoSAccountId": 456,
"IsBought": true,
"PurchaseExpenseAccountId": 567,
"PurchaseTaxCodeId": 123,
"MinimumStockLevel": 2.0,
"StockOnHand": 10.0,
"CurrentValue": 10.1,
"PrimarySupplierContactId": 123,
"PrimarySupplierItemCode": "XYZ",
"DefaultReOrderQuantity": 5.0,
"LastUpdatedId": "AAAAAKgc=",
"IsVisible": true,
"IsVirtual": false,
"VType": "ZYX",
"SellingPrice": 20.99,
"IsSellingPriceIncTax": true,
"CreatedDateUtc": "2024-05-03T19:00:13.0428462Z",
"LastModifiedDateUtc": "2024-04-23T19:00:13.0428462Z",
"LastModifiedBy": 123,
"BuyingPrice": 10.2,
"IsBuyingPriceIncTax": true,
"IsVoucher": false,
"ValidFrom": "2024-04-13T19:00:13.0428462Z",
"ValidTo": "2024-05-23T19:00:13.0428462Z",
"OnOrder": null,
"Committed": null,
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/Item/12?FileId=123",
"method": "GET",
"title": null
}
]
},
{
"Id": 13,
"Code": "ABC",
"Description": "Some other item",
"Type": "I",
"IsActive": true,
"IsInventoried": false,
"AssetAccountId": 789,
"IsSold": true,
"SaleIncomeAccountId": 789,
"SaleTaxCodeId": 112,
"SaleCoSAccountId": 456,
"IsBought": true,
"PurchaseExpenseAccountId": 567,
"PurchaseTaxCodeId": 123,
"MinimumStockLevel": 2.0,
"StockOnHand": 10.0,
"CurrentValue": 11.1,
"PrimarySupplierContactId": 123,
"PrimarySupplierItemCode": "XYZ",
"DefaultReOrderQuantity": 5.0,
"LastUpdatedId": "AAAAABgc=",
"IsVisible": true,
"IsVirtual": false,
"VType": "AB",
"SellingPrice": 20.99,
"IsSellingPriceIncTax": true,
"CreatedDateUtc": "2024-05-03T19:00:13.0428462Z",
"LastModifiedDateUtc": "2024-04-23T19:00:13.0428462Z",
"LastModifiedBy": 123,
"BuyingPrice": 11.2,
"IsBuyingPriceIncTax": true,
"IsVoucher": false,
"ValidFrom": "2024-04-13T19:00:13.0428462Z",
"ValidTo": "2024-05-23T19:00:13.0428462Z",
"OnOrder": null,
"Committed": null,
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/Item/13?FileId=123",
"method": "GET",
"title": null
}
]
}
],
"_links": [
{
"rel": "self",
"href": "https://api.saasu.com/Items?FileId=123",
"method": "GET",
"title": null
},
{
"rel": "next",
"href": "https://api.saasu.com/Items?FileId=123&Page=2&PageSize=25",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<ItemSummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<_links>
<Link>
<rel>self</rel>
<href>https://api.saasu.com/Items?FileId=123</href>
<method>GET</method>
</Link>
<Link>
<rel>next</rel>
<href>https://api.saasu.com/Items?FileId=123&Page=2&PageSize=25</href>
<method>GET</method>
</Link>
</_links>
<Items>
<ItemSummary>
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/Item/12?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<Id>12</Id>
<Code>ABC</Code>
<Description>Some item</Description>
<Type>I</Type>
<IsActive>true</IsActive>
<IsInventoried>false</IsInventoried>
<AssetAccountId>123</AssetAccountId>
<IsSold>true</IsSold>
<SaleIncomeAccountId>789</SaleIncomeAccountId>
<SaleTaxCodeId>112</SaleTaxCodeId>
<SaleCoSAccountId>456</SaleCoSAccountId>
<IsBought>true</IsBought>
<PurchaseExpenseAccountId>567</PurchaseExpenseAccountId>
<PurchaseTaxCodeId>123</PurchaseTaxCodeId>
<MinimumStockLevel>2</MinimumStockLevel>
<StockOnHand>10</StockOnHand>
<CurrentValue>10.10</CurrentValue>
<PrimarySupplierContactId>123</PrimarySupplierContactId>
<PrimarySupplierItemCode>XYZ</PrimarySupplierItemCode>
<DefaultReOrderQuantity>5</DefaultReOrderQuantity>
<LastUpdatedId>AAAAAKgc=</LastUpdatedId>
<IsVisible>true</IsVisible>
<IsVirtual>false</IsVirtual>
<VType>ZYX</VType>
<SellingPrice>20.99</SellingPrice>
<IsSellingPriceIncTax>true</IsSellingPriceIncTax>
<CreatedDateUtc>2024-05-03T19:00:13.0428462Z</CreatedDateUtc>
<LastModifiedDateUtc>2024-04-23T19:00:13.0428462Z</LastModifiedDateUtc>
<LastModifiedBy>123</LastModifiedBy>
<BuyingPrice>10.20</BuyingPrice>
<IsBuyingPriceIncTax>true</IsBuyingPriceIncTax>
<IsVoucher>false</IsVoucher>
<ValidFrom>2024-04-13T19:00:13.0428462Z</ValidFrom>
<ValidTo>2024-05-23T19:00:13.0428462Z</ValidTo>
<OnOrder xsi:nil="true" />
<Committed xsi:nil="true" />
</ItemSummary>
<ItemSummary>
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/Item/13?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<Id>13</Id>
<Code>ABC</Code>
<Description>Some other item</Description>
<Type>I</Type>
<IsActive>true</IsActive>
<IsInventoried>false</IsInventoried>
<AssetAccountId>789</AssetAccountId>
<IsSold>true</IsSold>
<SaleIncomeAccountId>789</SaleIncomeAccountId>
<SaleTaxCodeId>112</SaleTaxCodeId>
<SaleCoSAccountId>456</SaleCoSAccountId>
<IsBought>true</IsBought>
<PurchaseExpenseAccountId>567</PurchaseExpenseAccountId>
<PurchaseTaxCodeId>123</PurchaseTaxCodeId>
<MinimumStockLevel>2</MinimumStockLevel>
<StockOnHand>10</StockOnHand>
<CurrentValue>11.10</CurrentValue>
<PrimarySupplierContactId>123</PrimarySupplierContactId>
<PrimarySupplierItemCode>XYZ</PrimarySupplierItemCode>
<DefaultReOrderQuantity>5</DefaultReOrderQuantity>
<LastUpdatedId>AAAAABgc=</LastUpdatedId>
<IsVisible>true</IsVisible>
<IsVirtual>false</IsVirtual>
<VType>AB</VType>
<SellingPrice>20.99</SellingPrice>
<IsSellingPriceIncTax>true</IsSellingPriceIncTax>
<CreatedDateUtc>2024-05-03T19:00:13.0428462Z</CreatedDateUtc>
<LastModifiedDateUtc>2024-04-23T19:00:13.0428462Z</LastModifiedDateUtc>
<LastModifiedBy>123</LastModifiedBy>
<BuyingPrice>11.20</BuyingPrice>
<IsBuyingPriceIncTax>true</IsBuyingPriceIncTax>
<IsVoucher>false</IsVoucher>
<ValidFrom>2024-04-13T19:00:13.0428462Z</ValidFrom>
<ValidTo>2024-05-23T19:00:13.0428462Z</ValidTo>
<OnOrder xsi:nil="true" />
<Committed xsi:nil="true" />
</ItemSummary>
</Items>
</ItemSummaryResponse>