> For the complete documentation index, see [llms.txt](https://docs.xorosoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xorosoft.com/developers-api/third-party-logistics-3pl/list-credit-memos.md).

# List Credit Memos

Retrieves a list of credit memos from the data source based on the provided 3PL account token.

```json
{"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Third-Party Logistics (3PL)","description":"Use 3PL APIs when a warehouse or logistics provider needs account-specific access to customer orders, inventory, purchase orders, RMAs, bills, item receipts, packing slips, and related documents. 3PL requests use the 3PL account token generated in Xorosoft ERP so data access can be limited to the connected client account."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}}},"paths":{"/api/xerp/account3pl/getcreditmemo":{"get":{"parameters":[{"description":"A comma-separated list of credit memo ids","in":"query","name":"id","required":false,"schema":{"type":"number"}},{"description":"A comma-separated list of credit memo numbers","in":"query","name":"credit_memo_number","required":false,"schema":{"type":"string"}},{"description":"Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"created_at_min","required":false,"schema":{"type":"string"}},{"description":"Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"updated_at_min","required":false,"schema":{"type":"string"}},{"description":"Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"created_at_max","required":false,"schema":{"type":"string"}},{"description":"Show credit memo created at or after date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"updated_at_max","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of statuses","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Restrict results to after the specified ID","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of customer names","in":"query","name":"customer_name","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of store names","in":"query","name":"store_name","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of third party reference numbers","in":"query","name":"third_party_ref_no","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of sales order reference numbers","in":"query","name":"ref_no","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of sales order reference numbers 2","in":"query","name":"ref_no_2","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of third party source","in":"query","name":"third_party_source","required":false,"schema":{"type":"string"}},{"description":"A unique authentication token assigned to each 3PL account within the system","in":"query","name":"account_token","required":false,"schema":{"type":"string"}},{"description":"This will include credit memo line in the response","in":"query","name":"include_lines","required":false,"schema":{"type":"string"}},{"description":"This will exclude processed orders","in":"query","name":"exclude_processed","required":false,"schema":{"type":"string"}},{"description":"Page number for the query result set. Default = 1","in":"query","name":"page","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"items":{"properties":{"creditMemoHeader":{"properties":{"ASNCreatedFlag":{"type":"boolean"},"ASNId":{"type":"number"},"ASNNumber":{"type":"number","nullable":true},"AccntReceivableId":{"type":"string"},"AccntReceivableName":{"type":"string"},"Account3PLCode":{"type":"string","nullable":true},"Account3PLId":{"type":"number"},"Account3PLName":{"type":"string","nullable":true},"Amount":{"type":"number"},"AmountApplied":{"type":"number"},"AmountRefunded":{"type":"number"},"AmountRemaining":{"type":"number"},"AmountToApply":{"type":"number"},"AuthorizationDetailList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"AutoCreateASN":{"type":"boolean"},"BatchUploadFlag":{"type":"boolean"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"CreditId":{"type":"number"},"CreditMemoNumber":{"type":"string"},"CurrencyCode":{"type":"string"},"CurrencyId":{"type":"number"},"CurrencyName":{"type":"string","nullable":true},"CurrencySymbol":{"type":"string"},"CustomerCurrencyId":{"type":"string"},"CustomerDefaultARId":{"type":"string"},"CustomerEmailMain":{"type":"string"},"CustomerFirstName":{"type":"string","nullable":true},"CustomerId":{"type":"number"},"CustomerIntAcctId":{"type":"number","nullable":true},"CustomerLastName":{"type":"string","nullable":true},"CustomerMainPhone":{"type":"string"},"CustomerName":{"type":"string"},"CustomerTypeId3PL":{"type":"string","nullable":true},"DiscountAmount":{"type":"number"},"EntityUseCode":{"type":"string","nullable":true},"ExchangeRate":{"type":"number"},"ExchangeRateFormula":{"type":"string","nullable":true},"ExpenseDiscountAccntId":{"type":"string"},"ExpenseDiscountAccntName":{"type":"string","nullable":true},"ExpenseShippingAccntId":{"type":"string"},"ExpenseShippingAccntName":{"type":"string","nullable":true},"Id":{"type":"number"},"ImportError":{"type":"string","nullable":true},"InvoiceDiscountUsed":{"type":"string","nullable":true},"InvoiceId":{"type":"number","nullable":true},"InvoiceNumber":{"type":"string"},"InvoiceShipMethodId":{"type":"number","nullable":true},"InvoiceShipMethodName":{"type":"string","nullable":true},"InvoiceShipTaxCodeId":{"type":"number","nullable":true},"InvoiceShipTaxCodeName":{"type":"string","nullable":true},"InvoiceShippingTermId":{"type":"number","nullable":true},"InvoiceShippingTermName":{"type":"string","nullable":true},"InvoiceShippingUsed":{"type":"string","nullable":true},"ItemLineHtml":{"type":"string","nullable":true},"LinkedSoNumber":{"type":"number","nullable":true},"Memo":{"type":"string"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string"},"NoTaxServiceRequestFlag":{"type":"boolean","nullable":true},"OldTxnDate":{"type":"string"},"OpeningBalanceFlag":{"type":"boolean"},"ProjectClassId":{"type":"number","nullable":true},"ProjectClassName":{"type":"string","nullable":true},"RefNo":{"type":"string"},"RefNo2":{"type":"string"},"ReportDataObj":{"properties":{"EntityAccntId":{"type":"string"},"EntityName":{"type":"string"},"EntityObj":{"type":"object","additionalProperties":true,"nullable":true},"ReportEntityId":{"type":"number"},"TxnRefId":{"type":"number"},"TxnRefNumber":{"type":"string"},"TxnTypeId":{"type":"number"},"linkedTxnRefId":{"type":"number","nullable":true}},"type":"object"},"ReturnTypeId":{"type":"number","nullable":true},"RmaId":{"type":"number"},"RmaNumber":{"type":"number","nullable":true},"SaleStoreId":{"type":"number"},"SaleStoreName":{"type":"string"},"SalesOrderNumber":{"type":"number","nullable":true},"SalesRepFullName":{"type":"string","nullable":true},"SalesRepId":{"type":"string"},"ShipFromAddr":{"type":"string","nullable":true},"ShipFromAddr2":{"type":"string","nullable":true},"ShipFromCity":{"type":"string","nullable":true},"ShipFromCountry":{"type":"string","nullable":true},"ShipFromCountryISO2":{"type":"string","nullable":true},"ShipFromState":{"type":"string","nullable":true},"ShipFromZpCode":{"type":"string","nullable":true},"ShipToAddr":{"type":"string","nullable":true},"ShipToAddr2":{"type":"string","nullable":true},"ShipToCity":{"type":"string","nullable":true},"ShipToCompanyName":{"type":"string","nullable":true},"ShipToCountry":{"type":"string","nullable":true},"ShipToEmail":{"type":"string","nullable":true},"ShipToFirstName":{"type":"string","nullable":true},"ShipToLastName":{"type":"string","nullable":true},"ShipToPhoneNumber":{"type":"number","nullable":true},"ShipToState":{"type":"string","nullable":true},"ShipToZpCode":{"type":"string","nullable":true},"ShippingAddress":{"type":"string","nullable":true},"ShippingTaxData":{"properties":{"taxItems":{"items":{},"type":"array"},"totalAmount":{"type":"number"}},"type":"object"},"StatusId":{"type":"number"},"StatusName":{"type":"string"},"StoreCode":{"type":"string"},"StoreId":{"type":"number"},"StoreName":{"type":"string"},"SubTotal":{"type":"number"},"SubTotalExclDiscount":{"type":"number"},"SysLockFlag":{"type":"boolean"},"TaxServiceHashCode":{"type":"number"},"TaxServiceHashCodeOld":{"type":"number"},"TaxServiceRefNumber":{"type":"number","nullable":true},"TaxSummaryDataText":{"type":"string","nullable":true},"ThirdPartyAdjSku":{"type":"string","nullable":true},"ThirdPartyAdjustTotalFlag":{"type":"boolean"},"ThirdPartyDisplayName":{"type":"string"},"ThirdPartyIconUrl":{"type":"string"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"ThirdPartyTotalRefundAmount":{"type":"number"},"TotalQty":{"type":"number"},"TxnDate":{"type":"string"},"TxnId":{"type":"string"},"TxnNumber":{"type":"number"},"TypeId":{"type":"number"},"TypeName":{"type":"string"},"UnPostTranFlag":{"type":"boolean"},"UpdateEnable":{"type":"boolean"}},"type":"object"},"creditMemoItemLineArry":{"items":{"properties":{"ASNNumber":{"type":"number","nullable":true},"Account3plId":{"type":"number","nullable":true},"AllowedSellUOMList":{"type":"boolean","nullable":true},"AlternativeItemNumber1":{"type":"string"},"AlternativeItemNumber2":{"type":"string"},"AlternativeItemNumber3":{"type":"string"},"Amount":{"type":"number"},"AsnId":{"type":"number","nullable":true},"AsnLineId":{"type":"number","nullable":true},"AuthorizationDetailList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"BaseQtyOrdered":{"type":"string","nullable":true},"BaseQtyRemainingToShip":{"type":"string","nullable":true},"BaseQtyShipped":{"type":"string","nullable":true},"BaseUomId":{"type":"number"},"BaseUomName":{"type":"string","nullable":true},"ChargeLineId":{"type":"number"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string","nullable":true},"CreditMemoId":{"type":"number"},"DefaultSellUomId":{"type":"number"},"DeleteFlag":{"type":"boolean"},"Description":{"type":"string"},"Discount":{"type":"number"},"DiscountTypeId":{"type":"number"},"EditState":{"type":"boolean"},"EffectiveUnitPrice":{"type":"number"},"Id":{"type":"number"},"InventoryLocChangeList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"InvoiceLineId":{"type":"number"},"IsTaxableFlag":{"type":"boolean"},"ItemCategoryName":{"type":"string"},"ItemId":{"type":"number"},"ItemNumber":{"type":"string"},"ItemSubCategoryName":{"type":"string"},"ItemTypeId":{"type":"number"},"ItemTypeName":{"type":"string"},"LineNumber":{"type":"number"},"MatchFlag":{"type":"boolean"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"OldQty":{"type":"number"},"OldUomFactor":{"type":"string","nullable":true},"OldUomId":{"type":"number"},"ProjectClassId":{"type":"number","nullable":true},"ProjectClassName":{"type":"string"},"Qty":{"type":"number"},"QtyDecimalFlag":{"type":"boolean"},"Rate":{"type":"number"},"ReturnCodeId":{"type":"number"},"ReturnCodeName":{"type":"string"},"ReturnNotes":{"type":"string"},"RmaId":{"type":"number","nullable":true},"RmaLineId":{"type":"number","nullable":true},"RmaNumber":{"type":"number","nullable":true},"RmaQtyOrdered":{"type":"string","nullable":true},"RmaQtyReceived":{"type":"string","nullable":true},"RmaQtyRemaining":{"type":"string","nullable":true},"StatusId":{"type":"number"},"TaxAmount":{"type":"number"},"TaxCategoryCode":{"type":"string","nullable":true},"TaxCodeId":{"type":"number","nullable":true},"TaxCodeName":{"type":"string","nullable":true},"TaxData":{"properties":{"taxItems":{"items":{},"type":"array"},"totalAmount":{"type":"number"}},"type":"object"},"TaxItems":{"items":{},"type":"array"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"TrackingBySerialNumberFlag":{"type":"boolean"},"TxnId":{"type":"string"},"TxnNumber":{"type":"number"},"UomFactor":{"type":"number"},"UomId":{"type":"number"},"UomName":{"type":"string"}},"type":"object"},"type":"array"},"creditMemoItemSerialNumberArr":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true}},"type":"object"},"type":"array"},"IsForwardRequest":{"type":"boolean"},"Message":{"type":"string"},"MessageTitle":{"type":"string","nullable":true},"Result":{"type":"boolean"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Third-Party Logistics (3PL)"],"description":"Retrieves a list of credit memos from the data source based on the provided 3PL account token.","operationId":"get_account3pl_getcreditmemo","summary":"List Credit Memos"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xorosoft.com/developers-api/third-party-logistics-3pl/list-credit-memos.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.