> 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/credit-memo-management/get-credit-memo-details.md).

# Get Credit Memo Details

Retrieve creditmemo data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions.

```json
{"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Credit Memo Management","description":"Use Credit Memo Management APIs to import, retrieve, and work with customer credit memos. These APIs support refund, return, adjustment, and customer account-credit workflows where external systems need visibility into credits issued in Xorosoft ERP."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}},"schemas":{"XoroApiResponse":{"type":"object","description":"Standard Xorosoft ERP API response envelope used by most endpoints.","properties":{"Result":{"type":"boolean","description":"True when the operation completed successfully."},"Message":{"type":"string","description":"Human-readable success or error message."},"Data":{"description":"Endpoint-specific payload.","type":"object","additionalProperties":true,"nullable":true},"Page":{"type":"integer","description":"Current page number when paging is enabled.","nullable":true},"TotalPages":{"type":"integer","description":"Total page count when paging is enabled.","nullable":true}}}}},"paths":{"/api/xerp/creditmemo/getcreditmemoobj":{"get":{"tags":["Credit Memo Management"],"summary":"Get Credit Memo Details","description":"Retrieve creditmemo data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions.","operationId":"get_creditmemo_getcreditmemoobj","responses":{"200":{"description":"Request processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XoroApiResponse"}}}},"400":{"description":"Invalid request, failed validation, or business rule error.","content":{"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Missing or invalid private app credentials."},"403":{"description":"Private app does not have permission for this request."}},"parameters":[{"name":"id","in":"query","required":false,"description":"Comma-separated Xorosoft ERP record identifier(s).","schema":{"type":"string"}},{"name":"credit_memo_number","in":"query","required":false,"description":"Credit memo number.","schema":{"type":"string"}},{"name":"created_at_min","in":"query","required":false,"description":"Filter records created on or after this date.","schema":{"type":"string"}},{"name":"created_at_max","in":"query","required":false,"description":"Filter records created on or before this date.","schema":{"type":"string"}},{"name":"updated_at_min","in":"query","required":false,"description":"Filter records updated on or after this date.","schema":{"type":"string"}},{"name":"updated_at_max","in":"query","required":false,"description":"Filter records updated on or before this date.","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Status name, code, or identifier supported by this module.","schema":{"type":"string"}},{"name":"since_id","in":"query","required":false,"description":"Return records with an identifier greater than this value.","schema":{"type":"string"}},{"name":"customer_name","in":"query","required":false,"description":"Customer name to search or match when a customer identifier is not supplied.","schema":{"type":"string"}},{"name":"store_name","in":"query","required":false,"description":"Store or warehouse name.","schema":{"type":"string"}},{"name":"third_party_ref_no","in":"query","required":false,"description":"Third-party reference number supplied by the external system.","schema":{"type":"string"}},{"name":"ref_no","in":"query","required":false,"description":"Reference number used to find matching documents or transactions.","schema":{"type":"string"}},{"name":"ref_no_2","in":"query","required":false,"description":"Secondary reference number used to narrow matching documents or transactions.","schema":{"type":"string"}},{"name":"third_party_source","in":"query","required":false,"description":"Name of the external system or channel that supplied the transaction.","schema":{"type":"string"}},{"name":"header_only","in":"query","required":false,"description":"When true, returns only header-level information.","schema":{"type":"boolean","default":false}}]}}}}
```


---

# 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/credit-memo-management/get-credit-memo-details.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.