Skip to content

Send invoices in bulk

POST/documents/bulk/send

Costs 2 rate-limit points · Rate limits

Emails many invoices to their customers in one job, as the Invoices page bulk send does: pick invoices by id, or by a created date range with optional status / link / document type. Returns 202 with a job id; GET /documents/bulk/:job_id reports which were sent.

Sends emails to customers as soon as the job runs; there is no confirmation step. Refused when the shop cannot send email (email_sending_disabled). Only one bulk job may run per shop at a time (429 bulk_action_in_progress). Filtering needs both from and to.

Also searched asbulk send invoicesemail all unpaid invoicessend invoices for a date rangesend many invoicesemail these invoicesmass send invoices

Request body

  • idsarray of integers

    Invoice ids to include. Without ids the list filters below select the invoices.

  • document_typestring

    Which documents when filtering: 'invoice' (default), 'quote', 'credit_note' or 'pro_forma'.

    One of invoicequotecredit_notepro_forma
  • linkstring

    'linked' (created from a Shopify order), 'not_linked' (standalone) or 'trashed'.

    One of linkednot_linkedtrashed
  • statusstring

    Shopify financial status of the order, one or many ('paid', 'pending').

  • fromstring

    Created on or after this date (ISO 8601).

  • tostring

    Created on or before this date (ISO 8601).

Returns

  • job_idinteger
    Example: 10
  • statusstring
    Example: pending
  • countinteger
    Example: 0
  • kindstring
    Example: send

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.

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.

POST/documents/bulk/send
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/send" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      48213,
      48190
    ]
  }'
Response
{
  "job_id": 10,
  "status": "pending",
  "count": 0,
  "kind": "send"
}