Revenue report — sales, fees, refunds (by refund date), revenue, COGS (net of refunded stock), gross profit and margin per local day/week/month, plus invoice revenue (actual/collected and expected/invoiced) shown alongside

GET

/api/dash/{orgId}/reports/revenue

curl --request GET \
  --url 'https://api.medivy.id/api/dash/example/reports/revenue?from=example&to=example&groupBy=day' \
  --header 'x-api-key: <x-api-key>'

• Production

Authorizations

• apiKey

Parameters

Path Parameters

orgId

required

string

Your organization ID. The API key must belong to this organization.

Query Parameters

from

required

string

/^\d{4}-\d{2}-\d{2}$/

to

required

string

/^\d{4}-\d{2}-\d{2}$/

outletId

string

channelId

string

groupBy

string

default: day

Allowed values: day week month

Responses

200

OK

Media typeapplication/json

Example ^generated

example

401

Missing, invalid, disabled or expired API key.

Media typeapplication/json

object

ok

message

string

Example

{
  "ok": false
}

403

The key belongs to another organization, the request came from an IP outside the key’s allowlist, or the key’s user lacks the permission.

Media typeapplication/json

object

ok

message

string

Example

{
  "ok": false
}

429

Too many requests from this organization.

Media typeapplication/json

object

ok

message

string

Example

{
  "ok": false
}