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

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

# Stock Transfer Summary Response

## 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:
    StockTransferSummary:
      title: Stock Transfer Summary
      type: object
      properties:
        date:
          title: Date
          type: string
          description: The date of the summary
          format: date
        store_id:
          title: Store ID
          type: string
          description: The ID of the store within this system
        amount_tax:
          title: Amount Tax
          type: number
          description: The tax chargeable on the cost of goods being transferred
        transfer_type_id:
          title: Transfer Type
          type: string
          description: The type of transfer
        amount_inclusive:
          title: Amount Inclusive
          type: number
          description: The cost of goods being transferred, inclusive of tax
        amount_exclusive:
          title: Amount Exclusive
          type: number
          description: The cost of goods being transferred, exclusive of tax
        transfer_id:
          title: Transfer Id
          type: string
          description: Empty for summaries
        transaction_type:
          title: Transaction Type
          type: string
          description: The ID of the transaction type within this system
        direction:
          title: Transfer Direction
          type: string
          description: The direction of the transfer
      description: A summary of stock transfers for a given store on a given date
    PageNumber:
      title: Page Number
      type: integer
      description: The current page number
    TotalRecords:
      title: Total Record Count
      type: integer
      description: The total number of records in your query
    TotalPages:
      title: Total Page Count
      type: integer
      description: The total number of pages in your query
    PageSize:
      title: Page Size
      type: integer
      description: The maximum number of records in a single page
    StockTransferSummaryResponse:
      title: Stock Transfer Summary Response
      type: object
      properties:
        summary_lines:
          type: array
          description: A list of stock transfer summary records
          items:
            $ref: "#/components/schemas/StockTransferSummary"
        page_number:
          $ref: "#/components/schemas/PageNumber"
        total_records:
          $ref: "#/components/schemas/TotalRecords"
        total_pages:
          $ref: "#/components/schemas/TotalPages"
        page_size:
          $ref: "#/components/schemas/PageSize"
```