Reporting API

Roll your issued invoices up into tax liabilities — summarized for remittance totals, line-by-line for reconciliation, or as a CSV for your workpapers.

What these reports are

The reporting endpoints are read-only views over your issued fiscal documents — not a separate ledger. Commercial invoices (380) and self-billed invoices (389) contribute positive lines; credit notes (381) contribute negative reversals. Periods key off issued_at, so calculated-but-unissued bookings are intentionally excluded. For the dashboard view of the same data, see Tax report.

Detail

These three report endpoints are not part of the runnable docs allowlist, so there's no live "Run" button here — the static examples below show the exact request and the shape you'll get back.

Common filters

The summary and lines endpoints share most filters. All are optional; omit them for an all-time, all-jurisdiction view.

Field	Type	Description
from / to	datetime	Inclusive issued_at bounds (ISO 8601). The reporting period.
currency	string	ISO 4217 filter. A multi-currency summary returns total_tax_amount as null and breaks totals out per currency.
legal_issuer_id	integer	Filter to one org-owned legal issuer.
jurisdiction_code	string	Exact component jurisdiction (e.g. US-NY-NYC).
authority	string	Exact tax authority name.
category_code	string	Tax category code (e.g. occ_pct, vat_standard).

Liability summary

GET /v1/invoices/liability-summary aggregates tax by jurisdiction, authority, category, and currency — the numbers you carry into a remittance. Multi-currency reports expose total_tax_amount_by_currency alongside a null overall total.

curl "https://api.taxlens.getdynamiq.ai/v1/invoices/liability-summary?from=2026-06-01T00:00:00Z&to=2026-06-30T23:59:59Z" \
  -H "X-API-Key: $TAXLENS_KEY"

{
  "items": [
    {
      "jurisdiction_code": "US-NY-NYC",
      "authority": "New York City Department of Finance",
      "category_code": "occ_pct",
      "currency": "USD",
      "taxable_amount": "750.0000",
      "tax_amount": "44.0600",
      "invoice_count": 3
    }
  ],
  "total_tax_amount": "44.0600",
  "total_tax_amount_by_currency": { "USD": "44.0600" }
}

Liability lines

GET /v1/invoices/liability-lines returns invoice-level component lines for reconciliation and remittance workpapers — one row per tax component per document, with sign = +1 for 380/389 and −1 for credit-note (381) reversals. Paginate with limit/offset.

curl "https://api.taxlens.getdynamiq.ai/v1/invoices/liability-lines?category_code=occ_pct" \
  -H "X-API-Key: $TAXLENS_KEY"

{
  "items": [
    {
      "invoice_number": "2026-000001",
      "document_type": "380",
      "booking_id": 123,
      "property_id": 42,
      "jurisdiction_code": "US-NY-NYC",
      "authority": "New York City Department of Finance",
      "category_code": "occ_pct",
      "taxable_amount": "750.0000",
      "tax_amount": "44.0600",
      "sign": 1
    }
  ],
  "total": 1,
  "next_cursor": null
}

CSV export

GET /v1/invoices/liability-export.csv returns the same lines as CSV for your remittance spreadsheet. It accepts the same filters and streams a text/csv body.

curl "https://api.taxlens.getdynamiq.ai/v1/invoices/liability-export.csv?currency=USD" \
  -H "X-API-Key: $TAXLENS_KEY" \
  -o liability-2026-06.csv

invoice_number,document_type,booking_id,property_id,external_reference,issued_at,legal_issuer_id,currency,jurisdiction_code,authority,category_code,taxable_amount,tax_amount,sign
2026-000001,380,123,42,PMS-123,2026-06-04T12:00:00Z,7,USD,US-NY-NYC,New York City Department of Finance,occ_pct,750.0000,44.0600,1

Tip

For the complete, per-field schema of every reporting field (and every other endpoint), open the in-app API Reference page. The reports here are built from issued invoices — see E-invoicing API for how documents get issued in the first place.