---
title: "List catalog allowances"
method: GET
path: "/catalog/allowances"
tags: ["catalog"]
---

# List catalog allowances

`GET /catalog/allowances`

Returns a paginated list of catalog allowances, filterable by company, catalog entry, location, and effective date.

## Query parameters

- `ottimate_company_id` integer
- `catalog_entry_id` string
- `ottimate_location_id` integer
- `effective_date` string, date
- `page` integer
- `limit` integer

## Headers

- `Authorization` string, required
- `X-Api-Key` string, required
- `X-API-Version` string

## Response `200`

Successful response with paginated allowance list

- CatalogAllowanceListResponse
  - `count` integer, required
  - `page` integer — Current page number
  - `per_page` integer — Items per page
  - `results` CatalogAllowanceListResponseResultsItems[], required
    - `id` string, required — Unique identifier
    - `catalog_entry_id` string, required — Associated catalog entry ID (prefixed with cte_)
    - `ottimate_company_id` integer, required — Company ID
    - `ottimate_location_id` integer — Location ID
    - `ottimate_group_id` integer — Location group ID
    - `allowance_type` 'allowance' | 'discount' | 'rebate', required — Type of allowance
    - `amount` string, required — Allowance amount (decimal string)
    - `unit_allowance` string — Unit allowance amount (decimal string)
    - `percent_allowance` string — Percentage-based allowance (decimal string). Always present and non-null - "0.00" when the allowance is not percent-mode.
    - `target` integer, required — Target code (10=company, 15=location_group, 20=location)
    - `target_type` 'company' | 'location_group' | 'location' — Human-readable target type
    - `start_date` string, required — Start date
    - `start_date_utc` string, date-time, nullable — UTC equivalent of start_date. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".
    - `end_date` string — End date
    - `end_date_utc` string, date-time, nullable — UTC equivalent of end_date. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".
    - `reference_id` string — Unique key
    - `created_date` string, date-time — Record creation date
    - `created_date_utc` string, date-time, nullable — UTC equivalent of created_date. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".
    - `last_modified_date` string, date-time — Record last modified date
    - `last_modified_date_utc` string, date-time, nullable — UTC equivalent of last_modified_date. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".

## Other responses

- `400` — Bad request - Invalid parameters or request format
- `403` — Forbidden - Access denied or insufficient permissions

---

[API](https://skmtc.dev/ottimate/apis/api-reference.md) · [All operations](https://skmtc.dev/ottimate/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ottimate/api-reference/revisions/ba91ff4c6969/schema)
