Overview
Vendors represent companies or individuals you pay for goods or services. Managing vendors allows you to track expenses, create bills, and maintain an organized accounts payable system.
How It Works
- Create a vendor — Add a new vendor with contact and payment details
- Create bills — Associate bills with the vendor for expenses owed
- Track payments — Monitor payments made to each vendor
- Export data — Download vendor information for your accounting system
Example: Add "Content Provider Inc." as a vendor with their payment details. When you receive their monthly invoice, create a bill linked to this vendor for easy tracking and payment.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/core/vendors | List vendors |
POST | /api/v1/core/vendors | Create vendor |
GET | /api/v1/core/vendors/{id} | Get vendor |
PUT | /api/v1/core/vendors/{id} | Update vendor |
DELETE | /api/v1/core/vendors/{id} | Delete vendor |
GET | /api/v1/core/vendors/export | Export vendors |
Vendor Object
| Attribute | Type | Description |
|---|---|---|
id | integer | The vendor's user ID |
vendor_id | integer | Internal vendor record ID |
name | string | Full name (first_name + last_name) |
first_name | string | First name |
last_name | string | Last name |
email | string | Email address |
phone | string | Phone number |
birthdate | string | Birthdate (when vendor relationship is expanded) |
job_title | string | Job title (when vendor relationship is expanded) |
delivery_service_area_prompt | string | AI delivery service area prompt (when vendor relationship is expanded) |
bills_count | integer | Number of bills associated with this vendor |
total_billed | decimal | Total amount billed (in dollars) |
payout_ready | boolean | Whether the vendor's payout details are fully configured and authorized |
metadata | object | Custom key-value metadata |
created_at | timestamp | Unix timestamp of creation |
updated_at | timestamp | Unix timestamp of last update |
Important Behaviors
- Vendor = User: A vendor is a User with
type=vendor. Theidfield is the user ID. - Delete converts, not removes: Deleting a vendor converts the user type back to customer. The user account is preserved.
- Cannot delete with bills: A vendor with existing bills cannot be deleted. Returns 400.
- Payout Details: Each vendor can have one set of payout details for ACH payments.