Clients

The Clients API provides endpoints for managing client records within your company. A client represents a customer or business entity that you provide services or products to.

Key Features

• Create, read, update, and delete client records
• Manage client contact information and billing details
• View client-specific transaction history
• Handle multiple contacts per client
• Track client-specific settings and preferences

Client Statuses

• Active: Client is currently active and can be billed
• Archived: Client is archived and hidden from active lists
• Deleted: Client is marked for deletion but retained in the database

Best Practices

• Always validate client email addresses
• Use unique client numbers for easy reference
• Keep contact information up to date
• Set appropriate client-specific currency and tax settings

📄️ List clients

### GET /api/v1/clients

📄️ Create client

## POST /api/v1/clients

📄️ Show client

## GET /api/v1/clients/{id}

📄️ Update client

## PUT /api/v1/clients/{id}

📄️ Delete client

## DELETE /api/v1/clients/{id}

📄️ Edit Client

## GET /api/v1/clients/{id}/edit

📄️ Blank Client

## GET /api/v1/clients/create

📄️ Bulk client actions

## POST /api/v1/clients/bulk

📄️ Add client document

## POST /api/v1/clients/{id}/upload

📄️ Purge client

## POST /api/v1/clients/{id}/purge

📄️ Merge client

## POST /api/v1/clients/{id}/{mergeable_client_hashed_id}/merge

📄️ Client statement PDF

## POST /api/v1/client_statement

📄️ Removes email suppression of a user in the system

## POST /api/v1/reactivate_email/{bounce_id}

📄️ Update tax data

## POST /api/v1/clients/{client}/updateTaxData