Customer refund details

A customer refund detail object includes an advance, adjustment, or invoice to pay and other details about the refund, including its state. Customer refund detail is an owned object of customer refund.

List customer refund details

get/objects/accounts-receivable/customer-refund-detail

Returns a collection with a key, ID, and link for each customer refund detail object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/accounts-receivable/customer-refund-detail/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/accounts-receivable/customer-refund-detail/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/accounts-receivable/customer-refund-detail/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get customer refund details
get/objects/accounts-receivable/customer-refund-detail/{key}
Returns detailed information for a specified customer refund detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the customer refund detail object.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "773",
    • "key": "773",
    • "arPayment": {
      • "id": "2346",
      • "key": "2346",
      • "href": "/objects/accounts-receivable/payment/2346"
      },
    • "customerRefund": {
      • "id": "2346",
      • "key": "2346",
      • "href": "/objects/accounts-receivable/customer-refund/2346"
      },
    • "customerRefundLine": {
      • "id": "5741",
      • "key": "5741",
      • "href": "/objects/accounts-receivable/customer-refund-line/5741"
      },
    • "paymentDate": "2025-03-31",
    • "baseRefundAmount": "222.00",
    • "txnRefundAmount": "222.00",
    • "arAdjustment": {
      • "id": null,
      • "key": null
      },
    • "arAdjustmentLine": {
      • "id": null,
      • "key": null
      },
    • "negativeInvoice": {
      • "id": "2345",
      • "key": "2345",
      • "href": "/objects/accounts-receivable/invoice/2345"
      },
    • "negativeInvoiceLine": {
      • "id": "5739",
      • "key": "5739",
      • "href": "/objects/accounts-receivable/invoice-line/5739"
      },
    • "arAdvance": {
      • "id": null,
      • "key": null
      },
    • "arAdvanceLine": {
      • "id": null,
      • "key": null
      },
    • "overPayment": {
      • "id": null,
      • "key": null
      },
    • "overPaymentLine": {
      • "id": null,
      • "key": null
      },
    • "bankCurrency": "USD",
    • "state": "complete",
    • "audit": {
      • "createdDateTime": "2025-04-01T05:16:17Z",
      • "modifiedDateTime": "2025-04-01T05:16:17Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "href": "/objects/accounts-receivable/customer-refund-detail/773"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}