---
title: "Residual Summaries"
method: GET
path: "/v1/residual_table_summaries"
---

# Residual Summaries

`GET /v1/residual_table_summaries`

## Query parameters

- `from_date` string, required
- `to_date` string, required
- `year_month` boolean
- `classification_type` string
- `audit` boolean
- `w_p` boolean
- `tsys_mid` string
- `agent_id` string
- `bank` '5670' | '6719' | '9267'
- `view_agent_id` string
- `merchant_id` string

## Response `200`

200

- object
  - `header_data` object[]
    - `column_name` string
    - `sortable` boolean
    - `column_id` string
    - `type` string
  - `row_data` object[]
    - `boarded_date` string
    - `dba_name` string
    - `agent_name` string
    - `mid` string
    - `s_am` integer
    - `txn` integer
    - `inc` integer
    - `exp` integer
    - `net` integer
    - `ag_net` integer
    - `bps` integer
    - `perc` integer
    - `auth` integer
    - `template_id` string
    - `template_name` string
    - `calculation_type` string
    - `bank` string
    - `residual_date` string
    - `hash` string
    - `reviewed` unknown
    - `note` unknown
    - `ppm_id` unknown
    - `residual_category` string
    - `agent_id` integer
    - `account_id` integer
    - `hashed_agent_id` string
    - `hashed_account_id` string
  - `footer_data` object[]
    - `ag_net` unknown
    - `s_am` unknown
    - `txn` unknown
    - `inc` unknown
    - `exp` unknown
    - `net` unknown
    - `bps` unknown
    - `perc` unknown
    - `auth` unknown
    - `payarc_gr_profit` unknown
    - `agent_gr_profit` unknown
    - `profit_difference` unknown

## Other responses

- `401` — 401
- `422` — 422
- `500` — 500

---

[API](https://skmtc.net/payarc/apis/payarc-sandbox.md) · [All operations](https://skmtc.net/payarc/apis/payarc-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payarc/payarc-sandbox/revisions/face82bdd778/schema)