Search Invoices

GET/api/invoices/search/{keyword}

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
keyword String Search keywords
curl -X GET "https://yoursite.com/api/invoices/search/acme" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

 {
  "id": "1",
  "client_id": "2",
  "project_id": "1",
  "bill_date": "2021-09-12",
  "due_date": "2021-10-01",
  "note": "",
  "labels": "",
  "last_email_sent_date": "2021-09-12",
  "status": "not_paid",
  "tax_id": "1",
  "tax_id2": "1",
  "tax_id3": "0",
  "recurring": "0",
  "recurring_invoice_id": "0",
  "repeat_every": "1",
  "repeat_type": "months",
  "no_of_cycles": "0",
  "next_recurring_date": null,
  "no_of_cycles_completed": "0",
  "due_reminder_date": null,
  "recurring_reminder_date": null,
  "discount_amount": "1",
  "discount_amount_type": "percentage",
  "discount_type": "after_tax",
  "cancelled_at": null,
  "cancelled_by": "0",
  "files": "a:0:{}",
  "deleted": "0",
  "currency": "USD",
  "currency_symbol": "INR",
  "company_name": "Company",
  "project_title": "project 1",
  "invoice_value": "1188",
  "payment_received": "0",
  "tax_percentage": "10",
  "tax_percentage2": "10",
  "tax_percentage3": null,
  "cancelled_by_user": null,
  "labels_list": null
}
MethodGET
Path/api/invoices/search/{keyword}
GroupInvoices
Sincev1.0.0
Defined inRestApi/Controllers/InvoicesController.php