Skip to content
FreeTicketDocs
Esc
↑↓navigate↵open⌘Jpreview

Financial statement per event date: gross, costs, and net payable

One row per event date (event_date) with the financial breakdown of its confirmed sales — gross collected, platform fee + VAT (IVA), face value, payment gateway fee (actual for MercadoPago, rate-estimated for Wompi or Bold), 4x1000 tax, and net payable — plus the status of the associated settlement. If wompiSalesWithoutRate > 0, the gateway fee for some Wompi or Bold sales could not be estimated and the net amount is overstated.

GET/reports/financials
Authorization
AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

or
x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters
eventstring

Filter by event id

paststring

true = only event dates that already took place (settleable); false = upcoming ones

Allowed:truefalse
Header parameters
X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses
200

OK

dataReportFinancialsRow[]required
Show properties
Array of ReportFinancialsRow
eventIdstringrequired
eventNamestringrequired
eventDateIdstringrequired
startsAtstringrequired
pastbooleanrequired
unitsSoldintegerrequired
min -9007199254740991 · max 9007199254740991
grossnumberrequired
platformFeenumberrequired
facialnumberrequired
paymentFeenumberrequired
wompiSalesWithoutRateintegerrequired
min -9007199254740991 · max 9007199254740991
gmfnumberrequired
netnumberrequired
currencystringrequired
settlementStatusstring | nullrequired
Show properties
Any of:
string
string
null
null
settlementIdstring | nullrequired
Show properties
Any of:
string
string
null
null
settlementAmountnumber | nullrequired
Show properties
Any of:
number
number
null
null
warningsWarning[]
Show properties
Array of Warning
codestringrequired
messagestringrequired
fieldstring
activeWorkspaceIdstring
activeWorkspaceNamestring
accessibleWorkspacesinteger
min -9007199254740991 · max 9007199254740991
suggestedWorkspaceIdstring
suggestedWorkspaceNamestring
401

Missing or invalid credential.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
403

Insufficient role or resource not accessible.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
404

Resource does not exist or is out of scope.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
422

Request body/parameter validation failed.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://admin.appfreeticket.com/api/v1/reports/financials' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "data": [
    {
      "eventId": "string",
      "eventName": "string",
      "eventDateId": "string",
      "startsAt": "string",
      "past": true,
      "unitsSold": -9007199254740991,
      "gross": 0,
      "platformFee": 0,
      "facial": 0,
      "paymentFee": 0,
      "wompiSalesWithoutRate": -9007199254740991,
      "gmf": 0,
      "net": 0,
      "currency": "string",
      "settlementStatus": "SENT",
      "settlementId": "string",
      "settlementAmount": 0
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "field": "string",
      "activeWorkspaceId": "string",
      "activeWorkspaceName": "string",
      "accessibleWorkspaces": -9007199254740991,
      "suggestedWorkspaceId": "string",
      "suggestedWorkspaceName": "string"
    }
  ]
}