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

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
pageOptional
sizeOptional

Example

Response: PageResponse<EndOfDayReportSummaryResponse>

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"

Responses

StatusWhen
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

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reportDate

Example

Response: EndOfDayReportResponse

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"

Responses

StatusWhen
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

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reportDate

Query parameters

NameDefault
forcefalse

Example

Response: EndOfDayReportResponse

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"

Responses

StatusWhen
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

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
reportTypeOptional

Example

Response: List<ReportSubscriptionResponse>

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"

Responses

StatusWhen
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

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Example

Request body: ReportSubscriptionRequest · Response: ReportSubscriptionResponse

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"
  }'

Responses

StatusWhen
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

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: Void

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"

Responses

StatusWhen
200Subscription removed successfully
404No subscription exists for the given reference

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors