Skip to content

Bulk generate PDFs

POST/invoices/bulk_pdf

Costs 2 rate-limit points · Rate limits

Queue a bulk PDF generation job for a set of invoice IDs. Returns a bulk action ID to track progress. Maximum 5,000 invoices per request.

Request body

  • invoice_idsarray of integersRequired

    Array of invoice IDs to generate PDFs for.

  • template_namestring

    Template name to use.

    Default "default"

Returns

  • bulk_actionobject
    Show 3 child attributesHide child attributes
    • idinteger
      Example: 2087
    • statusstring
      Example: pending
    • total_countinteger
      Example: 3

Errors

401

Missing or invalid API key.

403

The store is not on a paid plan. API access requires a paid Invoice Falcon plan.

422

Request could not be processed.

429

A bulk action is already in progress for the store, or the rate limit was exceeded.

POST/invoices/bulk_pdf
curl -X POST "https://app.invoicefalcon.com/api/v1/external/invoices/bulk_pdf" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invoice_ids": [
      48213,
      48190,
      48177
    ]
  }'
Response
{
  "bulk_action": {
    "id": 2087,
    "status": "pending",
    "total_count": 3
  }
}