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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/revenue_facts/{revenue_fact}. |
uid | string | The fact's id: a hash of its source and external key. Output only. |
meta | ResourceMeta | Resource metadata. |
source | string | The source that reported it: orgs/{org}/revenue_sources/{id}. Output only. |
external_key | string | The source's own identity for the line. Output only. |
basis | string | booked, estimated or final. Output only. |
granularity | string | transaction, day or month. Output only. |
day | string | The source's reporting day; the first of the month for a month row. Output only. |
store_kind | string | stripe, app_store, google_play, bank_transfer, ad_network or other. Output only. |
account_ref | string | The account the source reports for. Output only. |
product_ref | string | The product reference the source uses. Output only. |
sku | string | The store's item id. Output only. |
region_code | string | Buyer country (ISO 3166-1 alpha-2), where the source reports it. Output only. |
currency_code | string | ISO 4217 code of the amounts. Output only. |
gross | string | What the buyer paid. Output only. |
fee | string | The store's or processor's fee. Output only. |
tax | string | Tax. Output only. |
net | string | What the org earns. Output only. |
units | int64 | Items or orders, where reported. Output only. |
settled_on | string | The 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.
| Method | Call | What it does |
|---|---|---|
GET | list | Lists 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