> ## 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.

# Update a purchase credit note

> Changes fields of a purchase credit note, such as its custom attributes, and returns it under `purchase_credit_note`.

Updates the purchase credit note, wrapped in `purchase_credit_note`, for example its `custom_attributes`. The updated credit note comes back under `purchase_credit_note`. An empty `custom_attributes` list, as in the example, removes all custom attributes.

> [!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 PATCH /purchase_credit_notes/{purchase_credit_note_id}
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}:
    patch:
      tags:
        - Purchase credit notes
      summary: Update a purchase credit note
      description: >-
        Updates the purchase credit note, wrapped in `purchase_credit_note`, for
        example its `custom_attributes`. The updated credit note comes back
        under `purchase_credit_note`. An empty `custom_attributes` list, as in
        the example, removes all custom attributes.
      operationId: purchase_credit_notes_update_purchase_credit_note
      parameters:
        - name: purchase_credit_note_id
          in: path
          required: true
          description: The purchase credit note's `id`, such as `pcn_...`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                purchase_credit_note:
                  type: object
                  properties:
                    custom_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value:
                            type: string
              required:
                - purchase_credit_note
            example:
              purchase_credit_note:
                custom_attributes: []
      responses:
        '200':
          description: The updated purchase credit note, under `purchase_credit_note`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseCreditNoteResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PATCH
            "$EXSITED_BASE_URL/api/v4/purchase_credit_notes/pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "purchase_credit_note": {
                  "custom_attributes": []
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.purchase_credit_notes.update_purchase_credit_note(
                "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
                {"purchase_credit_note": {"custom_attributes": []}},
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.purchaseCreditNotes.updatePurchaseCreditNote('pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
            {
                purchase_credit_note: {custom_attributes: []},
            });

            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->purchaseCreditNotes->updatePurchaseCreditNote(
                'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
                ['purchase_credit_note' => ['custom_attributes' => []]],
            );
            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_credit_notes.purchase_credit_notes_dto.PurchaseCreditNotesDto.PurchaseCreditNoteRead;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<PurchaseCreditNoteRead> response =
            client.purchaseCreditNotes().updatePurchaseCreditNote(
                    "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
                    Map.of("purchase_credit_note", Map.of("custom_attributes", List.of())));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.PurchaseCreditNotes.UpdatePurchaseCreditNoteAsync(
                "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
                new Dictionary<string, object?>
                {
                    ["purchase_credit_note"] = new Dictionary<string, object?>
                    {
                        ["custom_attributes"] = new List<object?>(),
                    },
                });

            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: >
            import 'package:exsited/exsited.dart';


            final client = buildClient();


            final response = await
            client.purchaseCreditNotes.updatePurchaseCreditNote(
              'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
              {
                'purchase_credit_note': {'custom_attributes': []},
              },
            );

            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.PurchaseCreditNotes().UpdatePurchaseCreditNote(context.Background(), \"pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b\", map[string]any{\n\t\"purchase_credit_note\": map[string]any{\"custom_attributes\": []any{}},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    PurchaseCreditNoteResponse:
      type: object
      properties:
        purchase_credit_note:
          $ref: '#/components/schemas/PurchaseCreditNoteRead'
    PurchaseCreditNoteRead:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/PurchaseCreditNoteReadAccount'
        code:
          type: string
        created_by:
          $ref: '#/components/schemas/PurchaseCreditNoteReadCreatedBy'
        created_on:
          type: string
        currency:
          $ref: '#/components/schemas/PurchaseCreditNoteReadCurrency'
        href:
          type: string
        id:
          type: string
        initial_amount:
          type: string
        issue_date:
          type: string
        last_updated_by:
          $ref: '#/components/schemas/PurchaseCreditNoteReadLastUpdatedBy'
        last_updated_on:
          type: string
        object:
          type: string
        purchase_credit_note_rows:
          type: array
          items:
            $ref: '#/components/schemas/PurchaseCreditNoteReadPurchaseCreditNoteRow'
        purchase_payment:
          $ref: '#/components/schemas/PurchaseCreditNoteReadPurchasePayment'
        refund_amount:
          type: string
        refundable:
          type: boolean
        remaining_amount:
          type: string
        status: {}
        version:
          type: integer
    PurchaseCreditNoteReadAccount:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    PurchaseCreditNoteReadCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    PurchaseCreditNoteReadCurrency:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    PurchaseCreditNoteReadLastUpdatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    PurchaseCreditNoteReadPurchaseCreditNoteRow:
      type: object
      properties:
        credit_note_from_blank_method:
          type: string
        credit_note_from_credit_note:
          type: string
        credit_note_from_payment_method:
          type: string
        credit_note_total:
          type: string
        payment_method:
          $ref: >-
            #/components/schemas/PurchaseCreditNoteReadPurchaseCreditNoteRowPaymentMethod
        payment_processor:
          $ref: >-
            #/components/schemas/PurchaseCreditNoteReadPurchaseCreditNoteRowPaymentProcessor
        refund_from_blank_method:
          type: string
        refund_from_credit_note:
          type: string
        refund_from_payment_method:
          type: string
        refund_total:
          type: string
    PurchaseCreditNoteReadPurchasePayment:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        object:
          type: string
    PurchaseCreditNoteReadPurchaseCreditNoteRowPaymentMethod:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    PurchaseCreditNoteReadPurchaseCreditNoteRowPaymentProcessor:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          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.