Top

Invoices

Get invoice settings
GET /settings/invoices
Get the details of invoice settings.
Update invoice settings
PUT /settings/invoices
Update the settings information for invoices.
Get invoice notes and terms
GET /settings/invoices/notesandterms
Get the details of invoice notes and terms.
Update invoice notes and terms
PUT /settings/invoices/notesandterms
Update the notes and terms for invoices.

Get invoice settings

GET  /settings/invoices

Get the details of invoice settings.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "invoice_settings": {
    "auto_generate": true,
    "prefix_string": "INV-",
    "start_at": 1,
    "next_number": "00004",
    "quantity_precision": 2,
    "discount_type": "item_level",
    "is_discount_before_tax": true,
    "reference_text": "",
    "notes": "Thanks for your business.",
    "terms": "Terms and conditions apply",
    "is_shipping_charge_required": true,
    "is_adjustment_required": true,
    "is_open_invoice_editable": true,
    "warn_convert_to_open": true,
    "warn_create_creditnotes": true,
    "attach_expense_receipt_to_invoice": "",
    "invoice_item_type": "product_and_project",
    "is_show_invoice_setup": false,
    "is_sales_person_required": true
  }
}

Update invoice settings

PUT  /settings/invoices

Update the settings information for invoices.

Request attributes

auto_generate boolean Boolean to enable or disable auto number generation.
prefix_string string
[50]
Prefix string for entity auto number generation.
start_at long Number at which the auto number generation should begin with.
next_number string
[100]
Number that will be next updated while creating an entity.
quantity_precision int
[1]
Number of decimal places to be configured for quantity.
discount_enabled boolean Boolean to enable or disable discounts.
reference_text string
[100]
Label for the reference number.
default_template_id string ID of the template that has been used as default template for an entity.
notes string
[5000]
Notes to the customer.
terms string
[10000]
Terms and conditions.
is_shipping_charge_required boolean Boolean to determine whether shipping charges to be included in invoice.
is_adjustment_required boolean Boolean to determine whether adjustments are required for invoices.
invoice_item_type string Select between the type of line item for invoice with either product or project or both.
Allowed Values: product, project and product_and_project
is_show_invoice_setup boolean Boolean to enable invoice setup.
discount_type string Select between the type of discounts applicable for invoice with either entity level or item level or no discount.
Allowed Values: entity_level, item_level and no_discount
warn_convert_to_open boolean Boolean to enable warning while converting a draft invoice to sent status.
warn_create_creditnotes boolean Boolean to warn while creating a creditnote.
is_open_invoice_editable boolean Boolean to determine whether sent invoices can be edited.
is_sales_person_required boolean Boolean to determine whether a field for sales person is required.

Sample Request

{
  "auto_generate": true,
  "prefix_string": "INV-",
  "start_at": 1,
  "next_number": "00004",
  "quantity_precision": 2,
  "discount_enabled": "",
  "reference_text": "",
  "default_template_id": "",
  "notes": "Thanks for your business.",
  "terms": "Terms and conditions apply",
  "is_shipping_charge_required": true,
  "is_adjustment_required": true,
  "invoice_item_type": "product_and_project",
  "is_show_invoice_setup": false,
  "discount_type": "item_level",
  "warn_convert_to_open": true,
  "warn_create_creditnotes": true,
  "is_open_invoice_editable": true,
  "is_sales_person_required": true
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Your invoice preferences have been saved.",
  "invoice_settings": {
    "auto_generate": true,
    "prefix_string": "INV-",
    "start_at": 1,
    "next_number": "00004",
    "quantity_precision": 2,
    "discount_type": "item_level",
    "is_discount_before_tax": true,
    "reference_text": "",
    "notes": "Thanks for your business.",
    "terms": "Terms and conditions apply",
    "is_shipping_charge_required": true,
    "is_adjustment_required": true,
    "is_open_invoice_editable": true,
    "warn_convert_to_open": true,
    "warn_create_creditnotes": true,
    "attach_expense_receipt_to_invoice": "",
    "invoice_item_type": "product_and_project",
    "is_show_invoice_setup": false,
    "is_sales_person_required": true
  }
}

Get invoice notes and terms

GET  /settings/invoices/notesandterms

Get the details of invoice notes and terms.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "notes_and_terms": {
    "notes": "Thanks for your business.",
    "terms": "Terms and conditions apply"
  }
}

Update invoice notes and terms

PUT  /settings/invoices/notesandterms

Update the notes and terms for invoices.

Request attributes

notes string
[5000]
Notes to the customer.
terms string
[10000]
Terms and conditions.

Sample Request

{
  "notes": "Thanks for your business.",
  "terms": "Terms and conditions apply"
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Your invoice preferences have been saved.",
  "notes_and_terms": {
    "notes": "Thanks for your business.",
    "terms": "Terms and conditions apply"
  }
}