---
title: "SupplierInvoice"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c/schemas/SupplierInvoice"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c.md

# SupplierInvoice

Suplier Invoice Model

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: v2.1
servers:
  - url: https://api.retailexpress.com.au/v2.1
components:
  schemas:
    LandedCostsCalculation:
      title: ""
      enum:
        - Manual
        - Currency Conversion
      type: string
    CountryLimited:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: id
          format: int32
          nullable: true
        name:
          type: string
          description: name
          nullable: true
      additionalProperties: false
    DirectCosts:
      title: ""
      type: object
      properties:
        applied_on:
          type: string
          description: DirectCosts AppliedOn
          format: date-time
          nullable: true
        apply_pending:
          type: boolean
          description: Is DirectCosts Apply Pending
        freight:
          $ref: "#/components/schemas/DirectCostsItem"
        duty:
          $ref: "#/components/schemas/DirectCostsItem"
        misc:
          $ref: "#/components/schemas/DirectCostsItem"
      additionalProperties: false
      description: Direct costs model
    SupplierInvoicePurchaseOrderReceipt:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: PurchaseOrderReceipt Id
          format: int32
          nullable: true
        purchase_order_id:
          type: integer
          description: Purchase order identifier
          format: int32
          nullable: true
        purchase_order_receipt_items:
          type: array
          items:
            $ref: "#/components/schemas/SupplierInvoicePurchaseOrderReceiptItem"
          description: Purchase order receipts items
          nullable: true
      additionalProperties: false
      description: Supplier Invoice Purchase Order Receipt Model
    UserExtended:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id.
          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
    DirectCostsItem:
      title: ""
      type: object
      properties:
        total_ex:
          type: number
          description: Total ex
          format: double
        includes_tax:
          type: boolean
          description: Includes tax
          nullable: true
        total_tax:
          type: number
          description: Total tax
          format: double
        total_inc:
          type: number
          description: Total inc
          format: double
      additionalProperties: false
      description: Direct Costs Item model
    SupplierInvoicePurchaseOrderReceiptItem:
      title: ""
      type: object
      properties:
        purchase_order_item_id:
          type: integer
          description: Purchase order item identifier
          format: int32
          nullable: true
        buy_price_ex:
          type: number
          description: Buy price ex
          format: double
          nullable: true
        supplier_buy_ex:
          type: number
          description: Supplier buy ex
          format: double
          nullable: true
        quantity_received:
          type: integer
          description: Quantity received
          format: int32
        quantity_faulty:
          type: integer
          description: Quantity faulty
          format: int32
        quantity_invoiced:
          type: integer
          description: Quantity invoiced
          format: int32
          nullable: true
        bin:
          type: string
          description: Bin
          nullable: true
        include_tax:
          type: boolean
          description: Include tax
          nullable: true
        notes:
          type: string
          description: Notes
          nullable: true
      additionalProperties: false
      description: Purchase order receipt item
    SupplierInvoice:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id
          format: int32
        supplier_invoice_number:
          type: string
          description: Supplier Invoice Number
          nullable: true
        status:
          type: string
          description: Supplier Invoice status
          nullable: true
        notes:
          type: string
          description: Supplier Invoice notes
          nullable: true
        international_order:
          type: boolean
          description: Is International Order
        landed_costs_calculation:
          $ref: "#/components/schemas/LandedCostsCalculation"
        currency_conversion:
          type: number
          description: Currency multiplier
          format: double
          nullable: true
        rounding_adjustment:
          type: number
          description: Rounding Adjustment
          format: double
        origin_country:
          $ref: "#/components/schemas/CountryLimited"
        distribute_costs_by:
          type: string
          description: Distribute costs by
          nullable: true
        direct_costs:
          $ref: "#/components/schemas/DirectCosts"
        purchase_order_receipts:
          type: array
          items:
            $ref: "#/components/schemas/SupplierInvoicePurchaseOrderReceipt"
          description: Purchase Order Receipts
          nullable: true
        total_buy_price_ex:
          type: number
          description: Total buy price ex
          format: double
        total_tax:
          type: number
          description: Total tax
          format: double
          nullable: true
        total_buy_price_inc:
          type: number
          description: Total buy price inc
          format: double
          nullable: true
        total_applied_buy_price_ex:
          type: number
          description: Total applied buy price ex
          format: double
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        created_by:
          $ref: "#/components/schemas/UserExtended"
        modified_on:
          type: string
          description: Modified on
          format: date-time
          nullable: true
        modified_by:
          $ref: "#/components/schemas/UserExtended"
        finalised_on:
          type: string
          description: Finalised on
          format: date-time
          nullable: true
        finalised_by:
          $ref: "#/components/schemas/UserExtended"
        supplier_invoiced_on:
          type: string
          description: Supplier Invoiced On
          format: date-time
          nullable: true
      additionalProperties: false
      description: Suplier Invoice Model
```