> ## 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 credit note

> Credits an invoice by an amount and creates a credit note.

Creates a credit note for an invoice. The body takes only `invoice_id` and `amount` under `credit_note`; any other key returns `400`. The amount is drawn from the invoice's active payments, oldest first. Creating a credit note schedules the `CREDIT_NOTE_ISSUED` communication.

> [!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 /credit_notes
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:
  /credit_notes:
    post:
      tags:
        - Credit notes
      summary: Create a credit note
      description: >-
        Creates a credit note for an invoice. The body takes only `invoice_id`
        and `amount` under `credit_note`; any other key returns `400`. The
        amount is drawn from the invoice's active payments, oldest first.
        Creating a credit note schedules the `CREDIT_NOTE_ISSUED` communication.
      operationId: credit_notes_create_credit_note
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                credit_note:
                  type: object
                  properties:
                    invoice_id:
                      type: string
                      description: The `id` of the invoice to credit.
                    amount:
                      type: number
                      description: The amount to credit.
              required:
                - credit_note
            example:
              credit_note:
                invoice_id: INV-0001
                amount: 5
      responses:
        '201':
          description: The credit note is created.
        '400':
          description: The body has a key other than `invoice_id` and `amount`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/credit_notes" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "credit_note": {
                  "invoice_id": "INV-0001",
                  "amount": 5
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.credit_notes.create_credit_note(
                {"credit_note": {"invoice_id": "INV-0001", "amount": 5}}
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.creditNotes.createCreditNote({credit_note: {invoice_id:
            'INV-0001', amount: 5}});

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

            $client = ClientRegistry::buildClient();

            $response = $client->creditNotes->createCreditNote([
                'credit_note' => ['invoice_id' => 'INV-0001', 'amount' => 5],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: |
            import com.exsited.Dto;
            import com.exsited.client.ApiResponse;
            import com.exsited.client.ClientRegistry;
            import com.exsited.client.ExsitedClient;
            import java.util.Map;

            ExsitedClient client = ClientRegistry.buildClient();

            ApiResponse<Dto> response = client.creditNotes().createCreditNote(
                    Map.of("credit_note", Map.of("invoice_id", "INV-0001", "amount", 5)));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await client.CreditNotes.CreateCreditNoteAsync(new
            Dictionary<string, object?>

            {
                ["credit_note"] = new Dictionary<string, object?>
                {
                    ["invoice_id"] = "INV-0001",
                    ["amount"] = 5,
                },
            });


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

            final client = buildClient();

            final response = await client.creditNotes.createCreditNote({
              'credit_note': {'invoice_id': 'INV-0001', 'amount': 5},
            });
            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.CreditNotes().CreateCreditNote(context.Background(), map[string]any{\n\t\"credit_note\": map[string]any{\"invoice_id\": \"INV-0001\", \"amount\": 5},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                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.