msdyn_rma EntityType

Records RMAs for products to be retuned from customers

Entity Set Path
[organization URI]/api/data/v9.0/msdyn_rmas
Base Type
Display Name
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read Only
exchangerate Edm.Decimal

Shows the exchange rate for the currency associated with the entity with respect to the base currency.

Display Name: Exchange Rate

Read Only
importsequencenumber Edm.Int32

Shows the sequence number of the import that created this record.

Display Name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read Only
msdyn_autonumbering Edm.String

Internal field used to generate the next name upon entity creation. It is optionally copied to the msdyn_name field.

Display Name: Auto-Numbering

msdyn_daterequested Edm.DateTimeOffset

Enter the date RMA was requested by the customer.

Display Name: Date Requested

msdyn_description Edm.String

Enter a short description of the RMA.

Display Name: Description

msdyn_eta Edm.DateTimeOffset


Display Name: ETA

msdyn_name Edm.String

Shows the unique number identifying this RMA record.

Display Name: RMA Number

msdyn_packagingtrackingno Edm.String

Shows the tracking number of package

Display Name: Packaging Tracking No

msdyn_processingaction Edm.Int32

Shows the default action to be taken on all RMA Products.

Display Name: Processing Action

Default Options
Value Label
690970000 Create RTV
690970001 Return to Warehouse
690970002 Change Asset Ownership
msdyn_referenceno Edm.String

Display Name: Reference No

msdyn_rmaid Edm.Guid

Shows the entity instances.

Display Name: RMA

msdyn_shippingtrackingno Edm.String

Shows the tracking number of the shipment.

Display Name: Shipping Tracking No

msdyn_systemstatus Edm.Int32

Enter the current status of the RMA.

Display Name: System Status

Default Options
Value Label
690970000 Pending
690970001 Canceled
690970002 Products Received
msdyn_taxable Edm.Boolean

Specify if RMA is taxable

Display Name: Taxable

Default Options
Value Label
1 Yes
0 No
msdyn_totalamount Edm.Decimal

Shows the total amount of all RMA Products including tax.

Display Name: Total Amount

msdyn_totalamount_base Edm.Decimal

Shows the value of the total amount in the base currency.

Display Name: Total Amount (Base)

Read Only
overriddencreatedon Edm.DateTimeOffset

Shows the date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

Status of the RMA

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the RMA

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Shows the time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_msdyn_approvedby_value msdyn_approvedby

User who approved RMA

_msdyn_billingaccount_value msdyn_billingaccount

Account to be billed. If a billing account has been set on service account it will be populated by default. Otherwise, the billing account will be the same as the service account.

_msdyn_pricelist_value msdyn_pricelist

Price List that determines the pricing for this product

_msdyn_requestedbycontact_value msdyn_requestedbycontact

Contact who requested this return

_msdyn_serviceaccount_value msdyn_serviceaccount

Account to be serviced

_msdyn_shipvia_value msdyn_shipvia

Method of shipment by Customer

_msdyn_substatus_value msdyn_substatus

RMA Substatus

_msdyn_taxcode_value msdyn_taxcode

Tax Code to be used to calculate tax when RMA is taxable. By default the system will use the tax code specified on the service account

_msdyn_workorder_value msdyn_workorder

Work Order this RMA is linked to

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_transactioncurrencyid_value transactioncurrencyid

