docs.vin

financialStatement

The financialStatement noun — identity, lifecycle, events, and every capability as an anchored section: 3 capabilities, 0 live, 3 sandbox, 0 declared.

financialStatement is one of the estate's 317 automotive nouns — a job a car needs done. It carries 3 capabilities: 0 live, 3 sandbox, 0 declared · doors aggregator.vin.

Identity

NounfinancialStatement
PillarServices (facets: 1 data · 2 services)
Capabilities3 — 0 live · 3 sandbox · 0 declared
EntitiesDealer
Doorsaggregator.vin
SDKVin.financialStatement.* from apis.vin
Address/catalog/financialStatement#{action} — the anchor IS the wire name minus financialStatement.

Events

The vocabulary this noun can append to the record — 2 past-tense, versioned event types, each linked to the capability that emits it:

Apply & book

submit

financialStatement.submit · POST /financial-statements/submit · gate key · sandbox · answers FinancialStatementSubmit@1

No input — this capability takes no request body.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /3KPF54AD5NE486632 (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.

EmitsFinancialStatement.submitted@1.

the SDK — financialStatement.submit
import { financialStatement } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await financialStatement.submit()
POST /financial-statements/submit
curl -X POST https://apis.vin/financial-statements/submit \
  -H 'content-type: application/json' \
  -d '{}'

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.

receipt · executed 2026-08-17T00:18:27.781Z · HTTP 200
{
  "type": "OK",
  "answers": "FinancialStatementSubmit@1",
  "value": {
    "noun": "financialStatement",
    "asOf": "2026-08-10",
    "dealerId": "DLR-b9066ade",
    "rooftopIds": [
      "DLR-b9066ade"
    ],
    "dealerLicense": "DL-7bcdd2ef",
    "auctionStanding": "active",
    "submission": {
      "statementId": "FS-298627e3",
      "period": "2026-08",
      "to": "factory-authority",
      "submittedOn": "2026-08-10",
      "status": "submitted"
    }
  },
  "evidence": {
    "noun": "financialStatement",
    "asOf": "2026-08-10",
    "dealerId": "DLR-b9066ade",
    "rooftopIds": [
      "DLR-b9066ade"
    ],
    "dealerLicense": "DL-7bcdd2ef",
    "auctionStanding": "active",
    "submission": {
      "statementId": "FS-298627e3",
      "period": "2026-08",
      "to": "factory-authority",
      "submittedOn": "2026-08-10",
      "status": "submitted"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "back-office-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

reconcile

financialStatement.reconcile · POST /financial-statements/reconcile · gate key · sandbox · answers FinancialStatementReconcile@1

No input — this capability takes no request body.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /3KPF54AD5NE486632 (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.

EmitsFinancialStatement.reconciled@1.

the SDK — financialStatement.reconcile
import { financialStatement } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await financialStatement.reconcile()
POST /financial-statements/reconcile
curl -X POST https://apis.vin/financial-statements/reconcile \
  -H 'content-type: application/json' \
  -d '{}'

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.

receipt · executed 2026-08-17T00:18:27.781Z · HTTP 200
{
  "type": "OK",
  "answers": "FinancialStatementReconcile@1",
  "value": {
    "noun": "financialStatement",
    "asOf": "2026-08-10",
    "dealerId": "DLR-b9066ade",
    "rooftopIds": [
      "DLR-b9066ade"
    ],
    "dealerLicense": "DL-7bcdd2ef",
    "auctionStanding": "active",
    "reconciliation": {
      "statementId": "FS-298627e3",
      "period": "2026-08",
      "checks": [
        {
          "line": "floorplan-draw",
          "statementCents": 2375000,
          "anchorCents": 2375000,
          "varianceCents": 0
        },
        {
          "line": "floorplan-limit",
          "statementCents": 10000000,
          "anchorCents": 10000000,
          "varianceCents": 0
        },
        {
          "line": "floorplan-available",
          "statementCents": 7625000,
          "anchorCents": 7625000,
          "varianceCents": 0
        },
        {
          "line": "coop-fund-accrual",
          "statementCents": 23750,
          "anchorCents": 23750,
          "varianceCents": 0
        }
      ],
      "balanced": true
    }
  },
  "evidence": {
    "noun": "financialStatement",
    "asOf": "2026-08-10",
    "dealerId": "DLR-b9066ade",
    "rooftopIds": [
      "DLR-b9066ade"
    ],
    "dealerLicense": "DL-7bcdd2ef",
    "auctionStanding": "active",
    "reconciliation": {
      "statementId": "FS-298627e3",
      "period": "2026-08",
      "checks": [
        {
          "line": "floorplan-draw",
          "statementCents": 2375000,
          "anchorCents": 2375000,
          "varianceCents": 0
        },
        {
          "line": "floorplan-limit",
          "statementCents": 10000000,
          "anchorCents": 10000000,
          "varianceCents": 0
        },
        {
          "line": "floorplan-available",
          "statementCents": 7625000,
          "anchorCents": 7625000,
          "varianceCents": 0
        },
        {
          "line": "coop-fund-accrual",
          "statementCents": 23750,
          "anchorCents": 23750,
          "varianceCents": 0
        }
      ],
      "balanced": true
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "back-office-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

generate

financialStatement.generate · GET /financial-statements/generate · gate none · sandbox · answers FinancialStatementGenerate@1

No input — this capability takes no request body.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /3KPF54AD5NE486632 (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.

the SDK — financialStatement.generate
import { financialStatement } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await financialStatement.generate()
GET /financial-statements/generate
curl 'https://apis.vin/financial-statements/generate'

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.

receipt · executed 2026-08-17T00:18:27.781Z · HTTP 200
{
  "type": "OK",
  "answers": "FinancialStatementGenerate@1",
  "value": {
    "noun": "financialStatement",
    "asOf": "2026-08-10",
    "dealerId": "DLR-b9066ade",
    "rooftopIds": [
      "DLR-b9066ade"
    ],
    "dealerLicense": "DL-7bcdd2ef",
    "auctionStanding": "active",
    "statement": {
      "id": "FS-298627e3",
      "period": "2026-08",
      "store": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store",
        "licenseId": "DL-7bcdd2ef"
      },
      "lines": [
        {
          "line": "floorplan-draw",
          "amountCents": 2375000,
          "basis": "floored-iron-listing-value"
        },
        {
          "line": "floorplan-limit",
          "amountCents": 10000000,
          "basis": "posted-credit-line"
        },
        {
          "line": "floorplan-available",
          "amountCents": 7625000,
          "basis": "limit-minus-draw"
        },
        {
          "line": "coop-fund-accrual",
          "amountCents": 23750,
          "basis": "floorplan-draw-100bp"
        }
      ],
      "operations": {
        "unitsInStock": 10,
        "listingsActive": 1,
        "dealsClosed": 1,
        "leadsOnFile": 8
      },
      "status": "generated"
    }
  },
  "evidence": {
    "noun": "financialStatement",
    "asOf": "2026-08-10",
    "dealerId": "DLR-b9066ade",
    "rooftopIds": [
      "DLR-b9066ade"
    ],
    "dealerLicense": "DL-7bcdd2ef",
    "auctionStanding": "active",
    "statement": {
      "id": "FS-298627e3",
      "period": "2026-08",
      "store": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store",
        "licenseId": "DL-7bcdd2ef"
      },
      "lines": [
        {
          "line": "floorplan-draw",
          "amountCents": 2375000,
          "basis": "floored-iron-listing-value"
        },
        {
          "line": "floorplan-limit",
          "amountCents": 10000000,
          "basis": "posted-credit-line"
        },
        {
          "line": "floorplan-available",
          "amountCents": 7625000,
          "basis": "limit-minus-draw"
        },
        {
          "line": "coop-fund-accrual",
          "amountCents": 23750,
          "basis": "floorplan-draw-100bp"
        }
      ],
      "operations": {
        "unitsInStock": 10,
        "listingsActive": 1,
        "dealsClosed": 1,
        "leadsOnFile": 8
      },
      "status": "generated"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "back-office-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.

Dealer

Modeled

The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. One diagram, rendered from the estate model.

FinancialStatement · Class model


Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.