HomeGuidesAPI ReferenceRelease Notes
Log In
Guides

Credit Policy - Activation & Settings

This page explains how to enable/disable Credit Control, define the default credit limit, and manage per-account tolerances (Grace Amount) and manual blocks (Credit Holds). These settings directly drive the credit part of the policy evaluation.

Key points

  • Credit Control is tenant-level and toggleable.
  • Default credit limit applies when no more specific limit exists in your setup.
  • Grace Amounts are per account tolerances used when exposure is just over the limit.
  • Credit Holds are explicit, manual blocks for one or many accounts.

🧭 What this config controls

graph LR
  %% ---------- Nodes ----------
  CC[Credit Control<br>tenant settings]
  TOG[Toggle<br>on or off]
  LIMIT[Default credit limit]
  GRACE[Grace Amounts<br>per account]
  HOLD[Credit Holds<br>manual blocks]
  ACCT[Accounts]
  ORD[Orders<br>credit evaluation]

  %% ---------- Relations ----------
  CC --> TOG
  CC --> LIMIT
  CC --> GRACE
  CC --> HOLD
  GRACE --> ACCT
  HOLD --> ACCT
  CC --> ORD

  %% ---------- Styles ----------
  classDef total fill:#e8f1ff,stroke:#2f6feb,stroke-width:2px,color:#0b3d91;
  classDef op fill:#e0f7fa,stroke:#06b6d4,stroke-width:2px,color:#065f46;
  classDef visible fill:#ecfdf5,stroke:#10b981,stroke-width:2px,color:#064e3b;
  classDef resp fill:#f2f4f7,stroke:#475569,stroke-width:2px,color:#111827;

  class CC,TOG,LIMIT,GRACE,HOLD op;
  class ACCT visible;
  class ORD total;

  style CC rx:8,ry:8
  style TOG rx:8,ry:8
  style LIMIT rx:8,ry:8
  style GRACE rx:8,ry:8
  style HOLD rx:8,ry:8
  style ACCT rx:8,ry:8
  style ORD rx:8,ry:8

Effect on evaluation

  • Toggle off → credit checks are skipped entirely.
  • Toggle on → credit checks run in this order: manual hold then exposure vs limit with grace.

🔄 Toggle and outcomes

graph LR
  SAVE[Save settings] --> EN{Credit Control enabled}
  EN -->|No| SKIP[Skip credit checks<br>orders unaffected]
  EN -->|Yes| START[Run credit checks<br>on orders]

  %% ---------- Styles ----------
  classDef total fill:#e8f1ff,stroke:#2f6feb,stroke-width:2px,color:#0b3d91;
  classDef diff fill:#fff4e5,stroke:#f59e0b,stroke-width:2px,color:#7a3e00;
  classDef visible fill:#ecfdf5,stroke:#10b981,stroke-width:2px,color:#064e3b;

  class SAVE total;
  class EN diff;
  class SKIP,START visible;

  style SAVE rx:8,ry:8
  style EN rx:8,ry:8
  style SKIP rx:8,ry:8
  style START rx:8,ry:8

Tip: toggle changes are immediate for new orders entering the evaluation pipeline.

🎯 Default credit limit

The default credit limit is the baseline used for exposure checks. It applies when your commercial setup does not provide a more specific limit. Combine with Grace Amounts to allow a small tolerance above the limit before blocking.

✅

Tip: Exposure is tracked continuously — it is incremented with each validated order to reflect the most up-to-date balance. A daily synchronization from your external system can still overwrite the value for periodic reconciliation.

Admin endpoints

  • GET /v1/buying-policies/credit-control — ADM-BUYING-POLICY-500
  • PATCH /v1/buying-policies/credit-control — ADM-BUYING-POLICY-200
  • PATCH /v1/buying-policies/credit-control/credit-limit — ADM-BUYING-POLICY-201

🧩 Grace Amounts (per account tolerance)

Grace Amount is a per account tolerance used when exposure is just above the limit.

The list endpoint returns the accountName for each grace amount entry. You can also filter and sort by accountName (alphabetical or reverse).

