Documentation Index Fetch the complete documentation index at: https://help.daylit.com/llms.txt
Use this file to discover all available pages before exploring further.
The customers endpoints let you read and write every aspect of a customer record in your Daylit company. You can list customers with rich filtering and cursor-based pagination, create or update records, manage nested contacts, and retrieve per-customer AR aging history — all scoped to a single company_id.
List customers GET /api/companies/{company_id}/customers
Returns a paginated list of customers for the given company. The response uses cursor-based pagination so you can efficiently load large portfolios. On the first request (no cursor), the response includes a count of total matching records and a next_cursor you pass on subsequent requests to fetch the next page.
Path parameters UUID of the company whose customers you want to list.
Query parameters Filter by customer status. Accepted values: active, inactive, suspended, prospect. Pass any or omit to return all statuses.
Filter by industry (case-insensitive exact match).
Case-insensitive partial match against customer_company_name.
Filter by AR aging risk level derived from the latest AR aging detail snapshot.
UUID of the team member assigned as AR owner. Returns only customers assigned to that owner.
UUID of the team member assigned as sales owner.
Pass true to return individual person contacts only. Pass false to return company accounts (and records where is_person is null).
Comma-separated list of label UUIDs. Returns customers matching any of the given labels (OR semantics).
Pass true to exclude customers with a zero open balance.
Pass positive to return only customers with a positive open balance when no other balance filter is active.
sort
string
default: "total_balance_desc"
Sort order. Accepted values: total_balance_desc, total_balance_asc, customer_name_asc, customer_name_desc.
Maximum number of customers to return per page. Capped at 500.
Opaque cursor returned as next_cursor from a previous response. Omit on the first request.
Pass true (or 1 / yes) to embed the customer’s contacts array in each list item.
Response fields Total number of customers matching the applied filters. Only present on the first page (when no cursor is supplied).
The page size used for this response.
true when additional pages are available.
Pass this value as cursor on your next request to fetch the following page. null when you have reached the last page.
Echo of all filters that were active for this request, useful for debugging.
Array of customer objects for the current page. UUID of the customer record.
Display name of the customer (company or individual).
true when the customer is an individual rather than a company.
Sum of all open invoice balances for this customer.
Amount currently overdue across all open invoices.
Balance amounts grouped by AR aging bucket. Keys are current, 1_30, 31_60, 61_90, and 91_over.
UUID of the assigned AR owner, or null.
Full name of the assigned AR owner, or null.
UUID of the assigned sales owner, or null.
Full name of the assigned sales owner, or null.
Total count of open AR invoices for this customer.
Configured credit limit for this customer, or null if not set.
Percentage of the credit limit consumed by the current open balance. null when no credit limit is set.
Labels assigned to this customer. Each object contains id, name, and the parent group.
Active AI signals for this customer, up to 5. Each signal includes title, severity, impact_usd, tags, and drivers.
Severity of the highest-ranked signal: high, med, info, healthy, or null.
Latest AI-generated conversation summary, or null. Includes summary, tone, commitment_date, predicted_pay_date, and action.
ISO 8601 timestamp of the last sent or synced email communication, or null.
ISO 8601 timestamp when the customer record was created.
ISO 8601 timestamp of the most recent update.
Example curl --request GET \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers?status=active&sort=total_balance_desc&limit=50" \ --header "Authorization: Token YOUR_API_KEY"
{ "count" : 142 , "limit" : 50 , "has_more" : true , "next_cursor" : "eyJtb2RlIjoidG90YWxfYmFsYW5jZSIsInRvdGFsX2JhbGFuY2UiOiIxMjM0NS4wMCIsImlkIjoiYWJjMTIzIn0=" , "applied_filters" : { "company_id" : "9e8f1234-0000-0000-0000-abcdef012345" , "status" : "active" }, "items" : [ { "id" : "c1a2b3c4-0000-0000-0000-000000000001" , "customer_company_name" : "Acme Corp" , "is_person" : false , "open_balance" : 48200.00 , "total_due" : 12500.00 , "aging_breakdown" : { "current" : 35700.00 , "1_30" : 8000.00 , "31_60" : 3500.00 , "61_90" : 1000.00 , "91_over" : 0.00 }, "ar_owner" : "u1a2b3c4-0000-0000-0000-000000000099" , "ar_owner_name" : "Jane Smith" , "invoices_count" : 7 , "credit_limit" : 60000.00 , "credit_usage_percent" : 80.3 , "labels" : [], "signals" : [], "primary_signal_severity" : null , "conversation_summary" : null , "last_contact_date" : "2026-04-30T14:22:00Z" , "created_at" : "2025-01-15T09:00:00Z" , "updated_at" : "2026-04-30T14:22:00Z" } ] }
Create a customer POST /api/companies/{company_id}/customers
Creates a new customer record under the given company. Returns the created customer with HTTP 201.
Path parameters UUID of the company to create the customer under.
Request body Display name of the customer (company or individual).
Set to true when the customer is an individual rather than a company.
Initial status of the customer. Common values: active, inactive, prospect.
Industry classification for filtering.
Free-text description of the customer.
Default net payment terms in days (e.g., 30 for Net 30).
Credit limit for this customer in your base currency.
URL to the customer’s payment portal or pay link.
preferred_communication_method
Preferred outreach channel for this customer (e.g., email, phone).
UUID of the team member to assign as AR owner.
UUID of the team member to assign as sales owner.
Internal notes visible only to your team.
Example curl --request POST \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers" \ --header "Authorization: Token YOUR_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "customer_company_name": "Globex Industries", "customer_status": "active", "default_payment_terms": 30, "credit_limit": 75000.00, "industry": "Manufacturing" }'
Get a customer GET /api/companies/{company_id}/customers/{customer_id}
Returns a single customer record with full detail, including nested locations, active contacts, open invoices (up to 20), and computed AR metrics.
Path parameters UUID of the customer to retrieve.
Response fields The detail response extends the list item fields with the following additional fields:
Free-text description of the customer.
Current status of the customer.
Default net payment terms in days.
Pay link URL for this customer.
preferred_communication_method
Preferred outreach channel.
Team-only internal notes.
All saved locations for this customer. Each object includes id, location_name, address_line1, address_city, address_state, address_zipcode, address_country, is_primary, is_billing_address, and is_active.
All active contacts (is_active=true) for this customer. See the contacts fields below. Up to 20 open AR invoices for this customer. Each entry includes id, invoice_number, due_date, balance, total_amount, status, and days_outstanding.
Total count of open AR invoices (not capped at 20).
Count of open invoices whose due_date is in the past.
Sum of all open invoice balances.
Weighted-average age of open AR in days, sourced from the latest AR aging snapshot.
Weighted-average days past the agreed payment terms, sourced from the latest AR aging snapshot.
Average days from invoice issue to payment across historical paid invoices.
Month-by-month payment history for trend analysis. Each entry has month (YYYY-MM), days (weighted-average days to pay), and optionally days_beyond (weighted-average days beyond terms).
Total open AR balance across the entire company (not just this customer).
Example curl --request GET \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/c1a2b3c4-0000-0000-0000-000000000001" \ --header "Authorization: Token YOUR_API_KEY"
Update a customer PATCH /api/companies/{company_id}/customers/{customer_id} PUT /api/companies/{company_id}/customers/{customer_id}
Updates an existing customer record. Use PATCH to update individual fields without supplying the full object. Use PUT to replace the entire record. Both methods trigger a customer metrics sync.
You can also update label assignments atomically by including label_ids in the PATCH body — this replaces the customer’s full set of labels.
Path parameters UUID of the customer to update.
Request body (PATCH) Supply any subset of the writable customer fields. All fields from the Create a customer request body are accepted, plus:
Array of label UUIDs to assign to this customer. Replaces the customer’s current label set entirely.
Example curl --request PATCH \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/c1a2b3c4-0000-0000-0000-000000000001" \ --header "Authorization: Token YOUR_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "credit_limit": 90000.00, "customer_status": "active", "label_ids": ["label-uuid-1", "label-uuid-2"] }'
Customer AR summary GET /api/companies/{company_id}/customers/summary
Returns an aggregated AR summary across all customers in the company — total open balance, aging breakdowns, counts by status, and related metrics. Use this endpoint to populate portfolio-level dashboards.
Path parameters Example curl --request GET \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/summary" \ --header "Authorization: Token YOUR_API_KEY"
GET /api/companies/{company_id}/customers/{customer_id}/contacts
Returns all contacts on file for a customer.
Path parameters Query parameters Filter to active (true) or inactive (false) contacts only. Omit to return all.
Filter by contact type (e.g., AP Manager, Controller, CFO, Primary Contact).
Response fields Total number of contacts matching the filter.
Array of contact objects. UUID of the parent customer.
Job title. May be sourced from the accounting integration and overridden by your team.
Department. May be sourced from the accounting integration and overridden by your team.
Classification of the contact’s role for AR purposes.
true when this is the primary point of contact for AR on this account.
false for deactivated contacts.
Source system that created this contact (e.g., merge, nylas). null for manually added contacts.
ISO 8601 timestamp when the contact was created.
Example curl --request GET \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/c1a2b3c4-0000-0000-0000-000000000001/contacts?is_active=true" \ --header "Authorization: Token YOUR_API_KEY"
{ "count" : 2 , "data" : [ { "id" : "ct000001-0000-0000-0000-000000000001" , "customer" : "c1a2b3c4-0000-0000-0000-000000000001" , "first_name" : "Alice" , "last_name" : "Johnson" , "email" : "alice.johnson@acmecorp.com" , "phone" : "+1-555-0100" , "title" : "AP Manager" , "department" : "Finance" , "contact_type" : "AP Manager" , "is_primary" : true , "is_active" : true , "data_source_type" : null , "created_at" : "2025-03-01T10:00:00Z" } ] }
POST /api/companies/{company_id}/customers/{customer_id}/contacts
Creates a new contact under the given customer. Returns HTTP 201 with the created contact object. Email addresses must be unique per customer.
Path parameters UUID of the customer to add the contact to.
Request body Contact’s email address. Must be unique per customer.
Role classification for AR purposes.
Set to true to mark this contact as the primary AR contact for the account.
Whether the contact is active.
Example curl --request POST \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/c1a2b3c4-0000-0000-0000-000000000001/contacts" \ --header "Authorization: Token YOUR_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "first_name": "Bob", "last_name": "Chen", "email": "bob.chen@acmecorp.com", "title": "Controller", "contact_type": "Controller", "is_primary": false }'
Customer activity log GET /api/companies/{company_id}/customers/{customer_id}/activity
Returns a chronological log of all activity events for the given customer, including communications sent, notes logged, invoice status changes, and system events.
Path parameters Example curl --request GET \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/c1a2b3c4-0000-0000-0000-000000000001/activity" \ --header "Authorization: Token YOUR_API_KEY"
Customer AR aging history GET /api/companies/{company_id}/customers/{customer_id}/ar-aging/history
Returns historical AR aging snapshots for a specific customer. Each snapshot captures the customer’s balance across aging buckets, risk metrics, and computed scores at a point in time. Use this data to build trend charts and benchmark payment behavior over time.
Path parameters Response fields Array of historical AR aging snapshots, sorted by report date descending. UUID of the aging detail record.
Balance in the current (not yet overdue) bucket.
Balance 1–30 days past due.
Balance 31–60 days past due.
Balance 61–90 days past due.
Balance more than 90 days past due.
Total AR balance at the time of the snapshot.
Total overdue balance at the time of the snapshot.
Weighted-average age of AR in days at the time of the snapshot.
Weighted-average days past agreed payment terms.
Numeric risk score at the time of the snapshot.
Risk level classification (e.g., low, medium, high).
Number of open invoices in this snapshot.
Number of overdue invoices in this snapshot.
ISO 8601 timestamp when this snapshot was created.
Example curl --request GET \ --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/customers/c1a2b3c4-0000-0000-0000-000000000001/ar-aging/history" \ --header "Authorization: Token YOUR_API_KEY"
{ "data" : [ { "id" : "ah000001-0000-0000-0000-000000000001" , "current" : 35700.00 , "days_1_30" : 8000.00 , "days_31_60" : 3500.00 , "days_61_90" : 1000.00 , "days_91_over" : 0.00 , "total_ar" : 48200.00 , "overdue" : 12500.00 , "weighted_avg_ar_age" : 22.4 , "days_beyond_terms" : 5.1 , "risk_score" : 42 , "risk_level" : "low" , "invoice_count" : 7 , "overdue_count" : 3 , "created_at" : "2026-05-01T00:00:00Z" } ] }
