cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_refunds/PR-0001" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_refund": {
"reference": "REF-1002"
}
}'from exsited import build_client
client = build_client()
response = client.purchase_refunds.update_purchase_refund(
"PR-0001", {"purchase_refund": {"reference": "REF-1002"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseRefunds.updatePurchaseRefund('PR-0001', {
purchase_refund: {reference: 'REF-1002'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseRefunds->updatePurchaseRefund('PR-0001', [
'purchase_refund' => ['reference' => 'REF-1002'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_refunds.purchase_refunds_dto.PurchaseRefundsDto.PurchaseRefund;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseRefund> response = client.purchaseRefunds().updatePurchaseRefund(
"PR-0001",
Map.of("purchase_refund", Map.of("reference", "REF-1002")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseRefunds.UpdatePurchaseRefundAsync(
"PR-0001",
new Dictionary<string, object?>
{
["purchase_refund"] = new Dictionary<string, object?>
{
["reference"] = "REF-1002",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseRefunds.updatePurchaseRefund(
'PR-0001',
{
'purchase_refund': {'reference': 'REF-1002'},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.PurchaseRefunds().UpdatePurchaseRefund(context.Background(), "PR-0001", map[string]any{
"purchase_refund": map[string]any{"reference": "REF-1002"},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_refund": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"alternate_date": "<string>",
"amount": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"credit_note": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"issue_date": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"note": "<string>",
"object": "<string>",
"payment_method": "<string>",
"payment_processor": "<string>",
"reference": "<string>",
"status": "<string>",
"uuid": "<string>",
"version": 123
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Purchase refunds
Update a purchase refund
Changes a refund’s reference, note, date or custom attributes and returns it under purchase_refund.
PATCH
/
purchase_refunds
/
{purchase_refund_id}
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_refunds/PR-0001" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_refund": {
"reference": "REF-1002"
}
}'from exsited import build_client
client = build_client()
response = client.purchase_refunds.update_purchase_refund(
"PR-0001", {"purchase_refund": {"reference": "REF-1002"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseRefunds.updatePurchaseRefund('PR-0001', {
purchase_refund: {reference: 'REF-1002'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseRefunds->updatePurchaseRefund('PR-0001', [
'purchase_refund' => ['reference' => 'REF-1002'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_refunds.purchase_refunds_dto.PurchaseRefundsDto.PurchaseRefund;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseRefund> response = client.purchaseRefunds().updatePurchaseRefund(
"PR-0001",
Map.of("purchase_refund", Map.of("reference", "REF-1002")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseRefunds.UpdatePurchaseRefundAsync(
"PR-0001",
new Dictionary<string, object?>
{
["purchase_refund"] = new Dictionary<string, object?>
{
["reference"] = "REF-1002",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseRefunds.updatePurchaseRefund(
'PR-0001',
{
'purchase_refund': {'reference': 'REF-1002'},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.PurchaseRefunds().UpdatePurchaseRefund(context.Background(), "PR-0001", map[string]any{
"purchase_refund": map[string]any{"reference": "REF-1002"},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_refund": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"alternate_date": "<string>",
"amount": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"credit_note": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"issue_date": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"note": "<string>",
"object": "<string>",
"payment_method": "<string>",
"payment_processor": "<string>",
"reference": "<string>",
"status": "<string>",
"uuid": "<string>",
"version": 123
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Updates the refund, wrapped in
purchase_refund. Only alternate_date, reference, note and custom_attributes can change; any other key returns 400, and the amount cannot change.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The purchase refund's id. The update and delete do not accept its uuid.
Body
application/json
Show child attributes
Show child attributes
Response
The updated purchase refund, under purchase_refund.
Show child attributes
Show child attributes