iotoms Docs

Dismiss a price variance

POST
/api/v1/pricing/variances/{id}/dismiss

Closes an open price variance on the worklist. Include a note explaining why it was dismissed so the reason is kept for later audit.

How to use it

  1. Find the variance ID with List price variances (status=OPEN).
  2. Send a note explaining why the difference is acceptable, plus dismissedBy for audit.
  3. The variance moves to DISMISSED and leaves the open count; dismissing it again is rejected.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

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
note?|

Why the variance is being dismissed, e.g. "freight included this time". Strongly recommended; kept for audit.

dismissedBy?|

Name or username of the reviewer, stored for audit.

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 price variance after the change.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/pricing/variances/497f6eca-6276-4993-bfeb-53cbbbba6f08/dismiss' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "occurredOn": "2019-08-24",    "documentType": "PURCHASE_ORDER",    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",    "documentNumber": "string",    "documentLineId": 0,    "partyRole": "SUPPLIER",    "partyId": "string",    "partyName": "string",    "itemId": "string",    "itemName": "string",    "uomId": "4df47f00-a69d-4ff2-b50d-4a7649a4b70c",    "currencyCode": "string",    "expectedRate": 0,    "expectedSource": "AGREEMENT",    "expectedSourceRef": "string",    "expectedObservedOn": "2019-08-24",    "documentRate": 0,    "qty": 0,    "varianceAmount": 0,    "variancePct": 0,    "status": "OPEN",    "dispositionNote": "string",    "dismissedBy": "string",    "dismissedAt": "2019-08-24T14:15:22Z",    "postingStatus": "NOT_APPLICABLE",    "journalEntryId": "72600ee4-b304-47f3-89cd-f685d2692490",    "postedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  }}