API product catalogInstitutional Reporting, Auditing & Compliance

List this partner's commercial and historical cash records

Institutional Reporting, Auditing & Compliance

GET

/commercial

Production onlylistPartnerCommercialRecords

Production only. Requires reports:read API scope and reports.read member permission. Reads only the authenticated organization, ignoring supplied tenant identifiers. Returns up to 25 records ordered by document reference. Private operator evidence, credential values, decision identities and provisioning diagnostics are omitted. Contracts, invoices, repository access and period cash reports have separate state. Period boundaries are operator-supplied USD statement balances; these are not historical securities or custody proofs. Tier entitlement expiry does not change installation-license expiry or automatically settle an invoice.

Parameters

kindcontracts | invoices | registry | periodsquery

Collection of organization-owned records to retrieve.

Example: contracts

afterstringquery

Optional nextCursor returned by the previous page for the same kind.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

kindcontracts | invoices | registry | periodsRequired

rowsobject[]Required

rows[].idstring

nextCursorstringRequired

Response codes

200Organization-scoped records without private administration evidence.

400Invalid kind or cursor.

401Authentication required.

403Scope or member permission denied.

429Rate limit exceeded.

503Registry unavailable.

Request reference

Production only

kind Optional · queryafter Optional · query

Use the API Reference for this production-only or streaming operation.

https://mystocks.africa/api/v1/partner/commercial

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "kind",
    "rows",
    "nextCursor"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "contracts",
        "invoices",
        "registry",
        "periods"
      ]
    },
    "rows": {
      "type": "array",
      "maxItems": 25,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "nextCursor": {
      "type": "string",
      "nullable": true
    }
  }
}

curl -X GET 'https://mystocks.africa/api/v1/partner/commercial' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY"

GET /client-activity

GET /documents