INVRMA: Vendor RMA
A return merchandise authorisation for items being returned to a vendor, covering defective, damaged, or warranty claims on purchased inventory.
Default definition. This article describes the default
INVRMA definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches INVRMA.Entity properties
| Property | Value |
|---|---|
| Entity code | INVRMA |
| Display name | Vendor RMA |
| Plural | Vendor RMAs |
| Level | 55000 |
Use cases
Tracks the full lifecycle of returning purchased inventory to vendors. Three-column layout: left (30%) has RMA details (reference, reason, status workflow, priority, dates), middle (30%) has item and vendor info (component, inventory item, serial, quantity, vendor lookup, PO reference, original value), right (40%) has resolution and logistics (vendor RMA number, resolution type, shipping/tracking, credit/refund amount, notes). Status workflow: raised → vendor-approved → shipped → vendor-received → resolved / rejected.
Fields
RMA Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | RMA Reference. |
reason | enum | Yes | Valid ids: defective (Defective / Faulty), damaged (Damaged in Transit), wrongItem (Wrong Item Received), warranty (Warranty Claim), doa (Dead on Arrival), intermittent (Intermittent Fault), recall (Vendor Recall). |
status | enum | Yes | Valid ids: raised (Raised), vendorApproved (Vendor Approved), shipped (Shipped to Vendor), vendorReceived (Received by Vendor), resolved (Resolved), rejected (Rejected by Vendor), cancelled (Cancelled). |
priority | enum | Valid ids: low (Low), normal (Normal), high (High), critical (Critical). | |
raisedDate | date | Date Raised. | |
resolvedDate | date | Date Resolved. |
Item & Vendor
| Field | Type | Required | Notes |
|---|---|---|---|
componentId | reference → COMP | Yes | Component. |
inventoryId | reference → COMPINV | Inventory Item. | |
serialNumber | text | Serial Number. | |
qty | number | Yes | Quantity. |
vendorId | reference → VEN | Yes | Vendor. |
poRef | text | Original PO Reference. | |
originalValue | number | Original Value. |
Resolution & Logistics
| Field | Type | Required | Notes |
|---|---|---|---|
vendorRmaNumber | text | RMA reference provided by the vendor | |
resolution | enum | Valid ids: replacement (Replacement Unit), refund (Full Refund), repair (Repair & Return), creditNote (Credit Note), partialRefund (Partial Refund). | |
returnTrackingNumber | text | Return Tracking Number. | |
replacementTrackingNumber | text | Replacement Tracking Number. | |
creditAmount | number | Credit / Refund Amount. | |
faultDescription | text (multi-line) | Fault Description. | |
notes | text (multi-line) | Notes. |
Relationships
- Lookups:
componentIdpoints at aCOMPrecord;inventoryIdpoints at aCOMPINVrecord;vendorIdpoints at aVENrecord.
Creating a Vendor RMA via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "INVRMA",
"level": 55000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"reason": "defective",
"status": "raised",
"componentId": ""
} Listing Vendor RMAs
# All records in your tenant
GET /v1/entities/INVRMA/SUB:<your-sub-id>