CFO financial reconciliation (MP ↔ sale ↔ Siigo invoice)

Minimum role: ADMIN. Active workspace via the X-Workspace-Id header.

GET/reports/reconciliation

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).

x-api-keyAPI key · headerrequired

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

Query parameters

date_fromstringrequired

ISO 8601 (start, on Sale.created_at)

date_tostringrequired

ISO 8601 (end)

match_statusstring

Filter by flag: OK|MISSING_INVOICE|MISSING_CUFE|AMOUNT_MISMATCH|MISSING_PAYMENT

Allowed:OKMISSING_INVOICEMISSING_CUFEAMOUNT_MISMATCHMISSING_PAYMENT

providerstring

Filter by payment_provider (e.g. mercadopago)

eventstring

Filter by event id

eventDatestring

Filter by event date id (takes precedence over event)

pageinteger

1-based page (default 1)

default: 1

page_sizeinteger

Page size 1..500 (default 100)

default: 100

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

dataReconciliationRow[]required

Show properties

Array of ReconciliationRow

sale_referencestringrequired

sale_statusstringrequired

Allowed:PENDINGCONFIRMEDABANDONEDCANCELLEDREFUNDED

sale_amountnumberrequired

mp_payment_refstring | nullrequired

Show properties

Any of:

string

string

null

null

mp_providerstring | nullrequired

Show properties

Any of:

string

string

null

null

mp_amountnumber | nullrequired

Show properties

Any of:

number

number

null

null

siigo_invoice_namestring | nullrequired

Show properties

Any of:

string

string

null

null

siigo_invoice_statusstring | nullrequired

Show properties

Any of:

string

string

null

null

siigo_cufestring | nullrequired

Show properties

Any of:

string

string

null

null

match_statusMatchStatusrequired

Allowed:OKMISSING_INVOICEMISSING_CUFEAMOUNT_MISMATCHMISSING_PAYMENT

event_idstring | nullrequired

Show properties

Any of:

string

string

null

null

event_namestring | nullrequired

Show properties

Any of:

string

string

null

null

event_date_idstring | nullrequired

Show properties

Any of:

string

string

null

null

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

date_fromquery*ISO 8601 (start, on Sale.created_at)date_toquery*ISO 8601 (end)match_statusqueryFilter by flag: OK|MISSING_INVOICE|MISSING_CUFE|AMOUNT_MISMATCH|MISSING_PAYMENTproviderqueryFilter by payment_provider (e.g. mercadopago)eventqueryFilter by event ideventDatequeryFilter by event date id (takes precedence over `event`)pagequery1-based page (default 1)page_sizequeryPage size 1..500 (default 100)X-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/reports/reconciliation?date_from=string&date_to=string' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/reports/reconciliation?date_from=string&date_to=string", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/reports/reconciliation?date_from=string&date_to=string",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": [
    {
      "sale_reference": "string",
      "sale_status": "PENDING",
      "sale_amount": 0,
      "mp_payment_ref": "string",
      "mp_provider": "string",
      "mp_amount": 0,
      "siigo_invoice_name": "string",
      "siigo_invoice_status": "string",
      "siigo_cufe": "string",
      "match_status": "OK",
      "event_id": "string",
      "event_name": "string",
      "event_date_id": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}