Impact records

The Impact Records endpoint provides a paginated list of all contributions and reversals linked to your products and brands. It’s primarily used for reconciliation, reporting, and audit trails.

ℹ️

See the API reference for example payloads.

What it does

• Retrieves a list of transactions including contributions, compensations and reversals
• Provides key financial details such as impact amount, service fees, and funds flow
• Allows filtering by date range, brand, product, project or customer
• Returns results in a paginated format for easy handling of large datasets
• Ensures a complete and auditable view of all impact activity

Key fields explained

• dateTimeFrom, dateTimeTo → optional filters to narrow the date range
• brandId, productId, projectId, customerId → optional filters to refine results
• recordType → filter by contribution or reversal
• hasMore → indicates if additional pages of results are available
• impactAmount → amount directed to impact projects
• serviceFee → amount retained as service fee
• fundsFlow → shows whether the amount is payable or receivable
• originalTransactionReferenceId → included in reversals to link them to the original transaction

ℹ️

The fundsFlow field shows who is responsible for transferring funds and in which direction.

Receivable → ekko has collected the full impact amount and service fee (for example through a hosted flow or ImpactPay). The client receives their service fee share from ekko.

Payable → the client has collected the full amount from the end user. The client will be invoiced the impact amount plus ekko’s share of the service fee, and keeps their own share.

Best practices

• Use filters like dateTimeFrom and dateTimeTo to fetch manageable result sets for reporting
• Store the reference for every transaction for easier reconciliation and support
• Expect reversals to appear as negative values in monetary fields