Zoho Inventory vendor-credits API

openapi: 3.2.0
info:
  title: batches Vendor Credits 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: vendor-credits
  description: Vendor-Credits Module
paths:
  /vendorcredits:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: create_vendor_credit
      summary: Create a vendor credit
      description: Create a vendor credit for a vendor.
      parameters:
      - name: ignore_auto_number_generation
        in: query
        description: Ignore auto number generation for this vendor credit only. On enabling this option vendor credit number is mandatory.
        required: false
        schema:
          type: boolean
      - name: bill_id
        in: query
        description: Bill Associated with the Vendor Credit
        required: false
        schema:
          type: string
        example: '460000000057075'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create-a-vendor-credit-request'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create-a-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
    get:
      tags:
      - vendor-credits
      operationId: list_vendor_credits
      summary: List vendor credits
      description: List vendor credits with pagination.
      parameters:
      - name: vendor_credit_number
        in: query
        description: 'Search vendor credits by vendor credit number. Variants: <code>vendor_credit_number_startswith</code> and <code>vendor_credit_number_contains</code>'
        required: false
        schema:
          type: string
        example: DN-00002
      - name: date
        in: query
        description: 'General Format: yyyy-mm-dd. Search vendor credits by date. Variants: <code>date.start</code>, <code>date.end</code>, <code>date.before</code> and <code>date.after</code>'
        required: false
        schema:
          type: string
        example: '2014-08-28'
      - name: status
        in: query
        description: 'Search vendor credits by vendor credit status. Allowed statuses are open, closed and void. Allowed Values: <code>open</code>, <code>closed</code> and <code>void</code>'
        required: false
        schema:
          type: string
        example: open
      - name: total
        in: query
        description: 'Search vendor credits by total amount. Variants: <code>total_start</code>, <code>total_end</code>, <code>total_less_than</code>, <code>total_less_equals</code>, <code>total_greater_than</code> and <code>total_greater_equals</code>'
        required: false
        schema:
          type: string
        example: 30
      - name: reference_number
        in: query
        description: 'Search vendor credits by vendor credit reference number. Variants: <code>reference_number_startswith</code> and <code>reference_number_contains</code>'
        required: false
        schema:
          type: string
        example: ''
      - name: customer_name
        in: query
        description: 'Search vendor credits by vendor name. Variants: <code>customer_name_startswith</code> and <code>customer_name_contains</code>'
        required: false
        schema:
          type: string
        example: Bowman and Co
      - name: item_name
        in: query
        description: 'Search vendor credits by item name. Variants: <code>item_name_startswith</code> and <code>item_name_contains</code>'
        required: false
        schema:
          type: string
        example: ''
      - name: item_description
        in: query
        description: 'Search vendor credits by vendor credit item description. Variants: <code>item_description_startswith</code> and <code>item_description_contains</code>'
        required: false
        schema:
          type: string
        example: ''
      - name: notes
        in: query
        description: 'Search vendor credits by vendor credit notes. Variants: <code>notes_startswith</code> and <code>notes_contains</code>'
        required: false
        schema:
          type: string
        example: ''
      - name: custom_field
        in: query
        description: 'Search vendor credits by custom field. Variants : <code>custom_field_startswith</code> and <code>custom_field_contains</code>'
        required: false
        schema:
          type: string
        example: ''
      - name: last_modified_time
        in: query
        description: Search vendor credits by vendor credit last modfified time
        required: false
        schema:
          type: string
        example: 2014-08-28T22:53:31-0700
      - name: customer_id
        in: query
        description: Search vendor credits by vendor credit customer ID
        required: false
        schema:
          type: string
        example: ''
      - name: line_item_id
        in: query
        description: Search vendor credits by vendor credit line item ID
        required: false
        schema:
          type: string
        example: '460000000020077'
      - name: item_id
        in: query
        description: Search vendor credits by vendor credit item ID
        required: false
        schema:
          type: string
        example: '460000000020071'
      - name: tax_id
        in: query
        description: Search vendor credits by vendor credit tax ID
        required: false
        schema:
          type: string
        example: ''
      - name: filter_by
        in: query
        description: 'Filter vendor credits 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 vendor credits by vendor credit number or vendor name or vendor credit reference number.
        required: false
        schema:
          type: string
        example: ''
      - name: sort_column
        in: query
        description: 'Sort vendor credits by following columns vendor_name, vendorcredit_number, balance, total, date and created_time. Allowed Values: <code>vendor_name</code>, <code>vendor_credit_number</code>, <code>balance</code>, <code>total</code>, <code>date</code>, <code>created_time</code>, <code>last_modified_time</code> and <code>reference_number</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-vendor-credits-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
  /vendorcredits/{vendor_credit_id}:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    put:
      tags:
      - vendor-credits
      operationId: update_vendor_credit
      summary: Update vendor credit
      description: Update an existing vendor credit.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-vendor-credit-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.UPDATE
    get:
      tags:
      - vendor-credits
      operationId: get_vendor_credit
      summary: Get vendor credit
      description: Get details of a vendor credit.
      parameters:
      - name: print
        in: query
        description: 'Export vendor credit pdf with default print option. Allowed Values: <code>true</code>, <code>false</code>, <code>on</code> and <code>off</code>.'
        required: false
        schema:
          type: boolean
      - name: accept
        in: query
        description: 'You can get vendor credit details as json/pdf/html. Default format is html. Allowed Values: <code>json</code>, <code>xml</code>, <code>csv</code>, <code>xls</code>, <code>pdf</code>, <code>html</code> and <code>jhtml</code>.'
        required: false
        schema:
          type: string
        example: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
    delete:
      tags:
      - vendor-credits
      operationId: delete_vendor_credit
      summary: Delete vendor credit
      description: Delete a vendor credit.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.DELETE
  /vendorcredits/{vendor_credit_id}/status/open:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: mark_vendor_credit_as_open
      summary: Convert to open
      description: Change an existing vendor credit status to open.
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/convert-to-open-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
  /vendorcredits/{vendor_credit_id}/status/void:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: mark_vendor_credit_as_void
      summary: Void vendor credit
      description: Mark an existing vendor credit as void.
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/void-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
  /vendorcredits/{vendor_credit_id}/submit:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: submit_vendor_credit
      summary: Submit a Vendor credit for approval
      description: Submit a Vendor credit for approval.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submit-a-vendor-credit-for-approval-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
  /vendorcredits/{vendor_credit_id}/approve:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: approve_vendor_credit
      summary: Approve a Vendor credit
      description: Approve a Vendor credit.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/approve-a-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
  /vendorcredits/{vendor_credit_id}/bills:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - vendor-credits
      operationId: list_vendor_credited_bills
      summary: List bills credited
      description: List bills to which the vendor credit is applied.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-bills-credited-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
    post:
      tags:
      - vendor-credits
      operationId: apply_vendor_credit_to_bill
      summary: Apply credits to a bill
      description: Apply vendor credit to existing bills.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apply-credits-to-a-bill-request'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apply-credits-to-a-bill-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
  /vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id}:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    delete:
      tags:
      - vendor-credits
      operationId: delete_vendor_credited_bill
      summary: Delete bills credited
      description: Delete the credits applied to a bill.
      parameters:
      - name: vendor_credit_bill_id
        in: path
        required: true
        description: Unique identifier of the vendor credit bill.
        schema:
          type: string
        example: '460000000057075'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-bills-credited-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.DELETE
  /vendorcredits/{vendor_credit_id}/refunds:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: refund_vendor_credit
      summary: Refund a vendor credit
      description: Refund vendor credit amount.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refund-a-vendor-credit-request'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/refund-a-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
    get:
      tags:
      - vendor-credits
      operationId: list_refunds_of_a_vendor_credit
      summary: List refunds of a vendor credit
      description: List all refunds of an existing vendor credit.
      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-vendor-credit-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
  /vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    put:
      tags:
      - vendor-credits
      operationId: update_vendor_credit_refund
      summary: Update vendor credit refund
      description: Update the refunded transaction.
      parameters:
      - name: vendor_credit_refund_id
        in: path
        required: true
        description: Unique identifier of the vendor credit refund.
        schema:
          type: string
        example: '3000000003151'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-vendor-credit-refund-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-vendor-credit-refund-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.UPDATE
    get:
      tags:
      - vendor-credits
      operationId: get_vendor_credit_refund
      summary: Get vendor credit refund
      description: Get refund of a particular vendor credit.
      parameters:
      - name: vendor_credit_refund_id
        in: path
        required: true
        description: Unique identifier of the vendor credit refund.
        schema:
          type: string
        example: '3000000003151'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-vendor-credit-refund-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
    delete:
      tags:
      - vendor-credits
      operationId: delete_vendor_credit_refund
      summary: Delete vendor credit refund
      description: Delete a vendor credit refund.
      parameters:
      - name: vendor_credit_refund_id
        in: path
        required: true
        description: Unique identifier of the vendor credit refund.
        schema:
          type: string
        example: '3000000003151'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-vendor-credit-refund-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.DELETE
  /vendorcredits/refunds:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - $ref: '#/components/parameters/organization_id'
    get:
      tags:
      - vendor-credits
      operationId: list_refunds_of_all_vendor_credits
      summary: List vendor credit refunds
      description: List all refunds with pagination.
      parameters:
      - name: customer_id
        in: query
        description: Search vendor credits by vendor credit customer ID
        required: false
        schema:
          type: string
        example: ''
      - name: last_modified_time
        in: query
        description: Search vendor credits by vendor credit last modfified time
        required: false
        schema:
          type: string
        example: 2014-08-28T22:53:31-0700
      - name: sort_column
        in: query
        description: 'Sort vendor credits by following columns vendor_name, vendorcredit_number, balance, total, date and created_time. Allowed Values: <code>vendor_name</code>, <code>vendor_credit_number</code>, <code>balance</code>, <code>total</code>, <code>date</code>, <code>created_time</code>, <code>last_modified_time</code> and <code>reference_number</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-vendor-credit-refunds-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
  /vendorcredits/{vendor_credit_id}/comments:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    post:
      tags:
      - vendor-credits
      operationId: add_vendor_credit_comment
      summary: Add a comment
      description: Add a comment to an existing vendor credit.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add-a-comment-request'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/add-a-comment-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.CREATE
    get:
      tags:
      - vendor-credits
      operationId: list_vendor_credit_comments
      summary: List vendor credit comments & history
      description: Get history and comments of a vendor credit.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-vendor-credit-comments-and-history-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.READ
  /vendorcredits/{vendor_credit_id}/comments/{comment_id}:
    x-mcp-group:
    - Vendor Credits
    parameters:
    - name: vendor_credit_id
      in: path
      required: true
      description: Unique identifier of the vendor credit.
      schema:
        type: string
      example: '3000000002075'
    - $ref: '#/components/parameters/organization_id'
    delete:
      tags:
      - vendor-credits
      operationId: delete_vendor_credit_comment
      summary: Delete a comment
      description: Delete a vendor credit comment.
      parameters:
      - name: comment_id
        in: path
        required: true
        description: Unique identifier of the comment.
        schema:
          type: string
        example: '3000000002089'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete-a-comment-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.debitnotes.DELETE
