Reports and financial close

Close a trading period, import settlement statements, and review matches.

/dashboard/platform/reports needs canManagePayments. Data comes from groceryFinancialCloses.

Close a period

createGroceryFinancialClose(startDate, endDate, timezone, idempotencyKey, note) creates a FinancialClose for the period and timezone, with an optional note.

Import a statement

importGrocerySettlementStatement(providerCode, statementReference, csv, idempotencyKey) loads the provider's settlement CSV. Each entry becomes a SettlementMatch. Reusing an entry reference with changed amounts fails.

Resolve matches

resolveGrocerySettlementMatch(matchId, reason, idempotencyKey) records a review of an entry that did not match a payment. The reason must be 8 to 1000 characters.

Export

groceryFinancialCloseExport returns the close as an export.

On this page