Breadcrumbs

API - Warehouse Receipts

Overview

This API returns the Warehouse Receipts which are documents linked to Purchase Orders that are waiting to be received. There are also procedures to post the received items.

Endpoint name

warehouseReceipts

Source table

Warehouse Receipt

Fixed view

No filter

Requests allowed

GET

Primary Key

number

Record ID

number

Procedures

Additionally POST requests can be done on a procedure endpoints

  • ReceiveItem

  • ReceiveItemToBin

Data

Field List

Property

Type

Max Len

Description

non-editable

systemId

string uuid


The system id of the record.


number

string

20

No. of the Warehouse Receipt.

Record ID

locationCode

string

10

Location Code


document

string


The type of BC document that is being received, this can be either a Purchase Order, or a Sales return


documentNo

Decimal

20

The number of the document


documentSenderNo

string

20

Sender of the receipt, this would most of the time be a Vendor number.


documentSenderName

string

50

The name, i.e. usually a vendor name.


documentStatus

string


The status of the document, it can be

Released, Partly Received


vendorShipmentNo

string

20

If the vendor has his own shipment reference.


expectedReceiptDate

date


The expected receipt date, for a Purchase order, else it is blank.


noOfLines

integer


The number of lines (items) on the warehouse receipt. Usually it matches the lines on the (purchase) document.


lastModifiedDateTime

date-time utc


Timestamp for the Warehouse Receipt.


warehouseReceiptLines

array


The array that contains the lines of the Warehouse Receipt lines.

TODO: Link to the documentation page.


Example Object

Expand to see the example json

An example of one object, where the lines are also shown with expand:

JSON
{
    "@odata.etag": "W/\"JzE5OzExNDkwNjE5NzE5NDkxMTU4MjIxOzAwOyc=\"",
    "id": "711a766b-60c1-f011-b029-f0a715866b22",
    "number": "RE000014",
    "locationCode": "STD-WHS-R",
    "document": "Purchase Order",
    "documentNo": "106086",
    "documentSenderNo": "01905382",
    "documentSenderName": "NewCaSup",
    "documentStatus": " ",
    "vendorShipmentNo": "",
    "expectedReceiptDate": "2026-02-03",
    "noOfLines": 1,
    "lastModifiedDateTime": "2025-11-14T13:48:35.813Z",
    "warehouseReceiptLines": [
        {
            "@odata.etag": "W/\"JzE5OzczNDgyMDk3MTk2NzQ5MjY4NzYxOzAwOyc=\"",
            "receiptNumber": "RE000014",
            "itemNumber": "80216-T",
            "description": "Ethernet Cable",
            "binCode": "C",
            "quantity": 10,
            "quantityReceived": 0,
            "quantityToReceive": 1,
            "lastModifiedDateTime": "2025-11-14T13:48:35.593Z"
        }
    ]
}



Procedures

Service-enabled procedures are the following, see below.

This is exactly what it does behind the scenes, just like a use would be working on the Warehouse Receipt.

  1. Removes the Qty to Receive from all lines of the Warehouse Receipt

  2. Then finds the line for the given item, updates the Qty to Receive there

  3. Update the Bin Code, if given

  4. Then posts the receipt, same method as if user would post from BC.

If there are still items to be received, the Warehouse Receipt document remains in the system. Else it will be deleted.

image-20251119-114304.png


Receive Item

To post the receipt of an item, usually for a Purchase Order in Wisefish, but it could also be a Sales Return Order.

Usage

JSON
POST .../warehouseReceipts([number])/Microsoft.NAV.receiveItem

Body:
{
    "itemNumber": "[item number]",
    "quantity": [quantity],
    "lotNo": "[lot number]"
}

Parameters

itemNumber

The item number. There must be a line on the Warehouse Receipt for this item.

quantity

How many items to receive in the base unit

lotNo

May be empty if this item is not lot tracked.


Receive Item To Bin

Same as above, but with a Bin Code. This should be used when the Location requires a Bin.

Usage

JSON
POST .../warehouseReceipts([number])/Microsoft.NAV.receiveItemToBin

Body:
{
    "itemNumber": "[item number]",
    "quantity": [quantity],
    "binCode": "[bin code]",
    "lotNo": "[lot number]"
}

Parameters

itemNumber

The item number. There must be a line on the Warehouse Receipt for this item.

quantity

How many items to receive in the base unit

lotNo

May be empty if this item is not lot tracked.

binCode

Bin Code, that must exist as a Bin on the Location of the receipt line.

Example

JSON
POST .../warehouseReceipts('RE000014')/Microsoft.NAV.ReceiveItemToBin

Body:
{
    "itemNumber": "80216-T",
    "quantity": 1,
    "binCode": "C",
    "lotNo": "25-01"
}