INinvoiceninja
invoices

Bulk invoice actions

Changed on

POST /api/v1/invoices/bulk

There are multiple actions that are available including:

post/api/v1/invoices/bulk

Request

Query parameters

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body

email_typestring

The email type to be sent, when bulk emailing invoices options include:

  • invoice (default)
  • quote
  • credit
  • payment
  • payment_partial
  • statement
  • reminder1
  • reminder2
  • reminder3
  • reminder_endless
  • custom1
  • custom2
  • custom3
  • purchase_order
  • email_quote_template_reminder1
actionstring

The action to be performed, options include:

  • bulk_download
    Bulk download an array of invoice PDFs (These are sent to the admin via email.)
  • download
    Download a single PDF. (Returns a single PDF object)
  • bulk_print
    Merges an array of Invoice PDFs for easy one click printing.
  • auto_bill
    Attempts to automatically bill the invoices with the payment method on file.
  • clone_to_invoice
    Returns a clone of the invoice.
  • clone_to_quote
    Returns a quote cloned using the properties of the given invoice.
  • mark_paid
    Marks an array of invoices as paid.
  • mark_sent
    Marks an array of invoices as sent.
  • restore
    Restores an array of invoices
  • delete
    Deletes an array of invoices
  • archive
    Archives an array of invoices
  • cancel
    Cancels an array of invoices
  • email
    Emails an array of invoices
  • send_email
    Emails an array of invoices. Requires additional properties to be sent. email_type
idsstring[]

Example request

{
  "action": "bulk_download",
  "ids": [
    "D2J234DFA",
    "D2J234DFA",
    "D2J234DFA"
  ]
}

Response

The Bulk Action response

Changes