Skip to main content
POST
/
coa
/
api
/
vendor
/
bulk-search
Bulk Search Vendors by External ID or Name
curl --request POST \
  --url https://api.meetcampfire.com/coa/api/vendor/bulk-search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendors": [
    {
      "name": "<string>",
      "external_id": "<string>",
      "vendor_type": "vendor",
      "email": "[email protected]"
    }
  ],
  "upsert": false
}
'
[
  {
    "id": 123,
    "parent_name": "<string>",
    "stripe_connection_name": "<string>",
    "stripe_connection_entity": 123,
    "stripe_connection_portal_url": "<string>",
    "stripe_connection_portal_enabled": true,
    "vendor_custom_field_1_name": "<string>",
    "payment_term_name_display": "<string>",
    "last_modified_at": "2023-11-07T05:31:56Z",
    "is_deleted": false,
    "deleted_at": "2023-11-07T05:31:56Z",
    "search_vector": "<string>",
    "search_text": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "customer": 123,
    "contacts": [
      {
        "id": 123,
        "last_modified_at": "2023-11-07T05:31:56Z",
        "is_deleted": false,
        "deleted_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[email protected]",
        "phone_number": "<string>",
        "mobile_number": "<string>"
      }
    ],
    "vendor_type": "vendor",
    "dba": "<string>",
    "company_name": "<string>",
    "website": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "phone_number": "<string>",
    "mobile_number": "<string>",
    "address_street_1": "<string>",
    "address_street_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip_code": "<string>",
    "country": "<string>",
    "billing_address_street_1": "<string>",
    "billing_address_street_2": "<string>",
    "billing_city": "<string>",
    "billing_state": "<string>",
    "billing_zip_code": "<string>",
    "billing_country": "<string>",
    "shipping_addressee": "<string>",
    "billing_addressee": "<string>",
    "notes": "<string>",
    "business_id_ssn": "<string>",
    "is_1099": true,
    "vat_number": "<string>",
    "entity_use_code": "<string>",
    "stripe_customer_id": "<string>",
    "use_stripe_auto_bill": true,
    "bill_vendor_id": "<string>",
    "external_id": "<string>",
    "source": "BILL",
    "invoice_message": "<string>",
    "abbreviation": "<string>",
    "status": "ACTIVE",
    "anrok_customer_id": "<string>",
    "terms": "custom",
    "lineage_array": [
      "<string>"
    ],
    "parent": 123,
    "stripe_connection": 123,
    "default_expense_category": 123,
    "vendor_custom_field_1": 123,
    "payment_term": 123
  }
]

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

​
vendors
object[]
required
Required array length: 1 - 10000 elements
​
upsert
boolean
default:false

If true, create vendors that don't exist

Response

200 - application/json
​
id
integer
required
​
parent_name
string
required
​
stripe_connection_name
string | null
required
​
stripe_connection_entity
integer | null
required
​
stripe_connection_portal_url
string | null
required
​
stripe_connection_portal_enabled
boolean | null
required
​
vendor_custom_field_1_name
string
required
​
payment_term_name_display
string
required
​
last_modified_at
string<date-time>
required
​
is_deleted
boolean
default:false
required
​
deleted_at
string<date-time> | null
required
​
search_vector
string | null
required
​
search_text
string | null
required
​
name
string | null
required
Maximum string length: 250
​
created_at
string<date-time>
required
​
customer
integer
required
​
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
​
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
​
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
  • SALESFORCE - Salesforce
Available options:
BILL,
BREX,
HUBSPOT,
MANUAL,
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
​
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