Skip to main content
POST
Create Vendor

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

name
string | null
required
Maximum string length: 250
contacts
object[]
vendor_type
default:vendor
  • vendor - Vendor
  • customer - Customer
  • employee - Employee
Available options:
vendor,
customer,
employee
dba
string | null
Maximum string length: 250
company_name
string | null
Maximum string length: 250
website
string | null
Maximum string length: 250
first_name
string | null
Maximum string length: 250
last_name
string | null
Maximum string length: 250
email
string<email> | null
Maximum string length: 250
phone_number
string | null
Maximum string length: 250
mobile_number
string | null
Maximum string length: 250
address_street_1
string | null
Maximum string length: 250
address_street_2
string | null
Maximum string length: 250
city
string | null
Maximum string length: 250
state
string | null
Maximum string length: 250
zip_code
string | null
Maximum string length: 250
country
string | null
Maximum string length: 250
billing_address_street_1
string | null
Maximum string length: 250
billing_address_street_2
string | null
Maximum string length: 250
billing_city
string | null
Maximum string length: 250
billing_state
string | null
Maximum string length: 250
billing_zip_code
string | null
Maximum string length: 250
billing_country
string | null
Maximum string length: 250
shipping_addressee
string | null
Maximum string length: 255
billing_addressee
string | null
Maximum string length: 255
notes
string | null
Maximum string length: 250
business_id_ssn
string | null
Maximum string length: 250
is_1099
boolean
vat_number
string | null
Maximum string length: 250
business_type
string | null

Business type classification (e.g., Korean NTS 업태)

Maximum string length: 250
business_category
string | null

Business category classification (e.g., Korean NTS 종목)

Maximum string length: 250
entity_use_code
string | null

Avalara entity/use code for tax exemptions (e.g., A - Federal Government, B - State/Local Govt)

Maximum string length: 25
withholding_tax_id
string | null

Vendor's tax-authority ID for withholding (PAN for India, TZ for Israel). Dedicated field since these have format/checksum rules distinct from business_id_ssn.

Maximum string length: 250
ita_deduction_type_code

Israel tax compliance: ITA nature-of-payment deduction type code for Form 856.

  • 1 - Services
  • 2 - Rent
  • 3 - Commissions
  • 4 - Interest
  • 5 - Dividends
Available options:
1,
2,
3,
4,
5
ita_vendor_entity_code

Israel tax compliance: vendor residency classification for Form 856.

  • 0 - Israeli company
  • 2 - PA resident
  • 3 - Foreign individual
  • 5 - Foreign company
Available options:
0,
2,
3,
5
ita_vendor_entity_type

Israel tax compliance: vendor legal-form classification for Form 856.

  • 1 - Individual
  • 2 - Company
  • 3 - Osek
Available options:
1,
2,
3
stripe_customer_id
string | null
Maximum string length: 250
use_stripe_auto_bill
boolean | null
bill_vendor_id
string | null
Maximum string length: 250
external_id
string | null
Maximum string length: 250
source
  • BILL - Bill
  • BREX - Brex
  • HUBSPOT - Hubspot
  • MANUAL - Manual
  • PAYROLL - Payroll
  • SALESFORCE - Salesforce
Available options:
BILL,
BREX,
HUBSPOT,
MANUAL,
PAYROLL,
SALESFORCE
invoice_message
string | null
abbreviation
string | null
Maximum string length: 250
status
enum<string>
  • ACTIVE - Active
  • INACTIVE - Inactive
Available options:
ACTIVE,
INACTIVE
anrok_customer_id
string | null
Maximum string length: 250
terms
  • custom - Custom
  • net_5 - Net 5
  • net_7 - Net 7
  • net_10 - Net 10
  • net_15 - Net 15
  • net_20 - Net 20
  • net_30 - Net 30
  • net_40 - Net 40
  • net_45 - Net 45
  • net_60 - Net 60
  • net_90 - Net 90
  • net_105 - Net 105
  • net_120 - Net 120
  • due_on_receipt - Due on Receipt
Available options:
custom,
net_5,
net_7,
net_10,
net_15,
net_20,
net_30,
net_40,
net_45,
net_60,
net_90,
net_105,
net_120,
due_on_receipt
invoice_labels
unknown
invoice_language
string | null
Maximum string length: 10
lineage_array
string[] | null

Pre-computed lineage array from root to this vendor

Maximum string length: 50
parent
integer | null
stripe_connection
integer | null
default_expense_category
integer | null
vendor_custom_field_1
integer | null
payment_term
integer | null

Payment term for this vendor

Response

