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

Daftra API Docs

Edit Purchase Refund

Prod Env

{{subdomain}}/api2

PUT

/api2/purchase_refunds/{{id}}.json

Last modified:2025-04-20 12:10:30

Maintainer:Not configured

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

Path Parameters:

id: Purchase Refund ID (required)

Request Body Fields:

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

PurchaseRefund Object:

date (string): Purchase refund date (YYYY-MM-DD)

notes (string): Purchase refund notes/reason

refund_method (string): Method of refund (e.g., "Credit", "Cash", "Bank Transfer")

PurchaseOrderItem 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": {
    "PurchaseRefund": {
      "id": 678,
      // Updated purchase refund fields...
    }
  },
  "message": "Purchase refund updated successfully"
}

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT '{{subdomain}}/api2/api2/purchase_refunds/{{id}}.json' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "PurchaseRefund": {
    "date": "2023-03-24",
    "notes": "Updated notes for damaged item return",
    "refund_method": "Bank Transfer",
    "PurchaseOrderItem": [
      {
        "id": 901,
        "quantity": 4,
        "unit_price": 55
      }
    ]
  }
}'

Response Example

200 - Success Response

{
  "result": "success",
  "code": 200,
  "data": {
    "PurchaseRefund": {
      "id": 678,
      "number": "PR-2023-001",
      "supplier_id": 1,
      "date": "2023-03-24",
      "total": 250,
      "modified": "2023-03-23 16:45:22"
    }
  },
  "message": "Purchase refund updated successfully"
}

Request

Body Params text/plain

Examples

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

object

required

PurchaseRefund

object

required

message

string

required

🟠404Error - Not Found

Delete Purchase Order

Delete Purchase Refund