components:
  schemas:
    total_refunded_amount:
      type: number
      format: double
      example: 0
    vendor_credit_refund:
      type: object
      properties:
        vendor_credit_refund_id:
          $ref: '#/components/schemas/vendor_credit_refund_id'
        vendor_credit_id:
          $ref: '#/components/schemas/vendor_credit_id'
        date:
          $ref: '#/components/schemas/date'
        refund_mode:
          $ref: '#/components/schemas/refund_mode'
        reference_number:
          $ref: '#/components/schemas/reference_number'
        amount:
          $ref: '#/components/schemas/amount'
        exchange_rate:
          $ref: '#/components/schemas/exchange_rate'
        account_id:
          $ref: '#/components/schemas/account_id'
        account_name:
          $ref: '#/components/schemas/account_name'
        description:
          $ref: '#/components/schemas/description'
        imported_transactions:
          $ref: '#/components/schemas/imported_transactions'
    acquisition_vat_total:
      description: Total of the VAT Acquistion
      type: number
      format: double
      x-node_available_in:
      - uk
      - eu
      x-node_unavailable_in: []
    commented_by_id:
      description: ID of the User who caused the comment
      type: string
      example: '3000000000741'
    acquisition_vat_percentage:
      description: Percentage of the VAT Acquistion
      type: string
      x-node_available_in:
      - uk
      - eu
      x-node_unavailable_in: []
    add-a-comment-request:
      required:
      - description
      type: object
      properties:
        description:
          description: Description of the Comment
          type: string
          example: Credits applied to Bill 1
    bill_number:
      type: string
    delete-vendor-credit-response:
      type: object
      properties:
        code:
          type: integer
          example: 0
          readOnly: true
        message:
          type: string
          example: The vendor credit has been deleted.
          readOnly: true
    account_id:
      description: ID of the account, the line item is associated with
      type: string
      example: '460000000020097'
    item_total_inclusive_of_tax:
      description: Total price of the Item inclusive of Tax
      type: number
      format: double
      example: 30
    transaction_id:
      description: Transaction ID that caused the Comment
      type: string
      example: '460000000069087'
    tax_type:
      description: Type of the Tax
      type: string
    location_id:
      description: Location ID
      type: string
      example: '460000000038080'
    list-bills-credited-response:
      type: object
      properties:
        code:
          type: integer
          example: 0
          readOnly: true
        message:
          type: string
          example: success
          readOnly: true
        bills_credited:
          type: array
          items:
            type: object
            properties:
              vendor_credit_id:
                $ref: '#/components/schemas/vendor_credit_id'
              bill_id:
                $ref: '#/components/schemas/bill_id'
              vendor_credit_bill_id:
                $ref: '#/components/schemas/vendor_credit_bill_id'
              date:
                $ref: '#/components/schemas/date'
              bill_number:
                $ref: '#/components/schemas/bill_number'
    list-vendor-credit-refunds-response:
      type: object
      properties:
        code:
          type: integer
          example: 0
          readOnly: true
        message:
          type: string
          example: success
          readOnly: true
        vendor_credit_refunds:
          type: array
          items:
            type: object
            properties:
              vendor_credit_refund_id:
                $ref: '#/components/schemas/vendor_credit_refund_id'
              vendor_credit_id:
                $ref: '#/components/schemas/vendor_credit_id'
              date:
                description: Date of the Vendor Credit Refund
                type: string
                example: '2017-01-22'
              refund_mode:
                $ref: '#/components/schemas/refund_mode'
              reference_number:
                $ref: '#/components/schemas/reference_number'
              amount:
                $ref: '#/components/schemas/amount'
              vendor_credit_number:
                $ref: '#/components/schemas/vendor_credit_number'
              customer_name:
                $ref: '#/components/schemas/customer_name'
              description:
                description: Description of the Vendor Credit Refund
                type: string
                example: Cheque deposit
              amount_bcy:
                $ref: '#/components/schemas/amount_bcy'
              amount_fcy:
                $ref: '#/components/schemas/amount_fcy'
    reverse_charge_tax_name:
      description: Enter the tax name of the reverse charge
      type: string
      example: intra
      x-node_available_in:
      - in
      x-node_unavailable_in: []
    apply-credits-to-a-bill-request:
      required:
      - bills
      type: object
      properties:
        bills:
          description: Amount applied from vendor credits to specified bills.
          type: array
          items:
            type: object
            required:
            - bill_id
            - amount_applied
            properties:
              bill_id:
                description: Bill Associated with the Vendor Credit
                type: string
                example: '460000000057075'
              amount_applied:
                description: Amount applied to the bill.
                type: number
                format: double
                example: 10
    location_name:
      description: Name of the location.
      type: string
    create-a-vendor-credit-response:
      type: object
      properties:
        code:
          type: integer
          example: 0
          readOnly: true
        message:
          type: string
          example: Vendor credit has been created.
          readOnly: true
        vendor_credit:
          $ref: '#/components/schemas/vendor_credit-response'
    notes:
      description: Notes for the Vendor Credit
      type: string
    tax_exemption_code:
      description: Code of the Tax Exemption associated
      type: string
      x-node_available_in:
      - in
      - au
      x-node_unavailable_in: []
    documents:
      type: array
      description: List of documents associated with the vendor credit
      items:
        type: object
        properties:
          document_id:
            $ref: '#/components/schemas/document_id'
          file_name:
            $ref: '#/components/schemas/file_name'
    reverse_charge_vat_id:
      description: ID of the Reverse Charge
      type: string
      x-node_available_in:
      - uk
      - eu
      x-node_unavailable_in: []
    tax_name:
      description: Name of the Tax
      type: string
    list-refunds-of-a-vendor-credit-response:
      type: object
      properties:
        code:
          type: integer
          example: 0
          readOnly: true
        message:
  

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