Create a vendor

POST
/v1/vendors/

Create a vendor for an integration.

Request

This endpoint expects an object.
integration_idstringRequired
vendor_category_idstringOptional

The Propexo unique identifier for the vendor category

is_companybooleanOptionalDefaults to false

Indicates whether the vendor should be considered a company or person

first_namestringOptional

First name of the vendor. Required if is_company is false

last_namestringOptional

Last name of the vendor. Required if is_company is false

namestringOptional

Company name of the vendor. Required if is_company is true

email_1stringOptional

Primary email for the vendor

email_2stringOptional

Alternate email for the vendor

phone_1stringOptional=10 characters

First phone number

phone_1_typeenumOptional
Allowed values: HOMEWORKMOBILEFAX

First phone number type

phone_2stringOptional=10 characters

Second phone number

phone_2_typeenumOptional
Allowed values: HOMEWORKMOBILEFAX

Second phone number type

address_1stringOptional

The first address line associated with the vendor

address_2stringOptional

The second address line associated with the vendor

citystringOptional

The city associated with the vendor

statestringOptional

The state associated with the vendor

zipstringOptional

The zip code associated with the vendor

countrystringOptional

The country associated with the vendor

account_numberstringOptional

The account number associated with the vendor

websitestringOptional

The website URL associated with the vendor

insurance_providerstringOptional

Vendor insurance provider

insurance_policy_numberstringOptional

Vendor insurance policy number

insurance_expire_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Vendor insurance policy expiration date

notesstringOptional

Notes associated with the vendor

tax_idstringOptional

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

tax_payer_type"SSN" or "EIN"Optional
Allowed values: SSNEIN

The tax payer type. Required if tax_id is set

tax_payer_name_1stringOptional

The tax payer name 1

tax_payer_name_2stringOptional

The tax payer name 2

tax_address_1stringOptional

The tax payer address line 1

tax_address_2stringOptional

The tax payer address line 2

tax_citystringOptional

The tax payer address city

tax_statestringOptional

The tax payer address state

tax_zipstringOptional

The tax payer address zip code

tax_countrystringOptional

The tax payer address country

Response

Successful response

job_idstring

The ID of the job created to handle this operation

dataobject

Errors