Skip to content
Console
Menu

Generated Assets

Getting Started

Authentication

KV Store

On this page

Revenue facts

A Revenue Fact is one line a source reported, in that line's own currency (ADR §1): read for audit and export.

A Revenue Fact is one line a source reported, in that line's own currency (ADR §1): read for audit and export. Facts are written by Money's own bookings and by imports, never through this API.

Service Sylphx Money · Resource type money.sylphx.com/RevenueFact · Name pattern orgs/{org}/revenue_facts/{revenue_fact} · Shape record

#Fields

FieldTypeWhat it is
namestringorgs/{org}/revenue_facts/{revenue_fact}.
uidstringThe fact's id: a hash of its source and external key. Output only.
metaResourceMetaResource metadata.
sourcestringThe source that reported it: orgs/{org}/revenue_sources/{id}. Output only.
external_keystringThe source's own identity for the line. Output only.
basisstringbooked, estimated or final. Output only.
granularitystringtransaction, day or month. Output only.
daystringThe source's reporting day; the first of the month for a month row. Output only.
store_kindstringstripe, app_store, google_play, ad_network or other. Output only.
account_refstringThe account the source reports for. Output only.
product_refstringThe product reference the source uses. Output only.
skustringThe store's item id. Output only.
region_codestringBuyer country (ISO 3166-1 alpha-2), where the source reports it. Output only.
currency_codestringISO 4217 code of the amounts. Output only.
grossstringWhat the buyer paid. Output only.
feestringThe store's or processor's fee. Output only.
taxstringTax. Output only.
netstringWhat the org earns. Output only.
unitsint64Items or orders, where reported. Output only.
settled_onstringThe day the money reached the bank; empty until the source says so. 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.

MethodCallWhat it does
GETlistLists the org's revenue facts, newest day first, for audit and export.

#list

Lists the org's revenue facts, newest day first, for audit and export.

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