Clients API
Manage the client accounts attached to receivables, communication history, and collection work.
The public client API is:
/v1/receivables/clientsThe product term is Clients, and that is the resource documented here.
Client Object Shape
The documented response fields include:
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Northwind Advisory",
"email": "[email protected]",
"phone": "+1-555-0100",
"address": "1 Market St",
"website": "https://northwind.example",
"taxId": "US-123456",
"notes": "Primary billing contact is Dana",
"userId": "8c8398b5-0732-4f92-b04e-0dfd4af8c7de",
"createdAt": "2026-03-01T10:00:00.000Z",
"updatedAt": "2026-03-01T10:00:00.000Z"
}Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /v1/receivables/clients | list clients |
POST | /v1/receivables/clients | create a client |
GET | /v1/receivables/clients/{id} | fetch one client |
PATCH | /v1/receivables/clients/{id} | update a client |
DELETE | /v1/receivables/clients/{id} | delete a client |
Create Example
curl -X POST https://api.conduitt.io/v1/receivables/clients \
-H "Authorization: Bearer ck_test_your_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Northwind Advisory",
"email": "[email protected]",
"phone": "+1-555-0100",
"address": "1 Market St",
"website": "https://northwind.example",
"taxId": "US-123456",
"notes": "Primary billing contact is Dana"
}'Create and Update Schemas
| Field | Type | Create | Constraints and nullability |
|---|---|---|---|
name | string | needed | 1–255 characters. |
email | email string or null | optional | Valid email when present; null removes it during update. |
phone | string or null | optional | Standard local or E.164 representation. |
address | string or null | optional | Full billing address as one string. |
website | URL string or null | optional | Must be a valid URL when present. |
taxId | string or null | optional | Organization-specific tax identifier. |
notes | string or null | optional | Internal-only notes. The client does not see them. |
UpdateClientRequest is partial. Omitted fields do not change. Send null in a nullable field to clear it. The response is always ClientResponse with the saved server state inside data.
Delete returns { "success": true, "id": "..." }. Refresh invoice creation, collection queues, tags, and client search after a client mutation.
List and Search
GET /v1/receivables/clients supports:
- offset pagination by default
- cursor pagination when
pagination=cursor - text search with
q
See Pagination for the response shapes.