> ## Documentation Index
> Fetch the complete documentation index at: https://docs.valyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Credit Note



## OpenAPI

````yaml POST /external/creditNotes/upsert
openapi: 3.1.0
info:
  title: OpenAPI Valyx API
  description: To demonstrate features in the Valyx
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.valyx.com
security:
  - bearerAuth:
      - demo-api
tags:
  - name: billing
    description: External Billing APIs
  - name: external
    description: External APIs for customers
  - name: invoice
    description: Invoice APIs
  - name: creditNote
    description: Credit Note APIs
paths:
  /external/creditNotes/upsert:
    post:
      tags:
        - external
      operationId: post_credit_note_upsert_routes
      parameters:
        - name: X-Valyx-Signature
          in: header
          required: true
          description: Auth key for fetching ledger entries
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCreditNotesExternalAPIQueryModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties: {}
components:
  schemas:
    CreateCreditNotesExternalAPIQueryModel:
      properties:
        creditNote:
          $ref: '#/components/schemas/CreateCreditNotesExternalAPICreditNoteModel'
      type: object
    CreateCreditNotesExternalAPICreditNoteModel:
      properties:
        creditNoteId:
          type: string
          description: creditNoteId
        creditNoteNumber:
          type: string
          description: creditNoteNumber
        creditNoteDate:
          type: string
          format: date
          description: creditNoteDate
        customerDetails:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcustomerDetails
        creditNoteTotal:
          type: number
          description: creditNoteTotal
        creditNoteSubtotal:
          type: number
          description: creditNoteSubtotal
        creditNoteTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcreditNoteTax
        currency:
          type: string
          description: currency
          default: INR
        exchangeRate:
          type: number
          description: >-
            Exchange rate from credit note currency (FCY) to base currency
            (BCY). Formula - BCY amount = FCY amount × exchangeRate. Required
            when currency is not the company's base currency. If omitted,
            defaults to 1.0.
          example: 19.45
        lineItems:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItems
        tags:
          type: object
        description:
          type: string
          description: description
        invoiceId:
          type: string
          description: invoiceId
        invoiceNumber:
          type: string
          description: invoiceNumber
        companyId:
          type: string
          description: companyId
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcustomerDetails:
      required:
        - buyerId
      properties:
        buyerId:
          type: string
          description: buyerId
        name:
          type: string
          description: name
        registeredAddress:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcustomerDetailsregisteredAddress
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcreditNoteTax:
      required:
        - total
      properties:
        total:
          type: number
          description: total
          default: 0
        gstTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxgstTax
        cessTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxcessTax
        serviceTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxserviceTax
        tdsTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxtdsTax
        otherTaxes:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxotherTaxes
        cgst:
          type: number
          description: cgst
        sgst:
          type: number
          description: sgst
        igst:
          type: number
          description: igst
        tds:
          type: number
          description: tds
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItems:
      required:
        - subTotal
        - total
      properties:
        lineItemDetails:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemslineItemDetails
        subTotal:
          type: number
          description: subTotal
          default: 0
        total:
          type: number
          description: total
          default: 0
        tax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemstax
        quantity:
          type: number
          description: quantity
          default: 1
        amount:
          type: number
          description: amount
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcustomerDetailsregisteredAddress:
      properties:
        line1:
          type: string
          description: line1
        line2:
          type: string
          description: line2
        state:
          type: string
          description: state
        city:
          type: string
          description: city
        country:
          type: string
          description: country
        zipCode:
          type: string
          description: zipCode
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxgstTax:
      required:
        - cgst
        - cgstRate
        - igst
        - igstRate
        - sgst
        - sgstRate
        - totalGst
        - totalGstRate
      properties:
        totalGst:
          type: number
          description: totalGst
          default: 0
        totalGstRate:
          type: number
          description: totalGstRate
          default: 0
        cgst:
          type: number
          description: cgst
          default: 0
        cgstRate:
          type: number
          description: cgstRate
          default: 0
        sgst:
          type: number
          description: sgst
          default: 0
        sgstRate:
          type: number
          description: sgstRate
          default: 0
        igst:
          type: number
          description: igst
          default: 0
        igstRate:
          type: number
          description: igstRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxcessTax:
      required:
        - cess
        - cessRate
      properties:
        cess:
          type: number
          description: cess
          default: 0
        cessRate:
          type: number
          description: cessRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxserviceTax:
      required:
        - serviceTax
        - serviceTaxRate
      properties:
        serviceTax:
          type: number
          description: serviceTax
          default: 0
        serviceTaxRate:
          type: number
          description: serviceTaxRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxtdsTax:
      required:
        - tds
        - tdsRate
      properties:
        tds:
          type: number
          description: tds
          default: 0
        tdsRate:
          type: number
          description: tdsRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModelcreditNoteTaxotherTaxes:
      required:
        - genericTax
        - genericTaxRate
        - name
      properties:
        name:
          type: string
          description: name
        genericTax:
          type: number
          description: genericTax
          default: 0
        genericTaxRate:
          type: number
          description: genericTaxRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemslineItemDetails:
      required:
        - name
        - pricePerItem
        - taxRate
      properties:
        name:
          type: string
          description: name
        taxRate:
          type: number
          description: taxRate
        pricePerItem:
          type: number
          description: pricePerItem
          default: 0
        hsnOrSacCode:
          type: string
          description: hsnOrSacCode
        description:
          type: string
          description: description
        companyId:
          type: string
          description: companyId
        erpId:
          type: string
          description: erpId
        lineItemId:
          type: string
          description: lineItemId
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemstax:
      required:
        - total
      properties:
        total:
          type: number
          description: total
          default: 0
        gstTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemstaxgstTax
        cessTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemstaxcessTax
        serviceTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemstaxserviceTax
        tdsTax:
          $ref: >-
            #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemstaxtdsTax
        otherTaxes:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreateCreditNotesExternalAPICreditNoteModellineItemstaxotherTaxes
        cgst:
          type: number
          description: cgst
        sgst:
          type: number
          description: sgst
        igst:
          type: number
          description: igst
        tds:
          type: number
          description: tds
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemstaxgstTax:
      required:
        - cgst
        - cgstRate
        - igst
        - igstRate
        - sgst
        - sgstRate
        - totalGst
        - totalGstRate
      properties:
        totalGst:
          type: number
          description: totalGst
          default: 0
        totalGstRate:
          type: number
          description: totalGstRate
          default: 0
        cgst:
          type: number
          description: cgst
          default: 0
        cgstRate:
          type: number
          description: cgstRate
          default: 0
        sgst:
          type: number
          description: sgst
          default: 0
        sgstRate:
          type: number
          description: sgstRate
          default: 0
        igst:
          type: number
          description: igst
          default: 0
        igstRate:
          type: number
          description: igstRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemstaxcessTax:
      required:
        - cess
        - cessRate
      properties:
        cess:
          type: number
          description: cess
          default: 0
        cessRate:
          type: number
          description: cessRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemstaxserviceTax:
      required:
        - serviceTax
        - serviceTaxRate
      properties:
        serviceTax:
          type: number
          description: serviceTax
          default: 0
        serviceTaxRate:
          type: number
          description: serviceTaxRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemstaxtdsTax:
      required:
        - tds
        - tdsRate
      properties:
        tds:
          type: number
          description: tds
          default: 0
        tdsRate:
          type: number
          description: tdsRate
          default: 0
      type: object
    CreateCreditNotesExternalAPICreditNoteModellineItemstaxotherTaxes:
      required:
        - genericTax
        - genericTaxRate
        - name
      properties:
        name:
          type: string
          description: name
        genericTax:
          type: number
          description: genericTax
          default: 0
        genericTaxRate:
          type: number
          description: genericTaxRate
          default: 0
      type: object

````