201 - application/json
id
integer
required
read-only
parent_name
string
required
read-only
stripe_connection_name
string | null
required
read-only
stripe_connection_entity
integer | null
required
read-only
stripe_connection_portal_url
string | null
required
read-only
stripe_connection_portal_enabled
boolean | null
required
read-only
stripe_connection_invoicing_enabled
boolean | null
required
read-only
vendor_custom_field_1_name
string
required
read-only
payment_term_name_display
string
required
read-only
last_modified_at
string<date-time>
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
search_vector
string | null
required
read-only
search_text
string | null
required
read-only
campfire_id
string | null
required
read-only
name
string | null
required
Maximum string length: 250
created_at
string<date-time>
required
read-only
customer
integer
required
read-only
contacts
object[]
vendor_type
default:vendor
  • vendor - Vendor
  • customer - Customer
  • employee - Employee
Available options:
vendor,
customer,
employee
dba
string | null
Maximum string length: 250
company_name
string | null
Maximum string length: 250
website
string | null
Maximum string length: 250
first_name
string | null
Maximum string length: 250
last_name
string | null
Maximum string length: 250
email
string<email> | null
Maximum string length: 250
phone_number
string | null
Maximum string length: 250
mobile_number
string | null
Maximum string length: 250
address_street_1
string | null
Maximum string length: 250
address_street_2
string | null
Maximum string length: 250
city
string | null
Maximum string length: 250
state
string | null
Maximum string length: 250
zip_code
string | null
Maximum string length: 250
country
string | null
Maximum string length: 250
billing_address_street_1
string | null
Maximum string length: 250
billing_address_street_2
string | null
Maximum string length: 250
billing_city
string | null
Maximum string length: 250
billing_state
string | null
Maximum string length: 250
billing_zip_code
string | null
Maximum string length: 250
billing_country
string | null
Maximum string length: 250
shipping_addressee
string | null
Maximum string length: 255
billing_addressee
string | null
Maximum string length: 255
notes
string | null
Maximum string length: 250
business_id_ssn
string | null
Maximum string length: 250
is_1099
boolean
vat_number
string | null
Maximum string length: 250
business_type
string | null

Business type classification (e.g., Korean NTS 업태)

Maximum string length: 250
business_category
string | null

Business category classification (e.g., Korean NTS 종목)

Maximum string length: 250
entity_use_code
string | null

Avalara entity/use code for tax exemptions (e.g., A - Federal Government, B - State/Local Govt)

Maximum string length: 25
withholding_tax_id
string | null

Vendor's tax-authority ID for withholding (PAN for India, TZ for Israel). Dedicated field since these have format/checksum rules distinct from business_id_ssn.

Maximum string length: 250
ita_deduction_type_code

Israel tax compliance: ITA nature-of-payment deduction type code for Form 856.

  • 1 - Services
  • 2 - Rent
  • 3 - Commissions
  • 4 - Interest
  • 5 - Dividends
Available options:
1,
2,
3,
4,
5
ita_vendor_entity_code

Israel tax compliance: vendor residency classification for Form 856.

  • 0 - Israeli company
  • 2 - PA resident
  • 3 - Foreign individual
  • 5 - Foreign company
Available options:
0,
2,
3,
5
ita_vendor_entity_type

Israel tax compliance: vendor legal-form classification for Form 856.

  • 1 - Individual
  • 2 - Company
  • 3 - Osek
Available options:
1,
2,
3
stripe_customer_id
string | null
Maximum string length: 250
use_stripe_auto_bill
boolean | null
bill_vendor_id
string | null
Maximum string length: 250
external_id
string | null
Maximum string length: 250
source
  • BILL - Bill
  • BREX - Brex
  • HUBSPOT - Hubspot
  • MANUAL - Manual
  • PAYROLL - Payroll
  • SALESFORCE - Salesforce
Available options:
BILL,
BREX,
HUBSPOT,
MANUAL,
PAYROLL,
SALESFORCE
invoice_message
string | null
abbreviation
string | null
Maximum string length: 250
status
enum<string>
  • ACTIVE - Active
  • INACTIVE - Inactive
Available options:
ACTIVE,
INACTIVE
anrok_customer_id
string | null
Maximum string length: 250
terms
  • custom - Custom
  • net_5 - Net 5
  • net_7 - Net 7
  • net_10 - Net 10
  • net_15 - Net 15
  • net_20 - Net 20
  • net_30 - Net 30
  • net_40 - Net 40
  • net_45 - Net 45
  • net_60 - Net 60
  • net_90 - Net 90
  • net_105 - Net 105
  • net_120 - Net 120
  • due_on_receipt - Due on Receipt
Available options:
custom,
net_5,
net_7,
net_10,
net_15,
net_20,
net_30,
net_40,
net_45,
net_60,
net_90,
net_105,
net_120,
due_on_receipt
invoice_labels
unknown
invoice_language
string | null
Maximum string length: 10
lineage_array
string[] | null

Pre-computed lineage array from root to this vendor

Maximum string length: 50
parent
integer | null
stripe_connection
integer | null
default_expense_category
integer | null
vendor_custom_field_1
integer | null
payment_term
integer | null

Payment term for this vendor