API reference · Pricing, reporting & reconciliation
Reports GET List end-of-day transaction reports GET /report/eod
Returns a paginated summary (no metric lines) of past reports, newest first.
Headers Name Notes AuthorizationBearer token X-TenantYour tenant X-Environmenttest or live
Query parameters Name Default pageOptional sizeOptional
Example Response: PageResponse<EndOfDayReportSummaryResponse>
curl Response
Copy curl -X GET "https://api.bridgemoni.com/report/eod?page=value&size=value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" Copy {
"data": {
"contents": [
{
"...": "the resource"
}
],
"page": 1,
"size": 1,
"total": 1,
"pages": 1
},
"description": "List end-of-day transaction reports"
} Responses Status When 200Reports fetched successfully
GET Fetch the end-of-day transaction report for a date GET /report/eod/{reportDate}
Returns the persisted report, including every metric line, for the given date.
Headers Name Notes AuthorizationBearer token X-TenantYour tenant X-Environmenttest or live
Path parameters Example Response: EndOfDayReportResponse
curl Response
Copy curl -X GET "https://api.bridgemoni.com/report/eod/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" Copy {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"reportType": "report type",
"reportDate": "2027-03-14",
"status": "GENERATING",
"generatedAt": "2027-03-14T14:30:01",
"failureReason": "March payroll",
"metrics": [
{
"section": "text",
"label": "field label",
"value": "text"
}
]
},
"description": "Fetch the end-of-day transaction report for a date"
} Responses Status When 200Report fetched successfully 404No report exists for the given date
POST Generate (or regenerate) the end-of-day transaction report for a date POST /report/eod/{reportDate}/generate
Runs the same computation the nightly scheduler runs, on demand. Idempotent by default: if a report already exists for this date it is returned as-is, without recomputing or re-notifying subscribers. Pass force=true to recompute an already-COMPLETED report - even then, subscribers are not re-notified, only the initial completion ever sends a notification. reportDate cannot be in the future or more than 365 days in the past.
Headers Name Notes AuthorizationBearer token X-TenantYour tenant X-Environmenttest or live
Path parameters Query parameters Example Response: EndOfDayReportResponse
curl Response
Copy curl -X POST "https://api.bridgemoni.com/report/eod/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/generate?force=false" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" Copy {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"reportType": "report type",
"reportDate": "2027-03-14",
"status": "GENERATING",
"generatedAt": "2027-03-14T14:30:01",
"failureReason": "March payroll",
"metrics": [
{
"section": "text",
"label": "field label",
"value": "text"
}
]
},
"description": "Generate (or regenerate) the end-of-day transaction report for a date"
} Responses Status When 200Report generated successfully 400reportDate is in the future or too far in the past
GET List active subscriptions for a report type GET /report/subscription
Headers Name Notes AuthorizationBearer token X-TenantYour tenant X-Environmenttest or live
Query parameters Name Default reportTypeOptional
Example Response: List<ReportSubscriptionResponse>
curl Response
Copy curl -X GET "https://api.bridgemoni.com/report/subscription?reportType=value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" Copy {
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"emailAddress": "ada@example.com",
"reportType": "report type",
"active": true,
"creationDateTime": "2027-03-14T14:30:01"
}
],
"description": "List active subscriptions for a report type"
} Responses Status When 200Subscriptions fetched successfully
POST Subscribe to a report's email digest POST /report/subscription
emailAddress must belong to an existing user in the caller's tenant - arbitrary external addresses are rejected (Security review #2).
Headers Name Notes AuthorizationBearer token X-TenantYour tenant X-Environmenttest or live Content-Typeapplication/json
Example Request body: ReportSubscriptionRequest · Response: ReportSubscriptionResponse
curl Request Response
Copy curl -X POST "https://api.bridgemoni.com/report/subscription" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"emailAddress": "ada@example.com",
"reportType": "report type"
}' Copy {
"emailAddress": "ada@example.com",
"reportType": "report type"
} Copy {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"emailAddress": "ada@example.com",
"reportType": "report type",
"active": true,
"creationDateTime": "2027-03-14T14:30:01"
},
"description": "Subscribe to a report's email digest"
} Responses Status When 200Subscription created successfully 400emailAddress does not belong to an existing user in this tenant 409An active subscription already exists
DELETE Unsubscribe (deactivate) a report subscription DELETE /report/subscription/{reference}
Headers Name Notes AuthorizationBearer token X-TenantYour tenant X-Environmenttest or live
Path parameters Example Response: Void
curl Response
Copy curl -X DELETE "https://api.bridgemoni.com/report/subscription/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" Copy {
"description": "Unsubscribe (deactivate) a report subscription"
} Responses Status When 200Subscription removed successfully 404No subscription exists for the given reference