Skip to content

Invoice history

GET/documents/invoices/{id}/history

Costs 1 rate-limit point · Rate limits

What happened to a document: every time it was emailed (to which address, whether that is the customer's, and whether it was automatic, a payment reminder, a bulk send or a BCC copy), printed, downloaded or opened, newest first, plus the emails sent for it with the recipient and the delivery, open, click and bounce timestamps the mail provider reported. The last 200 of each. Read-only.

event values: sent (Emailed to the customer), reminder_sent (Payment reminder emailed), copy_sent (Copy emailed to the shop (BCC)), printed (Printed), downloaded (Downloaded), viewed (Opened in the dashboard), rendered (Rendered on the customer account page).

Also searched asinvoice historywas this invoice sentwhen was the invoice emailedinvoice activitydid the customer open the invoicedid the invoice bouncewho received this invoice

Path parameters

  • idstringRequired

Returns

  • invoice_idinteger
    Example: 980191021
  • invoice_numberstring
    Example: INV-2
  • customer_emailstring, nullable
  • eventsarray of objects
    Show 7 child attributesHide child attributes
    • idinteger
      Example: 46
    • eventstring
      Example: sent
    • atstring
      Example: 2026-11-10T09:07:40Z
    • automaticboolean
      Example: false
    • bulkboolean
      Example: false
    • templatestring
      Example: default
    • tostring
      Example: test@example.com
  • emailsarray of objects
    Show 11 child attributesHide child attributes
    • idinteger
      Example: 5
    • tostring
      Example: test@example.com
    • kindstring
      Example: invoice
    • sent_atstring
      Example: 2026-11-10T09:07:40Z
    • delivered_atstring, nullable
    • opened_atstring, nullable
    • clicked_atstring, nullable
    • bounced_atstring, nullable
    • bounce_reasonstring, nullable
    • rejected_atstring, nullable
    • complained_atstring, nullable

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

404

The resource does not exist for this shop, or no action is registered at this path.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

GET/documents/invoices/{id}/history
curl "https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059/history" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "invoice_id": 980191021,
  "invoice_number": "INV-2",
  "customer_email": null,
  "events": [
    {
      "id": 46,
      "event": "sent",
      "at": "2026-11-10T09:07:40Z",
      "automatic": false,
      "bulk": false,
      "template": "default",
      "to": "test@example.com"
    }
  ],
  "emails": [
    {
      "id": 5,
      "to": "test@example.com",
      "kind": "invoice",
      "sent_at": "2026-11-10T09:07:40Z",
      "delivered_at": null,
      "opened_at": null,
      "clicked_at": null,
      "bounced_at": null,
      "bounce_reason": null,
      "rejected_at": null,
      "complained_at": null
    }
  ]
}