Reference

Revenue

The Revenue Summary is an org's revenue over a period, read from the daily roll-up and never from raw facts (ADR §4), converted into one…

Checked 2026-09-28

The Revenue Summary is an org's revenue over a period, read from the daily roll-up and never from raw facts (ADR §4), converted into one reporting currency at each day's rate (§3), with the highest basis counting for each store, product and day (§1 "Which row counts"). Computed on every read; nothing writes it.

Service Sylphx Money · Resource type money.sylphx.com/RevenueSummary · Name pattern orgs/{org}/revenue · Shape singleton

#Fields

Field	Type	What it is
name	string	orgs/{org}/revenue.
uid	string	The org's id. Output only.
meta	ResourceMeta	Resource metadata. Output only.
start_day	string	The first day of the period, YYYY-MM-DD. Output only.
end_day	string	The last day of the period, inclusive. Output only.
currency_code	string	The reporting currency every converted amount is in. Output only.
amount	string	net or gross. Output only.
group_by	string	day or month. Output only.
split	string	none, source or product. Output only.
total	string	The period's total, in minor units of the reporting currency. Output only.
buckets	RevenueBucket[]	One bucket per day or month that holds revenue, oldest first. Output only.
lines	RevenueLine[]	The period's total per source or product, largest first; empty when split is none. Output only.
stale_sources	StaleRevenueSource[]	Sources that report late: their missing days make the period incomplete. Output only.
unconverted	UnconvertedAmount[]	Amounts with no exchange rate for their day yet, in their own currency: counted here, never in total. Output only.
unconverted_count	int64	Daily rows that had no rate and are in unconverted. Output only.
incomplete	bool	A stale source has not reported some day of the period. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

Method	Call	What it does
GET	get	Gets the org's revenue over a period: totals by day or month, split by source or product, gross or net, in one reporting currency, with the basis of each bucket, the sources that report late, and what has no rate yet. Reads only the daily roll-up, bounded by a 5 second statement timeout. For example sylphx money revenue summary --period mtd --split source.

#get

Gets the org's revenue over a period: totals by day or month, split by source or product, gross or net, in one reporting currency, with the basis of each bucket, the sources that report late, and what has no rate yet. Reads only the daily roll-up, bounded by a 5 second statement timeout. For example sylphx money revenue summary --period mtd --split source.

GET https://api.sylphx.com/v1/orgs/acme/revenue · scope revenue:read · effect read · Request, response and examples