Unique identifier of the currency associated with the entity.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_msdyn_rma_createdby
createdonbehalfby systemuser lk_msdyn_rma_createdonbehalfby
modifiedby systemuser lk_msdyn_rma_modifiedby
modifiedonbehalfby systemuser lk_msdyn_rma_modifiedonbehalfby
msdyn_approvedby systemuser msdyn_systemuser_msdyn_rma_ApprovedBy
msdyn_billingaccount account msdyn_account_msdyn_rma_BillingAccount
msdyn_pricelist pricelevel msdyn_pricelevel_msdyn_rma_PriceList
msdyn_requestedbycontact contact msdyn_contact_msdyn_rma_RequestedByContact
msdyn_serviceaccount account msdyn_account_msdyn_rma_ServiceAccount
msdyn_shipvia msdyn_shipvia msdyn_msdyn_shipvia_msdyn_rma_ShipVia
msdyn_substatus msdyn_rmasubstatus msdyn_msdyn_rmasubstatus_msdyn_rma_SubStatus
msdyn_taxcode msdyn_taxcode msdyn_msdyn_taxcode_msdyn_rma_TaxCode
msdyn_workorder msdyn_workorder msdyn_msdyn_workorder_msdyn_rma_WorkOrder
ownerid principal owner_msdyn_rma
owningbusinessunit businessunit business_unit_msdyn_rma
owningteam team team_msdyn_rma
owninguser systemuser user_msdyn_rma
transactioncurrencyid transactioncurrency TransactionCurrency_msdyn_rma

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
msdyn_msdyn_rma_msdyn_rmaproduct_RMA msdyn_rmaproduct msdyn_rma
msdyn_msdyn_rma_msdyn_rmareceipt_RMA msdyn_rmareceipt msdyn_rma
msdyn_msdyn_rma_msdyn_rmareceiptproduct_RMA msdyn_rmareceiptproduct msdyn_rma
msdyn_msdyn_rma_msdyn_rtv_OriginatingRMA msdyn_rtv msdyn_originatingrma
msdyn_msdyn_rma_msdyn_rtvproduct_RMA msdyn_rtvproduct msdyn_rma
msdyn_rma_ActivityPointers activitypointer regardingobjectid_msdyn_rma
msdyn_rma_Annotations annotation objectid_msdyn_rma
msdyn_rma_Appointments appointment regardingobjectid_msdyn_rma_appointment
msdyn_rma_AsyncOperations asyncoperation regardingobjectid_msdyn_rma
msdyn_rma_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_rma
msdyn_rma_connections1 connection record1id_msdyn_rma
msdyn_rma_connections2 connection record2id_msdyn_rma
msdyn_rma_DuplicateBaseRecord duplicaterecord baserecordid_msdyn_rma
msdyn_rma_DuplicateMatchingRecord duplicaterecord duplicaterecordid_msdyn_rma
msdyn_rma_Emails email regardingobjectid_msdyn_rma_email
msdyn_rma_Faxes fax regardingobjectid_msdyn_rma_fax
msdyn_rma_Letters letter regardingobjectid_msdyn_rma_letter
msdyn_rma_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_rma
msdyn_rma_msdyn_approvals msdyn_approval regardingobjectid_msdyn_rma_msdyn_approval
msdyn_rma_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_msdyn_rma_msdyn_bookingalert
msdyn_rma_PhoneCalls phonecall regardingobjectid_msdyn_rma_phonecall
msdyn_rma_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_rma
msdyn_rma_ProcessSession processsession regardingobjectid_msdyn_rma
msdyn_rma_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_msdyn_rma_recurringappointmentmaster
msdyn_rma_ServiceAppointments serviceappointment regardingobjectid_msdyn_rma_serviceappointment
msdyn_rma_SharePointDocumentLocations sharepointdocumentlocation regardingobjectid_msdyn_rma
msdyn_rma_SocialActivities socialactivity regardingobjectid_msdyn_rma_socialactivity
msdyn_rma_SyncErrors syncerror regardingobjectid_msdyn_rma
msdyn_rma_Tasks task regardingobjectid_msdyn_rma_task


The following operations can be used with the msdyn_rma entity type.

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound


The following solutions include the msdyn_rma entity type.

Name Description
Field Service Microsoft Dynamics 365 for Field Service allows organizations of any size to deliver intelligent, world class field service, managing all aspects of the end-to-end field service management cycle. Features include scheduling, mobile, asset management, inventory control, customer notifications, and resource utilization controls that help maximize efficiency and minimize costs.

See also