Appearance
Color theme
Appearance
Account for a contractual rebate when defining the amount due.
Asset type · volume-rebates · Version 0.1.0
This MINT definition describes the claim and the evidence to inspect. For individual receivables and recorded amounts, use asset records.
The catalog is available at GET /asset-definitions.json. Load it once, then select this exact ID with the MINT client. The response contains definitions and field descriptions. It contains no receivable balances.
Download the client beside your script:
export MINT_DOCS_BASE="https://docs.mint.us"
curl --fail --show-error "$MINT_DOCS_BASE/cohorts-client.mjs" -o cohorts-client.mjsSave as definition.mjs and run node definition.mjs:
import { loadAssetDefinitions, getAssetDefinition } from './cohorts-client.mjs';
const catalog = await loadAssetDefinitions(process.env.MINT_DOCS_BASE);
const definition = getAssetDefinition(catalog, 'volume-rebates');
console.log(JSON.stringify(definition, null, 2));For Python, download cohorts_client.py beside your script and run it with the same MINT_DOCS_BASE:
import json
import os
from cohorts_client import load_asset_definitions, get_asset_definition
catalog = load_asset_definitions(os.environ['MINT_DOCS_BASE'])
definition = get_asset_definition(catalog, 'volume-rebates')
print(json.dumps(definition, indent=2, ensure_ascii=False))See client setup and errors for requirements and failure handling.
These descriptors identify amounts and dates to inspect in the source. They are proposed field names, not a claim that each source file uses this schema.
| Field | Type | Unit | Meaning |
|---|---|---|---|
grossObligation | decimal-string | source-currency | Gross obligation retained for inspection. This field does not establish an amount due. |
supportedPrincipal | decimal-string | source-currency | Principal supported by the inspected evidence. Record the source and assumptions; no calculation is supplied. |
contingentAmount | decimal-string | source-currency | Amount still dependent on a stated condition. Keep it separate from supported principal. |
excludedAmount | decimal-string | source-currency | Amount recorded as excluded in the analysis. The catalog supplies no exclusion rule. |
accruedRebateAmount | decimal-string | source-currency | Accrued rebate amount recorded under the inspected rebate agreement. |
settledRebateAmount | decimal-string | source-currency | Rebate amount recorded as settled in the source. |
measurementPeriodStart | date | ISO-8601-date | Start of the rebate measurement period, only when recorded in the source. |
measurementPeriodEnd | date | ISO-8601-date | End of the rebate measurement period, only when recorded in the source. |
Preserve decimal amounts as strings with their source currency. Use ISO 8601 dates when recorded in the source. Keep missing evidence unknown. Each field includes sourceBasis with a source ID, hash, and line range.
The client returns this complete record from mint-asset-definitions. Its ID links to the volume-rebates cohort definition. The shared ID does not assign a receivable to that cohort.
{
"id": "volume-rebates",
"version": "0.1.0",
"cohortId": "volume-rebates",
"name": "Net-of-rebate receivable",
"purpose": "Account for a contractual rebate when defining the amount due.",
"evidenceToInspect": [
"Rebate agreement",
"eligible volume",
"measurement period",
"accrued and settled rebates"
],
"fields": [
{
"key": "grossObligation",
"scope": "shared",
"type": "decimal-string",
"unit": "source-currency",
"description": "Gross obligation retained for inspection. This field does not establish an amount due.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 26,
"endLine": 26
}
]
},
{
"key": "supportedPrincipal",
"scope": "shared",
"type": "decimal-string",
"unit": "source-currency",
"description": "Principal supported by the inspected evidence. Record the source and assumptions; no calculation is supplied.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 26,
"endLine": 26
}
]
},
{
"key": "contingentAmount",
"scope": "shared",
"type": "decimal-string",
"unit": "source-currency",
"description": "Amount still dependent on a stated condition. Keep it separate from supported principal.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 26,
"endLine": 26
}
]
},
{
"key": "excludedAmount",
"scope": "shared",
"type": "decimal-string",
"unit": "source-currency",
"description": "Amount recorded as excluded in the analysis. The catalog supplies no exclusion rule.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 26,
"endLine": 26
}
]
},
{
"key": "accruedRebateAmount",
"scope": "asset-type",
"type": "decimal-string",
"unit": "source-currency",
"description": "Accrued rebate amount recorded under the inspected rebate agreement.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 10,
"endLine": 26
}
]
},
{
"key": "settledRebateAmount",
"scope": "asset-type",
"type": "decimal-string",
"unit": "source-currency",
"description": "Rebate amount recorded as settled in the source.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 10,
"endLine": 26
}
]
},
{
"key": "measurementPeriodStart",
"scope": "asset-type",
"type": "date",
"unit": "ISO-8601-date",
"description": "Start of the rebate measurement period, only when recorded in the source.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 10,
"endLine": 26
}
]
},
{
"key": "measurementPeriodEnd",
"scope": "asset-type",
"type": "date",
"unit": "ISO-8601-date",
"description": "End of the rebate measurement period, only when recorded in the source.",
"sourceBasis": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 10,
"endLine": 26
}
]
}
],
"sourceRefs": [
{
"sourceId": "docs:volume-rebates",
"sha256": "eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6",
"startLine": 1,
"endLine": 31
},
{
"sourceId": "shadow-dashboard",
"sha256": "a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26",
"startLine": 298,
"endLine": 311
}
],
"entryRule": null,
"exclusionRule": null,
"amountRule": null,
"releaseRule": null
}| Role | Action |
|---|---|
| Supplier | Prepare the listed evidence. Keep gross obligation, supported principal, contingent amount, and excluded amount separate. |
| Buyer | Inspect the supported claim against the chosen Buy Box. Retain assumptions, conditions, and missing evidence. |
The four rule fields remain null. The definition supplies no automatic membership, amount calculation, price, buyer approval, or purchase instruction.
docs:volume-rebates, lines 1–31, SHA-256 eb0f212f809b3cab628713f2a4218dc122f0191a10a950fd7643c13b5307aae6.shadow-dashboard, lines 298–311, SHA-256 a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26.Return to Asset types or inspect asset records.