List RMAs
Retrieves a list of RMAs from the data source using the provided 3PL account token.
Headers
Authorization: Basic ABC123
get
Authorizations
AuthorizationstringRequired
Query parameters
idnumberOptional
A comma-separated list of RMA ids
rma_numberstringOptional
A comma-separated list of RMA numbers
created_at_minstringOptional
Show RMA created at or after date (format: 2014-04-25T16:15:47-04:00)
updated_at_minstringOptional
Show RMA updated at or after date (format: 2014-04-25T16:15:47-04:00)
created_at_maxstringOptional
Show RMA created at or before date (format: 2014-04-25T16:15:47-04:00)
updated_at_maxstringOptional
Show RMA updated at or before date (format: 2014-04-25T16:15:47-04:00)
statusstringOptional
A comma-separated list of statuses
since_idstringOptional
Restrict results to after the specified ID
customer_namestringOptional
A comma-separated list of customer names
store_namestringOptional
A comma-separated list of store names
third_party_ref_nostringOptional
A comma-separated list of third party reference numbers
ref_nostringOptional
A comma-separated list of sales order reference numbers
account_tokenstringRequired
A unique authentication token assigned to each 3PL account within the system
pagenumberRequired
Page number for the query result set. Default = 1
exclude_processedstringOptional
This will exclude processed orders
Responses
200
OK
application/json
IsForwardRequestbooleanOptional
MessagestringOptional
MessageTitlestring · nullableOptional
ResultbooleanOptional
get/api/xerp/account3pl/getrma
GET /api/xerp/account3pl/getrma?account_token=text&page=1 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*
200
OK
{
"Data": [
{
"rmaHeader": {
"ASNCreatedFlag": false,
"ASNId": 0,
"ASNNumber": "",
"AccntReceivableId": "B7744F1BD912C85895EA7D9E4A93",
"AccntReceivableName": "Accounts Receivable CAD",
"Amount": 1050,
"AmountApplied": 0,
"AmountRefunded": 0,
"AmountRemaining": 1050,
"AmountToApply": 0,
"AuthorizationDetailList": null,
"BatchUploadFlag": false,
"CreateDttm": "06/23/2023 02:17:49 AM",
"CreateSource": "xoro@test",
"CreditId": 0,
"CreditMemoId": 0,
"CreditMemoNumber": "",
"CurrencyCode": "CAD",
"CurrencyId": 1,
"CurrencyName": null,
"CurrencySymbol": "$ ",
"CustomFieldH1": null,
"CustomFieldH10": null,
"CustomFieldH11": null,
"CustomFieldH12": null,
"CustomFieldH13": null,
"CustomFieldH14": null,
"CustomFieldH15": null,
"CustomFieldH16": null,
"CustomFieldH17": null,
"CustomFieldH18": null,
"CustomFieldH19": null,
"CustomFieldH2": null,
"CustomFieldH20": null,
"CustomFieldH21": null,
"CustomFieldH22": null,
"CustomFieldH23": null,
"CustomFieldH24": null,
"CustomFieldH25": null,
"CustomFieldH26": null,
"CustomFieldH27": null,
"CustomFieldH28": null,
"CustomFieldH29": null,
"CustomFieldH3": null,
"CustomFieldH30": null,
"CustomFieldH31": null,
"CustomFieldH32": null,
"CustomFieldH33": null,
"CustomFieldH34": null,
"CustomFieldH35": null,
"CustomFieldH36": null,
"CustomFieldH37": null,
"CustomFieldH38": null,
"CustomFieldH39": null,
"CustomFieldH4": null,
"CustomFieldH40": null,
"CustomFieldH41": null,
"CustomFieldH42": null,
"CustomFieldH43": null,
"CustomFieldH44": null,
"CustomFieldH45": null,
"CustomFieldH46": null,
"CustomFieldH47": null,
"CustomFieldH48": null,
"CustomFieldH49": null,
"CustomFieldH5": null,
"CustomFieldH50": null,
"CustomFieldH6": null,
"CustomFieldH7": null,
"CustomFieldH8": null,
"CustomFieldH9": null,
"CustomerCurrencyId": "1",
"CustomerDefaultARId": "B7744F1BD912C85895EA7D9E4A93",
"CustomerEmailMain": "antaudio@yopmail.com",
"CustomerId": 231,
"CustomerMainPhone": "(234) 234-2342",
"CustomerName": "Ant Audio",
"DiscountAmount": 0,
"ExchangeRate": 1,
"ExpenseDiscountAccntId": "",
"ExpenseDiscountAccntName": null,
"ExpenseShippingAccntId": "",
"ExpenseShippingAccntName": null,
"HeaderTypeId": 20,
"Id": 316,
"ImportError": null,
"InvoiceDiscountUsed": 0,
"InvoiceId": null,
"InvoiceNumber": "",
"InvoiceShipMethodId": null,
"InvoiceShipMethodName": "",
"InvoiceShipTaxCodeId": null,
"InvoiceShipTaxCodeName": "",
"InvoiceShippingTermId": null,
"InvoiceShippingTermName": "",
"InvoiceShippingUsed": null,
"Memo": "",
"ModifyDttm": null,
"ModifySource": "",
"OldTxnDate": "06/23/2023",
"OpeningBalanceFlag": false,
"ProjectClassId": null,
"ProjectClassName": "",
"RMANumber": "ADF-R000306",
"RefNo": "",
"ReportDataObj": {
"EntityAccntId": "1FB69F8D-4EED-4693-B2C5-AA5BFCA283E1",
"EntityName": "Ant Audio",
"ReportEntityId": 111,
"TxnRefId": 316,
"TxnRefNumber": "ADF-R000306",
"TxnTypeId": 105,
"linkedTxnRefId": null
},
"ReturnTypeId": 20,
"SaleStoreId": 0,
"SaleStoreName": "",
"SalesRepFullName": null,
"SalesRepId": "",
"ShipToAddr": "123",
"ShipToAddr2": "",
"ShipToCity": "Burnaby",
"ShipToCompanyName": "MAIN",
"ShipToCountry": "Canada",
"ShipToEmail": "store@yopmail.com",
"ShipToFirstName": "Ant",
"ShipToLastName": "ABCD",
"ShipToPhoneNumber": "6452317890",
"ShipToState": "BC",
"ShipToZpCode": "V1M 3B5",
"ShippingAddress": {
"Addr": "123",
"Addr2": "",
"AddressId": 484,
"AddressInstructionId": 0,
"AddressTypeId": 20,
"AddressTypeName": "Ship To",
"AddressVerificationError": null,
"AddressVerificationWarning": null,
"City": "Burnaby",
"Company": null,
"CompanyName": "MAIN",
"Country": "Canada",
"CountryCode": null,
"CustomerId": null,
"CustomerName": null,
"DefaultFlag": true,
"DeleteFlag": false,
"EditState": true,
"Email": "store@yopmail.com",
"FirstName": "Ant",
"Id": 484,
"ImportError": null,
"IntAccountId": "1FB69F8D-4EED-4693-B2C5-AA5BFCA283E1",
"IsUpdateDefaultBillToAddr": false,
"IsUpdateDefaultShipToAddr": false,
"LastName": "ABCD",
"Name": "storeaddress",
"Phone": null,
"PhoneNumber": "6452317890",
"PostalZipCode": "V1M 3B5",
"ResidentialFlag": false,
"ShippingAccountNumber": "",
"State": "BC",
"StateCode": null
},
"ShippingTaxData": {
"taxItems": [],
"totalAmount": 0
},
"StatusId": 10,
"StatusName": "Open",
"StoreCode": null,
"StoreId": 10020,
"StoreName": "ADF",
"SubTotal": 0,
"SubTotalExclDiscount": 0,
"SysLockFlag": false,
"TaxSummaryDataText": null,
"ThirdPartyAdjSku": null,
"ThirdPartyAdjustTotalFlag": false,
"ThirdPartyDisplayName": "",
"ThirdPartyIconUrl": "",
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"ThirdPartyTotalRefundAmount": 0,
"TotalQty": 0,
"TxnDate": "06/23/2023",
"TxnId": "",
"TxnNumber": 0,
"TypeId": 10,
"TypeName": "Credit Memo",
"UnPostTranFlag": false,
"ValidUntilDate": "06/28/2023"
},
"rmaItemLineArry": [
{
"AllowedSellUOMList": null,
"Amount": 1000,
"AuthorizationDetailList": null,
"BaseUomId": 15,
"CreateDttm": "01/01/0001 12:00:00 AM",
"CreateSource": null,
"CustomFieldD1": "",
"CustomFieldD10": "",
"CustomFieldD11": "",
"CustomFieldD12": "",
"CustomFieldD13": "",
"CustomFieldD14": "",
"CustomFieldD15": "",
"CustomFieldD16": "",
"CustomFieldD17": "",
"CustomFieldD18": "",
"CustomFieldD19": "",
"CustomFieldD2": "",
"CustomFieldD20": "",
"CustomFieldD21": "",
"CustomFieldD22": "",
"CustomFieldD23": "",
"CustomFieldD24": "",
"CustomFieldD25": "",
"CustomFieldD26": "",
"CustomFieldD27": "",
"CustomFieldD28": "",
"CustomFieldD29": "",
"CustomFieldD3": "",
"CustomFieldD30": "",
"CustomFieldD31": "",
"CustomFieldD32": "",
"CustomFieldD33": "",
"CustomFieldD34": "",
"CustomFieldD35": "",
"CustomFieldD36": "",
"CustomFieldD37": "",
"CustomFieldD38": "",
"CustomFieldD39": "",
"CustomFieldD4": "",
"CustomFieldD40": "",
"CustomFieldD41": "",
"CustomFieldD42": "",
"CustomFieldD43": "",
"CustomFieldD44": "",
"CustomFieldD45": "",
"CustomFieldD46": "",
"CustomFieldD47": "",
"CustomFieldD48": "",
"CustomFieldD49": "",
"CustomFieldD5": "",
"CustomFieldD50": "",
"CustomFieldD6": "",
"CustomFieldD7": "",
"CustomFieldD8": "",
"CustomFieldD9": "",
"DeleteFlag": false,
"Description": "item description",
"Discount": 0,
"DiscountTypeId": -1,
"EditState": true,
"EffectiveUnitPrice": 200,
"Id": 10495,
"InventoryLocChangeList": null,
"InvoiceLineId": -1,
"IsReceivableFlag": false,
"IsTaxableFlag": true,
"ItemId": 46475,
"ItemNumber": " ARP-FR-M-125-36-G-BLK-L",
"ItemTypeId": 10,
"ItemTypeName": "Inventory",
"ItemUpc": null,
"LineNumber": 1,
"ModifyDttm": null,
"ModifySource": null,
"OldQty": 5,
"OpenFlag": false,
"ProjectClassId": null,
"ProjectClassName": "",
"Qty": 5,
"QtyAvailableToReceive": null,
"QtyDecimalFlag": true,
"QtyInReceiving": 0,
"QtyOpenAsn": null,
"QtyReceived": null,
"QtyRemaining": 5,
"RMAId": 316,
"Rate": 200,
"ReturnCodeId": 20,
"ReturnCodeName": "CS",
"ReturnNotes": "",
"RmaNumber": null,
"StatusId": 10,
"StatusName": null,
"StoreId": null,
"StoreName": null,
"TaxAmount": 50,
"TaxCodeId": 2,
"TaxCodeName": "GST 5% (AB, BC, MB, NWT, QC, SK)",
"TaxData": {
"taxItems": [
{
"itemAmount": 50,
"itemId": 100,
"itemName": "GST on Sale 5%",
"itemRatePerc": 5,
"lineAmount": 1000
}
],
"totalAmount": 50
},
"TaxItems": [
{
"Id": 100,
"Name": "GST on Sale 5%",
"Rate": 0,
"RateType": "percentage",
"TotalAmount": 50
}
],
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"TxnId": null,
"TxnNumber": 0,
"UomFactor": 1,
"UomId": 15,
"UomName": "KG",
"VASDiscountableFlag": false,
"VASItemCost": null,
"VASItemCostTotal": null,
"VASItemId": null,
"VASItemName": null,
"VASTaxableFlag": false,
"ValidUntilDate": "01/01/0001"
}
]
}
],
"IsForwardRequest": false,
"Message": "Data loaded successfully",
"MessageTitle": null,
"Result": true
}Last updated
Was this helpful?