Customer Refund API

Issue refunds to customers for overpayments or unapplied credits.

---

Endpoints

Method	Endpoint	Description
GET	/record/v1/customerRefund	List refunds
GET	/record/v1/customerRefund/{id}	Get specific refund
POST	/record/v1/customerRefund	Create refund
PATCH	/record/v1/customerRefund/{id}	Update refund
DELETE	/record/v1/customerRefund/{id}	Delete refund

---

Key Fields

Field	Type	Description	Required
customer	object	Customer	Yes
tranDate	string	Refund date	Yes
total	number	Refund amount	Yes
subsidiary	object	Subsidiary	Yes (OneWorld)
currency	object	Currency	Yes
paymentMethod	object	Payment method	No
account	object	Cash/bank account	Yes
apply	collection	Credits/payments to refund	No

---

Example: Create Customer Refund

POST /record/v1/customerRefund
Content-Type: application/json

{
  "customer": {
    "id": "456"
  },
  "tranDate": "2025-12-25",
  "total": 250.00,
  "subsidiary": {
    "id": "1"
  },
  "currency": {
    "id": "1"
  },
  "account": {
    "id": "10"
  },
  "paymentMethod": {
    "id": "2"
  },
  "memo": "Refund for overpayment",
  "apply": {
    "items": [
      {
        "doc": {
          "id": "7001"
        },
        "apply": true,
        "amount": 250.00
      }
    ]
  }
}

---

Customer Refund vs Cash Refund

Customer Refund	Cash Refund
Refunds overpayments/credits	Refunds returned items
Applies against credit memos or payments	Includes line items
Reduces A/R credit balance	Reverses revenue

---

See Also

• Customer Payment - Original payments
• Credit Memo - Credits being refunded
• Cash Refund - Item return refunds