API ReferenceReceiving Documents

Fetch Receiving Document

Fetches a specific receiving document by its ID.

Authentication

Impilo-API-Keystring
API Key authentication via header

Path Parameters

receivingDocumentIdlongRequired

Response

OK
activeboolean or null
Indicates whether the receiving document is active.
completedAtstring or nullformat: "date-time"
The timestamp when the receiving document was completed.
createTimestampstring or nullformat: "date-time"
The timestamp when the receiving document was created.
deviceIdslist of longs or null
List of device IDs included in the receiving document.
expectedReceiveDatestring or nullformat: "date"
The expected date for receiving the items.
idlong or null
The unique identifier of the receiving document.
impiloSiteenum or null
The Impilo site associated with the receiving document.
Allowed values:
isUsedDevicesboolean or null
Indicates whether the receiving document contains used devices.
itemIdslist of longs or null
List of item IDs included in the receiving document.
openboolean or null
Indicates whether the receiving document is open.
orderIdlong or null
The order ID associated with the receiving document, if applicable.
procurementIdslist of longs or null
List of procurement IDs associated with the receiving document.
receivingDocumentNoteslist of objects or null
Notes associated with the receiving document.
receivingDocumentTypeenum or null
The type of the receiving document.
Allowed values:
returnMerchAuthIdlong or null
The ID of the return merchandise authorization associated with the receiving document, if applicable.
trackingNumberslist of objects or null
Tracking numbers associated with the receiving document.