Return Authorization
A return authorization transaction, also known as a return materials authorization (RMA), records information about an expected return of items from a customer, including the item IDs, vendors, quantities, and prices (which determine the amounts to be credited or refunded to the customer. This transaction is non-posting. It is available when the Return Authorizations feature is enabled.
For more details about this type of transaction, see Customer Return Management.
The return authorization record is defined in the tranCust (customers) XSD.
Supported Operations
add | addList | attach / detach | delete | deleteList | get | getDeleted | getList | getSavedSearch | getSelectValue | initialize / initializeList | search | update | updateList | upsert | upsertList
You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.
Field Definitions
The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s return authorization reference page.
For information about using the SOAP Schema Browser, see SOAP Schema Browser.
Usage Notes
Working with Credit Card Data
When working with credit card data, be aware of the following security features:
-
When adding a transaction that uses a credit card number, you cannot identify the credit card number using a masked value such as ************5151. You must enter the full 16-digit number, or you can identify an existing credit card record through a RecordRef. (You can identify the full number using the ccNumber field. You can reference an existing record using the creditCard field.)
-
Searches do not work if they include the operator is or isNot in conjunction with the ccNumber field. The only search operators that can apply to this field are empty and notEmpty.
Initializing Return Authorizations
You can initialize a Return Authorization from a Cash Sale, an Invoice, or a Sales Order.
The SOAP web services initialize operation emulates the UI workflow by prepopulating fields on transaction line items with values from a related record. For more information about this operation, see initialize / initializeList.
Working with Return Authorization Sublists
The SOAP Schema Browser includes all sublists associated with the return authorization record. See the following information for usage notes regarding specific return authorization sublists. Usage notes are not provided for every sublist type.
ReturnAuthorizationItemList
To access per line tax fields, the Per-Line Taxes on Transactions feature must be enabled.
Accessing Serial or Lot Number Data for Line Items
As of the 2011.2 endpoint, code to access serial number or lot number data varies according to whether the Advanced Bin Management / Numbered Inventory Management feature is enabled.
-
If this feature is enabled, you must use the 2011.2 endpoint or later to access the Inventory Detail subrecord and the most up-to-date bin and numbered inventory fields. You need to update any SOAP web services code from a previous endpoint that accesses these fields, to avoid errors or unexpected results.
-
If this feature is not enabled, you do not need to use the inventory detail record to access bin and numbered inventory fields and you do not need to update any related SOAP web services code from prior to 2011.2.
For more details, see Updating SOAP Web Services Code When Advanced Bin / Numbered Inventory Management is Enabled.