Get settlement plan

A read-only snapshot of what is due across the workspace’s venue accounts. Unknown deadlines remain unknown. Per-source read failures are explicit and make the plan incomplete. Reading creates no transfer, reservation, approval request or LP instruction. 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}/settlement/plan

Read the cross-venue settlement plan

cURL

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

200

{
  "accountSummaries": [
    {
      "accountName": "<string>",
      "complete": true,
      "openWindowCount": 1,
      "state": "<string>",
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "venueId": "<string>",
      "venueName": "<string>"
    }
  ],
  "builtAt": "2023-11-07T05:31:56Z",
  "complete": true,
  "failedReads": [
    {
      "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"
    }
  ],
  "horizonDays": 1,
  "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revision": "<string>",
  "sources": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "lpWhitelist": "listed",
      "obligationIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "proposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "readiness": "<string>",
      "toVenueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "versionCommitment": "<string>",
      "balanceReadAt": "2023-11-07T05:31:56Z",
      "destination": {
        "confirmedAt": "2023-11-07T05:31:56Z",
        "kind": "<string>",
        "provenance": "<string>",
        "address": "<string>",
        "bankInstructionsId": "<string>",
        "memo": "<string>"
      },
      "feeBudget": "<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
        }
      },
      "fromFinancialAccountId": "<string>",
      "network": "<string>",
      "payment": {
        "amount": "<string>",
        "asset": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "kind": "<string>",
        "obligationIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sourceFinancialAccountId": "<string>",
        "status": "<string>",
        "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bankReference": "<string>",
        "declaration": {
          "retryAllowed": true,
          "state": "<string>",
          "code": "<string>",
          "noticeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "refusalReason": "<string>",
          "stepId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "destinationAddress": "<string>",
        "destinationMemo": "<string>",
        "failure": {
          "code": "<string>",
          "detail": "<string>"
        },
        "lpReceivedAt": "2023-11-07T05:31:56Z",
        "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "nativeOperationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "network": "<string>",
        "rail": "<string>",
        "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "runRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "runState": "<string>",
        "sentAt": "2023-11-07T05:31:56Z",
        "submittedAt": "2023-11-07T05:31:56Z",
        "txHash": "<string>"
      },
      "rail": "<string>",
      "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"
      },
      "reservedAmount": "<string>",
      "shortfall": "<string>",
      "sourceBalance": "<string>",
      "spendableBalance": "<string>",
      "uncoveredPending": "<string>"
    }
  ],
  "state": "<string>",
  "windows": [
    {
      "accountName": "<string>",
      "amountBasis": "<string>",
      "automaticSelectionAllowed": true,
      "group": "<string>",
      "owed": [
        {
          "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"
        }
      ],
      "proposedTransfers": [
        {
          "amount": "<string>",
          "asset": "<string>",
          "lpWhitelist": "listed",
          "obligationIds": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ],
          "proposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "readiness": "<string>",
          "toVenueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "versionCommitment": "<string>",
          "balanceReadAt": "2023-11-07T05:31:56Z",
          "destination": {
            "confirmedAt": "2023-11-07T05:31:56Z",
            "kind": "<string>",
            "provenance": "<string>",
            "address": "<string>",
            "bankInstructionsId": "<string>",
            "memo": "<string>"
          },
          "feeBudget": "<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
            }
          },
          "fromFinancialAccountId": "<string>",
          "network": "<string>",
          "payment": {
            "amount": "<string>",
            "asset": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "kind": "<string>",
            "obligationIds": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sourceFinancialAccountId": "<string>",
            "status": "<string>",
            "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bankReference": "<string>",
            "declaration": {
              "retryAllowed": true,
              "state": "<string>",
              "code": "<string>",
              "noticeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "refusalReason": "<string>",
              "stepId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "destinationAddress": "<string>",
            "destinationMemo": "<string>",
            "failure": {
              "code": "<string>",
              "detail": "<string>"
            },
            "lpReceivedAt": "2023-11-07T05:31:56Z",
            "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "nativeOperationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "network": "<string>",
            "rail": "<string>",
            "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "runRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "runState": "<string>",
            "sentAt": "2023-11-07T05:31:56Z",
            "submittedAt": "2023-11-07T05:31:56Z",
            "txHash": "<string>"
          },
          "rail": "<string>",
          "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"
          },
          "reservedAmount": "<string>",
          "shortfall": "<string>",
          "sourceBalance": "<string>",
          "spendableBalance": "<string>",
          "uncoveredPending": "<string>"
        }
      ],
      "scheduleId": "<string>",
      "snapshotAt": "2023-11-07T05:31:56Z",
      "state": "<string>",
      "toReceive": [
        {
          "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"
        }
      ],
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "venueId": "<string>",
      "venueName": "<string>",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cadence": {
        "dayBasis": "calendarDays",
        "kind": "intraday",
        "everyHours": 1,
        "localTimes": [
          "<string>"
        ]
      },
      "completionAt": "2023-11-07T05:31:56Z",
      "cutoffAt": "2023-11-07T05:31:56Z",
      "paymentDeadlineAt": "2023-11-07T05:31:56Z",
      "snapshotFailure": {
        "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"
      },
      "statementVersion": 123
    }
  ],
  "nextCursor": "<string>"
}

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

Query Parameters

horizonDays · integer<int32>

Required range: x >= 0

cursor · string<uuid>

limit · integer<int32>

Required range: x >= 0

Response

200

application/json

accountSummaries · object[] · required

Show child attributes

builtAt · string<date-time> · required

complete · boolean · required

failedReads · object[] · required

Show child attributes

horizonDays · integer<int32> · required

Required range: x >= 0

planId · string<uuid> · required

revision · string · required

sources · object[] · required

Show child attributes

state · string · required

windows · object[] · required

Show child attributes

nextCursor · string | null