Payees

Create Payee

Creates a new Payee

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payee_ID
string or null <= 20 characters

Unique identifier assigned to the Payee. If a Payee ID is not provided, one will be assigned at the time of creation.

address
string or null <= 255 characters

Address of the Payee.

address2
string or null <= 128 characters

Address line 2 of the Payee.

alternate_ID
string or null <= 20 characters

Field using for storing a custom alternate ID associated with this Payee.

blid
string or null <= 64 characters

The BaseLoad identifier associated with this Billing entity (Payee).

city
string or null <= 30 characters

City of the Payee's address.

contact
string or null <= 50 characters

Name of the desired contact person associated with the Payee.

country_ID
string or null <= 8 characters

Identifier of the country where the Payee resides.

email_Address
string or null <= 128 characters

Email address of the Payee.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

fax_Country_Code
string or null <= 8 characters

Country code of the Payee's fax number.

fax_Number
string or null <= 20 characters

Fax number of the Payee.

federal_ID
string or null <= 15 characters

Identifier assigned to the Payee that is used for federal tax purposes.

inactive
required
boolean

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 or null <double>

Latitudinal coordinates for the Payee's location.

longitude
number or null <double>

Longitudinal coordinate for the Payee's location.

name
string or null <= 128 characters

Name of the Payee.

name_For_Check
string or null <= 128 characters

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 or null <= 1 characters

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 or null <= 128 characters

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 or null <= 128 characters

Line 2 of the address that should be used for payments to the Payee.

payTo_City
string or null <= 30 characters

City of the address that should be used for payments to the Payee.

payTo_Country_ID
string or null <= 8 characters

Identifier of the country where the Payee's payments are received.

payTo_State
string or null <= 2 characters

State of the Payee's address used for payments.

payTo_Zip
string or null <= 32 characters

Zip Code of the Payee's address used for payments.

pend_Ex_Code
string or null <= 6 characters

Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.

pend_Flag
boolean or null

Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee.

phone_Country_Code
string or null <= 8 characters

Country code of the Payee's phone number.

phone_Number
string or null <= 20 characters

Phone number of the Payee.

state
string or null <= 2 characters

State of the Payee's address.

tax_Address
string or null <= 128 characters

Address that the Payee uses for tax purposes.

tax_Address2
string or null <= 128 characters

Address line 2 that the Payee uses for tax purposes.

tax_City
string or null <= 32 characters

City of the address that the Payee uses for tax purposes.

tax_Contact
string or null <= 64 characters

Contact that the Payee uses for tax purposes.

tax_Fax_Number
string or null <= 16 characters

Fax number of the Contact that the Payee uses for tax purposes.

tax_Name
string or null <= 64 characters

Name that the Payee uses for tax purposes.

tax_Phone_Number
string or null <= 16 characters

Phone number of the Contact that the Payee uses for tax purposes.

tax_State
string or null <= 2 characters

State of the address that the Payee uses for tax purposes.

tax_Zip_Code
string or null <= 16 characters

Zip Code of the address that the Payee uses for tax purposes.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

virtual_Office
required
boolean

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
required
boolean

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
required
boolean

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 or null <= 256 characters

Website of the Payee.

wire_Transfer
required
boolean

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 or null <= 32 characters

Zip Code of the Payee's address.

Responses
200

Success

401

Unauthorized

