Products

Retrieve a Product's books

One read for a Product's money: cash and claims now, revenue to date, and earnings, payouts, Hyperscale fees and gross revenue by business month. The months use the same posted figures as the company finance report narrowed to this Product; sandbox months use the Product's business time. Amounts are minor-unit strings.

get/v1/products/{productId}/books

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/products/{productId}/books
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

productIdstring required

Hyperscale product ID

Query parameters

fromPeriodstring

First business month. With neither month, the books run from the first posting to the Product clock's month, at most 24 months.

toPeriodstring

Last business month.

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

environment'sandbox' | 'live' required
tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

asOfstring date-time required

When the books hold. In sandbox this is the Product clock, which can run ahead of wall time.

observedAtstring date-time required

Wall time of the read.

currency'SAR' required
completeboolean required

False when a figure below is withheld. unavailable says why.

revenueToDatestring required

Posted earnings net of reversals since the Product started, in minor units.

fromPeriodstring required

UTC calendar month in YYYY-MM form

toPeriodstring required

UTC calendar month in YYYY-MM form

Changes

No recorded changes to this operation across all 1 revision of this API.