Skip to content
Console
Menu

Generated Assets

Getting Started

Authentication

KV Store

Revenue sources

A Revenue Source is one place an org's revenue is read from.

A Revenue Source is one place an org's revenue is read from. kind selects the connector Money implements once (ADR §2). The money source is implicit, one per environment with Money, made the first time Money books a sale there; it cannot be created or deleted through the API, only renamed or paused. A connector's credential is sealed and never returned; connectors arrive kind by kind, and a source of a kind whose connector has not shipped yet is registered and reported stale until it first syncs.

Service Sylphx Money · Resource type money.sylphx.com/RevenueSource · Name pattern orgs/{org}/revenue_sources/{revenue_source} · Shape spec_status

#Fields

FieldTypeWhat it is
namestringorgs/{org}/revenue_sources/{revenue_source}.
uidstringThe source's id (rvs-…); never reused. Output only.
metaResourceMetaResource metadata.
specRevenueSourceSpecDesired state. Required.
statusRevenueSourceStatusObserved state. 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
GETgetGets a revenue source, with its freshness. Revenue reporting (docs/adr/ADR-01M40HRQT0VSXZ1WANP8M318F2) is org-wide: revenue:read or revenue:write, held by an org-wide key or an org owner's or admin's session only; a project or environment key is refused.
GETlistLists the org's revenue sources, with their freshness.
POSTcreateRegisters a revenue source. The money source is implicit and never created here.
PATCHupdateRenames, pauses or resumes a revenue source, or changes its settings.
DELETEdeleteDeletes a revenue source and the facts it reported. The money source cannot be deleted; pause it instead.
POSTrunSyncs a revenue source now, or backfills a period. A money source fills any booked fact its environment's ledger holds and the facts lack; a paused source, or one whose connector has not shipped yet, is refused (INVALID_STATE).

#get

Gets a revenue source, with its freshness. Revenue reporting (docs/adr/ADR-01M40HRQT0VSXZ1WANP8M318F2) is org-wide: revenue:read or revenue:write, held by an org-wide key or an org owner's or admin's session only; a project or environment key is refused.

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

#list

Lists the org's revenue sources, with their freshness.

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

#create

Registers a revenue source. The money source is implicit and never created here.

POST https://api.sylphx.com/v1/orgs/acme/revenue_sources · scope revenue:write · effect write · Request, response and examples

#update

Renames, pauses or resumes a revenue source, or changes its settings.

PATCH https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:write · effect write · Request, response and examples

#delete

Deletes a revenue source and the facts it reported. The money source cannot be deleted; pause it instead.

DELETE https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:write · effect destructive · Request, response and examples

#run

Syncs a revenue source now, or backfills a period. A money source fills any booked fact its environment's ledger holds and the facts lack; a paused source, or one whose connector has not shipped yet, is refused (INVALID_STATE).

POST https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source:run · scope revenue:write · effect write · Request, response and examples