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 payments endpoints let you list, retrieve, and record payments in Daylit. You can query all payments across a company with date and method filters, look up a single payment by ID, or fetch the payment history for a specific invoice. All endpoints are scoped to a company_id.

List all payments


GET /api/companies/{company_id}/payments
Returns all payment records for the given company, ordered by transaction date descending. Use this endpoint to build reconciliation views or export payment history.

Path parameters

company_id
string
required
UUID of the company whose payments you want to list.

Query parameters

status
string
Filter by payment status (e.g., PAID, PARTIAL, PENDING). Omit to return all statuses.
payment_method
string
Filter by payment method (e.g., ACH, CHECK, CREDIT_CARD, WIRE).
date_from
string
ISO 8601 date (YYYY-MM-DD). Returns payments with a transaction_date on or after this date.
date_to
string
ISO 8601 date (YYYY-MM-DD). Returns payments with a transaction_date on or before this date.

Response fields

count
number
Total number of payment records matching the applied filters.
data
object[]
Array of payment objects.

Example

curl --request GET \
  --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/payments?payment_method=ACH&date_from=2026-01-01&date_to=2026-05-01" \
  --header "Authorization: Token YOUR_API_KEY"
{
  "count": 3,
  "data": [
    {
      "id": "pay00001-0000-0000-0000-000000000001",
      "invoice": "inv00001-0000-0000-0000-000000000001",
      "invoice_number": "INV-2026-0042",
      "company": "9e8f1234-0000-0000-0000-abcdef012345",
      "payment_type": "Payment",
      "amount": 8500.00,
      "payment_date": "2026-04-10",
      "payment_method": "ACH",
      "transaction_id": null,
      "remote_id": "QB-PAY-00123",
      "status": "PAID",
      "notes": null,
      "created_at": "2026-04-10T14:00:00Z"
    },
    {
      "id": "pay00002-0000-0000-0000-000000000002",
      "invoice": "inv00001-0000-0000-0000-000000000008",
      "invoice_number": "INV-2026-0015",
      "company": "9e8f1234-0000-0000-0000-abcdef012345",
      "payment_type": "Payment",
      "amount": 3200.00,
      "payment_date": "2026-03-22",
      "payment_method": "ACH",
      "transaction_id": null,
      "remote_id": "QB-PAY-00105",
      "status": "PAID",
      "notes": null,
      "created_at": "2026-03-22T11:45:00Z"
    }
  ]
}

Get a payment


GET /api/companies/{company_id}/payments/{payment_id}
Returns a single payment record by its UUID.

Path parameters

company_id
string
required
UUID of the company.
payment_id
string
required
UUID of the payment to retrieve.

Response fields

Returns a single payment object. All fields are identical to the items returned by List all payments.
id
string
UUID of the payment record.
invoice
string
UUID of the invoice this payment is applied to.
invoice_number
string
Human-readable invoice number for the linked invoice.
company
string
UUID of the owning company.
payment_type
string
Type of payment transaction.
amount
number
Payment amount.
payment_date
string
Date the payment was transacted, in ISO 8601 format.
payment_method
string
Method used to make the payment.
transaction_id
string
Internal transaction identifier, or null.
remote_id
string
Identifier from the upstream accounting system, or null.
status
string
Current status of the payment.
notes
string
Free-text notes, or null.
created_at
string
ISO 8601 timestamp when the payment record was created.

Example

curl --request GET \
  --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/payments/pay00001-0000-0000-0000-000000000001" \
  --header "Authorization: Token YOUR_API_KEY"
{
  "id": "pay00001-0000-0000-0000-000000000001",
  "invoice": "inv00001-0000-0000-0000-000000000001",
  "invoice_number": "INV-2026-0042",
  "company": "9e8f1234-0000-0000-0000-abcdef012345",
  "payment_type": "Payment",
  "amount": 8500.00,
  "payment_date": "2026-04-10",
  "payment_method": "ACH",
  "transaction_id": null,
  "remote_id": "QB-PAY-00123",
  "status": "PAID",
  "notes": null,
  "created_at": "2026-04-10T14:00:00Z"
}

List payments by invoice


GET /api/companies/{company_id}/invoices/{invoice_id}/payments
Returns all payment records linked to a specific invoice, ordered by transaction date descending. Use this endpoint when you need the payment history scoped to a single invoice rather than querying across the entire company.
You can also reach this data from the invoice side — see List payments on an invoice in the Invoices reference. Both paths return identical response shapes.

Path parameters

company_id
string
required
UUID of the company.
invoice_id
string
required
UUID of the invoice whose payments you want to list.

Response fields

count
number
Total number of payments recorded against this invoice.
data
object[]
Array of payment objects. All fields are identical to List all payments.

Example

curl --request GET \
  --url "https://your-instance.com/api/companies/9e8f1234-0000-0000-0000-abcdef012345/invoices/inv00001-0000-0000-0000-000000000001/payments" \
  --header "Authorization: Token YOUR_API_KEY"
{
  "count": 2,
  "data": [
    {
      "id": "pay00003-0000-0000-0000-000000000003",
      "invoice": "inv00001-0000-0000-0000-000000000001",
      "invoice_number": "INV-2026-0042",
      "company": "9e8f1234-0000-0000-0000-abcdef012345",
      "payment_type": "Payment",
      "amount": 4250.00,
      "payment_date": "2026-04-10",
      "payment_method": "CHECK",
      "transaction_id": null,
      "remote_id": null,
      "status": "PAID",
      "notes": "Partial payment — remainder promised by May 15",
      "created_at": "2026-04-10T14:00:00Z"
    },
    {
      "id": "pay00004-0000-0000-0000-000000000004",
      "invoice": "inv00001-0000-0000-0000-000000000001",
      "invoice_number": "INV-2026-0042",
      "company": "9e8f1234-0000-0000-0000-abcdef012345",
      "payment_type": "Payment",
      "amount": 4250.00,
      "payment_date": "2026-05-14",
      "payment_method": "CHECK",
      "transaction_id": null,
      "remote_id": null,
      "status": "PAID",
      "notes": "Final payment",
      "created_at": "2026-05-14T10:15:00Z"
    }
  ]
}