v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Company Objects

Create Vendor

Create a new vendor or customer in the system

post/coa/api/vendor

Request body

idinteger required
parent_namestring required
stripe_connection_namestring nullable required
stripe_connection_entityinteger nullable required
stripe_connection_portal_urlstring nullable required
stripe_connection_portal_enabledboolean nullable required
stripe_connection_invoicing_enabledboolean nullable required
vendor_custom_field_1_namestring required
payment_term_name_displaystring required
last_modified_atstring date-time required
is_deletedboolean required
deleted_atstring date-time nullable required
search_vectorstring nullable required
search_textstring nullable required
campfire_idstring nullable required
namestring nullable required
dbastring nullable
company_namestring nullable
websitestring nullable
first_namestring nullable
last_namestring nullable
emailstring email nullable
phone_numberstring nullable
mobile_numberstring nullable
address_street_1string nullable
address_street_2string nullable
citystring nullable
statestring nullable
zip_codestring nullable
countrystring nullable
billing_address_street_1string nullable
billing_address_street_2string nullable
billing_citystring nullable
billing_statestring nullable
billing_zip_codestring nullable
billing_countrystring nullable
shipping_addresseestring nullable
billing_addresseestring nullable
notesstring nullable
business_id_ssnstring nullable
is_1099boolean
vat_numberstring nullable
business_typestring nullable

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

business_categorystring nullable

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

entity_use_codestring nullable

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

withholding_tax_idstring nullable

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.

stripe_customer_idstring nullable
use_stripe_auto_billboolean nullable
bill_vendor_idstring nullable
external_idstring nullable
invoice_messagestring nullable
abbreviationstring nullable
created_atstring date-time required
status'ACTIVE' | 'INACTIVE'
  • ACTIVE - Active
  • INACTIVE - Inactive
anrok_customer_idstring nullable
avalara_customer_idstring nullable
{"stackTrail":"components:schemas:Vendor:properties:invoice_labels","oasType":"schema","type":"unknown","nullable":true}
invoice_languagestring nullable
lineage_arraystring[] nullable

Pre-computed lineage array from root to this vendor

customerinteger required
parentinteger nullable
stripe_connectioninteger nullable
default_expense_categoryinteger nullable
vendor_custom_field_1integer nullable
payment_terminteger nullable

Payment term for this vendor

Response

idinteger required
parent_namestring required
stripe_connection_namestring nullable required
stripe_connection_entityinteger nullable required
stripe_connection_portal_urlstring nullable required
stripe_connection_portal_enabledboolean nullable required
stripe_connection_invoicing_enabledboolean nullable required
vendor_custom_field_1_namestring required
payment_term_name_displaystring required
last_modified_atstring date-time required
is_deletedboolean required
deleted_atstring date-time nullable required
search_vectorstring nullable required
search_textstring nullable required
campfire_idstring nullable required
namestring nullable required
dbastring nullable
company_namestring nullable
websitestring nullable
first_namestring nullable
last_namestring nullable
emailstring email nullable
phone_numberstring nullable
mobile_numberstring nullable
address_street_1string nullable
address_street_2string nullable
citystring nullable
statestring nullable
zip_codestring nullable
countrystring nullable
billing_address_street_1string nullable
billing_address_street_2string nullable
billing_citystring nullable
billing_statestring nullable
billing_zip_codestring nullable
billing_countrystring nullable
shipping_addresseestring nullable
billing_addresseestring nullable
notesstring nullable
business_id_ssnstring nullable
is_1099boolean
vat_numberstring nullable
business_typestring nullable

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

business_categorystring nullable

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

entity_use_codestring nullable

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

withholding_tax_idstring nullable

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.

stripe_customer_idstring nullable
use_stripe_auto_billboolean nullable
bill_vendor_idstring nullable
external_idstring nullable
invoice_messagestring nullable
abbreviationstring nullable
created_atstring date-time required
status'ACTIVE' | 'INACTIVE'
  • ACTIVE - Active
  • INACTIVE - Inactive
anrok_customer_idstring nullable
avalara_customer_idstring nullable
{"stackTrail":"components:schemas:Vendor:properties:invoice_labels","oasType":"schema","type":"unknown","nullable":true}
invoice_languagestring nullable
lineage_arraystring[] nullable

Pre-computed lineage array from root to this vendor

customerinteger required
parentinteger nullable
stripe_connectioninteger nullable
default_expense_categoryinteger nullable
vendor_custom_field_1integer nullable
payment_terminteger nullable

Payment term for this vendor