List Credit Memos
Retrieves a list of credit memos from the data source based on the provided 3PL account token.
get
Authorizations
AuthorizationstringRequired
Query parameters
idnumberOptional
A comma-separated list of credit memo ids
credit_memo_numberstringOptional
A comma-separated list of credit memo numbers
created_at_minstringOptional
Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)
updated_at_minstringOptional
Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)
created_at_maxstringOptional
Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)
updated_at_maxstringOptional
Show credit memo created at or after 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
ref_no_2stringOptional
A comma-separated list of sales order reference numbers 2
third_party_sourcestringOptional
A comma-separated list of third party source
account_tokenstringOptional
A unique authentication token assigned to each 3PL account within the system
include_linesstringOptional
This will include credit memo line in the response
exclude_processedstringOptional
This will exclude processed orders
pagenumberRequired
Page number for the query result set. Default = 1
Responses
200
OK
application/json
IsForwardRequestbooleanOptional
MessagestringOptional
MessageTitlestring · nullableOptional
ResultbooleanOptional
get/api/xerp/account3pl/getcreditmemo
GET /api/xerp/account3pl/getcreditmemo?page=1 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*
200
OK
{
"Data": [
{
"creditMemoHeader": {
"ASNCreatedFlag": false,
"ASNId": 0,
"ASNNumber": null,
"AccntReceivableId": "12640C4BF2CB3BD35A3A196F4AD1",
"AccntReceivableName": "Acc-1",
"Account3PLCode": null,
"Account3PLId": 3,
"Account3PLName": null,
"Amount": 139.16,
"AmountApplied": 0,
"AmountRefunded": 0,
"AmountRemaining": 139.16,
"AmountToApply": 0,
"AuthorizationDetailList": null,
"AutoCreateASN": false,
"BatchUploadFlag": false,
"CreateDttm": "02/08/2024 02:40:06 AM",
"CreateSource": "test",
"CreditId": 20,
"CreditMemoNumber": "STORE-77-C000020",
"CurrencyCode": "USD",
"CurrencyId": 1001,
"CurrencyName": null,
"CurrencySymbol": "$ ",
"CustomerCurrencyId": "1001",
"CustomerDefaultARId": "12640C4BF2CB3BD35A3A196F4AD1",
"CustomerEmailMain": "test@yopmail.com",
"CustomerFirstName": null,
"CustomerId": 8,
"CustomerIntAcctId": null,
"CustomerLastName": null,
"CustomerMainPhone": "(678) 876-8497",
"CustomerName": "test",
"CustomerTypeId3PL": null,
"DiscountAmount": 0,
"EntityUseCode": null,
"ExchangeRate": 1,
"ExchangeRateFormula": null,
"ExpenseDiscountAccntId": "",
"ExpenseDiscountAccntName": null,
"ExpenseShippingAccntId": "",
"ExpenseShippingAccntName": null,
"Id": 20,
"ImportError": null,
"InvoiceDiscountUsed": null,
"InvoiceId": null,
"InvoiceNumber": "",
"InvoiceShipMethodId": null,
"InvoiceShipMethodName": null,
"InvoiceShipTaxCodeId": null,
"InvoiceShipTaxCodeName": null,
"InvoiceShippingTermId": null,
"InvoiceShippingTermName": null,
"InvoiceShippingUsed": null,
"ItemLineHtml": null,
"LinkedSoNumber": null,
"Memo": "",
"ModifyDttm": null,
"ModifySource": "",
"NoTaxServiceRequestFlag": null,
"OldTxnDate": "02/08/2024",
"OpeningBalanceFlag": false,
"ProjectClassId": null,
"ProjectClassName": null,
"RefNo": "",
"RefNo2": "",
"ReportDataObj": {
"EntityAccntId": "451CAC9B-843E-4E86-927D-9D8A74C590C8",
"EntityName": "test",
"EntityObj": null,
"ReportEntityId": 111,
"TxnRefId": 20,
"TxnRefNumber": "STORE-77-C000020",
"TxnTypeId": 105,
"linkedTxnRefId": null
},
"ReturnTypeId": null,
"RmaId": 0,
"RmaNumber": null,
"SaleStoreId": 0,
"SaleStoreName": "",
"SalesOrderNumber": null,
"SalesRepFullName": null,
"SalesRepId": "101",
"ShipFromAddr": null,
"ShipFromAddr2": null,
"ShipFromCity": null,
"ShipFromCountry": null,
"ShipFromCountryISO2": null,
"ShipFromState": null,
"ShipFromZpCode": null,
"ShipToAddr": null,
"ShipToAddr2": null,
"ShipToCity": null,
"ShipToCompanyName": null,
"ShipToCountry": null,
"ShipToEmail": null,
"ShipToFirstName": null,
"ShipToLastName": null,
"ShipToPhoneNumber": null,
"ShipToState": null,
"ShipToZpCode": null,
"ShippingAddress": null,
"ShippingTaxData": {
"taxItems": [],
"totalAmount": 0
},
"StatusId": 10,
"StatusName": "Open",
"StoreCode": "STORE-77",
"StoreId": 10004,
"StoreName": "Store77",
"SubTotal": 0,
"SubTotalExclDiscount": 0,
"SysLockFlag": false,
"TaxServiceHashCode": 0,
"TaxServiceHashCodeOld": 0,
"TaxServiceRefNumber": null,
"TaxSummaryDataText": null,
"ThirdPartyAdjSku": null,
"ThirdPartyAdjustTotalFlag": false,
"ThirdPartyDisplayName": "",
"ThirdPartyIconUrl": "",
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"ThirdPartyTotalRefundAmount": 0,
"TotalQty": 0,
"TxnDate": "02/08/2024",
"TxnId": "12688A6BE9F9E7D4F89E8269495B",
"TxnNumber": 2803,
"TypeId": 10,
"TypeName": "Credit Memo",
"UnPostTranFlag": false,
"UpdateEnable": false
},
"creditMemoItemLineArry": [
{
"ASNNumber": null,
"Account3plId": null,
"AllowedSellUOMList": null,
"AlternativeItemNumber1": "Alt1",
"AlternativeItemNumber2": "Alt2",
"AlternativeItemNumber3": "Alt3",
"Amount": 139.16,
"AsnId": null,
"AsnLineId": null,
"AuthorizationDetailList": null,
"BaseQtyOrdered": null,
"BaseQtyRemainingToShip": null,
"BaseQtyShipped": null,
"BaseUomId": -1,
"BaseUomName": null,
"ChargeLineId": 0,
"CreateDttm": "01/01/0001 12:00:00 AM",
"CreateSource": null,
"CreditMemoId": 20,
"DefaultSellUomId": 0,
"DeleteFlag": false,
"Description": "800",
"Discount": 2,
"DiscountTypeId": 10,
"EditState": true,
"EffectiveUnitPrice": 139.16,
"Id": 31,
"InventoryLocChangeList": null,
"InvoiceLineId": 0,
"IsTaxableFlag": true,
"ItemCategoryName": "Glass",
"ItemId": 12323,
"ItemNumber": "800",
"ItemSubCategoryName": "wire",
"ItemTypeId": 10,
"ItemTypeName": "Inventory",
"LineNumber": 1,
"MatchFlag": false,
"ModifyDttm": null,
"ModifySource": null,
"OldQty": 1,
"OldUomFactor": null,
"OldUomId": -1,
"ProjectClassId": null,
"ProjectClassName": "",
"Qty": 1,
"QtyDecimalFlag": false,
"Rate": 142,
"ReturnCodeId": 20,
"ReturnCodeName": "CS",
"ReturnNotes": "rr",
"RmaId": null,
"RmaLineId": null,
"RmaNumber": null,
"RmaQtyOrdered": null,
"RmaQtyReceived": null,
"RmaQtyRemaining": null,
"StatusId": 10,
"TaxAmount": 0,
"TaxCategoryCode": null,
"TaxCodeId": null,
"TaxCodeName": null,
"TaxData": {
"taxItems": [],
"totalAmount": 0
},
"TaxItems": [],
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"TrackingBySerialNumberFlag": false,
"TxnId": "12688A6BE9F9E7D4F89E8269495B",
"TxnNumber": 2803,
"UomFactor": 1,
"UomId": -1,
"UomName": "Each"
}
],
"creditMemoItemSerialNumberArr": null
}
],
"IsForwardRequest": false,
"Message": "Credit Memo header data loaded successfully",
"MessageTitle": null,
"Result": true
}Last updated
Was this helpful?