For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact UsDashboard
DocumentationAPI ReferenceChangelog
DocumentationAPI ReferenceChangelog
  • Get Started
    • Welcome
    • What is Ottimate?
    • Integration Journey
    • Sandbox Environment
    • Authentication
    • API Limits
    • Idempotency
    • Release Plan
  • Account Set Up
    • Onboarding an Ottimate account
    • Accounting Integration
  • Invoice Capture
    • Overview
  • Accounts payable
    • Overview
    • Purchase Orders
    • Purchase Receipts
    • Invoices
  • Catalog
    • Overview
    • Catalog-Entries
      • Allowances
LogoLogo
Contact UsDashboard
On this page
  • Configuration Requirements
  • Creating Allowances
  • Allowance Object Fields
  • Managing Allowances Separately
CatalogCatalog-Entries

Allowances

Learn how to manage allowances for a catalog entry
Was this page helpful?
Previous
Built with

Allowances represent item-specific discounts or rebates applied to catalog entries stored in Ottimate. Common use cases include:

  • Volume rebates from distributors
  • Promotional discounts
  • Contract-based pricing adjustments

Configuration Requirements

Allowances require the client to have been configured for related features

Creating Allowances

If you wish to include allowances in Ottimate, include the allowances array when creating catalog entries:

1POST /catalog/entries
2Content-Type: application/json
3
4{
5 "ottimate_company_id": 15196,
6 "erp_vendor_id": "9999",
7 "item_name": "BACON BITS PER LB",
8 "upc": "23585000000",
9 "reference_id": "23585000000",
10 "price": 3.99,
11 "allowances": [
12 {
13 "allowance_type": "discount",
14 "amount": 0.25,
15 "unit_allowance": 0.25,
16 "target": "location",
17 "start_date": "2024-01-01T00:00:00Z",
18 "end_date": "2024-12-31T23:59:59Z",
19 "unique_key": "sysco-tomato-rebate-2024"
20 }
21 ]
22}

Allowance Object Fields

FieldTypeRequiredDescription
allowance_typeStringYesType of allowance: "rebate", "discount", or "allowance"
amountDecimalYesTotal allowance amount per case
unit_allowanceDecimalNoAllowance per unit
targetEnumNoLevel at which the allowance should be applied:"company", "location", or "group"
start_dateDateTimeNoDate when allowance becomes effective. Defaults to date created if null.
end_dateDateTimeNoDate when allowance expires (null = no expiration)
reference_idStringNoUnique identifier for this allowance

Managing Allowances Separately

List allowances for a catalog entry:

1GET /catalog/allowances?catalog_entry_id=cte_12345&ottimate_company_id=15196

Filter by effective date:

1GET /catalog/allowances?catalog_entry_id=cte_12345&ottimate_company_id=15196&effective_date=2024-12-01

Create a new allowance:

1POST /catalog/allowances
2Content-Type: application/json
3
4{
5 "catalog_entry_id": "cte_12345",
6 "ottimate_company_id": 15196,
7 "allowance_type": "rebate",
8 "amount": 2.00,
9 "target": "company",
10 "start_date": "2024-12-01T00:00:00Z",
11 "reference_id": "sysco-tomato-q4-rebate"
12}