Get day-end report data

Request

Account payments, including gift card and membership payments, are limited to accounts accessible to the user. An empty restricted account selection produces zero account payment totals. Attendance quantities and non-account payment methods retain their own permissions.

start_date: Report date
team_member_id: team member ID

Security

BearerPartnerUser

Path

location_idintegerrequired

location ID

Query

start_datestring

period start date

Example:start_date=''

team_member_idinteger

Team Member ID

Example:team_member_id=0

Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/reports/z_report/{location_id}?start_date='\'''\''&team_member_id=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataobject

Object with data

Example:

{
  "stats": {
    "clients": 7,
    "clients_average": 123.45,
    "records": 14,
    "records_average": 4231.51,
    "visit_records": 13,
    "visit_records_average": 100500.01,
    "non_visit_records": 1,
    "non_visit_records_average": 200,
    "targets": 14,
    "targets_paid": 10255,
    "goods": 4,
    "goods_paid": 12452.18,
    "certificates": 1,
    "certificates_paid": 9876,
    "abonement": 0,
    "abonement_paid": 0
  },
  "paids": {
    "accounts": [ … ],
    "discount": [ … ],
    "total": { … }
  },
  "z_data": {
    "1481101200": [ … ]
  },
  "currency": "USD"
}

metaArray of objects

Metadata (empty array)

Example:

[]

Response

{
  "success": true,
  "data": {
    "stats": { … },
    "paids": { … },
    "z_data": { … },
    "currency": "USD"
  },
  "meta": []
}