Skip to content
Console
Menu

Generated Assets

Getting Started

Authentication

KV Store

On this page

sylphx money revenue

Every sylphx money revenue command: its argument, its flags and a run line.

The revenue commands of Sylphx Money, as the CLI spells them: the same calls as the revenue API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#summary

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.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx money revenue summary orgs/acme/revenue

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

Flags

FlagTypeWhat it does
--periodstringtoday, mtd (month to date, the default), month (with month), or range (with start_day and end_day). Days are UTC.
--monthstringThe month of a month period, YYYY-MM.
--start-daystringThe first day of a range, YYYY-MM-DD.
--end-daystringThe last day of a range, inclusive; at most 400 days after the first.
--group-bystringday (the default) or month.
--bystringnone (the default), source or product.
--amountstringnet (the default) or gross.
--currencystringThe reporting currency, ISO 4217; default USD.