Zoho Inventory credit-notes API

Credit-Notes Module

OpenAPI Specification

zoho-inventory-credit-notes-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: batches credit-notes API
  description: Batches help you track inventory items by batch numbers, manufacturing dates, and expiration dates.
  contact: {}
  version: 1.0.0
servers:
- url: https://www.zohoapis.com/inventory/v1
  description: API Endpoint
tags:
- name: credit-notes
  description: Credit-Notes Module
paths:
  /creditnotes:
    x-mcp-group:
    - Credit Notes
    parameters:
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: create_credit_note
      summary: Create a credit note
      description: To create a credit note for a customer.
      parameters:
      - name: invoice_id
        in: query
        description: Invoice ID of the required invoice.
        required: false
        schema:
          type: string
        example: '90300000079426'
      - name: ignore_auto_number_generation
        in: query
        description: Set to true if you need to provide your own credit note number.
        required: false
        schema:
          type: boolean
        example: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create-a-credit-note-request'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
    get:
      tags:
      - credit-notes
      operationId: list_credit_notes
      summary: List all Credit Notes
      description: List all the Credit Notes.
      parameters:
      - name: creditnote_number
        in: query
        description: Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]
        required: false
        schema:
          type: string
        example: CN-29
      - name: date
        in: query
        description: The date on which the credit note was raised. Format [yyyy-mm-dd]
        required: false
        schema:
          type: string
        example: '2016-06-05'
      - name: status
        in: query
        description: Status of the credit note. This can be <code>open</code>, <code>closed</code> or <code>void</code>.
        required: false
        schema:
          type: string
        example: draft
      - name: total
        in: query
        description: Total credits raised in this credit note.
        required: false
        schema:
          type: number
          format: double
        example: 450
      - name: reference_number
        in: query
        description: Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]
        required: false
        schema:
          type: string
        example: INV-384
      - name: customer_name
        in: query
        description: Name of the customer to whom the credit note is raised. Max-Length [100]
        required: false
        schema:
          type: string
        example: Bowman Furniture
      - name: item_name
        in: query
        description: Search credit notes by item name.Max_length [100]
        required: false
        schema:
          type: string
        example: kit
      - name: customer_id
        in: query
        description: Customer ID of the customer for whom the credit note is raised.
        required: false
        schema:
          type: string
        example: '903000000000099'
      - name: item_description
        in: query
        description: description for the item.Variants <code>item_description_startswith</code> and <code>item_description_contains</code>. Max-length [100]
        required: false
        schema:
          type: string
        example: ''
      - name: item_id
        in: query
        description: Unique string generated for the item for which a refund has to be made.
        required: false
        schema:
          type: string
        example: '90300000081501'
      - name: line_item_id
        in: query
        description: Search credit notes by credit note line item id.
        required: false
        schema:
          type: string
        example: 903000006245
      - name: tax_id
        in: query
        description: Unique ID to denote the tax associated with the credit note.
        required: false
        schema:
          type: string
        example: '903000000000356'
      - name: filter_by
        in: query
        description: Filter credit notes by statuses. Allowed values <code>Status.All</code> <code>Status.Open</code> <code>Status.Draft</code> <code>Status.Closed</code> and <code>Status.Void</code>
        required: false
        schema:
          type: string
        example: ''
      - name: search_text
        in: query
        description: Search credit notes by credit note number or customer name or credit note reference number. Max-length [100]
        required: false
        schema:
          type: string
        example: ''
      - name: sort_column
        in: query
        description: Sort the credit notes by the following columns - customer_name, creditnote_number, balance, total, date and created_time. Allowed Values <code>customer_name</code> <code>creditnote_number</code> <code>balance</code> <code>total</code> <code>date</code> and <code>created_time</code>
        required: false
        schema:
          type: string
        example: created_time
      - name: page
        in: query
        description: Page number to be fetched. Default value is 1.
        required: false
        schema:
          type: integer
          default: 1
        example: 1
      - name: per_page
        in: query
        description: Number of records to be fetched per page. Default value is 200.
        required: false
        schema:
          type: integer
          default: 200
        example: 200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-all-credit-notes-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
  /creditnotes/{creditnote_id}:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    put:
      tags:
      - credit-notes
      operationId: update_credit_note
      summary: Update a credit note
      description: To update the details of an existing creditnote.
      parameters:
      - name: ignore_auto_number_generation
        in: query
        description: Set to true if you need to provide your own credit note number.
        required: false
        schema:
          type: boolean
        example: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-a-credit-note-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.UPDATE
    get:
      tags:
      - credit-notes
      operationId: get_credit_note
      summary: Get a credit note
      description: Fetch the details of an existing creditnote.
      parameters:
      - name: print
        in: query
        description: Export credit note PDF using the default print option. The allowed values are <code>true</code>, <code>false</code>, <code>on</code> and <code>off</code>
        required: false
        schema:
          type: boolean
        example: true
      - name: accept
        in: query
        description: You can fetch the credit note details as json/pdf/html. The default format is html. The allowed values are <code>json</code>, <code>pdf</code> and <code>html</code>
        required: false
        schema:
          type: string
        example: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
    delete:
      tags:
      - credit-notes
      operationId: delete_credit_note
      summary: Delete a credit note
      description: Delete an existing credit note.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.DELETE
  /creditnotes/{creditnote_id}/email:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: email_credit_note
      summary: Email a credit note
      description: Email a credit note.
      parameters:
      - name: customer_id
        in: query
        description: Customer ID of the customer for whom the credit note is raised.
        required: false
        schema:
          type: string
        example: '903000000000099'
      - name: attachments
        in: query
        description: The files to be attached with the email.
        required: false
        schema:
          type: string
          format: binary
        example: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email-a-credit-note-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
    get:
      tags:
      - credit-notes
      operationId: get_credit_note_email_content
      summary: Get email content
      description: Get email content of a credit note.
      parameters:
      - name: email_template_id
        in: query
        description: Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with the customer. If no template is associated with the customer, then default template will be used.
        required: false
        schema:
          type: string
        example: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-email-content-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
  /creditnotes/{creditnote_id}/void:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: mark_credit_note_as_void
      summary: Void a Credit Note
      description: Mark the credit note as Void.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/void-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/draft:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: mark_credit_note_as_draft
      summary: Convert Credit Note to Draft.
      description: Convert a voided credit note to Draft.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/convert-credit-note-to-draft-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/converttoopen:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: mark_credit_note_as_open
      summary: Convert credit note to Open
      description: Convert a credit note in Draft status to Open.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/convert-credit-note-to-open-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/submit:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: submit_credit_note
      summary: Submit a credit note for approval
      description: Submit a credit note for approval.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submit-a-credit-note-for-approval-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/approve:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - credit-notes
      operationId: approve_credit_note
      summary: Approve a credit note.
      description: Approve a credit note.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/approve-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/emailhistory:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: get_credit_note_email_history
      summary: Email history
      description: Get email history of a credit code.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-history-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
  /creditnotes/{creditnote_id}/address/billing:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    put:
      tags:
      - credit-notes
      operationId: update_credit_note_billing_address
      summary: Update billing address
      description: Updates the billing address for an existing credit note.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-billing-address-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-billing-address-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.UPDATE
  /creditnotes/{creditnote_id}/address/shipping:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    put:
      tags:
      - credit-notes
      operationId: update_credit_note_shipping_address
      summary: Update Shipping address
      description: Updates the shipping address for an existing credit note.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-shipping-address-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-shipping-address-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.UPDATE
  /creditnotes/templates:
    x-mcp-group:
    - Credit Notes
    parameters:
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: list_credit_note_templates
      summary: List the credit note templates
      description: Get all credit note pdf templates.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-the-credit-note-templates-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
  /creditnotes/{creditnote_id}/templates/{template_id}:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      required: true
      description: Unique identifier of the credit note.
      schema:
        type: string
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    put:
      tags:
      - credit-notes
      operationId: update_credit_note_template
      summary: Update a credit note template
      description: Update the pdf template associated with the credit note.
      parameters:
      - name: template_id
        in: path
        required: true
        description: Unique identifier of the credit note template.
        schema:
          type: string
        example: '90300000001336'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-a-credit-note-template-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.UPDATE
  /creditnotes/{creditnote_id}/invoices:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note.
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: list_invoices_credited
      summary: List invoices credited
      description: List invoices to which the credit note is applied.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-invoices-credited-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
    post:
      tags:
      - credit-notes
      operationId: apply_credits_to_invoices
      summary: Apply credits to invoices
      description: Apply credit note to existing invoices.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apply-credits-to-invoices-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apply-credits-to-invoices-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note.
      example: '90300000072369'
    - name: creditnote_invoice_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note invoice.
      example: '982000000567172'
    - $ref: '#/components/parameters/organization_id'
    delete:
      tags:
      - credit-notes
      operationId: delete_credits_applied_to_invoice
      summary: Delete credits applied to an invoice
      description: Delete the credits applied to an invoice.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-credits-applied-to-an-invoice-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.DELETE
  /creditnotes/{creditnote_id}/comments:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note.
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: list_credit_note_comments
      summary: List credit note comments & history
      description: Get history and comments of a credit note.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-credit-note-comments-and-history-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
    post:
      tags:
      - credit-notes
      operationId: create_credit_note_comment
      summary: Add a comment
      description: Add a comment to an existing credit note.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add-a-comment-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/add-a-comment-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/comments/{comment_id}:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note.
      example: '90300000072369'
    - name: comment_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the comment.
      example: '982000000570001'
    - $ref: '#/components/parameters/organization_id'
    delete:
      tags:
      - credit-notes
      operationId: delete_credit_note_comment
      summary: Delete a Comment
      description: Delete a credit note comment.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-a-comment-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.DELETE
  /creditnotes/refunds:
    x-mcp-group:
    - Credit Notes
    parameters:
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: list_credit_note_refunds_of_all_credit_notes
      summary: List credit note refunds
      description: List all refunds with pagination.
      parameters:
      - name: customer_id
        in: query
        description: Customer ID of the customer for whom the credit note is raised.
        required: false
        schema:
          type: string
        example: '903000000000099'
      - name: sort_column
        in: query
        description: Sort refunds list. Allowed Values <code>refund_mode</code>, <code>reference_number</code>, <code>date</code>, <code>creditnote_number</code>, <code>customer_name</code>, <code>amount_bcy</code> and <code>amount_fcy</code>
        required: false
        schema:
          type: string
        example: created_time
      - name: page
        in: query
        description: Page number to be fetched. Default value is 1.
        required: false
        schema:
          type: integer
          default: 1
        example: 1
      - name: per_page
        in: query
        description: Number of records to be fetched per page. Default value is 200.
        required: false
        schema:
          type: integer
          default: 200
        example: 200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-credit-note-refunds-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
  /creditnotes/{creditnote_id}/refunds:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note.
      example: '90300000072369'
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: list_credit_note_refunds_of_a_credit_notes
      summary: List refunds of a credit note
      description: List all refunds of an existing credit note.
      parameters:
      - name: page
        in: query
        description: Page number to be fetched. Default value is 1.
        required: false
        schema:
          type: integer
          default: 1
        example: 1
      - name: per_page
        in: query
        description: Number of records to be fetched per page. Default value is 200.
        required: false
        schema:
          type: integer
          default: 200
        example: 200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-refunds-of-a-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
    post:
      tags:
      - credit-notes
      operationId: create_credit_note_refund
      summary: Refund credit note
      description: Refund credit note amount.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refund-credit-note-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/refund-credit-note-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.CREATE
  /creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}:
    x-mcp-group:
    - Credit Notes
    parameters:
    - name: creditnote_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note.
      example: '90300000072369'
    - name: creditnote_refund_id
      in: path
      schema:
        type: string
      required: true
      description: Unique identifier of the credit note refund.
      example: '982000000567158'
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - credit-notes
      operationId: get_credit_note_refund
      summary: Get credit note refund
      description: Fetch the refund of a particular credit note.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-credit-note-refund-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.READ
    put:
      tags:
      - credit-notes
      operationId: update_credit_note_refund
      summary: Update credit note refund
      description: Update the refunded transaction.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-credit-note-refund-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-credit-note-refund-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.UPDATE
    delete:
      tags:
      - credit-notes
      operationId: delete_credit_note_refund
      summary: Delete credit note refund
      description: Delete a credit note refund.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-credit-note-refund-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.creditnotes.DELETE
