RMA
RMA Header:
Id
long
Unique identifier
RMANumber
string
RMA number
CreditId
long
Credit ID
InvoiceId
long?
Invoice ID (nullable)
InvoiceNumber
string
Invoice number
HeaderTypeId
int?
Header type ID (nullable)
TypeId
int?
Type ID (nullable)
ReturnTypeId
int?
Return type ID (nullable)
TypeName
string
Type name
TxnId
string
Transaction ID
TxnNumber
long
Transaction number
StoreId
int
Store ID
StoreName
string
Store name
StoreCode
string
Store code
SaleStoreId
int
Sale store ID
SaleStoreName
string
Sale store name
CustomerId
int
Customer ID
CurrencyName
string
Currency name
AccntReceivableId
string
Receivable account ID
AccntReceivableName
string
Receivable account name
CustomerName
string
Customer name
TxnDate
DateTime
Transaction date
OldTxnDate
DateTime
Old transaction date
CurrencyId
int
Currency ID
CurrencyCode
string
Currency code
CurrencySymbol
string
Currency symbol
StatusId
int
Status ID
StatusName
string
Status name
ExchangeRate
double
Exchange rate
RefNo
string
Reference number
Memo
string
Memo
Amount
double
Amount
AmountApplied
double
Applied amount
AmountRefunded
double
Refunded amount
AmountRemaining
double
Remaining amount
CreateDttm
DateTime
Creation date and time
CreateSource
string
Creation source
ModifyDttm
DateTime?
Modification date and time (nullable)
ModifySource
string
Modification source
AmountToApply
double
Amount to apply
InvoiceShippingUsed
double?
Used shipping amount (nullable)
ExpenseDiscountAccntId
string
Discount account ID
ExpenseDiscountAccntName
string
Discount account name
InvoiceDiscountUsed
double?
Used discount amount (nullable)
ExpenseShippingAccntId
string
Shipping account ID
InvoiceShippingTermId
int?
Shipping term ID (nullable)
InvoiceShippingTermName
string
Shipping term name
InvoiceShipMethodId
int?
Shipping method ID (nullable)
InvoiceShipMethodName
string
Shipping method name
InvoiceShipTaxCodeId
int?
Shipping tax code ID (nullable)
InvoiceShipTaxCodeName
string
Shipping tax code name
ExpenseShippingAccntName
string
Shipping account name
TaxSummaryDataText
string
Tax summary data text
OpeningBalanceFlag
bool
Opening balance flag
SysLockFlag
bool
System lock flag
UnPostTranFlag
bool
Unposted transaction flag
CustomerEmailMain
string
Main customer email
CustomerMainPhone
string
Main customer phone number
CustomerCurrencyId
string
Customer currency ID
CustomerDefaultARId
string
Customer default AR ID
ImportError
string
Import error message
BatchUploadFlag
bool
Batch upload flag
ASNCreatedFlag
bool
ASN created flag
ASNNumber
string
ASN number
ASNId
long
ASN ID
ShippingAddress
Address
Shipping address
ProjectClassId
int?
Project class ID (nullable)
ProjectClassName
string
Project class name
ShippingCreditAmount
double
Shipping credit amount
ThirdPartyRefNo
string
Third party reference number
ThirdPartySource
string
Third party source
ThirdPartyDisplayName
string
Third party display name
ThirdPartyIconUrl
string
Third party icon URL
ShippingTaxData
Tax.TaxData
Shipping tax data
TotalQty
double
Total quantity
SubTotalExclDiscount
double
Subtotal excluding discount
DiscountAmount
double
Discount amount
SubTotal
double
Subtotal
ThirdPartyTotalRefundAmount
double
Third party total refund amount
ThirdPartyAdjustTotalFlag
bool
Third party adjust total flag
ThirdPartyAdjSku
string
Third party adjusted SKU
SalesRepId
string
Sales representative ID
SalesRepFullName
string
Sales representative full name
CreditMemoId
long?
Credit memo ID (nullable)
CreditMemoNumber
string
Credit memo number
ShipToAddr
string
Shipping address
ShipToAddr2
string
Shipping address line 2
ShipToCity
string
Shipping city
ShipToState
string
Shipping state
ShipToFirstName
string
Shipping recipient's first name
ShipToCountry
string
Shipping country
ShipToLastName
string
Shipping recipient's last name
ShipToZpCode
string
Shipping ZIP code
ShipToCompanyName
string
Shipping company name
ShipToPhoneNumber
string
Shipping recipient's phone number
ShipToEmail
string
Shipping recipient's email
UpdateEnable
bool
Update enable flag
VoidAndCreate
bool
Void and create flag
AutoApprove
bool
Auto approve flag
AutoGenerateAsn
bool
Auto-generate ASN flag
QualityId
int?
Quality ID (nullable)
QualityName
string
Quality name
CustomerTypeId3PL
int?
3PL customer type ID (nullable)
AsnNotes
string
ASN notes
CustomFieldH1 - CustomFieldH50
string
Custom Fields (CustomFieldH1 - CustomFieldH50).
RMA Detail:
Id
long
ID
RMAId
long
RMA ID
InvoiceLineId
long?
Invoice line ID (nullable)
TxnId
string
Transaction ID
TxnNumber
long
Transaction number
LineNumber
int
Line number
ItemTypeId
int
Item type ID
ItemTypeName
string
Item type name
ItemId
long
Item ID
ItemNumber
string
Item number
Description
string
Description
StatusId
int
Status ID
Qty
double
Quantity
UomId
int
Unit of measure ID
UomName
string
Unit of measure name
OldQty
double
Old quantity
QtyDecimalFlag
bool
Quantity decimal flag
Discount
double?
Discount
DiscountTypeId
int?
Discount type ID
EffectiveUnitPrice
double?
Effective unit price
Rate
double
Rate
Amount
double
Amount
TaxCodeId
int?
Tax code ID (nullable)
TaxCodeName
string
Tax code name
TaxAmount
double
Tax amount
CreateDttm
DateTime
Creation date and time
CreateSource
string
Creation source
ModifyDttm
DateTime?
Modification date and time (nullable)
ModifySource
string
Modification source
DeleteFlag
bool
Delete flag
EditState
bool
Edit state flag
InventoryLocChangeList
List<InventoryLocationChange>
List of inventory location changes
ReturnCodeId
int?
Return code ID (nullable)
ReturnCodeName
string
Return code name
ReturnNotes
string
Return notes
ProjectClassId
int?
Project class ID (nullable)
ProjectClassName
string
Project class name
TaxItems
List<Tax.OrderTaxItem>
List of tax items
ThirdPartyRefNo
string
Third party reference number
ThirdPartySource
string
Third party source
TaxData
Tax.TaxData
Tax data
IsTaxableFlag
bool
Taxable flag
OpenFlag
bool
Open flag
QualityId
int?
Quality ID (nullable)
StatusName
string
Status name
QtyReceived
double?
Quantity received (nullable)
QtyRemaining
double?
Quantity remaining (nullable)
QtyAvailableToReceive
double?
Quantity available to receive (nullable)
IsReceivableFlag
bool
Receivable flag
AsnItemId
long?
ASN item ID (nullable)
AsnId
long?
ASN ID (nullable)
AsnNumber
string
ASN number
AsnQtyReceived
double?
ASN quantity received (nullable)
AsnQtyRemaining
double?
ASN quantity remaining (nullable)
AsnQty
double?
ASN quantity (nullable)
CreateTranTypeId
int?
Create transaction type ID (nullable)
CreateTranTypeName
string
Create transaction type name
CreateTranNumber
string
Create transaction number
TotalReceivableQty
double?
Total receivable quantity (nullable)
ASNItemLineId
long?
ASN item line ID (nullable)
InvoiceShippingUsed
double?
Used shipping amount (nullable)
InvoiceDiscountUsed
double?
Used discount amount (nullable)
InvoiceDiscountAccntId
string
Discount account ID
InvoiceDiscountAccntName
string
Discount account name
InvoiceShippingTermId
int?
Shipping term ID (nullable)
InvoiceShippingTermName
string
Shipping term name
InvoiceShipMethodId
int?
Shipping method ID (nullable)
InvoiceShipMethodName
string
Shipping method name
InvoiceShipTaxCodeId
int?
Shipping tax code ID (nullable)
InvoiceShipTaxCodeName
string
Shipping tax code name
ExpenseShippingAccntId
string
Shipping account ID
ExpenseShippingAccntName
string
Shipping account name
ExpenseDiscountAccntId
string
Discount account ID
ExpenseDiscountAccntName
string
Discount account name
InvoiceItemShipTaxCodeId
int?
Shipping tax code ID for item line (nullable)
InvoiceItemShipTaxCodeName
string
Shipping tax code name for item line
AllocateFlag
bool
Allocate flag
OriginalQtyAllocated
double?
Original quantity allocated (nullable)
QtyAllocated
double?
Quantity allocated (nullable)
ExpireDate
DateTime?
Expiration date (nullable)
OrderLineId
long?
Order line ID (nullable)
OrderNo
string
Order number
OrderLineNo
int?
Order line number (nullable)
OrderItemId
long?
Order item ID (nullable)
OrderQty
double?
Order quantity (nullable)
ShipToAddr
string
Shipping address
ShipToAddr2
string
Shipping address line 2
ShipToCity
string
Shipping city
ShipToState
string
Shipping state
ShipToFirstName
string
Shipping recipient's first name
ShipToCountry
string
Shipping country
ShipToLastName
string
Shipping recipient's last name
ShipToZpCode
string
Shipping ZIP code
ShipToCompanyName
string
Shipping company name
ShipToPhoneNumber
string
Shipping recipient's phone number
ShipToEmail
string
Shipping recipient's email
OrderItemId3PL
string
3PL order item ID
OrderLineId3PL
string
3PL order line ID
ItemWeight
double?
Item weight (nullable)
ItemVolume
double?
Item volume (nullable)
BatchUploadFlag
bool
Batch upload flag
ThirdPartyRefNo
string
Third party reference number
ThirdPartySource
string
Third party source
ThirdPartyDisplayName
string
Third party display name
ThirdPartyIconUrl
string
Third party icon URL
Item
Item
Item details
LotNo
string
Lot number
SerialNo
string
Serial number
IsSerialTracking
bool
Serial tracking flag
InventoryLocChangeList
List<InventoryLocationChange>
List of inventory location changes
Memo
string
Memo
QualityId
int?
Quality ID (nullable)
QualityName
string
Quality name
OrderDiscountAmount
double?
Order discount amount (nullable)
RmaItemGroupId
int?
RMA item group ID (nullable)
RmaItemGroupName
string
RMA item group name
CustomFieldD1 - CustomFieldD50
string
Custom Fields (CustomFieldD1 - CustomFieldD50).
InventoryLocationChange:
StoreId
int
Identifier for the store
StoreName
string
Name of the store
LocationId
long
Identifier for the location
LocationOnHand
double
Quantity on hand at the location
LocationName
string
Name of the location
RefLineId
long
Identifier for the reference line
ItemId
long
Identifier for the item
ItemNumber
string
Number of the item
DeltaQty
double
Change in quantity
DeltaBaseQty
double
Difference between new and old quantity
OpCodeId
int?
Identifier for the operation code
LpnId
long?
Identifier for the LPN (License Plate Number)
LpnNumber
string
Number of the LPN
UomFactor
double
Unit of measure factor
BaseUomId
int?
Identifier for the base unit of measure
EffectiveUomId
int?
Identifier for the effective unit of measure
BaseUomName
string
Name of the base unit of measure
EffectiveUomName
string
Name of the effective unit of measure
LotNumber
string
Lot number associated with the item
MfgDate
DateTime?
Manufacturing date of the item
ExpDate
DateTime?
Expiry date of the item
BatchNumber
string
Batch number associated with the item
AutoGenerateLpnFlag
bool
Flag indicating whether LPN should be generated
ItemQualityId
long
Identifier for the item quality
OrderTaxItem:
Id
int
Identifier for the tax item
Name
string
Name of the tax item
TotalAmount
double
Total amount of the tax item
Rate
double
Rate of the tax item
RateType
string
Type of the tax rate
TaxData.TaxItem:
itemId
int
Identifier for the item associated with tax
itemName
string
Name of the item associated with tax
itemAmount
double
Amount related to the item
lineAmount
double
Amount related to the line
itemRatePerc
double
Rate percentage of the item
JSON Example:
{
"rmaHeader": {
"AccntReceivableId": "B7744F1BD912C85895EA7D9E4A93",
"AccntReceivableName": "Accounts Receivable CAD",
"Amount": 1050.0,
"AmountApplied": 0.0,
"AmountRefunded": 0.0,
"AmountRemaining": 1050.0,
"AmountToApply": 0.0,
"ASNCreatedFlag": false,
"ASNId": 0,
"ASNNumber": "",
"AuthorizationDetailList": null,
"BatchUploadFlag": false,
"CreateDttm": "06/23/2023 02:17:49 AM",
"CreateSource": "xoro@parshant",
"CreditId": 0,
"CreditMemoId": 0,
"CreditMemoNumber": "",
"CurrencyCode": "CAD",
"CurrencyId": 1,
"CurrencyName": null,
"CurrencySymbol": "$ ",
"CustomerCurrencyId": "1",
"CustomerDefaultARId": "B7744F1BD912C85895EA7D9E4A93",
"CustomerEmailMain": "[email protected]",
"CustomerId": 231,
"CustomerMainPhone": "(234) 234-2342",
"CustomerName": "Ant Audio",
"DiscountAmount": 0.0,
"ExchangeRate": 1.0,
"ExpenseDiscountAccntId": "",
"ExpenseDiscountAccntName": null,
"ExpenseShippingAccntId": "",
"ExpenseShippingAccntName": null,
"HeaderTypeId": 20,
"Id": 316,
"ImportError": null,
"InvoiceDiscountUsed": 0.0,
"InvoiceId": null,
"InvoiceNumber": "",
"InvoiceShipMethodId": null,
"InvoiceShipMethodName": "",
"InvoiceShippingTermId": null,
"InvoiceShippingTermName": "",
"InvoiceShippingUsed": null,
"InvoiceShipTaxCodeId": null,
"InvoiceShipTaxCodeName": "",
"Memo": "",
"ModifyDttm": null,
"ModifySource": "",
"OldTxnDate": "06/23/2023",
"OpeningBalanceFlag": false,
"ProjectClassId": null,
"ProjectClassName": "",
"RefNo": "",
"ReportDataObj": {
"EntityAccntId": "1FB69F8D-4EED-4693-B2C5-AA5BFCA283E1",
"EntityName": "Ant Audio",
"linkedTxnRefId": null,
"ReportEntityId": 111,
"TxnRefId": 316,
"TxnRefNumber": "ADF-R000306",
"TxnTypeId": 105
},
"ReturnTypeId": 20,
"RMANumber": "ADF-R000306",
"SalesRepFullName": null,
"SalesRepId": "",
"SaleStoreId": 0,
"SaleStoreName": "",
"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": "[email protected]",
"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.0
},
"ShipToAddr": "123",
"ShipToAddr2": "",
"ShipToCity": "Burnaby",
"ShipToCompanyName": "MAIN",
"ShipToCountry": "Canada",
"ShipToEmail": "[email protected]",
"ShipToFirstName": "Ant",
"ShipToLastName": "ABCD",
"ShipToPhoneNumber": "6452317890",
"ShipToState": "BC",
"ShipToZpCode": "V1M 3B5",
"StatusId": 10,
"StatusName": "Open",
"StoreCode": null,
"StoreId": 10020,
"StoreName": "ADF",
"SubTotal": 0.0,
"SubTotalExclDiscount": 0.0,
"SysLockFlag": false,
"TaxSummaryDataText": null,
"ThirdPartyAdjSku": null,
"ThirdPartyAdjustTotalFlag": false,
"ThirdPartyDisplayName": "",
"ThirdPartyIconUrl": "",
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"ThirdPartyTotalRefundAmount": 0.0,
"TotalQty": 0.0,
"TxnDate": "06/23/2023",
"TxnId": "",
"TxnNumber": 0,
"TypeId": 10,
"TypeName": "Credit Memo",
"UnPostTranFlag": false,
"ValidUntilDate": "06/28/2023",
"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
},
"rmaItemLineArry": [
{
"AllowedSellUOMList": null,
"Amount": 1000.0,
"AuthorizationDetailList": null,
"BaseUomId": 15,
"CreateDttm": "01/01/0001 12:00:00 AM",
"CreateSource": null,
"DeleteFlag": false,
"Description": "item description",
"Discount": 0.0,
"DiscountTypeId": -1,
"EditState": true,
"EffectiveUnitPrice": 200.0,
"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.0,
"OpenFlag": false,
"ProjectClassId": null,
"ProjectClassName": "",
"Qty": 5.0,
"QtyAvailableToReceive": null,
"QtyDecimalFlag": true,
"QtyInReceiving": 0.0,
"QtyOpenAsn": null,
"QtyReceived": null,
"QtyRemaining": 5.0,
"Rate": 200.0,
"ReturnCodeId": 20,
"ReturnCodeName": "CS",
"ReturnNotes": "",
"RMAId": 316,
"RmaNumber": null,
"StatusId": 10,
"StatusName": null,
"StoreId": null,
"StoreName": null,
"TaxAmount": 50.0,
"TaxCodeId": 2,
"TaxCodeName": "GST 5% (AB, BC, MB, NWT, QC, SK)",
"TaxData": {
"taxItems": [
{
"itemAmount": 50.0,
"itemId": 100,
"itemName": "GST on Sale 5%",
"itemRatePerc": 5.0,
"lineAmount": 1000.0
}
],
"totalAmount": 50.0
},
"TaxItems": [
{
"Id": 100,
"Name": "GST on Sale 5%",
"Rate": 0.0,
"RateType": "percentage",
"TotalAmount": 50.0
}
],
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"TxnId": null,
"TxnNumber": 0,
"UomFactor": 1.0,
"UomId": 15,
"UomName": "KG",
"ValidUntilDate": "01/01/0001",
"VASDiscountableFlag": false,
"VASItemCost": null,
"VASItemCostTotal": null,
"VASItemId": null,
"VASItemName": null,
"VASTaxableFlag": false,
"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": ""
}
]
}Last updated