> ## Documentation Index > Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create a purchase refund from a purchase credit note > Records a refund from a supplier against a purchase credit note and returns it under `purchase_refund`. Records a refund against the purchase credit note in the path, wrapped in `purchase_refund`. `payment_method` is the reference of one of the supplier's payment methods. A purchase refund is always raised against a purchase credit note; there is no create on the purchase refunds path. > [!NOTE] > > The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). 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](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload. ## OpenAPI ````yaml POST /purchase_credit_notes/{purchase_credit_note_id}/purchase_refunds openapi: 3.1.0 info: title: Exsited API version: v4 servers: - url: https://{host}/api/v4 variables: host: default: your-api-host.example.com description: Your Exsited API host name, without https://. security: - bearerAuth: [] tags: - name: Authentication - name: Accounts - name: Account emails - name: Account groups - name: Communications - name: Communication profiles - name: Orders - name: Quote orders - name: Express - name: Usages - name: Sales reps - name: Gift certificates - name: Invoices - name: Pro-forma invoices - name: Payments - name: Refunds - name: Credit notes - name: Credit note applications - name: Reconciliations - name: Items - name: Inventory adjustments - name: Units of measurement - name: Zones - name: Shipping packages - name: Shipping rules - name: Fulfillment profiles - name: Fulfillment terms - name: Item fulfillments - name: Item receipts - name: Bookings - name: Rental assets - name: Return merchandise authorisations - name: Purchase orders - name: Purchase invoices - name: Purchase payments - name: Purchase refunds - name: Purchase credit notes - name: Purchase credit note applications - name: Purchase express - name: Return vendor authorizations - name: ABA files - name: Receive terms - name: Labours - name: Tasks - name: Timesheets - name: Milestones - name: Employees - name: Departments - name: Designations - name: Teams - name: Time periods - name: Workflows - name: Workflow settings - name: Events - name: Custom events - name: System events - name: Approvals - name: Approval profiles - name: Approval user groups - name: Alerts - name: Alert responsibility settings - name: Alert responsibilities - name: Action scripts - name: Note groups - name: Note attachments - name: Instance settings - name: Accounting codes - name: Additional codes - name: Billing periods - name: Charging periods - name: Pricing periods - name: Invoice terms - name: Days of the month - name: Countries - name: Salutations - name: Document templates - name: Email templates - name: Roles - name: Operators - name: Operator groups - name: User settings - name: Custom attributes - name: Custom components - name: Custom features - name: Custom fields - name: Custom forms - name: Attribute attachments - name: Portal - name: Integration connections - name: External databases - name: Reports - name: Applications - name: Organisation - name: Child organisations - name: Webhooks paths: /purchase_credit_notes/{purchase_credit_note_id}/purchase_refunds: post: tags: - Purchase refunds summary: Create a purchase refund from a purchase credit note description: >- Records a refund against the purchase credit note in the path, wrapped in `purchase_refund`. `payment_method` is the reference of one of the supplier's payment methods. A purchase refund is always raised against a purchase credit note; there is no create on the purchase refunds path. operationId: purchase_refunds_create_purchase_credit_note_purchase_refund parameters: - name: purchase_credit_note_id in: path required: true description: The purchase credit note's `id`. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: purchase_refund: type: object properties: amount: type: string description: The amount refunded, as a decimal string such as `0.50`. payment_method: type: string description: The reference of one of the supplier's payment methods. reference: type: string description: Your reference for the refund. note: type: string custom_attributes: type: array items: type: object properties: name: type: string value: type: string required: - purchase_refund example: purchase_refund: amount: '0.50' payment_method: Acme Pty Ltd bank account reference: REF-1001 note: Refund for returned stock. responses: '201': description: The new purchase refund, under `purchase_refund`. content: application/json: schema: $ref: '#/components/schemas/PurchaseRefundResponse' x-codeSamples: - lang: bash label: cURL source: >- curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_credit_notes/pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b/purchase_refunds" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "purchase_refund": { "amount": "0.50", "payment_method": "Acme Pty Ltd bank account", "reference": "REF-1001", "note": "Refund for returned stock." } }' - lang: python label: Python source: > from exsited import build_client client = build_client() response = client.purchase_refunds.create_purchase_credit_note_purchase_refund( "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", { "purchase_refund": { "amount": "0.50", "payment_method": "Acme Pty Ltd bank account", "reference": "REF-1001", "note": "Refund for returned stock.", } }, ) print(response.data) - lang: javascript label: JavaScript source: > import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.purchaseRefunds.createPurchaseCreditNotePurchaseRefund( 'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b', { purchase_refund: { amount: '0.50', payment_method: 'Acme Pty Ltd bank account', reference: 'REF-1001', note: 'Refund for returned stock.', }, }, ); console.log(response.data); - lang: php label: PHP source: > use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->purchaseRefunds->createPurchaseCreditNotePurchaseRefund( 'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b', [ 'purchase_refund' => [ 'amount' => '0.50', 'payment_method' => 'Acme Pty Ltd bank account', 'reference' => 'REF-1001', 'note' => 'Refund for returned stock.', ], ], ); print_r($response->data); - lang: java label: Java source: > 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 response = client.purchaseRefunds().createPurchaseCreditNotePurchaseRefund( "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", Map.of( "purchase_refund", Map.of( "amount", "0.50", "payment_method", "Acme Pty Ltd bank account", "reference", "REF-1001", "note", "Refund for returned stock."))); System.out.println(response.getMap()); - lang: csharp label: .NET source: > using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.PurchaseRefunds.CreatePurchaseCreditNotePurchaseRefundAsync( "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", new Dictionary { ["purchase_refund"] = new Dictionary { ["amount"] = "0.50", ["payment_method"] = "Acme Pty Ltd bank account", ["reference"] = "REF-1001", ["note"] = "Refund for returned stock.", }, }); Console.WriteLine(response.Json); - lang: dart label: Dart source: | import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.purchaseRefunds .createPurchaseCreditNotePurchaseRefund( 'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b', { 'purchase_refund': { 'amount': '0.50', 'payment_method': 'Acme Pty Ltd bank account', 'reference': 'REF-1001', 'note': 'Refund for returned stock.', }, }, ); print(response.map); - lang: go label: Go source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.PurchaseRefunds().CreatePurchaseCreditNotePurchaseRefund(context.Background(), \"pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b\", map[string]any{\n\t\"purchase_refund\": map[string]any{\n\t\t\"amount\": \"0.50\",\n\t\t\"payment_method\": \"Acme Pty Ltd bank account\",\n\t\t\"reference\": \"REF-1001\",\n\t\t\"note\": \"Refund for returned stock.\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: PurchaseRefundResponse: type: object properties: purchase_refund: $ref: '#/components/schemas/PurchaseRefund' PurchaseRefund: type: object properties: account: $ref: '#/components/schemas/PurchaseRefundAccount' alternate_date: type: string amount: type: string created_by: $ref: '#/components/schemas/PurchaseRefundCreatedBy' created_on: type: string credit_note: $ref: '#/components/schemas/PurchaseRefundCreditNote' custom_attributes: type: array items: $ref: '#/components/schemas/PurchaseRefundCustomAttribute' id: type: string issue_date: type: string last_updated_by: type: string last_updated_on: type: string note: type: string object: type: string payment_method: type: string payment_processor: type: string reference: type: string status: type: string uuid: type: string version: type: integer PurchaseRefundAccount: type: object properties: object: type: string id: type: string name: type: string href: type: string PurchaseRefundCreatedBy: type: object properties: name: type: string object: type: string PurchaseRefundCreditNote: type: object properties: object: type: string id: type: string name: type: string href: type: string PurchaseRefundCustomAttribute: type: object properties: href: type: string id: type: string name: type: string object: type: string type: type: string value: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: >- An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.