Get account window

One window with its indicative statement (positions, snapshot prices and the minimum-settlement decision), its obligations, the LP’s own statement on an LP-issued window, and the movements matched to it. Required API-key scope: settlements_read; an OAuth client needs the same scope. The key’s owner must also be allowed to view the workspace’s settlements.

GET /api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows/{windowId}

Read a settlement window

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows/{windowId} \
  --header 'Authorization: Bearer <token>'

200

{
  "readAt": "2023-11-07T05:31:56Z",
  "scheduleId": "<string>",
  "scheduleVersion": 123,
  "snapshotAt": "2023-11-07T05:31:56Z",
  "state": "<string>",
  "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "capabilities": {
    "agreeLpFigures": true,
    "compare": true,
    "editChoices": true,
    "pay": {
      "available": true,
      "missingCapability": "<string>"
    },
    "recordKeepAnswer": true,
    "recordLpFigures": true,
    "requestKeep": true,
    "refusal": {
      "error": "<string>",
      "message": "<string>",
      "component": "<string>",
      "fix": {
        "approvers": [
          {
            "basis": "walletManager",
            "name": "<string>",
            "email": "<string>",
            "roleName": "<string>"
          }
        ],
        "kind": "requestPermission",
        "target": {
          "kind": "walletRight",
          "right": "readAuthority",
          "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "venueId": "<string>"
        },
        "action": "<string>",
        "existingRequest": {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "votesCast": 1,
          "votesRequired": 1
        }
      },
      "lastGoodReadAt": "2023-11-07T05:31:56Z",
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "keepPolicy": "<string>",
  "keepRequests": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "emailBody": "<string>",
      "emailSubject": "<string>",
      "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requestedAt": "2023-11-07T05:31:56Z",
      "requestedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 123,
      "statementVersion": 123,
      "status": "requested",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "answerRecordedAt": "2023-11-07T05:31:56Z",
      "answeredBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lpAnswer": "<unknown>"
    }
  ],
  "nettedIn": [
    {
      "asset": "<string>",
      "fromWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fromWindowSnapshotAt": "2023-11-07T05:31:56Z",
      "nettedAmount": "<string>",
      "nettedAt": "2023-11-07T05:31:56Z",
      "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payer": "workspace"
    }
  ],
  "obligations": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "consequence": "overdue",
      "dueAt": "2023-11-07T05:31:56Z",
      "metAmount": "<string>",
      "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "origin": {
        "kind": "windowSnapshot",
        "originId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 123
      },
      "payee": "workspace",
      "payer": "workspace",
      "policyVersion": 123,
      "readAt": "2023-11-07T05:31:56Z",
      "remainingAmount": "<string>",
      "revision": 123,
      "state": "open",
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceId": "<string>",
      "arrivalAt": "2023-11-07T05:31:56Z",
      "consequencePolicy": {
        "grace": "disabled",
        "lateFee": "disabled",
        "rollover": "disabled",
        "source": "<string>",
        "tradingBlock": "disabled",
        "version": 123
      },
      "dueRefusal": "<string>",
      "dueState": "notDue",
      "lateFundsAmount": "<string>",
      "latePayment": true,
      "lpDelivery": {
        "sends": [
          {
            "amount": "<string>",
            "asset": "<string>",
            "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "occurredAt": "2023-11-07T05:31:56Z",
            "network": "<string>",
            "txHash": "<string>"
          }
        ],
        "state": "awaitingWorkspacePayment",
        "agreementAt": "2023-11-07T05:31:56Z",
        "dueAt": "2023-11-07T05:31:56Z",
        "refusal": "<string>",
        "sla": {
          "seconds": 123,
          "source": "<string>"
        },
        "workspaceFinalAt": "2023-11-07T05:31:56Z"
      },
      "needsReview": true,
      "observedAt": "2023-11-07T05:31:56Z",
      "originalWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "overdueSince": "2023-11-07T05:31:56Z",
      "payInDifference": {
        "amount": "<string>",
        "direction": "over"
      },
      "remindersPaused": true,
      "closure": {
        "reason": "keptAtVenue",
        "recordedAt": "2023-11-07T05:31:56Z",
        "fromWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "intoWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "keepRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "nettedAmount": "<string>"
      },
      "dispute": {
        "note": "<string>",
        "openedAt": "2023-11-07T05:31:56Z",
        "openedBy": "<string>",
        "priorState": "open",
        "openedByName": "<string>"
      },
      "dueBasis": "clock",
      "metAt": "2023-11-07T05:31:56Z",
      "tradeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "revision": 123,
  "statementSource": "indicative",
  "matches": [
    {
      "allocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "asset": "<string>",
      "matchedAt": "2023-11-07T05:31:56Z",
      "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "movementRevision": 123,
      "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reversedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "matching": {
    "discrepancy": "<string>",
    "eligibleDeliveryUsdValue": "<string>",
    "observedDeliveryUsdValue": "<string>",
    "paidUsdValue": "<string>",
    "priceVersion": "<string>",
    "reasonCode": "<string>",
    "remainingDeliveryUsdValue": "<string>",
    "rule": "<string>",
    "statementVersion": 123
  },
  "unappliedMovements": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reasonCode": "<string>"
    }
  ],
  "consequencePolicy": {
    "grace": "disabled",
    "lateFee": "disabled",
    "rollover": "disabled",
    "source": "<string>",
    "tradingBlock": "disabled",
    "version": 123
  },
  "dueAt": "2023-11-07T05:31:56Z",
  "dueRefusal": "<string>",
  "dueState": "notDue",
  "lpDelivery": {
    "sends": [
      {
        "amount": "<string>",
        "asset": "<string>",
        "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "occurredAt": "2023-11-07T05:31:56Z",
        "network": "<string>",
        "txHash": "<string>"
      }
    ],
    "state": "awaitingWorkspacePayment",
    "agreementAt": "2023-11-07T05:31:56Z",
    "dueAt": "2023-11-07T05:31:56Z",
    "refusal": "<string>",
    "sla": {
      "seconds": 123,
      "source": "<string>"
    },
    "workspaceFinalAt": "2023-11-07T05:31:56Z"
  },
  "overdueSince": "2023-11-07T05:31:56Z",
  "remindersPaused": true,
  "residuals": [
    {
      "asset": "<string>",
      "dueState": "notDue",
      "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payer": "workspace",
      "remainingAmount": "<string>"
    }
  ],
  "completionAt": "2023-11-07T05:31:56Z",
  "cutoffAt": "2023-11-07T05:31:56Z",
  "failure": {
    "error": "<string>",
    "message": "<string>",
    "component": "<string>",
    "fix": {
      "approvers": [
        {
          "basis": "walletManager",
          "name": "<string>",
          "email": "<string>",
          "roleName": "<string>"
        }
      ],
      "kind": "requestPermission",
      "target": {
        "kind": "walletRight",
        "right": "readAuthority",
        "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "venueId": "<string>"
      },
      "action": "<string>",
      "existingRequest": {
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "votesCast": 1,
        "votesRequired": 1
      }
    },
    "lastGoodReadAt": "2023-11-07T05:31:56Z",
    "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "paymentDeadlineAt": "2023-11-07T05:31:56Z",
  "statement": {
    "cutoffStatus": "<string>",
    "cutoffTrades": [
      {
        "boundaryAt": "2023-11-07T05:31:56Z",
        "filledAt": "2023-11-07T05:31:56Z",
        "mayFallInEitherWindow": true,
        "tradeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "lpReadAt": "2023-11-07T05:31:56Z",
    "priceStatus": "<string>",
    "prices": [
      {
        "asset": "<string>",
        "currency": "<string>",
        "price": "<string>",
        "pricedAt": "2023-11-07T05:31:56Z",
        "source": "<string>",
        "status": "available",
        "version": "<string>"
      }
    ],
    "provenance": "<string>",
    "reconstructed": true,
    "releaseEligible": true,
    "rows": [
      {
        "asset": "<string>",
        "availableToTake": "<string>",
        "carriedForwardObligationIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "chosenToTakePositive": "<string>",
        "earlierOpenAmount": "<string>",
        "earlierOpenLpDelivery": "<string>",
        "newOwedToWorkspace": "<string>",
        "payAmount": "<string>",
        "position": "<string>"
      }
    ],
    "snapshotAt": "2023-11-07T05:31:56Z",
    "statementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 123,
    "belowMinimum": true,
    "cutoffFailure": {
      "error": "<string>",
      "message": "<string>",
      "component": "<string>",
      "fix": {
        "approvers": [
          {
            "basis": "walletManager",
            "name": "<string>",
            "email": "<string>",
            "roleName": "<string>"
          }
        ],
        "kind": "requestPermission",
        "target": {
          "kind": "walletRight",
          "right": "readAuthority",
          "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "venueId": "<string>"
        },
        "action": "<string>",
        "existingRequest": {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "votesCast": 1,
          "votesRequired": 1
        }
      },
      "lastGoodReadAt": "2023-11-07T05:31:56Z",
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "deferredWindows": [
      {
        "rows": [
          {
            "asset": "<string>",
            "availableToTake": "<string>",
            "carriedForwardObligationIds": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "chosenToTakePositive": "<string>",
            "earlierOpenAmount": "<string>",
            "earlierOpenLpDelivery": "<string>",
            "newOwedToWorkspace": "<string>",
            "payAmount": "<string>",
            "position": "<string>"
          }
        ],
        "snapshotAt": "2023-11-07T05:31:56Z",
        "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "minimumSettlement": {
      "minimumUsd": "<string>",
      "outcome": "belowMinimum",
      "prices": [
        {
          "asset": "<string>",
          "price": "<string>",
          "source": "<string>"
        }
      ],
      "stated": "assumed",
      "netOwedUsd": "<string>"
    },
    "reconstruction": {
      "fillIds": [
        "<string>"
      ],
      "laterReadAt": "2023-11-07T05:31:56Z",
      "movementIds": [
        "<string>"
      ],
      "unexplainedAssets": [
        "<string>"
      ]
    }
  },
  "choices": {
    "rows": [
      {
        "asset": "<string>",
        "availablePositive": "<string>",
        "confirmedKeepAmount": "<string>",
        "earlierOpenLpDelivery": "<string>",
        "keepAmount": "<string>",
        "takeAmount": "<string>",
        "keepRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "source": "default",
    "statementVersion": 123,
    "choiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "savedAt": "2023-11-07T05:31:56Z",
    "savedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "comparison": {
    "history": [
      {
        "comparisonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "current": true,
        "recordedAt": "2023-11-07T05:31:56Z",
        "recordedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "result": "matches",
        "statementVersion": 123,
        "note": "<string>"
      }
    ],
    "statementVersion": 123,
    "status": "unreviewed",
    "current": {
      "comparisonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "current": true,
      "recordedAt": "2023-11-07T05:31:56Z",
      "recordedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "result": "matches",
      "statementVersion": 123,
      "note": "<string>"
    }
  },
  "lpStatement": {
    "figures": [
      {
        "allMatch": true,
        "figuresId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "figuresVersion": 123,
        "latest": true,
        "lpReference": "<string>",
        "receivedAt": "2023-11-07T05:31:56Z",
        "recordedAt": "2023-11-07T05:31:56Z",
        "recordedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rows": [
          {
            "asset": "<string>",
            "difference": "<string>",
            "result": "matches",
            "indicativeAmount": "<string>",
            "lpAmount": "<string>"
          }
        ],
        "statementVersion": 123,
        "differsNote": "<string>",
        "note": "<string>"
      }
    ],
    "lpName": "<string>",
    "payable": true,
    "status": "awaitingFigures",
    "agreement": {
      "agreedAt": "2023-11-07T05:31:56Z",
      "agreedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agreementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "carriedForward": [
        {
          "asset": "<string>",
          "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "windowSnapshotAt": "2023-11-07T05:31:56Z"
        }
      ],
      "figuresVersion": 123,
      "obligationIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "agreedByName": "<string>",
      "note": "<string>"
    },
    "differsNotePrefill": "<string>",
    "latestFiguresVersion": 123
  }
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

settlements_read · bearer_auth

settlements_read · api_key

Headers

X-Workspace-Id · string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId · string · required

Workspace id

venueAccountId · string<uuid> · required

The venue account's id

windowId · string<uuid> · required

The window's id

Response

200

application/json

Choices, comparison, keep requests, obligations, capabilities and revision.

readAt · string<date-time> · required

scheduleId · string · required

scheduleVersion · integer<int64> · required

snapshotAt · string<date-time> · required

state · string · required

windowId · string<uuid> · required

capabilities · object · required

Show child attributes

keepPolicy · string · required

paidOutEachWindow unless the LP confirmed a keep for this window.

keepRequests · object[] · required

Show child attributes

nettedIn · object[] · required

Earlier windows' obligations whose unpaid remainder this window's cumulative position took over, one entry per netting, oldest window first. Empty when it took over none.

Show child attributes

obligations · object[] · required

This window's obligations and the earlier ones it carries forward.

Show child attributes

revision · integer<int64> · required

Window review revision; every choice, comparison or keep write advances it.

statementSource · enum<string> · required

Whose statement settles the window (the schedule's statementSource).

Available options: indicative, lpIssued

matches · object[] · required

Show child attributes

matching · object · required

Show child attributes

unappliedMovements · object[] · required

Show child attributes

consequencePolicy · null | object

The LP's explicit, versioned consequence terms. Every setting is stated; an absent policy is unavailable, never read as all disabled.

Show child attributes

dueAt · string<date-time> | null

The confirmed payment deadline; absent while the LP value is pending.

dueRefusal · string | null

dueState · enum<string>

New values may be added; treat unknown values as other.

Available options: notDue, dueSoon, overdue, lpDeliveryOverdue, disputed, met, lapsed, nothingOwed, deadlineUnconfirmed, unavailable, updating, dueNow

lpDelivery · null | object

The LP's delivery against the schedule's promise, the most actionable of the window's LP-paid residuals; absent when the schedule makes none.

Show child attributes

overdueSince · string<date-time> | null

remindersPaused · boolean

residuals · object[]

This window's own obligations; carried earlier debt stays on its original window.

Show child attributes

completionAt · string<date-time> | null

cutoffAt · string<date-time> | null

failure · null | object

Show child attributes

paymentDeadlineAt · string<date-time> | null

statement · null | object

Show child attributes

choices · null | object

Show child attributes

comparison · null | object

Show child attributes

lpStatement · null | object

The LP's own statement on an lpIssued window: recorded figures, comparison and agreement.

Show child attributes