post/payees
Request samples
{
  • "payee_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "alternate_ID": "string",
  • "blid": "string",
  • "city": "string",
  • "contact": "string",
  • "country_ID": "string",
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "federal_ID": "string",
  • "inactive": true,
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "name": "string",
  • "name_For_Check": "string",
  • "need_1099": "s",
  • "payTo_Address": "string",
  • "payTo_Address2": "string",
  • "payTo_City": "string",
  • "payTo_Country_ID": "string",
  • "payTo_State": "st",
  • "payTo_Zip": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": true,
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "state": "st",
  • "tax_Address": "string",
  • "tax_Address2": "string",
  • "tax_City": "string",
  • "tax_Contact": "string",
  • "tax_Fax_Number": "string",
  • "tax_Name": "string",
  • "tax_Phone_Number": "string",
  • "tax_State": "st",
  • "tax_Zip_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "virtual_Office": true,
  • "void_Checks": true,
  • "w9_Received": true,
  • "website": "string",
  • "wire_Transfer": true,
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Payee

Lists all Payee

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/payees
Request samples 
Response samples 
No sample
Get Payee
Gets Payee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payees/{payeeID}
Request samples 
Response samples 
No sample
Update Payee
Updates a specific Payee.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payee_ID
string or null  <= 20 characters 
Unique identifier assigned to the Payee.  If a Payee ID is not provided, one will be assigned at the time of creation.


 
address
string or null  <= 255 characters 
Address of the Payee.


 
address2
string or null  <= 128 characters 
Address line 2 of the Payee.


 
alternate_ID
string or null  <= 20 characters 
Field using for storing a custom alternate ID associated with this Payee.


 
blid
string or null  <= 64 characters 
The BaseLoad identifier associated with this Billing entity (Payee).


 
city
string or null  <= 30 characters 
City of the Payee's address.


 
contact
string or null  <= 50 characters 
Name of the desired contact person associated with the Payee.


 
country_ID
string or null  <= 8 characters 
Identifier of the country where the Payee resides.


 
email_Address
string or null  <= 128 characters 
Email address of the Payee.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the Payee's fax number.


 
fax_Number
string or null  <= 20 characters 
Fax number of the Payee.


 
federal_ID
string or null  <= 15 characters 
Identifier assigned to the Payee that is used for federal tax purposes.


 
inactive
required
boolean
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 or null <double> 
Latitudinal coordinates for the Payee's location.


 
longitude
number or null <double> 
Longitudinal coordinate for the Payee's location.


 
name
string or null  <= 128 characters 
Name of the Payee.


 
name_For_Check
string or null  <= 128 characters 
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 or null  <= 1 characters 
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 or null  <= 128 characters 
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 or null  <= 128 characters 
Line 2 of the address that should be used for payments to the Payee.


 
payTo_City
string or null  <= 30 characters 
City of the address that should be used for payments to the Payee.


 
payTo_Country_ID
string or null  <= 8 characters 
Identifier of the country where the Payee's payments are received.


 
payTo_State
string or null  <= 2 characters 
State of the Payee's address used for payments.


 
payTo_Zip
string or null  <= 32 characters 
Zip Code of the Payee's address used for payments.


 
pend_Ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.


 
pend_Flag
boolean or null
Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Payee's phone number.


 
phone_Number
string or null  <= 20 characters 
Phone number of the Payee.


 
state
string or null  <= 2 characters 
State of the Payee's address.


 
tax_Address
string or null  <= 128 characters 
Address that the Payee uses for tax purposes.


 
tax_Address2
string or null  <= 128 characters 
Address line 2 that the Payee uses for tax purposes.


 
tax_City
string or null  <= 32 characters 
City of the address that the Payee uses for tax purposes.


 
tax_Contact
string or null  <= 64 characters 
Contact that the Payee uses for tax purposes.


 
tax_Fax_Number
string or null  <= 16 characters 
Fax number of the Contact that the Payee uses for tax purposes.


 
tax_Name
string or null  <= 64 characters 
Name that the Payee uses for tax purposes.


 
tax_Phone_Number
string or null  <= 16 characters 
Phone number of the Contact that the Payee uses for tax purposes.


 
tax_State
string or null  <= 2 characters 
State of the address that the Payee uses for tax purposes.


 
tax_Zip_Code
string or null  <= 16 characters 
Zip Code of the address that the Payee uses for tax purposes.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
virtual_Office
required
boolean
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
required
boolean
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
required
boolean
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 or null  <= 256 characters 
Website of the Payee.


 
wire_Transfer
required
boolean
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 or null  <= 32 characters 
Zip Code of the Payee's address.


 
Responses 
200
Success


401
Unauthorized


put/payees/{payeeID}
Request samples 
{
  • "payee_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "alternate_ID": "string",
  • "blid": "string",
  • "city": "string",
  • "contact": "string",
  • "country_ID": "string",
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "federal_ID": "string",
  • "inactive": true,
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "name": "string",
  • "name_For_Check": "string",
  • "need_1099": "s",
  • "payTo_Address": "string",
  • "payTo_Address2": "string",
  • "payTo_City": "string",
  • "payTo_Country_ID": "string",
  • "payTo_State": "st",
  • "payTo_Zip": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": true,
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "state": "st",
  • "tax_Address": "string",
  • "tax_Address2": "string",
  • "tax_City": "string",
  • "tax_Contact": "string",
  • "tax_Fax_Number": "string",
  • "tax_Name": "string",
  • "tax_Phone_Number": "string",
  • "tax_State": "st",
  • "tax_Zip_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "virtual_Office": true,
  • "void_Checks": true,
  • "w9_Received": true,
  • "website": "string",
  • "wire_Transfer": true,
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Payee
Deletes an Payee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payees/{payeeID}
Request samples 
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.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
payee_ID
string or null  <= 20 characters 
Unique identifier assigned to the Payee.  If a Payee ID is not provided, one will be assigned at the time of creation.


 
address
string or null  <= 255 characters 
Address of the Payee.


 
address2
string or null  <= 128 characters 
Address line 2 of the Payee.


 
alternate_ID
string or null  <= 20 characters 
Field using for storing a custom alternate ID associated with this Payee.


 
blid
string or null  <= 64 characters 
The BaseLoad identifier associated with this Billing entity (Payee).


 
city
string or null  <= 30 characters 
City of the Payee's address.


 
contact
string or null  <= 50 characters 
Name of the desired contact person associated with the Payee.


 
country_ID
string or null  <= 8 characters 
Identifier of the country where the Payee resides.


 
email_Address
string or null  <= 128 characters 
Email address of the Payee.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the Payee's fax number.


 
fax_Number
string or null  <= 20 characters 
Fax number of the Payee.


 
federal_ID
string or null  <= 15 characters 
Identifier assigned to the Payee that is used for federal tax purposes.


 
inactive
required
boolean
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 or null <double> 
Latitudinal coordinates for the Payee's location.


 
longitude
number or null <double> 
Longitudinal coordinate for the Payee's location.


 
name
string or null  <= 128 characters 
Name of the Payee.


 
name_For_Check
string or null  <= 128 characters 
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 or null  <= 1 characters 
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 or null  <= 128 characters 
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 or null  <= 128 characters 
Line 2 of the address that should be used for payments to the Payee.


 
payTo_City
string or null  <= 30 characters 
City of the address that should be used for payments to the Payee.


 
payTo_Country_ID
string or null  <= 8 characters 
Identifier of the country where the Payee's payments are received.


 
payTo_State
string or null  <= 2 characters 
State of the Payee's address used for payments.


 
payTo_Zip
string or null  <= 32 characters 
Zip Code of the Payee's address used for payments.


 
pend_Ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.


 
pend_Flag
boolean or null
Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Payee's phone number.


 
phone_Number
string or null  <= 20 characters 
Phone number of the Payee.


 
state
string or null  <= 2 characters 
State of the Payee's address.


 
tax_Address
string or null  <= 128 characters 
Address that the Payee uses for tax purposes.


 
tax_Address2
string or null  <= 128 characters 
Address line 2 that the Payee uses for tax purposes.


 
tax_City
string or null  <= 32 characters 
City of the address that the Payee uses for tax purposes.


 
tax_Contact
string or null  <= 64 characters 
Contact that the Payee uses for tax purposes.


 
tax_Fax_Number
string or null  <= 16 characters 
Fax number of the Contact that the Payee uses for tax purposes.


 
tax_Name
string or null  <= 64 characters 
Name that the Payee uses for tax purposes.


 
tax_Phone_Number
string or null  <= 16 characters 
Phone number of the Contact that the Payee uses for tax purposes.


 
tax_State
string or null  <= 2 characters 
State of the address that the Payee uses for tax purposes.


 
tax_Zip_Code
string or null  <= 16 characters 
Zip Code of the address that the Payee uses for tax purposes.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
virtual_Office
required
boolean
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
required
boolean
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
required
boolean
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 or null  <= 256 characters 
Website of the Payee.


 
wire_Transfer
required
boolean
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 or null  <= 32 characters 
Zip Code of the Payee's address.


 
Responses 
207
Success


401
Unauthorized


put/payees-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}