v1

latestOpenAPI 3.0.02026-08-068926279.2 KB

Clients

Create a new client

Creates a new client with optional contacts

post/clients

Request body

client_namestring required

sourcestring

addressstring

tax_namestring

tax_numberstring

languagestring

Example request

{
  "client_name": "Acme Corporation",
  "source": "Referral",
  "address": "123 Main St, City, ST 12345",
  "tax_name": "Tax ID",
  "tax_number": "12-3456789",
  "language": "English"
}

Response

Client created successfully

idinteger

OpenAPI Schema definitions for API responses

team_idinteger

namestring

sourcestring nullable

addressstring nullable

tax_namestring nullable

tax_numberstring nullable

credit_availablenumber

sent_totalnumber

collected_totalnumber

outstanding_totalnumber

average_days_to_payinteger nullable

projects_countinteger nullable

invoices_countinteger nullable

estimates_countinteger nullable

other_income_countinteger nullable

Example response

{
  "id": 1,
  "team_id": 1,
  "name": "Acme Corporation",
  "source": "Referral",
  "address": "123 Main St, City, ST 12345",
  "tax_name": "Tax ID",
  "tax_number": "12-3456789",
  "status": {
    "id": 1,
    "name": "Active"
  },
  "sent_total": 15000,
  "collected_total": 12500,
  "outstanding_total": 2500,
  "average_days_to_pay": 14,
  "contacts": [
    {
      "id": 1,
      "team_id": 1,
      "client_id": 1,
      "title": "Mr.",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "phone": "555-1234"
    }
  ],
  "projects_count": 5,
  "invoices_count": 12,
  "estimates_count": 3,
  "other_income_count": 2
}