POST
/
api
/
vendors

Headers

Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
currencyCode
string
required

Currency code for the vendor

billingAddress1
string

Billing address line 1

billingAddress2
string

Billing address line 2

billingAddressCity
string

Billing address city

billingAddressCountry
string

Billing address country

billingAddressEmail
string

Billing address email

billingAddressZipcode
string

Billing address zipcode

billingAddressPhone
string

Billing address phone

billingAddressState
string

Billing address state

shippingAddress1
string

Shipping address line 1

shippingAddress2
string

Shipping address line 2

shippingAddressCity
string

Shipping address city

shippingAddressCountry
string

Shipping address country

shippingAddressEmail
string

Shipping address email

shippingAddressZipcode
string

Shipping address zipcode

shippingAddressPhone
string

Shipping address phone

shippingAddressState
string

Shipping address state

openingBalance
number

Vendor opening balance

openingBalanceExchangeRate
number
default:1

Vendor opening balance exchange rate

openingBalanceAt
string<date-time>

Date of the opening balance

openingBalanceBranchId
number

Branch ID for the opening balance

salutation
string

Vendor salutation

firstName
string

Vendor first name

lastName
string

Vendor last name

companyName
string

Vendor company name

displayName
string

Vendor display name

website
string

Vendor website

email
string

Vendor email address

workPhone
string

Vendor work phone number

personalPhone
string

Vendor personal phone number

note
string

Additional notes about the vendor

active
boolean
default:true

Whether the vendor is active