List Credit Memos

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.

get

Authorizations

AuthorizationstringRequired

Query parameters

idstringOptional

Comma-separated Xorosoft ERP record identifier(s).

credit_memo_numberstringOptional

Credit memo number.

created_at_minstringOptional

Filter records created on or after this date.

created_at_maxstringOptional

Filter records created on or before this date.

updated_at_minstringOptional

Filter records updated on or after this date.

updated_at_maxstringOptional

Filter records updated on or before this date.

statusstringOptional

Status name, code, or identifier supported by this module.

since_idstringOptional

Return records with an identifier greater than this value.

customer_namestringOptional

Customer name to search or match when a customer identifier is not supplied.

store_namestringOptional

Store or warehouse name.

third_party_ref_nostringOptional

Third-party reference number supplied by the external system.

ref_nostringOptional

Reference number used to find matching documents or transactions.

ref_no_2stringOptional

Secondary reference number used to narrow matching documents or transactions.

third_party_sourcestringOptional

Name of the external system or channel that supplied the transaction.

pagestringOptional

Page number for paginated responses.

Default: 1

account3pl_idstringOptional

3PL account identifier.

include_linesbooleanOptional

When true, includes line-level details in the response.

Default: false

exclude_processedbooleanOptional

When true, excludes records already marked as processed.

Default: false

Responses

200

Request processed successfully.

application/json

Standard Xorosoft ERP API response envelope used by most endpoints.

ResultbooleanOptional

True when the operation completed successfully.

MessagestringOptional

Human-readable success or error message.

Pageinteger · nullableOptional

Current page number when paging is enabled.

TotalPagesinteger · nullableOptional

Total page count when paging is enabled.

400

Invalid request, failed validation, or business rule error.

text/plain

401

Missing or invalid private app credentials.

403

Private app does not have permission for this request.

get/api/xerp/creditmemo/getcreditmemo

GET /api/xerp/creditmemo/getcreditmemo HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*

{
  "Result": true,
  "Message": "Request processed successfully",
  "Data": {}
}