API product catalogInstitutional Reporting, Auditing & Compliance

Report — Invoice

Institutional Reporting, Auditing & Compliance

GET

/report/invoice

Report — Invoice

Sandbox availablelistInvoice

Returns invoiceable fee data for a billing period, formatted for your finance team. Includes base fees billed by MyStocks and markup collected by you.

Parameters

monthstringqueryRequired

Billing month in YYYY-MM format.

Example: 2026-04

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

invoiceIdstringRequired

monthstringRequired

periodobjectRequired

period.fromstring | nullRequired

period.tostring | nullRequired

generatedAtstringRequired

partnerobjectRequired

partner.keyIdstringRequired

partner.businessNamestringRequired

partner.emailstringRequired

partner.tierstring

partner.markupBpsnumber

summaryobjectRequired

summary.tradeCountintegerRequired

summary.subAccountCountintegerRequired

summary.walletBalancenumberRequired

summary.totalMarkupRevenuenumberRequired

summary.totalBaseFeesnumberRequired

summary.totalFeesnumberRequired

summary.currencyUSDRequired

summary.feesOwednumber

summary.markupEarnednumber

summary.approvedTopupsnumber

summary.pendingTopupsnumber

summary.processedPayoutsnumber

summary.pendingPayoutsnumber

summary.adjustmentsnumber

statementOfAccountobjectRequired

statementOfAccount.feesOwedUsdnumberRequired

statementOfAccount.markupEarnedUsdnumberRequired

statementOfAccount.netPartnerPositionUsdnumberRequired

statementOfAccount.floatMovementsobject[]

statementOfAccount.payoutsobject[]

statementOfAccount.invoicesobject[]

statementOfAccount.adjustmentsobject[]

lineItemsobject[]Required

lineItems[].datestringRequired

lineItems[].orderIdstringRequired

lineItems[].symbolstringRequired

lineItems[].tradeTypestringRequired

lineItems[].markupFeenumberRequired

lineItems[].baseFeenumberRequired

lineItems[].totalFeenumberRequired

Response codes

200Invoice data.

Sandbox playground

Read-only sandbox request

month Required · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/report/invoice

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "invoiceId",
    "month",
    "period",
    "generatedAt",
    "partner",
    "summary",
    "statementOfAccount",
    "lineItems"
  ],
  "properties": {
    "invoiceId": {
      "type": "string"
    },
    "month": {
      "type": "string"
    },
    "period": {
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "generatedAt": {
      "type": "string"
    },
    "partner": {
      "type": "object",
      "required": [
        "keyId",
        "businessName",
        "email"
      ],
      "properties": {
        "keyId": {
          "type": "string"
        },
        "businessName": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "tier": {
          "type": "string"
        },
        "markupBps": {
          "type": "number"
        }
      }
    },
    "summary": {
      "type": "object",
      "required": [
        "tradeCount",
        "subAccountCount",
        "walletBalance",
        "totalMarkupRevenue",
        "totalBaseFees",
        "totalFees",
        "currency"
      ],
      "properties": {
        "tradeCount": {
          "type": "integer"
        },
        "subAccountCount": {
          "type": "integer"
        },
        "walletBalance": {
          "type": "number"
        },
        "totalMarkupRevenue": {
          "type": "number"
        },
        "totalBaseFees": {
          "type": "number"
        },
        "totalFees": {
          "type": "number"
        },
        "currency": {
          "type": "string",
          "enum": [
            "USD"
          ]
        },
        "feesOwed": {
          "type": "number"
        },
        "markupEarned": {
          "type": "number"
        },
        "approvedTopups": {
          "type": "number"
        },
        "pendingTopups": {
          "type": "number"
        },
        "processedPayouts": {
          "type": "number"
        },
        "pendingPayouts": {
          "type": "number"
        },
        "adjustments": {
          "type": "number"
        }
      }
    },
    "statementOfAccount": {
      "type": "object",
      "required": [
        "feesOwedUsd",
        "markupEarnedUsd",
        "netPartnerPositionUsd"
      ],
      "properties": {
        "feesOwedUsd": {
          "type": "number"
        },
        "markupEarnedUsd": {
          "type": "number"
        },
        "netPartnerPositionUsd": {
          "type": "number"
        },
        "floatMovements": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "payouts": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "invoices": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "adjustments": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    "lineItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "date",
          "orderId",
          "symbol",
          "tradeType",
          "markupFee",
          "baseFee",
          "totalFee"
        ],
        "properties": {
          "date": {
            "type": "string"
          },
          "orderId": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "tradeType": {
            "type": "string"
          },
          "markupFee": {
            "type": "number"
          },
          "baseFee": {
            "type": "number"
          },
          "totalFee": {
            "type": "number"
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/report/invoice' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET /report/fees

GET /report/positions