Vendors

Create a vendor

Create a vendor for an integration.

post/v1/vendors/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/vendors/
  • Auth: HTTP bearer

Request body

integration_idstring required
vendor_category_idstring

The Propexo unique identifier for the vendor category

is_companyboolean

Indicates whether the vendor should be considered a company or person

first_namestring

First name of the vendor. Required if is_company is false

last_namestring

Last name of the vendor. Required if is_company is false

namestring

Company name of the vendor. Required if is_company is true

email_1string email

Primary email for the vendor

email_2string email

Alternate email for the vendor

phone_1string

First phone number

phone_1_type'HOME' | 'WORK' | 'MOBILE' | 'FAX'

First phone number type

phone_2string

Second phone number

phone_2_type'HOME' | 'WORK' | 'MOBILE' | 'FAX'

Second phone number type

address_1string

The first address line associated with the vendor

address_2string

The second address line associated with the vendor

citystring

The city associated with the vendor

statestring

The state associated with the vendor

zipstring

The zip code associated with the vendor

countrystring

The country associated with the vendor

account_numberstring

The account number associated with the vendor

websitestring uri

The website URL associated with the vendor

insurance_providerstring

Vendor insurance provider

insurance_policy_numberstring

Vendor insurance policy number

insurance_expire_datestring date-time

Vendor insurance policy expiration date

notesstring

Notes associated with the vendor

tax_idstring

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

tax_payer_type'SSN' | 'EIN'

The tax payer type. Required if tax_id is set

tax_payer_name_1string

The tax payer name 1

tax_payer_name_2string

The tax payer name 2

tax_address_1string

The tax payer address line 1

tax_address_2string

The tax payer address line 2

tax_citystring

The tax payer address city

tax_statestring

The tax payer address state

tax_zipstring

The tax payer address zip code

tax_countrystring

The tax payer address country

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1VendorsPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.