API Referencevendors

Create a vendor

Create a vendor for an integration.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
vendor_category_idstringOptional
The Propexo unique identifier for the vendor category
is_companybooleanOptional
Indicates whether the vendor should be considered a company or person
first_namestringOptional<=127 characters

First name of the vendor. Required if is_company is false

last_namestringOptional<=127 characters

Last name of the vendor. Required if is_company is false

namestringOptional<=127 characters

Company name of the vendor. Required if is_company is true

email_1stringOptionalformat: "email"
Primary email for the vendor
email_2stringOptionalformat: "email"
Alternate email for the vendor
phone_1stringOptional>=10 characters<=20 characters
First phone number
phone_1_typeenumOptional
First phone number type
Allowed values:
phone_2stringOptional>=10 characters<=20 characters
Second phone number
phone_2_typeenumOptional
Second phone number type
Allowed values:
address_1stringOptional<=100 characters
The first address line associated with the vendor
address_2stringOptional<=100 characters
The second address line associated with the vendor
citystringOptional<=100 characters
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<=30 characters
The account number associated with the vendor
websitestringOptionalformat: "uri"<=100 characters
The website URL associated with the vendor
insurance_providerstringOptional<=65 characters
Vendor insurance provider
insurance_policy_numberstringOptional<=65 characters
Vendor insurance policy number
insurance_expire_datestringOptionalformat: "date-time"
Vendor insurance policy expiration date
notesstringOptional<=65535 characters
Notes associated with the vendor
tax_idstringOptional

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

tax_payer_typeenumOptional

The tax payer type. Required if tax_id is set

Allowed values:
tax_payer_name_1stringOptional<=40 characters
The tax payer name 1
tax_payer_name_2stringOptional<=40 characters
The tax payer name 2
tax_address_1stringOptional<=100 characters
The tax payer address line 1
tax_address_2stringOptional<=100 characters
The tax payer address line 2
tax_citystringOptional<=100 characters
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