---
title: "List inventory transactions"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/inventorytransaction"
tags: ["Inventory Transaction"]
---

# List inventory transactions

`GET /api/business/{businessId}/branch/{branchId}/inventorytransaction`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/inventorytransaction`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/inventorytransaction/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of inventory transactions for the specified business id and branch id. List can be filtered by transaction type, deleted status, compensating transaction status, and update time range.

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `type` string
- `deleted` boolean
- `compensatingTransaction` boolean
- `updated_from` string
- `updated_to` string

## Response `200`

Inventory transactions listed

- DataPagedModelInventoryTransaction
  - `_embedded` object
    - `inventoryTransactions` InventoryTransaction[]
      - `id` string: Inventory transaction id
      - `inventoryId` string: Inventory id
      - `transactionDateTime` string, date-time: Date time of the transaction
      - `quantityChange` number: Quantity change
      - `type` string: Type of transaction
      - `relatedTransactionDateTime` string, date-time: Date time of the related transaction
      - `relatedTransactionDeleted` boolean: Whether the related transaction is deleted
      - `compensatingTransaction` boolean: Whether this is a compensating transaction
      - `purchaseItemId` string: Purchase item reference
      - `stockTakeItemId` string: Stock take item reference
      - `deleted` boolean: Whether the transaction is deleted
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)