iotoms Docs

List goods receipts

GET
/api/v1/procurement/receipts

Returns goods receipts with their lines, newest first. Filter by purchaseOrderId or by vendorId; when both are sent, purchaseOrderId is used.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

purchaseOrderId?string

Optional. Only receipts against this purchase order. Takes priority over vendorId.

Formatuuid
vendorId?string

Optional. Only receipts from this vendor.

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 request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?array<>|

Goods receipts matching the filters, newest first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/procurement/receipts' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "grnNumber": "string",      "purchaseOrderId": "84a099d9-2935-4997-a6ac-0d3ee9bbef72",      "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",      "vendorName": "string",      "status": "string",      "receivedDate": "2019-08-24",      "deliveryNoteNumber": "string",      "receivedBy": "string",      "confirmedBy": "string",      "confirmedAt": "2019-08-24T14:15:22Z",      "notes": "string",      "items": [        {          "id": 0,          "itemId": "string",          "itemName": "string",          "receivedQty": 0,          "acceptedQty": 0,          "rejectedQty": 0,          "condition": "string",          "receivingLocationId": "f1f8626b-ea08-4582-99e5-64aabd817e6a",          "receivingLocationName": "string",          "unitCost": 0,          "measuredGrossWeight": 0,          "measuredNetWeight": 0,          "rejectedWeight": 0,          "packWeights": [            0          ],          "expectedWeight": 0,          "variancePct": 0,          "costPerBaseUnit": 0        }      ],      "createdAt": "2019-08-24T14:15:22Z"    }  ]}