Progress claim and retainage strip

Separate supported milestone amounts from retained amounts with a later release condition.

Asset type · milestones-retainage · 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

• Milestone schedule
• completion evidence
• certification
• retainage and release terms

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, 'milestones-retainage');
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, 'milestones-retainage')
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.
milestoneAmount	decimal-string	source-currency	Milestone amount supported by inspected completion and certification evidence.
retainageAmount	decimal-string	source-currency	Retained amount identified by the inspected retainage terms. No release is inferred.
milestoneDate	date	ISO-8601-date	Milestone date recorded in the schedule or completion evidence. Identify which event the date describes.
retainageReleaseDate	date	ISO-8601-date	Release date only when stated in the retainage terms or release evidence. Do not invent a date for a conditional event.

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 milestones-retainage cohort definition. The shared ID does not assign a receivable to that cohort.

Complete JSON

{
  "id": "milestones-retainage",
  "version": "0.1.0",
  "cohortId": "milestones-retainage",
  "name": "Progress claim and retainage strip",
  "purpose": "Separate supported milestone amounts from retained amounts with a later release condition.",
  "evidenceToInspect": [
    "Milestone schedule",
    "completion evidence",
    "certification",
    "retainage and release terms"
  ],
  "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:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "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:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "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:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "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:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "startLine": 26,
          "endLine": 26
        }
      ]
    },
    {
      "key": "milestoneAmount",
      "scope": "asset-type",
      "type": "decimal-string",
      "unit": "source-currency",
      "description": "Milestone amount supported by inspected completion and certification evidence.",
      "sourceBasis": [
        {
          "sourceId": "docs:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "startLine": 10,
          "endLine": 26
        }
      ]
    },
    {
      "key": "retainageAmount",
      "scope": "asset-type",
      "type": "decimal-string",
      "unit": "source-currency",
      "description": "Retained amount identified by the inspected retainage terms. No release is inferred.",
      "sourceBasis": [
        {
          "sourceId": "docs:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "startLine": 10,
          "endLine": 26
        }
      ]
    },
    {
      "key": "milestoneDate",
      "scope": "asset-type",
      "type": "date",
      "unit": "ISO-8601-date",
      "description": "Milestone date recorded in the schedule or completion evidence. Identify which event the date describes.",
      "sourceBasis": [
        {
          "sourceId": "docs:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "startLine": 10,
          "endLine": 26
        }
      ]
    },
    {
      "key": "retainageReleaseDate",
      "scope": "asset-type",
      "type": "date",
      "unit": "ISO-8601-date",
      "description": "Release date only when stated in the retainage terms or release evidence. Do not invent a date for a conditional event.",
      "sourceBasis": [
        {
          "sourceId": "docs:milestones-retainage",
          "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
          "startLine": 10,
          "endLine": 26
        }
      ]
    }
  ],
  "sourceRefs": [
    {
      "sourceId": "docs:milestones-retainage",
      "sha256": "a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74",
      "startLine": 1,
      "endLine": 31
    },
    {
      "sourceId": "shadow-dashboard",
      "sha256": "a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26",
      "startLine": 398,
      "endLine": 411
    }
  ],
  "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:milestones-retainage, lines 1–31, SHA-256 a3a027f63b69105968e3c3f12382748f43663379debf30fceab5451bb4b5ca74.
• shadow-dashboard, lines 398–411, SHA-256 a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26.

Return to Asset types or inspect asset records.