iotoms Docs

Update an agreed price's notes or end date

PATCH
/api/v1/pricing/agreements/{id}

Changes only the notes and validity of an agreement. The rate itself cannot be changed here; use the revise endpoint, which keeps the previous rate as history.

How to use it

  1. Find the ACTIVE agreement's ID with List agreed prices.
  2. Send a new validTo, clearValidTo=true to make it open-ended, and/or new notes.
  3. Only dates and notes change; to change the rate use Revise an agreed price.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Query Parameters

actor?string

Name or username of the person making the change, stored on the agreement for audit.

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Request Body

application/json
  1. body
validTo?|

New last day for the agreement, YYYY-MM-DD, not before its start date. Ignored when clearValidTo is true.

Formatdate
clearValidTo*boolean

true removes the end date so the agreement becomes open-ended. Optional; defaults to false.

notes?|

Replacement notes. Send an empty string to clear them; omit to leave them unchanged.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?

The agreed price. For a revision this is the new agreement, not the one it replaced.

Example Request
curl -X PATCH 'https://beta.iotoms.com/api/v1/pricing/agreements/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "clearValidTo": true}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "partyRole": "SUPPLIER",    "partyId": "string",    "partyName": "string",    "itemId": "string",    "itemName": "string",    "categoryId": "string",    "uomId": "4df47f00-a69d-4ff2-b50d-4a7649a4b70c",    "uomCode": "string",    "currencyCode": "string",    "rate": 0,    "taxInclusive": true,    "minQty": 0,    "validFrom": "2019-08-24",    "validTo": "2019-08-24",    "status": "ACTIVE",    "supersedesId": "688cf67a-2e6c-4e49-8750-5bc8809fcd6f",    "supersededById": "af9b715c-a460-4411-a694-40645ca4c9a7",    "source": "MANUAL",    "sourceRef": "string",    "notes": "string",    "createdBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedBy": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "inForceToday": true  }}