Invoice history
/documents/invoices/{id}/historyCosts 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_idintegerExample:980191021invoice_numberstringExample:INV-2customer_emailstring, nullableeventsarray of objectsShow 7 child attributesHide child attributes
idintegerExample:46eventstringExample:sentatstringExample:2026-11-10T09:07:40ZautomaticbooleanExample:falsebulkbooleanExample:falsetemplatestringExample:defaulttostringExample:test@example.com
emailsarray of objectsShow 11 child attributesHide child attributes
idintegerExample:5tostringExample:test@example.comkindstringExample:invoicesent_atstringExample:2026-11-10T09:07:40Zdelivered_atstring, nullableopened_atstring, nullableclicked_atstring, nullablebounced_atstring, nullablebounce_reasonstring, nullablerejected_atstring, nullablecomplained_atstring, nullable
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request failed validation. Nothing was saved.
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.
curl "https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059/history" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059/history", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059/history",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059/history")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}
]
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}