Distributions

A distribution represents a scheduled payout from a distributor. When obligations accumulate and a distributor’s payout cycle triggers, the system groups those obligations into a distribution with a total value and a trigger date. Each distribution tracks its own status through the fulfillment lifecycle and carries a set of allocations linking it back to the individual obligations it covers.

Distributions are read-only through the REST API. They are created internally by the distribution engine when payout conditions are met. The only write action available is crediting a manual metric to a collaborator, which lives on the distributors endpoint.

The Distribution Object

Field	Type	Description
id	integer	Unique identifier
distributorId	integer	ID of the distributor this distribution belongs to
status	string	Current distribution status
value	integer	Total value of the distribution, in the smallest currency or points unit
triggerDate	datetime	When the distribution is scheduled to be triggered
dateCreated	datetime	When the distribution was created
dateModified	datetime	When the distribution was last modified

Extended Fields (via ?fields=)

These fields are resolved dynamically via the field resolver system and must be explicitly requested:

Field	Type	Description
distributorName	string	Display name of the associated distributor
distributorUnits	string	Unit label configured on the distributor (e.g., USD, points)
allocationCount	integer	Number of allocations (obligations) included in this distribution
allocations	object[]	Array of allocation objects, each containing distributionId, obligationId, and status

Endpoints

All endpoints require authentication and are scoped to the current tenant (organization). Distributions are read-only through the REST API. The only write action available is crediting a manual metric to a collaborator. See the individual endpoint pages in the sidebar for full request and response details.

Relationship to Other Resources

• Distributor (parent). Every distribution belongs to a distributor via distributorId. The distributor defines the payout rules, units, and metric configuration that ultimately produce distributions.
• Obligation (upstream). Distributions aggregate approved obligations. Each allocation within a distribution references one obligation via obligationId.
• Metric (related). Metrics track collaborator scores against distributors. The credit-metric endpoint creates or updates metric records, which feed into the distribution engine’s calculations.