v1
latestOpenAPI 3.1.02026-07-24170121.2 MBResidual Summaries
Query parameters
It is not required by validation, but it is required for a query and throw server 500 error. Example: 2024-10-01
It is not required by validation, but it is required for a query and throw server 500 error. Example: 2024-10-20
If it is true, adds a column residual_year_month with the following format: Y-m
The following options: missing_changed_buy_rate, change_in_merchant_pricing, volume_tiers, merchant_refunds, net_current_vs_previous, current_vs_previous, profit_negative_difference
It combine itself with classification_type and based on that, it adds additional information, or compare current vs previous month
If it is true, makes a join with residual_summary_worked_flag
Nullable | Digits:15
This field is used for filtering merchants. If the Authenticated user is an agent, it takes their id and filters the merchants by it. Alternatively the agent_id can be passed as a parameter to filter. If both are true then the authenticated user's id take precedence.
If it is empty, it takes all the banks from the lov values for banks
Return all of the accounts where view_agent_it is primary agent. And view_agent_id should be secondary to the Authenticated user
This field is used for filtering results. The value should be crypted account id
Response
200
Example response
{
"header_data": [
{
"column_name": "Boarded Date",
"sortable": true,
"column_id": "boarded_date",
"type": "date"
}
],
"row_data": [
{
"boarded_date": "2020-06-11",
"dba_name": "Enterprise Accounting",
"agent_name": "Anchor Solutions",
"mid": "0926700349283458",
"template_id": "45",
"template_name": "No Residuals",
"calculation_type": "1",
"bank": "9267",
"residual_date": "2021-01-31",
"hash": "9f11c68e377c6bed2648dd8de35a813c",
"residual_category": "tsys",
"agent_id": 5,
"account_id": 638,
"hashed_agent_id": "lzlpPj91921vb2e6",
"hashed_account_id": "7e04nxeV97NRVG9Z"
}
]
}