GET v1/Refunds/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.Payment

Name	Type	Additional information
paymentActivityId	integer	None.
reference	string	None.
effectiveTimestamp	date	None.
referenceDate	date	None.
description	string	None.
customerId	integer	None.
originalPaymentActivityId	integer	None.
amount	decimal number	None.
currency	string	None.
invoiceAllocations	Collection of Common.Dto.Get.InvoiceAllocation	None.
refunds	Collection of Common.Dto.Get.Payment	None.
unallocatedAmount	decimal number	None.
refundableAmount	decimal number	None.
gatewayFee	decimal number	None.
settlement	Common.Dto.Get.Settlement	None.
netsuiteId	string	None.
surchargingFee	decimal number	None.
sendToNetsuite	boolean	None.
sendToQuickbooksOnline	boolean	None.
quickBooksId	integer	None.
quickBooksAttemptNumber	integer	None.
sageIntacctId	integer	None.
sageIntacctAttemptNumber	integer	None.
syncedToSageIntacct	boolean	None.
disputeStatus	string	None.
disputeId	string	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "paymentActivityId": 1,
  "reference": "sample string 2",
  "effectiveTimestamp": "2025-05-21T08:52:48.1234222+00:00",
  "referenceDate": "2025-05-21T08:52:48.1234222+00:00",
  "description": "sample string 4",
  "customerId": 5,
  "originalPaymentActivityId": 1,
  "amount": 6.0,
  "currency": "sample string 7",
  "invoiceAllocations": [
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    },
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    }
  ],
  "refunds": [],
  "unallocatedAmount": 8.0,
  "refundableAmount": 1.0,
  "gatewayFee": 1.0,
  "settlement": {
    "status": "sample string 1",
    "modifiedTimestamp": "2025-05-21T08:52:48.1234222+00:00",
    "lastCheckedTimestamp": "2025-05-21T08:52:48.1234222+00:00",
    "nextCheckTimestamp": "2025-05-21T08:52:48.1234222+00:00",
    "message": "sample string 2"
  },
  "netsuiteId": "sample string 9",
  "surchargingFee": 1.0,
  "sendToNetsuite": true,
  "sendToQuickbooksOnline": true,
  "quickBooksId": 1,
  "quickBooksAttemptNumber": 12,
  "sageIntacctId": 1,
  "sageIntacctAttemptNumber": 13,
  "syncedToSageIntacct": true,
  "disputeStatus": "sample string 15",
  "disputeId": "sample string 16",
  "id": 17,
  "uri": "sample string 18"
}