PUT ItemAdjustment/id

Update an item adjustment

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

id Inverntory adjustment id. integer

Required

Body Parameters

Item adjustment details.

AdjustmentDetail
Name Description Type Additional information
Tags List of tags associated with this resource. Collection of string

None.

Notes Notes for this adjustment. string

None.

AdjustmentItems A list of item adjustments. Collection of AdjustmentItem

None.

Id The unique Id for the item adjustment. integer

None.

Date The date of the adjustments date

None.

Summary Brief summary for this adjustment. string

None.

RequiresFollowUp Indicates whether the adjustment requires follow up. boolean

None.

LastUpdatedId A data field used to check concurreny when performing updates. This data is returned only and used for concurrency checking when performing an update/PUT. string

None.

CreatedDateUtc The date and time this resource was created in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. date

None.

LastModifiedDateUtc The date and time this resource was last modified in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. date

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.

Request Formats

application/json, text/json

Sample:
{
  "Tags": [
    "IA, Test"
  ],
  "Notes": "Inventory Adjustmemt from API",
  "AdjustmentItems": [
    {
      "Quantity": 10.0,
      "ItemId": 24532,
      "AccountId": 111011,
      "UnitPrice": 1.0,
      "TotalPrice": 10.0
    },
    {
      "Quantity": 1.0,
      "ItemId": 1212,
      "AccountId": 111011,
      "UnitPrice": 100.0,
      "TotalPrice": 100.0
    }
  ],
  "Id": 2631,
  "Date": "2016-10-24T00:00:00",
  "Summary": "Brief summary of this adjustment.",
  "RequiresFollowUp": false,
  "LastUpdatedId": "AAAAAAAKgc=",
  "CreatedDateUtc": "2017-08-16T21:35:22.733172Z",
  "LastModifiedDateUtc": "2017-08-17T21:35:22.733172Z",
  "_links": []
}

application/xml, text/xml

Sample:
<AdjustmentDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_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>2017-08-16T21:35:22.733172Z</CreatedDateUtc>
  <LastModifiedDateUtc>2017-08-17T21:35:22.733172Z</LastModifiedDateUtc>
  <Tags>
    <string>IA, Test</string>
  </Tags>
  <Notes>Inventory Adjustmemt from API</Notes>
  <AdjustmentItems>
    <AdjustmentItem>
      <Quantity>10</Quantity>
      <ItemId>24532</ItemId>
      <AccountId>111011</AccountId>
      <UnitPrice>1</UnitPrice>
      <TotalPrice>10</TotalPrice>
    </AdjustmentItem>
    <AdjustmentItem>
      <Quantity>1</Quantity>
      <ItemId>1212</ItemId>
      <AccountId>111011</AccountId>
      <UnitPrice>100</UnitPrice>
      <TotalPrice>100</TotalPrice>
    </AdjustmentItem>
  </AdjustmentItems>
</AdjustmentDetail>

Response Information

Resource Description

UpdateItemAdjustmentResult
Name Description Type Additional information
Id Updated item adjustment id integer

None.

LastUpdatedId The unique identifier generated as part of the update. This value is required when submitting subsequent update to prevent concurrency errors. string

None.

UtcLastModified The date and time this resource was modified in UTC. date

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:
{
  "Id": 0,
  "LastUpdatedId": "AAAAYhg=",
  "UtcLastModified": "2017-08-12T21:35:22.733172Z",
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/ItemAdjustment/321?FileId=123",
      "method": "PUT",
      "title": null
    },
    {
      "rel": "delete",
      "href": "https://api.saasu.com/ItemAdjustment/321?FileId=123",
      "method": "DELETE",
      "title": null
    },
    {
      "rel": "list",
      "href": "https://api.saasu.com/ItemAdjustments?FileId=123",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<UpdateItemAdjustmentResult 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/ItemAdjustment/321?FileId=123</href>
      <method>PUT</method>
    </Link>
    <Link>
      <rel>delete</rel>
      <href>https://api.saasu.com/ItemAdjustment/321?FileId=123</href>
      <method>DELETE</method>
    </Link>
    <Link>
      <rel>list</rel>
      <href>https://api.saasu.com/ItemAdjustments?FileId=123</href>
      <method>GET</method>
    </Link>
  </_links>
  <LastUpdatedId>AAAAYhg=</LastUpdatedId>
  <UtcLastModified>2017-08-12T21:35:22.733172Z</UtcLastModified>
  <Id>0</Id>
</UpdateItemAdjustmentResult>