API docs / API reference

List contribution types

GET/v1/contribution-types

The built-in types and your organization's custom types, with the multiplier each one earns.

Request

curl https://api.equitymatrix.io/v1/contribution-types \
  -H "Authorization: Bearer $EQUITY_MATRIX_API_KEY"

Response

The four built-in types come first, in the order TIME, CASH, COMMISSION, ROYALTY, then your organization’s custom types. Each shows the multiplier it earns right now.

{
  "data": [
    { "id": null, "type": "TIME", "name": "Time", "multiplier": 2, "enabled": true },
    { "id": null, "type": "CASH", "name": "Cash", "multiplier": 4, "enabled": true },
    { "id": null, "type": "COMMISSION", "name": "Commission", "multiplier": 1, "enabled": true },
    { "id": null, "type": "ROYALTY", "name": "Royalty", "multiplier": 1, "enabled": true },
    { "id": 12, "type": "CUSTOM", "name": "Equipment", "multiplier": 3, "enabled": true },
    { "id": 9, "type": "CUSTOM", "name": "Referrals", "multiplier": 1.5, "enabled": false }
  ]
}
FieldDescription
idThe custom type’s ID. Send it as contributionTypeId when you log a contribution of that type. null for built-in types, which you log with type instead.
typeOne of the built-in types, or CUSTOM.
nameThe name shown in Equity Matrix.
multiplierSlices per unit of value right now. Changing a multiplier in Equity Matrix doesn’t change contributions already logged.
enabledWhether new contributions can use the type. Always true for built-in types.

Turned-off custom types are included so you can still recognise past contributions that use them. A new contribution with a turned-off type is rejected with a 422. The one exception is resending an externalId that already has that type, so a sync can keep correcting its past records.

Custom types are created, renamed and turned on or off in Equity Matrix. There’s no API for that.