Schema

Discover the queryable fields, filter operators, and pagination contract before building a query.

---

GET /schema

Returns the field catalog: all queryable fields grouped by data source, available filter operators, and the pagination contract.

This endpoint is public — it does not require an X-API-Key header, unlike every other endpoint in this API.

Status Codes

Status	Description
200	Field catalog returned.

Example Request

curl https://ext.arc-aegis.billtrust.com/api/v1/remittance-export/schema

Example Response — 200

{
  "version": "1",
  "sources": ["cashapp", "iandp", "bpn"],
  "fields": {
    "core": [
      { "name": "status", "type": "string", "nullable": true, "filterable": true, "description": "Current status of the payment." },
      { "name": "totalAmount", "type": "decimal", "nullable": true, "filterable": true, "description": "Sum of all invoice amounts on the payment." },
      { "name": "currency", "type": "string", "nullable": true, "filterable": true, "description": "Currency the payment was made in." }
    ],
    "cashapp": [
      { "name": "credit_account", "type": "string", "nullable": true, "filterable": true, "description": "Account number associated with a credit item identified on the remittance." }
    ],
    "iandp": [],
    "bpn": []
  },
  "filters": {
    "supported": ["eq", "neq", "gt", "gte", "lt", "lte", "in", "nin", "date_range"],
    "logic": "AND",
    "minimumRequired": 1
  },
  "pagination": {
    "type": "cursor",
    "defaultPageSize": 500,
    "maxPageSize": 100000
  }
}

Each field entry also carries nullable and filterable flags and a description — check filterable before using a field in filters on POST /payments/query or POST /schedules; non-filterable fields can still be selected via fields but rejected if filtered on. filters.minimumRequired (currently always 1) reflects the same "at least one filter" rule enforced on POST /payments/query and POST /schedules.