# Update Payor

Updates a specific Payor.

Endpoint: PUT /payors/{payorId}
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Path parameters:

  - `payorId` (string, required)
    Payor ID

## Request fields (application/json):

  - `payor_ID` (string, required)
    Unique identifier assigned to the Payor.

  - `address` (string,null)
    Address of the Payor.

  - `address2` (string,null)
    Address line 2 of the Payor.

  - `admin_Fee` (number,null)
    Specifies the 'Admin Fee' amount that will be applied to the associated check.

  - `admin_Pct` (string,null)
    Identifies whether the associated 'Admin Fee' is a percentage.

  - `city` (string,null)
    City of the Payor's address.

  - `contact` (string,null)
    Name of the intended contact person for the Payor.

  - `country_ID` (string,null)
    Identifier of the country where the Payor resides.

  - `county_Code` (string,null)
    Indentifier of the county where the Payor resides.

  - `default_Pay_Date_Range` (integer,null)
    This option allows the User to post-date 'Check Paid Date' field at the Payor level by the designated number of days.

  - `edI_ID` (string,null)
    EDI ID associated with the Payor.

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

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

  - `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.

  - `fax_Country_Code` (string,null)
    Country code of the Payor's fax number.

  - `fax_Number` (string,null)
    Fax number of the Payor.

  - `federal_ID` (string,null)
    Identifier assigned to the Payor that is used for federal tax purposes.

  - `force_Filter` (boolean, required)
    This option will limit filters available from the Claim Funding screen to the filters that have been built on the Funds Filter tab. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `last_Wire_Check` (integer,null)
    Displays the check number of the Payor's last wire transfer.

  - `name` (string,null)
    Name of the Payor individual or institution.

  - `phone_Country_Code` (string,null)
    Country code of the Payor's phone number.

  - `phone_Number` (string,null)
    Phone number of the Payor.

  - `state` (string,null)
    State of the Payor's address.

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

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

  - `zip_Code` (string,null)
    Zip Code of the Payor's address.

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.payor_ID` (string, required)
    Unique identifier assigned to the Payor.

  - `data.address` (string,null)
    Address of the Payor.

  - `data.address2` (string,null)
    Address line 2 of the Payor.

  - `data.admin_Fee` (number,null)
    Specifies the 'Admin Fee' amount that will be applied to the associated check.

  - `data.admin_Pct` (string,null)
    Identifies whether the associated 'Admin Fee' is a percentage.

  - `data.city` (string,null)
    City of the Payor's address.

  - `data.contact` (string,null)
    Name of the intended contact person for the Payor.

  - `data.country_ID` (string,null)
    Identifier of the country where the Payor resides.

  - `data.county_Code` (string,null)
    Indentifier of the county where the Payor resides.

  - `data.default_Pay_Date_Range` (integer,null)
    This option allows the User to post-date 'Check Paid Date' field at the Payor level by the designated number of days.

  - `data.edI_ID` (string,null)
    EDI ID associated with the Payor.

  - `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.fax_Country_Code` (string,null)
    Country code of the Payor's fax number.

  - `data.fax_Number` (string,null)
    Fax number of the Payor.

  - `data.federal_ID` (string,null)
    Identifier assigned to the Payor that is used for federal tax purposes.

  - `data.force_Filter` (boolean, required)
    This option will limit filters available from the Claim Funding screen to the filters that have been built on the Funds Filter tab. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.last_Wire_Check` (integer,null)
    Displays the check number of the Payor's last wire transfer.

  - `data.name` (string,null)
    Name of the Payor individual or institution.

  - `data.phone_Country_Code` (string,null)
    Country code of the Payor's phone number.

  - `data.phone_Number` (string,null)
    Phone number of the Payor.

  - `data.state` (string,null)
    State of the Payor's address.

  - `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.

  - `data.zip_Code` (string,null)
    Zip Code of the Payor's address.

  - `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