{
  "job_id": "string",
  "data": {}
}

Body

integration_idrequired
string
first_name
string

First name of the vendor. Maps to the "Contact.FirstName" field in the PMS

last_name
string

Last name of the vendor. Maps to the "Contact.LastName" field in the PMS

is_company
boolean

Indicates whether the vendor should be considered a company or person. Maps to the "IsCompany" field in the PMS

company_name
string

Company name of the vendor. Maps to the "Name" field in the PMS

email_1
string

Primary email for the vendor. Maps to the "Contact.Email" field in the PMS

email_2
string

Location email for the vendor. Maps to the "location.email" field in the PMS

phone_1
string

First phone number. Maps to the "Contact.PhoneNumbers.PhoneNumber" field in the PMS

phone_1_type
string

First phone number type. Maps to keys of the "PhoneNumbers" field in the PMS

Available options:
HOME,
WORK,
MOBILE,
FAX
phone_2
string

Second phone number. Maps to the "Contact.PhoneNumbers.PhoneNumber" field in the PMS

phone_2_type
string

Second phone number type. Maps to keys of the "PhoneNumbers" field in the PMS

Available options:
HOME,
WORK,
MOBILE,
FAX
address_1
string

Vendor address line 1. Maps to the "Addresses.Address" field in the PMS

address_2
string

Vendor address line 2. Maps to the "location.addressLine2" field in the PMS

city
string

Vendor address city. Maps to the "Addresses.City" field in the PMS

state
string

Vendor address state. Maps to the "Addresses.State" field in the PMS

zip
string

Vendor address zip code. Maps to the "Addresses.PostalCode" field in the PMS

country
string

Vendor address country. Maps to the "location.country" field in the PMS

category_id
string

The unique identifier of the vendor category type. Maps to the "categories.categoryTypeId" field in the PMS

x_gl_account_id
string

The unique identifier of the default general ledger account to associate with the vendor. Maps to the "DefaultAccountID" field in the PMS

account_number
string

The account number of the vendor. Maps to the "AccountNumber" field in the PMS

website
string

The website of the vendor. The value must be a valid URL. Maps to the "Website" field in the PMS

insurance_provider
string

Vendor insurance provider. Maps to the "VendorInsurance > Provider" field in the PMS

insurance_policy_number
string

Vendor insurance policy number. Maps to the "VendorInsurance > PolicyNumber" field in the PMS

insurance_expire_date
string

Vendor insurance policy expiration date. Maps to the "InsuranceExpiration" field in the PMS

notes
string

Comments about the vendor. Maps to the "Comment" field in the PMS

tax_payer_id
string

The unique identifier of the tax payer. Maps to the "TaxID" field in the PMS

tax_payer_type
string

The tax payer type. Required if tax_payer_id is set. Maps to the "TaxInformation > TaxPayerType" field in the PMS

Available options:
SSN,
EIN
tax_payer_name_1
string

The tax payer first name. Maps to the "nameOnTaxReturn" field in the PMS

tax_payer_name_2
string

The tax payer last name. Maps to the "nameOnTaxReturn" field in the PMS

tax_address_1
string

The tax payer address line 1. Maps to the "TaxInformation > Address > AddressLine1" field in the PMS

tax_address_2
string

The tax payer address line 2. Maps to the "TaxInformation > Address > AddressLine2" field in the PMS

tax_city
string

The tax payer address city. Maps to the "TaxInformation > Address > City" field in the PMS

tax_state
string

The tax payer address state. Maps to the "TaxInformation > Address > State" field in the PMS

tax_zip
string

The tax payer address zip code. Maps to the "TaxInformation > Address > PostalCode" field in the PMS

tax_country
string

The tax payer address country. Maps to the "TaxInformation > Address > Country" field in the PMS

custom_data
object

Custom data

external_id
string

The external identifier of the vendor. Maps to the "externalId" field in the PMS

location_name
string

Location name for the vendor. Maps to the "location.name" field in the PMS

payment_method
string

The method of payment for the vendor. Maps to the "remittance.remittanceName" field in the PMS

payment_type_id
string

The unique identifier for the payment type. Maps to the "remittance.apPaymentTypeId" field in the PMS

payee_name
string

Full name of the payee associated with the vendor. Will be defaulted to "company_name" if not provided. Maps to the "Payee" field in the PMS

routing_number
string

The routing number of the vendor bank account. Required only when the payment type is ACH. Maps to the "remittance.routingNumber" field in the PMS

category
string

Category of the vendor. Maps to the "Category" field in the PMS

include_in_1099
boolean

Indicates if vendor is 1099. Maps to the "Is1099" field in the PMS

is_active
boolean

Indicates if vendor is active. Maps to the "IsActive" field in the PMS

Response

job_idrequired
string

The ID of the job created to handle this operation

datarequired
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.