Promotion-normalized claim

Separate supported payment from promotional allowances and their settlement treatment.

Asset type · promotional-allowances · Version 0.1.0

This MINT definition describes the claim and the evidence to inspect. For individual receivables and recorded amounts, use asset records.

Evidence

• Promotion agreement
• qualifying activity
• invoice
• allowance and settlement records

Read the definition

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.mjs

Save 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, 'promotional-allowances');
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, 'promotional-allowances')
print(json.dumps(definition, indent=2, ensure_ascii=False))

See client setup and errors for requirements and failure handling.

Fields

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.
allowanceAmount	decimal-string	source-currency	Promotional allowance amount in the inspected allowance record. Retain its earned, expected, disputed, or settled status in the evidence.
allowanceSettlementDate	date	ISO-8601-date	Date of the allowance settlement, only when recorded in the settlement evidence.

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.

Response

The client returns this complete record from mint-asset-definitions. Its ID links to the promotional-allowances cohort definition. The shared ID does not assign a receivable to that cohort.

Complete JSON

{
  "id": "promotional-allowances",
  "version": "0.1.0",
  "cohortId": "promotional-allowances",
  "name": "Promotion-normalized claim",
  "purpose": "Separate supported payment from promotional allowances and their settlement treatment.",
  "evidenceToInspect": [
    "Promotion agreement",
    "qualifying activity",
    "invoice",
    "allowance and settlement records"
  ],
  "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:promotional-allowances",
          "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
          "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:promotional-allowances",
          "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
          "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:promotional-allowances",
          "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
          "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:promotional-allowances",
          "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
          "startLine": 26,
          "endLine": 26
        }
      ]
    },
    {
      "key": "allowanceAmount",
      "scope": "asset-type",
      "type": "decimal-string",
      "unit": "source-currency",
      "description": "Promotional allowance amount in the inspected allowance record. Retain its earned, expected, disputed, or settled status in the evidence.",
      "sourceBasis": [
        {
          "sourceId": "docs:promotional-allowances",
          "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
          "startLine": 10,
          "endLine": 26
        }
      ]
    },
    {
      "key": "allowanceSettlementDate",
      "scope": "asset-type",
      "type": "date",
      "unit": "ISO-8601-date",
      "description": "Date of the allowance settlement, only when recorded in the settlement evidence.",
      "sourceBasis": [
        {
          "sourceId": "docs:promotional-allowances",
          "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
          "startLine": 10,
          "endLine": 26
        }
      ]
    }
  ],
  "sourceRefs": [
    {
      "sourceId": "docs:promotional-allowances",
      "sha256": "4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c",
      "startLine": 1,
      "endLine": 31
    },
    {
      "sourceId": "shadow-dashboard",
      "sha256": "a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26",
      "startLine": 323,
      "endLine": 336
    }
  ],
  "entryRule": null,
  "exclusionRule": null,
  "amountRule": null,
  "releaseRule": null
}

Buyer and supplier use

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.

Sources

Source references

• docs:promotional-allowances, lines 1–31, SHA-256 4f39b90f2ea0de156df3766c65550c621f28992007bb22013cea943546d2930c.
• shadow-dashboard, lines 323–336, SHA-256 a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26.

Return to Asset types or inspect asset records.