What a contribution is, how it turns into slices, and which members can receive one.
A contribution is something a member put into the business. Equity Matrix converts each one into slices, and a member’s share of the pie is their slices divided by everyone’s.
Contribution types
type | value means | Slices |
|---|---|---|
TIME | Hours worked | hours × the member’s hourly rate × your time multiplier |
CASH | Amount, in your organization’s currency | amount × your cash multiplier |
COMMISSION | Amount, in your organization’s currency | amount × your commission multiplier |
ROYALTY | Amount, in your organization’s currency | amount × your royalty multiplier |
CUSTOM | Amount, in your organization’s currency | amount × that custom type’s multiplier |
Multipliers and hourly rates are set in Equity Matrix, not through the API. Values must be greater than 0, with at most 2 decimal places.
Custom contribution types
An organization can define its own contribution types in Equity Matrix, like Equipment or Referrals, each with its own multiplier. List contribution types returns them with their IDs.
To log one, send its ID as contributionTypeId and leave type out, or send type: "CUSTOM". A custom contribution’s value is an amount, and its slices are value × the type's multiplier. The contribution comes back with contributionTypeId and contributionTypeName, which are null for built-in types.
A custom type can be turned off in Equity Matrix. Turned-off types still appear in the list, so past contributions can be matched, but a new contribution with one is rejected. Resending an externalId that already uses that type still works, so a sync can keep correcting its past records.
Deposits and expenses
An organization’s vault deposits and expenses show up when you list contributions, with type DEPOSIT or EXPENSE. An expense also carries expenseSource: VAULT when it was paid from the vault, OWN when the member paid out of pocket. It’s null on every other type. Deposits and expenses can only be logged in the app, because the app checks the vault balance. Sending either type through the API returns a 422.
Hourly rates
A TIME contribution needs the member to have an hourly rate. If they don’t, the request fails with a 422 and the message This member has no hourly rate, so time can't be converted to slices. Set one in Equity Matrix first.
A contribution keeps its hourly rate and multiplier
A new contribution takes the type’s multiplier at the moment it’s created, and a TIME contribution also takes the member’s hourly rate. It keeps both from then on. If the member’s rate or your multipliers change later, contributions already logged don’t change.
When you update a contribution, for example to correct the hours, its slices are recalculated from the new values and the hourly rate and multiplier stored on that contribution. Resending an older contribution never moves it to the member’s new rate or your new multiplier, as long as it stays with the same member and type.
Two kinds of update do take current values. If an update moves a TIME contribution to a different member, it takes that member’s current rate. If an update changes the type, including from one custom type to another, it takes the new type’s current multiplier, since the old one belonged to the other type.
Which members can receive contributions
Identify the member with exactly one of these:
memberId: the member’sidfrom List members. This is the member record’s ID in your organization, not a user ID.memberEmail: the member’s email address, matched without regard to case.
Members with the status ACTIVE or PENDING (invited but not joined yet) can receive contributions. INACTIVE members can’t. If an email matches more than one member, use memberId.
Where API contributions show up
API contributions appear in the Contributions table and on each member’s page like any other contribution. In front of the description, they show the name of the key that sent them, like [via Harvest] Q3 close. That label is only shown on screen. The description is stored as you sent it, apart from spaces at the start and end.
When an API contribution is created, Equity Matrix treats it like one logged in the app. It resets the member’s inactivity reminder, and a TIME contribution can trigger an hours milestone email. Updates and deletes don’t send anything.