Get account schedules

The LP’s published settlement schedules for this account, the one in effect with its minimum settlement, and the next window. 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/schedules

Read a venue account's settlement schedules

cURL

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

200

{
  "accountName": "<string>",
  "items": [
    {
      "anchorDate": "2023-12-25",
      "availability": "available",
      "businessDays": [
        1
      ],
      "cadence": {
        "dayBasis": "calendarDays",
        "kind": "intraday",
        "everyHours": 1,
        "localTimes": [
          "<string>"
        ]
      },
      "calendarStatus": "confirmed",
      "completion": {
        "source": "<string>",
        "status": "confirmed",
        "value": "<string>"
      },
      "lpId": "<string>",
      "name": "<string>",
      "paymentDeadline": {
        "source": "<string>",
        "status": "confirmed",
        "value": "<string>"
      },
      "scheduleId": "<string>",
      "snapshot": {
        "source": "<string>",
        "status": "confirmed",
        "value": "<string>"
      },
      "tradeCutoff": {
        "source": "<string>",
        "status": "confirmed",
        "value": "<string>"
      },
      "version": 123,
      "businessDaysAssumed": "<string>",
      "calendarAssumed": "<string>",
      "calendarVersion": 123,
      "holidayCalendarId": "<string>",
      "holidayDates": [
        "2023-12-25"
      ],
      "minimumSettlement": {
        "amountUsd": "<string>",
        "basis": "netOwed",
        "scope": "account",
        "stated": "assumed"
      },
      "statementSource": {
        "source": "<string>",
        "status": "confirmed",
        "value": "indicative"
      },
      "timeResolution": {
        "ambiguous": "earlier",
        "nonexistent": "shiftForward"
      },
      "timeZone": "<string>",
      "timeZoneAssumed": "<string>"
    }
  ],
  "lpName": "<string>",
  "permissions": {
    "canChangeSchedule": 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"
    }
  },
  "readAt": "2023-11-07T05:31:56Z",
  "revision": 123,
  "serverNow": "2023-11-07T05:31:56Z",
  "activeSelection": {
    "effectiveFrom": "2023-11-07T05:31:56Z",
    "revision": 123,
    "scheduleId": "<string>",
    "scheduleVersion": 123,
    "selectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "<string>",
    "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "confirmationRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "confirmedTerms": "<unknown>",
    "effectiveUntil": "2023-11-07T05:31:56Z"
  },
  "effectiveSchedule": {
    "anchorDate": "2023-12-25",
    "availability": "available",
    "businessDays": [
      1
    ],
    "cadence": {
      "dayBasis": "calendarDays",
      "kind": "intraday",
      "everyHours": 1,
      "localTimes": [
        "<string>"
      ]
    },
    "calendarStatus": "confirmed",
    "completion": {
      "source": "<string>",
      "status": "confirmed",
      "value": "<string>"
    },
    "lpId": "<string>",
    "name": "<string>",
    "paymentDeadline": {
      "source": "<string>",
      "status": "confirmed",
      "value": "<string>"
    },
    "scheduleId": "<string>",
    "snapshot": {
      "source": "<string>",
      "status": "confirmed",
      "value": "<string>"
    },
    "tradeCutoff": {
      "source": "<string>",
      "status": "confirmed",
      "value": "<string>"
    },
    "version": 123,
    "businessDaysAssumed": "<string>",
    "calendarAssumed": "<string>",
    "calendarVersion": 123,
    "holidayCalendarId": "<string>",
    "holidayDates": [
      "2023-12-25"
    ],
    "minimumSettlement": {
      "amountUsd": "<string>",
      "basis": "netOwed",
      "scope": "account",
      "stated": "assumed"
    },
    "statementSource": {
      "source": "<string>",
      "status": "confirmed",
      "value": "indicative"
    },
    "timeResolution": {
      "ambiguous": "earlier",
      "nonexistent": "shiftForward"
    },
    "timeZone": "<string>",
    "timeZoneAssumed": "<string>"
  },
  "nextWindow": {
    "calendarStatus": "confirmed",
    "cutoffBasis": "<string>",
    "scheduleId": "<string>",
    "scheduleVersion": 123,
    "snapshotAt": "2023-11-07T05:31:56Z",
    "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completionAt": "2023-11-07T05:31:56Z",
    "cutoffAt": "2023-11-07T05:31:56Z",
    "paymentDeadlineAt": "2023-11-07T05:31:56Z"
  },
  "pendingSelection": {
    "currentScheduleId": "<string>",
    "currentScheduleVersion": 123,
    "emailBody": "<string>",
    "emailSubject": "<string>",
    "missingTerms": [
      "<string>"
    ],
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedAt": "2023-11-07T05:31:56Z",
    "requestedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedScheduleId": "<string>",
    "requestedScheduleVersion": 123,
    "revision": 123,
    "status": "<string>",
    "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "effectiveFrom": "2023-11-07T05:31:56Z",
    "emailReference": "<string>",
    "emailSentAt": "2023-11-07T05:31:56Z",
    "emailSentBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lpConfirmation": "<unknown>"
  },
  "termSources": "<unknown>"
}

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

Response

200

application/json

accountName · string · required

The venue account's display name ("Selini account").

items · object[] · required

Show child attributes

lpName · string · required

The LP this account settles with, by its display name ("Selini").

permissions · object · required

Show child attributes

readAt · string<date-time> · required

revision · integer<int64> · required

serverNow · string<date-time> · required

activeSelection · null | object

Show child attributes

effectiveSchedule · null | object

Published terms are stored as versioned data, not venue-specific code.

Show child attributes

nextWindow · null | object

Show child attributes

pendingSelection · null | object

Show child attributes

termSources · any