This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Edit Refund Receipt

Prod Env

{{subdomain}}/api2

PUT

/api2/refund_receipts/{{id}}.json

Last modified:2025-03-23 23:11:40

Maintainer:Not configured

Updates an existing refund receipt by ID. You can provide only the fields you want to update.

Path Parameters:

id: Refund Receipt ID (required)

Request Body Fields:

The request body allows partial updates. You only need to include the fields you want to change.

RefundReceipt Object:

date (string): Refund receipt date (YYYY-MM-DD)

notes (string): Refund receipt notes/reason

payment_method (string): Method of refund (e.g., "Bank Transfer", "Credit Card")

treasury_id (integer): ID of the treasury/cash account

InvoiceItem Array (optional):

To update existing items, include the item id along with the fields to update

To add new items, omit the id field and include required item fields

To remove items, you must use a separate DELETE request for each item

Response:

{
  "result": "success",
  "code": 200,
  "data": {
    "RefundReceipt": {
      "id": 456,
      // Updated refund receipt fields...
    }
  },
  "message": "Refund receipt updated successfully"
}

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT '{{subdomain}}/api2/api2/refund_receipts/{{id}}.json' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "RefundReceipt": {
    "date": "2023-03-24",
    "notes": "Updated refund receipt for service cancellation",
    "payment_method": "Wire Transfer",
    "InvoiceItem": [
      {
        "id": 789,
        "quantity": 1,
        "unit_price": 150
      }
    ]
  }
}'

Response Example

200 - Success Response

{
  "result": "success",
  "code": 200,
  "data": {
    "RefundReceipt": {
      "id": 456,
      "number": "RF-2023-001",
      "client_id": 15,
      "date": "2023-03-24",
      "total": 200.00,
      "notes": "Updated refund receipt",
      "modified": "2023-03-23 16:45:22"
    }
  },
  "message": "Refund receipt updated successfully"
}

Request

Body Params text/plain

Examples

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

object

required

RefundReceipt

object

required

message

string

required

🟠404Error - Not Found

Modified at 2025-03-23 23:11:40

Delete Credit Note

Delete Refund Receipt