Goods receipt note entries
A quantity of stock received into a location on a goods receipt note to fulfill a planned receipt.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Goods receipt note | inventoryreceiptnoteId | Reference | Yes | |
| Item | productitemId | Reference | ||
| Quantity | quantity | Quantity | Quantity in the catalog unit after any unit conversion on the line. | |
| Item | customitemId | Reference | ||
| Identifier | inventoryidentifierId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Unit | catalogunit | Unit | ||
| Line item | inventoryreceiptitemId | Reference | Yes | |
| Exchange rate | exchangerateId | Reference | ||
| On hold | isOnhold | Boolean | Yes | When enabled, the receipt posts to the on-hold bucket in addition to available stock. |
| Unit price | unitPrice | Unit price | Price for one unit, before line discount. Includes tax only when the document price basis is gross. | |
| Unit cost | unitCost | Unit price | Cost of the inventory per unit. | |
| Exchange rate date | dateFxrateSource | Date | Calendar date of the exchange rate used for conversion. | |
| Location | sitelocationId | Reference | Yes | |
| Zone | siteareaId | Reference | Yes | |
| Putaway location | sitelocationIdPutaway | Reference | ||
| Exchange rate | fxrate | Decimal | Multiplier from document currency to functional currency on this date. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Goods receipt note inventoryreceiptnoteId | Goods receipt notes | owned by |
Identifier inventoryidentifierId | Inventory identifiers | reference |
Line item inventoryreceiptitemId | Goods receipt line items | reference |
Exchange rate exchangerateId | Exchange rates | reference |
Location sitelocationId | Site locations | reference |
Zone siteareaId | Site areas | reference |
Putaway location sitelocationIdPutaway | Site locations | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryreceiptnoteitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new entry. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this entry. | App · API · MCP · CLI |
| Delete | delete | Delete this entry and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |