# List PayorAccount

Lists PayorAccounts with optional Payor_ID filter.

Endpoint: GET /payor-accounts
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Query parameters:

  - `payorID` (string)
    Payor ID

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.payor_Account_Key` (integer, required)
    Unique identifier for each Payor and Account combination. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.account_Key` (integer, required)
    References the FundingAccount.Account_Key associated with this Payor/Account. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.check_Stock` (integer,null)
    When a check is printed, the check will default to the selected check stock.

  - `data.currency_ID` (string,null)
    Identifies the currency that is used by the Payor.

  - `data.default_Contact_Method` (string,null)
    Identifies the desired default contact method of the Payor.

  - `data.default_Funding_Format` (string,null)
    Identifies the desired default funding format of the Payor.

  - `data.effective_Date` (string,null)
    Date when the Payor account becomes/became effective.

  - `data.entry_Date` (string)
    Date when the record was added to the system.

  - `data.entry_User` (string,null)
    User that first added the record to the system.

  - `data.ex_Code` (string,null)
    Allows the User to select an Ex Code that will be applied to any claims associated with the Payor whenever the 'Apply Ex Code' option is selected.

  - `data.funding_Threshold` (integer,null)
    This option is informational only.

  - `data.logo_File` (string,null)
    Displays the currently used logo file for the Payor. This logo can be applied to custom check stock.

  - `data.payor_ID` (string, required)
    References the Payor.Payor_ID associated with this Payor/Account.

  - `data.signatures_Required` (integer,null)
    This option is informational only.

  - `data.single_Check_Per_Claim` (boolean, required)
    Requires that this Payor's claims be paid for with a single check. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.term_Date` (string,null)
    Date when the Payor account becomes/became terminated.

  - `data.update_Date` (string)
    Date when the record was last updated in the system.

  - `data.update_User` (string,null)
    User that last updated the record in the system.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields