Help Page Home - ItemAdjustments
GET ItemAdjustments
Retrieves a list of item adjustments.
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. |
| Tags | One or more tags that are used to filter the result set by. More tags can be separated with a comma, for example 'tags=tag1,tag2'. | string |
None. |
| TagSelection | Specifies how to filter when using the supplied tags.Valid values are: requireAny - filter records with ANY ONE of the supplied tags, requireAll - filter records with ALL of the supplied tags, excludeAny - filter records excluding any records with ANY ONE of the specified tags, excludeAll - filter records excluding any records with ALL of the specified tags. | string |
None. |
| FromDate | Filter records with Date greater than or equal to a date (must also specifiy ToDate). | string |
None. |
| ToDate | Filter records with Date less than or equal to a date (must also specifiy FromDate). | 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
ItemAdjustmentListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemAdjustments | List of item adjustments. | Collection of AdjustmentSummary |
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:
{
"ItemAdjustments": [
{
"Id": 2631,
"Date": "2016-10-24T00:00:00",
"Summary": "Brief summary of this adjustment.",
"RequiresFollowUp": false,
"LastUpdatedId": "AAAAAAAKgc=",
"CreatedDateUtc": "2025-12-08T18:00:12.9255046Z",
"LastModifiedDateUtc": "2025-12-09T18:00:12.9255046Z",
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/ItemAdjustment/2631?FileId=123",
"method": "GET",
"title": null
}
]
},
{
"Id": 8453,
"Date": "2016-11-24T00:00:00",
"Summary": "Brief summary of this adjustment.",
"RequiresFollowUp": false,
"LastUpdatedId": "AAAAAAAHbc=",
"CreatedDateUtc": "2025-12-07T18:00:12.9255046Z",
"LastModifiedDateUtc": "2025-12-09T18:00:12.9255046Z",
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/ItemAdjustment/8453?FileId=123",
"method": "GET",
"title": null
}
]
}
],
"_links": [
{
"rel": "self",
"href": "https://api.saasu.com/ItemAdjustments?FileId=123",
"method": "GET",
"title": null
},
{
"rel": "next",
"href": "https://api.saasu.com/ItemAdjustments?FileId=123&Page=2&PageSize=25",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<ItemAdjustmentListResponse 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/ItemAdjustments?FileId=123</href>
<method>GET</method>
</Link>
<Link>
<rel>next</rel>
<href>https://api.saasu.com/ItemAdjustments?FileId=123&Page=2&PageSize=25</href>
<method>GET</method>
</Link>
</_links>
<ItemAdjustments>
<AdjustmentSummary>
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/ItemAdjustment/2631?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<Id>2631</Id>
<Date>2016-10-24T00:00:00</Date>
<Summary>Brief summary of this adjustment.</Summary>
<RequiresFollowUp>false</RequiresFollowUp>
<LastUpdatedId>AAAAAAAKgc=</LastUpdatedId>
<CreatedDateUtc>2025-12-08T18:00:12.9255046Z</CreatedDateUtc>
<LastModifiedDateUtc>2025-12-09T18:00:12.9255046Z</LastModifiedDateUtc>
</AdjustmentSummary>
<AdjustmentSummary>
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/ItemAdjustment/8453?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<Id>8453</Id>
<Date>2016-11-24T00:00:00</Date>
<Summary>Brief summary of this adjustment.</Summary>
<RequiresFollowUp>false</RequiresFollowUp>
<LastUpdatedId>AAAAAAAHbc=</LastUpdatedId>
<CreatedDateUtc>2025-12-07T18:00:12.9255046Z</CreatedDateUtc>
<LastModifiedDateUtc>2025-12-09T18:00:12.9255046Z</LastModifiedDateUtc>
</AdjustmentSummary>
</ItemAdjustments>
</ItemAdjustmentListResponse>