Residual Summaries

get

https://testapi.payarc.net/v1/residual_table_summaries

Query Params

from_date

string

required

It is not required by validation, but it is required for a query and throw server 500 error. Example: 2024-10-01

to_date

string

required

It is not required by validation, but it is required for a query and throw server 500 error. Example: 2024-10-20

year_month

boolean

Defaults to false

If it is true, adds a column residual_year_month with the following format: Y-m

classification_type

string

Defaults to null

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

audit

boolean

Defaults to false

It combine itself with classification_type and based on that, it adds additional information, or compare current vs previous month

w_p

boolean

Defaults to false

If it is true, makes a join with residual_summary_worked_flag

tsys_mid

string

Defaults to null

Nullable | Digits:15

agent_id

string

Defaults to null

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.

bank

string

enum

If it is empty, it takes all the banks from the lov values for banks

Allowed:

view_agent_id

string

Defaults to null

Return all of the accounts where view_agent_it is primary agent. And view_agent_id should be secondary to the Authenticated user

merchant_id

string

Defaults to null

This field is used for filtering results. The value should be crypted account id

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401

422422

500500