Skip to content

Asset types

MINT organizes commercial payment claims into 12 asset types. Each type connects a claim to the evidence, amounts, and dates needed to inspect it. The catalog covers returns, delivery, acceptance, rebates, deductions, unbilled work, retainage, pricing, and netting.

These pages describe asset structures. Actual receivables keep their own IDs, source files, counterparties, and recorded amounts in the workspace. Inspect asset records to work with those records.

Asset types

Asset definitionCohort ID
Return-resolved receivablereturn-window-survivors
Penalty-bounded receivablelate-delivery-claims
Line-item microreceivablespartially-fulfilled-pos
Event-vested receivabledelivered-awaiting-acceptance
Clean base and recovery stripretail-chargebacks
Net-of-rebate receivablevolume-rebates
Promotion-normalized claimpromotional-allowances
Empirically netted receivablepredictable-short-pays
Verified unbilled receivabledelivered-not-invoiced
Progress claim and retainage stripmilestones-retainage
Formula-reset receivableformula-priced-shipments
Obligor-level net-settlement claimsetoff-netting

Each page includes the complete actual definition JSON, field descriptions, source references, and buyer and supplier uses.

Read the catalog

sh
export MINT_DOCS_BASE="https://docs.mint.us"
curl --fail --show-error "$MINT_DOCS_BASE/asset-definitions.json"

GET /asset-definitions.json returns catalog mint-asset-definitions, version 0.1.0, with twelve records. No API key is required. The response contains definitions, not live asset balances.

Use a client

Download the existing MINT definition client for your language. It supports both asset and cohort definitions.

sh
curl --fail --show-error "$MINT_DOCS_BASE/cohorts-client.mjs" -o cohorts-client.mjs
sh
curl --fail --show-error "$MINT_DOCS_BASE/cohorts_client.py" -o cohorts_client.py

Save the example beside the downloaded client.

js
import {
  loadAssetDefinitions, listAssetDefinitions,
  getAssetDefinition, searchAssetDefinitions
} from './cohorts-client.mjs';

const catalog = await loadAssetDefinitions(process.env.MINT_DOCS_BASE);
console.table(listAssetDefinitions(catalog));
console.log(JSON.stringify(getAssetDefinition(catalog, 'volume-rebates'), null, 2));
console.log(searchAssetDefinitions(catalog, 'return'));
python
import os
from cohorts_client import (
    load_asset_definitions, list_asset_definitions,
    get_asset_definition, search_asset_definitions,
)

catalog = load_asset_definitions(os.environ['MINT_DOCS_BASE'])
print(list_asset_definitions(catalog))
print(get_asset_definition(catalog, 'volume-rebates'))
print(search_asset_definitions(catalog, 'return'))
sh
node example.mjs
# Or:
python3 example.py

JavaScript requires Node.js 18+ or a browser with fetch. Python requires 3.8+ and uses only the standard library.

Response contract

FieldMeaning
catalogIdmint-asset-definitions; separate from mint-shadow-cohorts.
version0.1.0.
scopedefinition-discovery.
fieldStatusproposed-source-backed-descriptors. Field names and types describe inspection concepts; they are not quoted source schemas.
valueStatusno-observed-values. The response contains definitions, with no live receivable values.
recordsTwelve complete asset definitions.

Each record contains id, version, cohortId, name, purpose, evidenceToInspect, fields, sourceRefs, and the four null rule fields. Its id reuses the linked cohort ID within a separate catalog namespace. Its name preserves the cohort's assetStructure exactly.

Each fields[] entry contains key, scope, type, unit, description, and sourceBasis. The scope is shared or asset-type. Shared descriptors cover gross obligation, supported principal, contingent amount, and excluded amount. Type-specific descriptors cover relevant amounts and source-recorded dates. All descriptors carry a source ID, SHA-256 hash, and line range.

decimal-string describes a recorded decimal amount in its source currency. Record the currency code and any price basis with the source evidence. date describes an ISO 8601 calendar date only when supplied by the source. The catalog provides no sample financial values, currency assumptions, estimates, or date calculations.

Functions and errors

ActionJavaScriptPythonReturns
LoadloadAssetDefinitions(baseUrl)load_asset_definitions(base_url)Validated catalog
ListlistAssetDefinitions(catalog)list_asset_definitions(catalog)IDs, names, and cohort IDs
GetgetAssetDefinition(catalog, id)get_asset_definition(catalog, id)Complete record for an exact ID
SearchsearchAssetDefinitions(catalog, text)search_asset_definitions(catalog, text)Complete matching records

Search uses case-insensitive substring matching across IDs, names, purposes, evidence, and field descriptions. Search returns an empty array when no definition matches. The clients return copies for list, get, and search.

Error codeMeaning
ASSET_DEFINITION_NOT_FOUNDThe exact ID is unknown. No replacement is selected.
QUERY_REQUIREDSearch text is empty or missing.
INVALID_URLThe docs URL is invalid or has credentials, a query, or a fragment.
FETCH_FAILEDDownload or JSON parsing failed.
INVALID_REGISTRYThe catalog version, shape, rule fields, or source references are invalid.

Both clients use CohortError with a code property. Existing cohort functions keep their names and behavior.

Use the definitions

Suppliers can use the evidence list to prepare source records. Buyers can inspect the supported claim against a chosen Buy Box. Both must retain assumptions and missing evidence.

The four fields entryRule, exclusionRule, amountRule, and releaseRule remain null. Definition lookup does not assign membership, classify assets, calculate amounts, confirm buyer fit, set prices, or authorize purchase or release. For live records, use asset inspection.

Files

MINT · Product documentation