graph LR
  C[Create or update<br>Grace Amount for account] --> E[Evaluation uses tolerance<br>when over limit]
  E -->|Within grace| OK[Allow order<br>consume tolerance]
  E -->|Beyond grace| BLK[Block by credit policy]

  %% ---------- Styles ----------
  classDef total fill:#e8f1ff,stroke:#2f6feb,stroke-width:2px,color:#0b3d91;
  classDef visible fill:#ecfdf5,stroke:#10b981,stroke-width:2px,color:#064e3b;
  classDef inter fill:#fee2e2,stroke:#ef4444,stroke-width:2px,color:#7f1d1d;

  class C,E total; class OK visible; class BLK inter;
  style C rx:8,ry:8; style E rx:8,ry:8; style OK rx:8,ry:8; style BLK rx:8,ry:8

Admin endpoints

  • GET /v1/buying-policies/credit-control/grace-amounts — ADM-BUYING-POLICY-551
  • POST /v1/buying-policies/credit-control/grace-amounts — ADM-BUYING-POLICY-151
  • PUT /v1/buying-policies/credit-control/grace-amounts/graceAmountId — ADM-BUYING-POLICY-203
  • DELETE /v1/buying-policies/credit-control/grace-amounts/graceAmountId — ADM-BUYING-POLICY-301

✋ Credit Holds (manual blocks)

Use Credit Holds to explicitly block one or multiple accounts regardless of exposure. Holds take effect before any exposure or grace calculation.

The list endpoint returns the accountName for each credit hold entry. You can also filter and sort by accountName (alphabetical or reverse).

graph LR
  NEW[Create credit hold<br>one or more accounts] --> EFF[Orders entering pipeline<br>are blocked]
  EFF --> LIFT[Delete or update hold<br>accounts unblocked]

  %% ---------- Styles ----------
  classDef total fill:#e8f1ff,stroke:#2f6feb,stroke-width:2px,color:#0b3d91;
  classDef inter fill:#fee2e2,stroke:#ef4444,stroke-width:2px,color:#7f1d1d;
  classDef visible fill:#ecfdf5,stroke:#10b981,stroke-width:2px,color:#064e3b;

  class NEW total; class EFF inter; class LIFT visible;
  style NEW rx:8,ry:8; style EFF rx:8,ry:8; style LIFT rx:8,ry:8

Admin endpoints

  • GET /v1/buying-policies/credit-control/holds — ADM-BUYING-POLICY-550
  • POST /v1/buying-policies/credit-control/holds — ADM-BUYING-POLICY-150
  • PUT /v1/buying-policies/credit-control/holds/creditHoldId — ADM-BUYING-POLICY-202
  • DELETE /v1/buying-policies/credit-control/holds/creditHoldId — ADM-BUYING-POLICY-300

🔗 API quicklinks

  • GET /v1/buying-policies/credit-control — ADM-BUYING-POLICY-500
  • PATCH /v1/buying-policies/credit-control — ADM-BUYING-POLICY-200
  • PATCH /v1/buying-policies/credit-control/credit-limit — ADM-BUYING-POLICY-201
  • GET /v1/buying-policies/credit-control/grace-amounts — ADM-BUYING-POLICY-551
  • POST /v1/buying-policies/credit-control/grace-amounts — ADM-BUYING-POLICY-151
  • PUT /v1/buying-policies/credit-control/grace-amounts/graceAmountId — ADM-BUYING-POLICY-203
  • DELETE /v1/buying-policies/credit-control/grace-amounts/graceAmountId — ADM-BUYING-POLICY-301
  • GET /v1/buying-policies/credit-control/holds — ADM-BUYING-POLICY-550
  • POST /v1/buying-policies/credit-control/holds — ADM-BUYING-POLICY-150
  • PUT /v1/buying-policies/credit-control/holds/creditHoldId — ADM-BUYING-POLICY-202
  • DELETE /v1/buying-policies/credit-control/holds/creditHoldId — ADM-BUYING-POLICY-300

Updated 26 days ago