Customer refund lines

Customer refund line items represent entries in a customer refund object. Customer refund line is an owned object of AR customer refund.

List customer refund lines

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

Returns a collection with a key, ID, and link for each accounts receivable customer refund line.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "375",
    • "key": "375",
    • "customerRefund": {
      • "id": "70",
      • "key": "70",
      • "href": "/objects/accounts-receivable/customer-refund/70"
      },
    • "glAccount": {
      • "key": "36",
      • "id": "1200",
      • "name": "Accounts Receivable",
      • "href": "/objects/general-ledger/account/36"
      },
    • "baseCurrency": {
      • "amount": "50.00",
      • "currency": "USD",
      • "totalPaid": "50.00",
      • "totalSelected": "0.00"
      },
    • "txnCurrency": {
      • "amount": "50.00",
      • "currency": "USD",
      • "totalPaid": "50.00",
      • "totalSelected": "0.00"
      },
    • "dimensions": {
      • "location": {
        },
      • "customer": {
        }
      },
    • "memo": "Refund for overpayment",
    • "exchangeRate": {
      • "date": "2024-12-18",
      • "typeId": null,
      • "rate": 1
      },
    • "lineNumber": 1,
    • "audit": {
      • "createdDateTime": "2025-03-20T09:01:11Z",
      • "modifiedDateTime": "2025-03-20T09:11:49Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "href": "/objects/accounts-receivable/customer-refund-line/375"
    }
}