Skip to main content

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 Daylit AR Agent REST API gives you programmatic access to every resource in the platform — customers, invoices, payments, collection sequences, communication threads, AI insights, and more. All requests use JSON for both request bodies and responses, and all resource IDs are UUIDs. The API follows standard REST conventions: use GET to read, POST to create, PATCH or PUT to update, and DELETE to remove.

​
Base URL

The base URL depends on whether you’re using a self-hosted instance or a Daylit-managed cloud deployment. 
https://your-daylit-instance.com/api/v1/
Replace your-daylit-instance.com with your actual instance hostname. All paths below are relative to this base.

​
Resource groups

Every resource endpoint is scoped to a company using the {company_id} path parameter (a UUID). You must include a valid company ID in every request to a company-scoped endpoint. See the authentication page for how to find your company ID.
ResourceBase path
Customers/companies/{company_id}/customers
Invoices/companies/{company_id}/invoices
Payments/companies/{company_id}/payments
Actions/companies/{company_id}/actions
Sequences/companies/{company_id}/sequences
Communications/companies/{company_id}/communications/threads
Intelligence / Insights/intelligence/insights
Analytics (cash flow)/companies/{company_id}/analytics/cashflow-forecast
AR Aging/companies/{company_id}/ar-aging/summary
Integrations/companies/{company_id}/integrations
Jobs/jobs/trigger, /jobs/status

​
Standard response format

All successful responses return JSON. Resource collection endpoints return a list of objects. Single-resource endpoints return the object directly. There is no wrapper envelope. 
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Acme Corp",
    "status": "active"
  }
]

​
Pagination

Collection endpoints support offset/limit pagination using query parameters.
ParameterTypeDefaultDescription
limitinteger20Number of records to return.
offsetinteger0Number of records to skip.
GET /api/v1/companies/{company_id}/invoices?limit=50&offset=100

​
Error responses

When a request fails, the API returns a JSON object with an error key and an appropriate HTTP status code. 
{
  "error": "Invoice not found."
}
Status codeMeaning
200Request succeeded.
201Resource created successfully.
400Bad request — invalid or missing parameters.
401Unauthorized — missing or invalid auth token.
403Forbidden — you do not have access to this resource.
404Not found — the resource does not exist.
500Internal server error — something went wrong on the server.
401 responses indicate a missing or expired token. Obtain a fresh token from /api/v1/auth/login/ and retry the request.

​
Explore the API reference

Authentication

Learn how to obtain and send your auth token with every request.

Customers

List, create, and manage customer records and their contacts.

Invoices

Access invoice data, payment predictions, and bulk operations.

Payments

Retrieve payment records linked to invoices and customers.

Actions

Approve, reject, send, and cancel AI-recommended collection actions.

Sequences

Manage collection sequences and enroll customers in automated outreach.

Communications

Read and log communication threads and email history.

Insights

Retrieve AI-generated insights and provide feedback.

Analytics

Query cash flow forecasts and AR aging reports.

Integrations

Connect, disconnect, and sync third-party accounting integrations.

Webhooks

Receive real-time events from Vonage, Merge, and Nylas callbacks.