GET All Purchase Refunds

Retrieves a paginated list of all purchase refunds. The response includes both purchase refund data and pagination information.

Parameters:

limit: Number of records per page (1-1000)

page: Page number for pagination

search: Optional search term to filter results

start_date: Optional filter by purchase refund date (YYYY-MM-DD)

end_date: Optional filter by purchase refund date (YYYY-MM-DD)

supplier_id: Optional filter by supplier ID

sort: Optional field to sort by (id, date, total, etc.)

direction: Optional sort direction (asc or desc)

Response:

{
  "result": "success",
  "code": 200,
  "data": [
    {
      "PurchaseRefund": {
        "id": 678,
        "number": "PR-2023-001",
        "supplier_id": 1,
        "date": "2023-03-21",
        "total": 250.00,
        "status": 1,
        "currency_code": "USD",
        // Additional purchase refund fields...
      },
      "Supplier": {
        "id": 1,
        "name": "Supply Co",
        // Additional supplier fields...
      },
      "PurchaseOrderItem": [
        {
          "id": 901,
          "purchase_refund_id": 678,
          "product_id": 1,
          "description": "Premium Widget Return",
          "quantity": 5,
          "unit_price": 50.00,
          "total": 250.00
          // Additional item fields...
        }
      ]
    }
    // Additional purchase refunds...
  ],
  "pagination": {
    "page": 1,
    "page_count": 2,
    "total_results": 28,
    "prev": null,
    "next": "/api2/purchase_refunds.json?page=2"
  }
}

{ "result": "success", "code": 200, "data": [ { "PurchaseRefund": { "id": 678, "number": "PR-2023-001", "supplier_id": 1, "staff_id": 1, "date": "2023-03-21", "total": 250.00, "status": 1, "currency_code": "USD", "draft": 0, "notes": "Defective product return", "created": "2023-03-21 10:15:22", "modified": "2023-03-21 10:15:22" }, "Supplier": { "id": 1, "name": "Supply Co", "business_name": "Supply Company Ltd", "email": "orders@supplyco.com" }, "PurchaseOrderItem": [ { "id": 901, "purchase_refund_id": 678, "product_id": 1, "description": "Premium Widget Return", "quantity": 5, "unit_price": 50.00, "total": 250.00 } ] }, { "PurchaseRefund": { "id": 677, "number": "PR-2023-002", "supplier_id": 2, "staff_id": 1, "date": "2023-03-19", "total": 600.00, "status": 1, "currency_code": "USD", "draft": 0, "notes": "Incorrect item received", "created": "2023-03-19 14:30:45", "modified": "2023-03-19 14:30:45" }, "Supplier": { "id": 2, "name": "Office Depot", "business_name": "Office Depot Inc.", "email": "sales@officedepot.com" }, "PurchaseOrderItem": [ { "id": 900, "purchase_refund_id": 677, "product_id": 5, "description": "Office Furniture Set Return", "quantity": 1, "unit_price": 600.00, "total": 600.00 } ] } ], "pagination": { "page": 1, "page_count": 2, "total_results": 28, "prev": null, "next": "/api2/purchase_refunds.json?page=2" } }

Request

Responses