iotoms Docs

Get an agreed price's revision history

GET
/api/v1/pricing/agreements/{id}/history

Returns every agreement on the same party, item (or category), unit and currency as the given one, including the current one and all superseded and ended ones, newest first. For item agreements it also returns up to 10 recent rates seen on documents. Use it to answer what was agreed and when.

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.

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?

Every revision of the agreement plus the rates observed on documents.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/pricing/agreements/497f6eca-6276-4993-bfeb-53cbbbba6f08/history' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "revisions": [      {        "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      }    ],    "observations": [      {        "observedOn": "2019-08-24",        "unitRate": 0,        "uomId": "4df47f00-a69d-4ff2-b50d-4a7649a4b70c",        "uomCode": "string",        "currencyCode": "string",        "documentType": "PURCHASE_ORDER",        "documentId": "string",        "documentNumber": "string"      }    ]  }}