Sales return line items
A line of a sales return, with the product and quantity being returned.
- API name:
salesorderreturnitems - Domain: Sales
- Modules: Sales analytics, Sales, Stores
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Sales order return | salesorderreturnId | Reference | Yes | |
| Product | productitemId | Reference | ||
| Quantity | quantity | Quantity | Quantity returned in the sales order line unit. | |
| Unit price | unitPrice | Unit price | Price for one unit, before line discount. Includes tax only when the document price basis is gross. | |
| Sales order line | salesorderitemId | Reference | Yes | |
| Issue line | inventoryissuenoteitemId | Reference | ||
| Identifier | inventoryidentifierId | Reference | ||
| Line price | sourceUnitPrice | Currency | Amount in the document or line currency. | |
| Line tax | sourceTax | Currency | Amount in the document or line currency. | |
| Re-entry site | siteIdReentry | Reference | ||
| Re-entry location | sitelocationId | Reference | ||
| Reason | reason | Constant | Fixed option from the allowed set for this field. | |
| 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 | ||
| 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 |
|---|---|---|
Sales order return salesorderreturnId | Sales returns | owned by |
Product productitemId | Product items | reference |
Sales order line salesorderitemId | Sales order line items | reference |
Issue line inventoryissuenoteitemId | Goods issue note removals | reference |
Re-entry site siteIdReentry | Sites | reference |
Re-entry location sitelocationId | Site locations | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesorderreturnitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new line item. | App · API · MCP · CLI |
| Edit | update | Save changes to this line item. | App · API · MCP · CLI |
| Delete | delete | Delete this line item and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |