read

The profit and loss of one entity for a date range inside one fiscal year, with its calculation.

Revenue and expense sections by subtype, their totals and the result (a profit is positive), with trace and trace_url. Amounts are { "amount": "<decimal string>", "currency": "<ISO 4217>" } — never a JSON number.

The GET form of finance_profit_and_loss: the same arguments as query parameters.

get/api/v1/finance/reports/profit-and-loss

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/reports/profit-and-loss
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)

Query parameters

entity_idstring uuid required

The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.

fromstring date required

First day of the range.

tostring date required

Last day of the range, in the same fiscal year.

entitystring uuid

Alias of entity_id; give one of the two.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.