components:
  schemas:
    list-refunds-of-a-credit-note-response:
      type: object
      properties:
        code:
          type: integer
          example: 0
          readOnly: true
        message:
          type: string
          example: The refunds of the existing credit note are displayed successfully.
          readOnly: true
        creditnote_refunds:
          type: array
          items:
            type: object
            properties:
              creditnote_refund_id:
                $ref: '#/components/schemas/creditnote_refund_id'
              creditnote_id:
                $ref: '#/components/schemas/creditnote_id'
              date:
                $ref: '#/components/schemas/date'
              refund_mode:
                $ref: '#/components/schemas/refund_mode'
              reference_number:
                $ref: '#/components/schemas/reference_number'
              creditnote_number:
                $ref: '#/components/schemas/creditnote_number'
              customer_name:
                $ref: '#/components/schemas/customer_name'
              description:
                description: A brief description about the item.
                type: string
                example: ''
              amount_bcy:
                $ref: '#/components/schemas/amount_bcy'
              amount_fcy:
                $ref: '#/components/schemas/amount_fcy'
        page_context:
          type: object
          properties:
            page:
              $ref: '#/components/schemas/page'
            per_page:
              $ref: '#/components/schemas/per_page'
            has_more_page:
              $ref: '#/components/schemas/has_more_page'
            rep

# --- truncated at 32 KB (125 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-inventory/refs/heads/main/openapi/zoho-inventory-credit-notes-api-openapi.yml