---
title: "SupplierCredit"
url: "https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c/schemas/SupplierCredit"
---

> Full API specification: https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c.md

# SupplierCredit

A supplier credit

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: PublicApi
  version: 0.1.0
servers:
  - url: https://api.retailexpress.com.au/{basePath}
    variables:
      basePath:
        default: v1
components:
  schemas:
    CreditNoteLine:
      type: object
      properties:
        amount_tax:
          title: Amount Tax
          type: number
          description: The tax chargeable on the cost of the supplier credit
        amount_inclusive:
          title: Amount Inclusive
          type: number
          description: The cost of the supplier credit, inclusive of tax
        amount_exclusive:
          title: Amount Exclusive
          type: number
          description: The cost of the supplier credit, exclusive of tax
        transaction_type:
          title: Transaction Type
          type: string
          description: The type of supplier credit
      description: A supplier credit
    SupplierCredit:
      type: object
      properties:
        store_id:
          title: Store ID
          type: string
          description: The ID of the store
        date:
          title: Date
          type: string
          description: The date the supplier credit was received
        supplier_credit_note_date:
          title: Supplier Credit Note Date
          type: string
          description: The supplier credit note date
        credit_note_lines:
          type: array
          description: A list of items in supplier credit
          items:
            $ref: "#/components/schemas/CreditNoteLine"
        credit_note_id:
          title: Id
          type: string
          description: The id of the credit note
        supplier_reference:
          title: The supplier reference
          type: string
          description: The supplier reference
        supplier_return_id:
          title: Supplier Return Id
          type: integer
          description: The id of the supplier return
        supplier_id:
          title: Supplier Id
          type: string
          description: The ID of the supplier within this system
      description: A supplier credit
```