APIs for VBASoftware
VBASoftware APIDelete Payee
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
Unique identifier assigned to the Payee. If a Payee ID is not provided, one will be assigned at the time of creation.
Field using for storing a custom alternate ID associated with this Payee.
The BaseLoad identifier associated with this Billing entity (Payee).
Identifier assigned to the Payee that is used for federal tax purposes.
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.
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.
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.
Address that should be used for payments to the Payee. Payments will default to the Payee address if this field is not completed.
Line 2 of the address that should be used for payments to the Payee.
City of the address that should be used for payments to the Payee.
Identifier of the country where the Payee's payments are received.
Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.
Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee.
Fax number of the Contact that the Payee uses for tax purposes.
Phone number of the Contact that the Payee uses for tax purposes.
Zip Code of the address that the Payee uses for tax purposes.
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.
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.
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.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/payees/{payeeID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/payees/{payeeID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/payees/{payeeID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/payees/{payeeID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Body
- application/json
- text/json
- application/*+json
Unique identifier assigned to the Payee. If a Payee ID is not provided, one will be assigned at the time of creation.
Field using for storing a custom alternate ID associated with this Payee.
The BaseLoad identifier associated with this Billing entity (Payee).
Identifier assigned to the Payee that is used for federal tax purposes.
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.
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.
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.
Address that should be used for payments to the Payee. Payments will default to the Payee address if this field is not completed.
Line 2 of the address that should be used for payments to the Payee.
City of the address that should be used for payments to the Payee.
Identifier of the country where the Payee's payments are received.
Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.
Indicates whether an Ex Code should be applied to claims that involve payments to the selected Payee.
Fax number of the Contact that the Payee uses for tax purposes.
Phone number of the Contact that the Payee uses for tax purposes.
Zip Code of the address that the Payee uses for tax purposes.
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.
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.
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.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/payees-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/payees-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"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
No response example