Skip to content

Line-item microreceivables

Inspect accepted fulfilled lines independently from the unfulfilled balance of an order.

Asset type · partially-fulfilled-pos · 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

  • Purchase-order lines
  • fulfillment events
  • acceptance
  • invoice allocation

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:

sh
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:

js
import { loadAssetDefinitions, getAssetDefinition } from './cohorts-client.mjs';
const catalog = await loadAssetDefinitions(process.env.MINT_DOCS_BASE);
const definition = getAssetDefinition(catalog, 'partially-fulfilled-pos');
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:

python
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, 'partially-fulfilled-pos')
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.

FieldTypeUnitMeaning
grossObligationdecimal-stringsource-currencyGross obligation retained for inspection. This field does not establish an amount due.
supportedPrincipaldecimal-stringsource-currencyPrincipal supported by the inspected evidence. Record the source and assumptions; no calculation is supplied.
contingentAmountdecimal-stringsource-currencyAmount still dependent on a stated condition. Keep it separate from supported principal.
excludedAmountdecimal-stringsource-currencyAmount recorded as excluded in the analysis. The catalog supplies no exclusion rule.
lineInvoiceAmountdecimal-stringsource-currencyInvoice amount allocated to an inspected purchase-order line. Allocation does not confirm acceptance.
fulfillmentDatedateISO-8601-dateDate of the inspected fulfillment event, 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.

Response

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

Complete JSON
json
{
  "id": "partially-fulfilled-pos",
  "version": "0.1.0",
  "cohortId": "partially-fulfilled-pos",
  "name": "Line-item microreceivables",
  "purpose": "Inspect accepted fulfilled lines independently from the unfulfilled balance of an order.",
  "evidenceToInspect": [
    "Purchase-order lines",
    "fulfillment events",
    "acceptance",
    "invoice allocation"
  ],
  "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:partially-fulfilled-pos",
          "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
          "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:partially-fulfilled-pos",
          "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
          "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:partially-fulfilled-pos",
          "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
          "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:partially-fulfilled-pos",
          "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
          "startLine": 26,
          "endLine": 26
        }
      ]
    },
    {
      "key": "lineInvoiceAmount",
      "scope": "asset-type",
      "type": "decimal-string",
      "unit": "source-currency",
      "description": "Invoice amount allocated to an inspected purchase-order line. Allocation does not confirm acceptance.",
      "sourceBasis": [
        {
          "sourceId": "docs:partially-fulfilled-pos",
          "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
          "startLine": 10,
          "endLine": 26
        }
      ]
    },
    {
      "key": "fulfillmentDate",
      "scope": "asset-type",
      "type": "date",
      "unit": "ISO-8601-date",
      "description": "Date of the inspected fulfillment event, only when recorded in the source.",
      "sourceBasis": [
        {
          "sourceId": "docs:partially-fulfilled-pos",
          "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
          "startLine": 10,
          "endLine": 26
        }
      ]
    }
  ],
  "sourceRefs": [
    {
      "sourceId": "docs:partially-fulfilled-pos",
      "sha256": "964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d",
      "startLine": 1,
      "endLine": 31
    },
    {
      "sourceId": "shadow-dashboard",
      "sha256": "a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26",
      "startLine": 213,
      "endLine": 226
    }
  ],
  "entryRule": null,
  "exclusionRule": null,
  "amountRule": null,
  "releaseRule": null
}

Buyer and supplier use

RoleAction
SupplierPrepare the listed evidence. Keep gross obligation, supported principal, contingent amount, and excluded amount separate.
BuyerInspect 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:partially-fulfilled-pos, lines 1–31, SHA-256 964e7595085887a03061ad94746cede3d98c6bd4b24933c51985652461e71c1d.
  • shadow-dashboard, lines 213–226, SHA-256 a9143a735d64a35a18ef49f0d8f24a091815927646d0b2d2780778e360cb1c26.

Return to Asset types or inspect asset records.

MINT · Product documentation