> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.papertracc.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.papertracc.com/_mcp/server.

# Get Inventories

GET https://api.papertracc.com/v1/sales/inventory?limit=20

Lists inventory records.

Requires the `can_view_sales_inventory` permission on the key owner's role.

**Keys:** secret key only.

Reference: https://api-docs.papertracc.com/core/sales/inventory/get-inventories

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.
- `identity` header (required) — The identity for the active workspace.

## Servers

- `https://api.papertracc.com/v1` (Production, default)
- `https://api.papertracc.com/rc-1` (Release Candidate 1)

## Request

### Query parameters

- `limit` (integer, optional) — Optional. Number of records to return.

## Response

### 200

OK

- `data` (list of SalesInventoryLimit20GetResponsesContentApplicationJsonSchemaDataItems, required)
- `page` (integer, required)
- `count` (integer, required)
- `pages` (integer, required)
- `status` (boolean, required)
- `message` (string, required)
- `keyset` (any, optional)
- `last_id` (any, optional)

## Errors

### 401 Unauthorized Error

The API key is missing or invalid, the key owner is no longer an active member of the organisation, or the key owner is not a member of the workspace in the `identity` header.

- `status` (boolean, required)
- `message` (string, required)
- `error_code` (enum, optional) — Machine-readable reason. Present on 402 and 403 responses.
  - Allowed values: `PERMISSION_DENIED`, `SERVICE_DISABLED`, `OPEN_API_NOT_ENABLED`
- `permission` (string, optional) — The role permission the request needs. Set when `error_code` is `PERMISSION_DENIED`.
- `service` (string, optional) — The workspace service that is turned off. Set when `error_code` is `SERVICE_DISABLED`.

### 402 Payment Required Error

The workspace's subscription plan does not include the Open API.

- `status` (boolean, required)
- `message` (string, required)
- `error_code` (enum, optional) — Machine-readable reason. Present on 402 and 403 responses.
  - Allowed values: `PERMISSION_DENIED`, `SERVICE_DISABLED`, `OPEN_API_NOT_ENABLED`
- `permission` (string, optional) — The role permission the request needs. Set when `error_code` is `PERMISSION_DENIED`.
- `service` (string, optional) — The workspace service that is turned off. Set when `error_code` is `SERVICE_DISABLED`.

### 403 Forbidden Error

Either the key owner's role does not include the permission this endpoint needs (`PERMISSION_DENIED`), or the service this endpoint belongs to is turned off for the workspace (`SERVICE_DISABLED`).

- `status` (boolean, required)
- `message` (string, required)
- `error_code` (enum, optional) — Machine-readable reason. Present on 402 and 403 responses.
  - Allowed values: `PERMISSION_DENIED`, `SERVICE_DISABLED`, `OPEN_API_NOT_ENABLED`
- `permission` (string, optional) — The role permission the request needs. Set when `error_code` is `PERMISSION_DENIED`.
- `service` (string, optional) — The workspace service that is turned off. Set when `error_code` is `SERVICE_DISABLED`.

## Types

### SalesInventoryLimit20GetResponsesContentApplicationJsonSchemaDataItems

- `id` (string, required)
- `sku` (string, required)
- `name` (string, required)
- `type` (string, required)
- `usage` (string, required)
- `amount` (string, required)
- `created_at` (datetime, required)
- `project_id` (string, required)
- `cost_prices` (list of SalesInventoryLimit20GetResponsesContentApplicationJsonSchemaDataItemsCostPricesItems, required)
- `sales_tax_id` (string, required)
- `selling_prices` (list of SalesInventoryLimit20GetResponsesContentApplicationJsonSchemaDataItemsSellingPricesItems, required)
- `purchase_tax_id` (string, required)
- `is_tax_inclusive` (boolean, required)
- `sales_account_id` (string, required)
- `sales_description` (string, required)
- `purchase_vendor_id` (string, required)
- `purchase_account_id` (string, required)
- `purchase_description` (string, required)

### SalesInventoryLimit20GetResponsesContentApplicationJsonSchemaDataItemsCostPricesItems

- `rate` (double, required)
- `currency_code` (string, required)

### SalesInventoryLimit20GetResponsesContentApplicationJsonSchemaDataItemsSellingPricesItems

- `rate` (double, required)
- `currency_code` (string, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "55a40b4d-a23a-49aa-a417-828913e9a5c8",
      "sku": "SKU-1001",
      "name": "Office Desk",
      "type": "GOODS",
      "usage": "SALE_AND_PURCHASE",
      "amount": "150000.00",
      "created_at": "2026-06-18T10:00:00Z",
      "project_id": "spruce-demo",
      "cost_prices": [
        {
          "rate": 100000,
          "currency_code": "NGN"
        }
      ],
      "sales_tax_id": "78c68f6d-d734-4822-9a6c-73f517a0e5c1",
      "selling_prices": [
        {
          "rate": 150000,
          "currency_code": "NGN"
        }
      ],
      "purchase_tax_id": "78c68f6d-d734-4822-9a6c-73f517a0e5c1",
      "is_tax_inclusive": true,
      "sales_account_id": "d037d299-3029-4dc7-8e72-172f80f23c4f",
      "sales_description": "Office desk sold to customers",
      "purchase_vendor_id": "0cb2d1a5-2f50-43a1-8c3f-df06f998ef51",
      "purchase_account_id": "e35f42b4-a6e2-4664-96df-d2cf3f1a6f33",
      "purchase_description": "Office desk purchased from vendors"
    }
  ],
  "page": 0,
  "count": 1,
  "pages": 1,
  "status": true,
  "message": "Successfully fetched inventories"
}
```

**SDK Code**

```python Sales_Inventory_Get Inventories_example
import requests

url = "https://api.papertracc.com/v1/sales/inventory"

querystring = {"limit":"20"}

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Sales_Inventory_Get Inventories_example
const url = 'https://api.papertracc.com/v1/sales/inventory?limit=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Sales_Inventory_Get Inventories_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.papertracc.com/v1/sales/inventory?limit=20"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Sales_Inventory_Get Inventories_example
require 'uri'
require 'net/http'

url = URI("https://api.papertracc.com/v1/sales/inventory?limit=20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java Sales_Inventory_Get Inventories_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.papertracc.com/v1/sales/inventory?limit=20")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php Sales_Inventory_Get Inventories_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.papertracc.com/v1/sales/inventory?limit=20', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Sales_Inventory_Get Inventories_example
using RestSharp;

var client = new RestClient("https://api.papertracc.com/v1/sales/inventory?limit=20");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Sales_Inventory_Get Inventories_example
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.papertracc.com/v1/sales/inventory?limit=20")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```