Top

Settings

List preferences
GET /settings/preferences
List of preferences that are configured.
Update preferences
PUT /settings/preferences
Update the preferences that has been configured.
Create a unit
POST /settings/units
Create a unit the can be associated to a line item.
Delete a unit
DELETE /settings/units/:unit_id
Delete a unit that has been associated to an item.

List preferences

GET  /settings/preferences

List of preferences that are configured.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "preferences": {
    "convert_to_invoice": false,
    "notify_me_on_online_payment": true,
    "send_payment_receipt_acknowledgement": false,
    "auto_notify_recurring_invoice": true,
    "snail_mail_include_payment_stub": true,
    "is_show_powered_by": false,
    "attach_expense_receipt_to_invoice": "",
    "is_estimate_enabled": true,
    "is_project_enabled": true,
    "auto_reminders": [
      {
        "payment_reminder_id": "982000000011001",
        "is_enabled": false,
        "notification_type": "days_after_due_date",
        "address_type": "remind_me",
        "number_of_days": 0,
        "subject": "Payment Reminder",
        "body": "Dear Customer,\r\rMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is overdue by %OverdueDays% day(s). If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.                      \r\rPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\rThanks in advance for the payment."
      },
      {
        "payment_reminder_id": "982000000011003",
        "is_enabled": false,
        "notification_type": "days_after_due_date",
        "address_type": "remind_me",
        "number_of_days": 0,
        "subject": "Payment Reminder",
        "body": "Dear Customer,\r\rMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is overdue by %OverdueDays% day(s). If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.                      \r\rPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\rThanks in advance for the payment."
      },
      {
        "payment_reminder_id": "982000000011005",
        "is_enabled": false,
        "notification_type": "days_after_due_date",
        "address_type": "remind_me",
        "number_of_days": 0,
        "subject": "Payment Reminder",
        "body": "Dear Customer,\r\rMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is overdue by %OverdueDays% day(s). If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.                      \r\rPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\rThanks in advance for the payment."
      }
    ],
    "terms": {
      "invoice_terms": "Terms and conditions apply",
      "estimate_terms": "Terms & Conditions apply",
      "creditnote_terms": ""
    },
    "address_formats": {
      "organization": {
        "value": "",
        "default_value": "%StreetAddress1%\n%StreetAddress2%\n%City% %State% %PostalCode%\n%Country%"
      },
      "customer": {
        "value": "",
        "default_value": "%StreetAddress%\n%City%\n%PostalCode% %State%\n%Country%"
      }
    }
  },
  "customfields": {
    "invoice": [
      {
        "index": 1,
        "show_in_all_pdf": false,
        "label": "Delivery Date"
      },
      {
        "index": 2,
        "show_in_all_pdf": false,
        "label": "Late Charge"
      },
      {
        "index": 3,
        "show_in_all_pdf": false,
        "label": "Reporter"
      }
    ],
    "contact": [],
    "estimate": []
  },
  "placeholders_address_format": {
    "organization": {
      "%StreetAddress1%": "Street Address1",
      "%StreetAddress2%": "Street Address2",
      "%City%": "City",
      "%State%": "State/Province",
      "%Country%": "Country",
      "%PostalCode%": "ZIP/Postal Code",
      "%FaxLabel%": "Fax Label",
      "%Fax%": "Fax",
      "%PhoneLabel%": "Phone Label",
      "%Phone%": "Fax Label",
      "%Email%": "zb.common.Email",
      "%Website%": "Website"
    },
    "customer": {
      "%StreetAddress%": "Street Address",
      "%City%": "City",
      "%State%": "State/Province",
      "%Country%": "Country",
      "%PostalCode%": "ZIP/Postal Code",
      "%FaxLabel%": "Fax Label",
      "%Fax%": "Fax",
      "%PhoneLabel%": "Phone Label",
      "%Salutation%": "Salutation",
      "%FirstName%": "First Name",
      "%LastName%": "Last Name",
      "%ContactEMailId%": "Email",
      "%ContactPhone%": "Phone",
      "%ContactMobile%": "Mobile"
    }
  }
}

Update preferences

PUT  /settings/preferences

Update the preferences that has been configured.

Request attributes

convert_to_invoice boolean Boolean to automatically convert accepted estimate to invoice.
notify_me_on_online_payment boolean Boolean to get notified when customers pay online.
send_payment_receipt_acknowledgement boolean Boolean to automate thank you note to customer on receipt of online payment.
auto_notify_recurring_invoice boolean Boolean determining whether to send recurring invoices directly to the customer.
snail_mail_include_payment_stub boolean Boolean to include payment stub and return envelope in snail mails.
is_show_powered_by boolean Boolean to keep Zoho branding on your invoices and estimates.
attach_expense_receipt_to_invoice boolean Boolean to associate and display unbilled expense receipts in Invoice PDF.
is_estimate_enabled boolean Boolean to enable estimates.
is_project_enabled boolean Boolean to enable timesheet.

Sample Request

{
  "convert_to_invoice": "",
  "notify_me_on_online_payment": "",
  "send_payment_receipt_acknowledgement": "",
  "auto_notify_recurring_invoice": "",
  "snail_mail_include_payment_stub": "",
  "is_show_powered_by": "",
  "attach_expense_receipt_to_invoice": "",
  "allow_auto_categorize": "",
  "is_estimate_enabled": "",
  "is_project_enabled": ""
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Preferences have been saved."
}

Create a unit

POST  /settings/units

Create a unit the can be associated to a line item.

Request attributes

unit* string
[100]
Representation for the unit. For instance kg.

Sample Request

{
      "unit": "ltr."
}

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Unit added."
}

Delete a unit

DELETE  /settings/units/:unit_id

Delete a unit that has been associated to an item.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "You have successfully deleted the unit."
}