iotoms Docs

List price variances

GET
/api/v1/pricing/variances

Returns purchases that came in above or below the agreed or last-paid rate, filterable by status, role, partyId, itemId and a from/to date range. Paginated with 0-based page and size (default 25). Figures are frozen when recorded and variances never post to the ledger.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?string

OPEN | DISMISSED

Value in"OPEN""DISMISSED"
role?string

Only return variances for this side: SUPPLIER or CUSTOMER.

Value in"SUPPLIER""CUSTOMER"
partyId?string

Only return variances for this vendor ID (SUPPLIER) or customer number (CUSTOMER).

itemId?string

Only return variances for this item code.

from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate
page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default25

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?

One page of price variances with paging totals and the open count.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/pricing/variances' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "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"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "openCount": 0  }}