Refund Customer Deposit

Run the refund workflow for deposit records in Xorosoft ERP. This operation is typically used after the related transaction already exists and the external system needs to advance its processing status.

post

Authorizations

AuthorizationstringRequired

Body

Request body for Refund.

CustomerNamestringOptional

Customer name associated with the transaction.

AmountintegerOptional

Monetary amount for the transaction or allocation.

CurrencyCodestringOptional

Currency code for the transaction amount.

Other propertiesanyOptional

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.

post/api/xerp/deposit/refund

POST /api/xerp/deposit/refund HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "CustomerName": "Example Customer",
  "Amount": 100,
  "CurrencyCode": "USD"
}

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