settlementStatement
The settlementStatement noun — identity, lifecycle, events, and every capability as an anchored section: 4 capabilities, 0 live, 4 sandbox, 0 declared.
settlementStatement is one of the estate's 317 automotive nouns — a job a car needs done. It carries 4 capabilities: 0 live, 4 sandbox, 0 declared · doors aggregator.vin.
Identity
| Noun | settlementStatement |
| Pillar | Services (facets: 4 services) |
| Capabilities | 4 — 0 live · 4 sandbox · 0 declared |
| Entities | DealJacket |
| Doors | aggregator.vin |
| SDK | Vin.settlementStatement.* from apis.vin |
| Address | /catalog/settlementStatement#{action} — the anchor IS the wire name minus settlementStatement. |
Events
The vocabulary this noun can append to the record — 4 past-tense, versioned event types, each linked to the capability that emits it:
SettlementStatement.amended@1— emitted byamendSettlementStatement.delivered@1— emitted bydeliverSettlementStatement.generated@1— emitted bygenerateSettlementStatement.reconciled@1— emitted byreconcile
Pay & settle
reconcile
settlementStatement.reconcile · POST /settlement-statements/reconcile · gate offer · sandbox · answers SettlementStatementReconcile@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1FT7W2BT7MED40142 (the VIN lens).
Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.
Emits — SettlementStatement.reconciled@1.
import { settlementStatement } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await settlementStatement.reconcile({"vin":"1FT7W2BT7MED40142"})curl -X POST https://apis.vin/settlement-statements/reconcile \
-H 'content-type: application/json' \
-d '{"vin":"1FT7W2BT7MED40142"}'Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.
{
"type": "OK",
"answers": "SettlementStatementReconcile@1",
"value": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"reconciliation": {
"statementId": "SST-f8b9065c",
"checks": [
{
"line": "vehicle-price",
"statementCents": 2300000,
"anchorCents": 2300000,
"varianceCents": 0
},
{
"line": "contract-total",
"statementCents": 2300000,
"anchorCents": 2300000,
"varianceCents": 0
}
],
"balanced": true
}
},
"evidence": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"reconciliation": {
"statementId": "SST-f8b9065c",
"checks": [
{
"line": "vehicle-price",
"statementCents": 2300000,
"anchorCents": 2300000,
"varianceCents": 0
},
{
"line": "contract-total",
"statementCents": 2300000,
"anchorCents": 2300000,
"varianceCents": 0
}
],
"balanced": true
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "closing-papers-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}Fulfill & operate
deliver
settlementStatement.deliver · POST /settlement-statements/deliver · gate offer · sandbox · answers SettlementStatementDeliver@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1FT7W2BT7MED40142 (the VIN lens).
Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.
Emits — SettlementStatement.delivered@1.
import { settlementStatement } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await settlementStatement.deliver({"vin":"1FT7W2BT7MED40142"})curl -X POST https://apis.vin/settlement-statements/deliver \
-H 'content-type: application/json' \
-d '{"vin":"1FT7W2BT7MED40142"}'Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.
{
"type": "OK",
"answers": "SettlementStatementDeliver@1",
"value": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"delivery": {
"statementId": "SST-f8b9065c",
"threadId": "TH-31e306be",
"to": {
"identityId": "ID-11f17424",
"name": "Ava Good"
},
"deliveredOn": "2026-08-10",
"status": "delivered"
}
},
"evidence": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"delivery": {
"statementId": "SST-f8b9065c",
"threadId": "TH-31e306be",
"to": {
"identityId": "ID-11f17424",
"name": "Ava Good"
},
"deliveredOn": "2026-08-10",
"status": "delivered"
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "closing-papers-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}generate
settlementStatement.generate · POST /settlement-statements/generate · gate offer · sandbox · answers SettlementStatementGenerate@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1FT7W2BT7MED40142 (the VIN lens).
Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.
Emits — SettlementStatement.generated@1.
import { settlementStatement } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await settlementStatement.generate({"vin":"1FT7W2BT7MED40142"})curl -X POST https://apis.vin/settlement-statements/generate \
-H 'content-type: application/json' \
-d '{"vin":"1FT7W2BT7MED40142"}'Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.
{
"type": "OK",
"answers": "SettlementStatementGenerate@1",
"value": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"statement": {
"id": "SST-f8b9065c",
"jacketId": "DJK-4e10e788",
"dealId": "DL-2b286926",
"buyer": {
"identityId": "ID-11f17424",
"name": "Ava Good"
},
"lines": [
{
"line": "vehicle-price",
"amountCents": 2300000,
"basis": "the-one-asking-value"
},
{
"line": "contract-total",
"amountCents": 2300000,
"basis": "funding-package-law"
}
],
"currency": "USD",
"unposted": {
"lines": [
"sales-tax",
"government-fees"
],
"basis": "no-ratified-anchor-owning-nouns-deferred"
},
"status": "generated"
}
},
"evidence": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"statement": {
"id": "SST-f8b9065c",
"jacketId": "DJK-4e10e788",
"dealId": "DL-2b286926",
"buyer": {
"identityId": "ID-11f17424",
"name": "Ava Good"
},
"lines": [
{
"line": "vehicle-price",
"amountCents": 2300000,
"basis": "the-one-asking-value"
},
{
"line": "contract-total",
"amountCents": 2300000,
"basis": "funding-package-law"
}
],
"currency": "USD",
"unposted": {
"lines": [
"sales-tax",
"government-fees"
],
"basis": "no-ratified-anchor-owning-nouns-deferred"
},
"status": "generated"
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "closing-papers-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}More actions
amend
settlementStatement.amend · POST /settlement-statements/amend · gate offer · sandbox · answers SettlementStatementAmend@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1FT7W2BT7MED40142 (the VIN lens).
Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.
Emits — SettlementStatement.amended@1.
import { settlementStatement } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await settlementStatement.amend({"vin":"1FT7W2BT7MED40142"})curl -X POST https://apis.vin/settlement-statements/amend \
-H 'content-type: application/json' \
-d '{"vin":"1FT7W2BT7MED40142"}'Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.
{
"type": "OK",
"answers": "SettlementStatementAmend@1",
"value": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"amendment": {
"statementId": "SST-f8b9065c",
"status": "amended",
"position": "QUOTED",
"lines": [
{
"line": "vehicle-price",
"amountCents": 2300000,
"basis": "the-one-asking-value"
},
{
"line": "contract-total",
"amountCents": 2300000,
"basis": "funding-package-law"
}
]
}
},
"evidence": {
"vin": "1FT7W2BT7MED40142",
"noun": "settlementStatement",
"asOf": "2026-08-10",
"id": "DJK-4e10e788",
"dealId": "DL-2b286926",
"documents": [
"DOC-9ce0c0df"
],
"complete": false,
"amendment": {
"statementId": "SST-f8b9065c",
"status": "amended",
"position": "QUOTED",
"lines": [
{
"line": "vehicle-price",
"amountCents": 2300000,
"basis": "the-one-asking-value"
},
{
"line": "contract-total",
"amountCents": 2300000,
"basis": "funding-package-law"
}
]
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "closing-papers-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}Data model
The record shape behind this noun — one entity, each property an evidence field. See the whole estate model on the data model page.
DealJacket
Modeled
The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. 2 diagrams, rendered from the estate model.
SettlementStatement · Class model
SettlementStatement · State machine
Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.