---
title: "GET /inventory"
method: GET
path: "/inventory"
tags: ["Inventory"]
---

# GET /inventory

`GET /inventory`

## Request

- Base URL: `https://api.railz.ai`
- URL: `https://api.railz.ai/inventory`
- Auth: HTTP bearer

Gets the latest inventory/items for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks', required
- `offset` number
- `limit` number
- `orderBy` string

## Response `200`

- GetInventoryResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `count` number, required
  - `meta` ListReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `data` GetInventoryDataV1[], required
    - `id` string, required
    - `name` string
    - `code` string
    - `sourceModifiedDate` string, date-time
    - `billItem` BillOrInvoiceItem
      - `description` string
      - `unitPrice` number, float
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
      - `taxRateRef` TaxRateRef
        - `id` string, required
        - `name` string
        - `effectiveTaxRate` number, float
    - `invoiceItem` BillOrInvoiceItem
      - `description` string
      - `unitPrice` number, float
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
      - `taxRateRef` TaxRateRef
        - `id` string, required
        - `name` string
        - `effectiveTaxRate` number, float
    - `isInvoiceItem` boolean
    - `isBillItem` boolean
    - `subsidiaryRefs` InventorySubsidiaryRef[]
      - `id` string
      - `name` string
    - `quantityOnHand` QuantityOnHandData[]
      - `locationRef` InventoryLocationRef
        - `id` string, required
        - `name` string
      - `quantity` number, float
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
    - `type` 'inventory' | 'nonInventory' | 'service'
    - `quantityOnHandPerLocation` QuantityOnHandData[]
      - `locationRef` InventoryLocationRef
        - `id` string, required
        - `name` string
      - `quantity` number, float
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
    - `itemStatus` 'unknown' | 'active' | 'archived', required

## Other responses

- `202`: Data in pending state
- `204`: No data available
- `400`: Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401`: Unauthorized - Not logged in or log in expired
- `403`: Forbidden - Not enough permission
- `500`: Server Error

## Changes

- **2026-08-10** `5cdfae3fa1fa`: 13 breaking, 26 warning, 8 info
  - removed the enum value `plaid` from the `query` request parameter `serviceName`
  - removed the enum value `shopify` from the `query` request parameter `serviceName`
  - removed the enum value `square` from the `query` request parameter `serviceName`
  - the response property `data/items/name` became optional for the status `200`
  - …43 more

[Operation history](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/changes/inventory/get.md)

---

[API](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api.md) - [All operations](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/revisions/1383b9a47ac9?raw)