Customers API
List Customers
GET /api/v1/customersQuery Parameters:
| Parameter | Type | Description |
|---|---|---|
search | string | Search by name, email, or phone |
page | number | Page number |
limit | number | Items per page |
Create Customer
POST /api/v1/customersRequest Body:
json
{
"name": "Acme Corp",
"email": "[email protected]",
"phone": "+1-555-0123",
"address_line1": "123 Business Ave",
"address_line2": "Suite 456",
"city": "San Francisco",
"state": "CA",
"postal_code": "94102",
"country": "US",
"tax_id": "US123456789",
"notes": "Net 30 terms agreed"
}Get Customer
GET /api/v1/customers/:idReturns customer details with invoice summary (total invoiced, total paid, outstanding).
Update Customer
PUT /api/v1/customers/:idDelete Customer
DELETE /api/v1/customers/:idFails if the customer has existing invoices.
Export CSV
GET /api/v1/customers/export/csvBatch Operations
POST /api/v1/customers/batch