Vendors

Create a vendor

POST
Create a vendor for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
vendor_category_id
stringOptional
The Propexo unique identifier for the vendor category
is_company
booleanOptional
Indicates whether the vendor should be considered a company or person
first_name
stringOptional

First name of the vendor. Required if is_company is false

last_name
stringOptional

Last name of the vendor. Required if is_company is false

name
stringOptional

Company name of the vendor. Required if is_company is true

email_1
stringOptional
Primary email for the vendor
email_2
stringOptional
Alternate email for the vendor
phone_1
stringOptional
First phone number
phone_1_type
enumOptional
First phone number type
Allowed values: HOMEWORKMOBILEFAX
phone_2
stringOptional
Second phone number
phone_2_type
enumOptional
Second phone number type
Allowed values: HOMEWORKMOBILEFAX
address_1
stringOptional
The first address line associated with the vendor
address_2
stringOptional
The second address line associated with the vendor
city
stringOptional
The city associated with the vendor
state
stringOptional
The state associated with the vendor
zip
stringOptional
The zip code associated with the vendor
country
stringOptional
The country associated with the vendor
account_number
stringOptional
The account number associated with the vendor
website
stringOptional
The website URL associated with the vendor
insurance_provider
stringOptional
Vendor insurance provider
insurance_policy_number
stringOptional
Vendor insurance policy number
insurance_expire_date
datetimeOptional
Vendor insurance policy expiration date
notes
stringOptional
Notes associated with the vendor
tax_id
stringOptional

The unique identifier of the tax payer. Required if tax_payer_type is set

tax_payer_type
enumOptional

The tax payer type. Required if tax_id is set

Allowed values: SSNEIN
tax_payer_name_1
stringOptional
The tax payer name 1
tax_payer_name_2
stringOptional
The tax payer name 2
tax_address_1
stringOptional
The tax payer address line 1
tax_address_2
stringOptional
The tax payer address line 2
tax_city
stringOptional
The tax payer address city
tax_state
stringOptional
The tax payer address state
tax_zip
stringOptional
The tax payer address zip code
tax_country
stringOptional
The tax payer address country

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
POST
$curl -X POST https://api.propexo.com/v1/vendors \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "integration_id": "integration_id"
>}'
Response
1{
2 "job_id": "job_id",
3 "data": {}
4}