API referenceRevenue share
Retrieve a partner and its balance
GET
The partner with its balance in cents: open, on a statement, paid out. Scope partner:commissions:read.
apiKey partner:commissions:readheader
AuthorizationBearer <ab_…>An API key from Integrations → Connect AI assistants (MCP) → New access, bound to exactly one company. Each operation names the scope the key must carry.
Scope: partner:commissions:read
source*SourceMatch
^[a-z0-9][a-z0-9_-]{0,49}$external_ref*External RefMatch
^[A-Za-z0-9][A-Za-z0-9._:@+-]{0,254}$AlphaCount-Version?stringThe API version to use. Default: the current one.
OK
application/json- response
balance*bic*string|nullbilling_mode*Billing ModeValue in
"self_billing""settlement""partner_invoice"city*string|nullcountry_code*string|nullcreated_at*|nulle_invoice_format*E Invoice FormatValue in
"auto""zugferd""xrechnung""none"email*string|nullexternal_ref*string|nullexternal_source*string|nullhas_payee_account*Has Payee Accounthouse_number*string|nulliban_masked*|The payout account, masked. Set only in the app, by a person.
id*Idkind*KindValue in
"sales_partner""developer""other"kreditorennummer*|Creditor number in the company's books.
language*LanguageValue in
"de""en"min_payout_cents*Min Payout Centsname*Namenotes*string|nullpayee_changed_at*|nullpayout_rail*Payout Railself_billing_agreed_on*|nullself_billing_contract_ref*string|nullself_billing_objected_at*|nullstatement_cadence*Statement CadenceValue in
"month""quarter""year"status*Statusstreet*string|nullsupplier_id*Supplier Idtax_number*string|nulltax_status*Tax StatusValue in
"domestic_regular""domestic_small_business""eu_reverse_charge""third_country""private_person"vat_id*string|nullzip*string|nullcurl -X GET 'https://app.alphacount.ai/api/partner/v1/commission-partners/by-ref/string/string' \ -H 'Authorization: Bearer ab_...'Example Response
{ "balance": { "open": 15000, "paid": 0, "statemented": 0 }, "bic": null, "billing_mode": "self_billing", "city": "München", "country_code": "DE", "created_at": "2026-10-19T15:09:58.181504", "e_invoice_format": "auto", "email": null, "external_ref": "lernlink", "external_source": "alphalearn", "has_payee_account": false, "house_number": null, "iban_masked": null, "id": "00000000-0000-4000-8000-000000000001", "kind": "sales_partner", "kreditorennummer": "70001", "language": "de", "min_payout_cents": 0, "name": "lern.link GmbH", "notes": null, "payee_changed_at": null, "payout_rail": "external", "self_billing_agreed_on": "2026-09-01", "self_billing_contract_ref": null, "self_billing_objected_at": null, "statement_cadence": "month", "status": "active", "street": "Allee 1", "supplier_id": "00000000-0000-4000-8000-000000000002", "tax_number": null, "tax_status": "domestic_regular", "vat_id": "DE123456789", "zip": "80331"}