---
title: "CreditNoteItem"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed/schemas/CreditNoteItem"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed.md

# CreditNoteItem

Credit Note model

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: V2
servers:
  - url: https://api.retailexpress.com.au/v2
components:
  schemas:
    CreditNoteProduct:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Product id
          format: int32
          nullable: true
        supplier_sku:
          type: string
          description: Supplier SKU
          nullable: true
        manufacturer_sku:
          type: string
          description: Manufacturer SKU
          nullable: true
        supplier_sku2:
          type: string
          description: Supplier SKU 2
          nullable: true
        short_description:
          type: string
          description: Short Description
          nullable: true
        size:
          $ref: "#/components/schemas/ProductAttributeValue"
        colour:
          $ref: "#/components/schemas/ProductAttributeValue"
        modified_on:
          type: string
          description: Modified on
          format: date-time
      additionalProperties: false
      description: Product model for Credit Notes
    CreditNoteUser:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id of User
          format: int32
          nullable: true
        user_code:
          type: string
          description: User code.
          nullable: true
        first_name:
          type: string
          description: First name.
          nullable: true
        surname:
          type: string
          description: Surname.
          nullable: true
      additionalProperties: false
      description: Credit Note User
    ProductAttributeValue:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Attribute Value Id
          format: int32
          nullable: true
        name:
          type: string
          description: Attribute Value Name
          nullable: true
        list_order:
          type: integer
          description: List order
          format: int32
          nullable: true
      additionalProperties: false
    CreditNoteItem:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Credit Note Item id
          format: int32
          nullable: true
        credit_note_id:
          type: integer
          description: Credit Note id
          format: int32
        supplier_return_item_id:
          type: integer
          description: Supplier Return Item id
          format: int32
          nullable: true
        product:
          $ref: "#/components/schemas/CreditNoteProduct"
        credit_quantity:
          type: integer
          description: Credit Quantity
          format: int32
          nullable: true
        credit_amount_ex:
          type: number
          description: Credit Amount Ex
          format: double
          nullable: true
        total_credit_amount_ex:
          type: number
          description: Total Credit Amount Ex
          format: double
          nullable: true
        applied_credit_quantity:
          type: integer
          description: Applied Credit Quantity
          format: int32
          nullable: true
        applied_credit_tax:
          type: number
          description: Applied Credit Tax
          format: double
          nullable: true
        applied_credit_amount_inc:
          type: number
          description: Applied Credit Amount Inc
          format: double
          nullable: true
        applied_credit_amount_ex:
          type: number
          description: Applied Credit Amount Ex
          format: double
          nullable: true
        total_applied_credit_amount_ex:
          type: number
          description: Total Applied Credit Amount Ex
          format: double
          nullable: true
        total_credit_amount_inc:
          type: number
          description: Total Credit Amount Inc
          format: double
          nullable: true
        total_credit_amount_tax:
          type: number
          description: Total Credit Amount Tax
          format: double
          nullable: true
        total_applied_credit_amount_inc:
          type: number
          description: Total Applied Credit Amount Inc
          format: double
          nullable: true
        total_applied_credit_tax:
          type: number
          description: Total Applied Credit Tax
          format: double
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        modified_on:
          type: string
          description: Modified on
          format: date-time
        created_by:
          $ref: "#/components/schemas/CreditNoteUser"
        modified_by:
          $ref: "#/components/schemas/CreditNoteUser"
      additionalProperties: false
      description: Credit Note model
```