# Create or Update Batch Payee

Create or Update multiple Payee at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.

Endpoint: PUT /payees-batch
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Request fields (application/json):

  - `payee_ID` (string,null)
    Unique identifier assigned to the Payee.  If a Payee ID is not provided, one will be assigned at the time of creation.

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

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

  - `alternate_ID` (string,null)
    Field using for storing a custom alternate ID associated with this Payee.

  - `blid` (string,null)
    The BaseLoad identifier associated with this Billing entity (Payee).

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

  - `contact` (string,null)
    Name of the desired contact person associated with the Payee.

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

  - `email_Address` (string,null)
    Email address of the Payee.

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

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

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

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

  - `inactive` (boolean, required)
    This field indicates that the Payee is currently inactive  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

  - `latitude` (number,null)
    Latitudinal coordinates for the Payee's location.

  - `longitude` (number,null)
    Longitudinal coordinate for the Payee's location.

  - `name` (string,null)
    Name of the Payee.

  - `name_For_Check` (string,null)
    Name that should be writen on checks that are made out to the Payee. Only provide this information if the name differs from the Payee name.

  - `need_1099` (string,null)
    Indicates that the Payee needs a 1099 generated yearly by VBA. Checking this box enables additional 1099 address information. Only provide this information if it differs from the Payee address.

  - `payTo_Address` (string,null)
    Address that should be used for payments to the Payee. Payments will default to the Payee address if this field is not completed.

  - `payTo_Address2` (string,null)
    Line 2 of the address that should be used for payments to the Payee.

  - `payTo_City` (string,null)
    City of the address that should be used for payments to the Payee.

  - `payTo_Country_ID` (string,null)
    Identifier of the country where the Payee's payments are received.

  - `payTo_State` (string,null)
    State of the Payee's address used for payments.

  - `payTo_Zip` (string,null)
    Zip Code of the Payee's address used for payments.

  - `pend_Ex_Code` (string,null)
    Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.

  - `pend_Flag` (boolean,null)
    Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee.

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

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

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

  - `tax_Address` (string,null)
    Address that the Payee uses for tax purposes.

  - `tax_Address2` (string,null)
    Address line 2 that the Payee uses for tax purposes.

  - `tax_City` (string,null)
    City of the address that the Payee uses for tax purposes.

  - `tax_Contact` (string,null)
    Contact that the Payee uses for tax purposes.

  - `tax_Fax_Number` (string,null)
    Fax number of the Contact that the Payee uses for tax purposes.

  - `tax_Name` (string,null)
    Name that the Payee uses for tax purposes.

  - `tax_Phone_Number` (string,null)
    Phone number of the Contact that the Payee uses for tax purposes.

  - `tax_State` (string,null)
    State of the address that the Payee uses for tax purposes.

  - `tax_Zip_Code` (string,null)
    Zip Code of the address that the Payee uses for tax purposes.

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

  - `virtual_Office` (boolean, required)
    Indicates whether the Payee functions as a virtual office. This can be used for data exporting purposes.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

  - `void_Checks` (boolean, required)
    No longer in use.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

  - `w9_Received` (boolean, required)
    This field indicates that a W9 has been received from this Payee. This field is informational only.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

  - `website` (string,null)
    Website of the Payee.

  - `wire_Transfer` (boolean, required)
    Indicates whether the Payee account accepts wire transfers.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

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

## Response 207 fields (text/plain):

  - `data` (array,null)

  - `data.id` (array, required)
    List of key/value pairs that represent the unique id for the entity operation.

  - `data.id.key` (string,null)

  - `data.id.value` (any,null)

  - `data.status` (integer, required)
    http status of the operation (eg, 200, 201, 500)

  - `data.body` (string, required)
    operation message (eg, Updated, Created, Error message)

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