GET Single Purchase Refund
Prod Env
{{subdomain}}/api2
Prod Env
{{subdomain}}/api2
GET
{{subdomain}}/api2
Last modified:2025-04-20 12:10:30
Maintainer:Not configured
id
: Purchase Refund ID (required){
"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"
// Additional purchase refund fields...
},
"Supplier": {
"id": 1,
"name": "Supply Co",
"business_name": "Supply Company Ltd",
"email": "orders@supplyco.com"
// 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...
}
]
}
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{subdomain}}/api2/api2/purchase_refunds/{{id}}.json'
Response Response Example
200 - Success Response
{
"result": "success",
"code": 200,
"data": {
"PurchaseRefund": {
"id": 678,
"number": "PR-2023-001",
"supplier_id": 1,
"staff_id": 1,
"date": "2023-03-21",
"total": 250,
"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",
"refund_method": "Credit",
"treasury_id": 1
},
"Supplier": {
"id": 1,
"name": "Supply Co",
"business_name": "Supply Company Ltd",
"email": "orders@supplyco.com",
"phone1": "555-9876",
"address1": "456 Market St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94103",
"country_code": "US"
},
"PurchaseOrderItem": [
{
"id": 901,
"purchase_refund_id": 678,
"product_id": 1,
"description": "Premium Widget Return",
"quantity": 5,
"unit_price": 50,
"total": 250
}
]
}
}
Request
None