Top

Reminders

List auto payment reminder
GET /settings/autoreminders
List of automated payment reminders.
Get an auto payment reminder
GET /settings/autoreminders/:template_id
Get the details of an automated payment reminder.
Enable auto reminder
POST /settings/autoreminders/:reminder_id/enable
Enable an automated payment reminder.
Disable auto reminder
POST /settings/autoreminders/:reminder_id/disable
Disable an automated payment reminder.
Update an auto reminder
PUT /settings/autoreminders/:reminder_id
Update the details of an automated payment reminder.
List manual reminders
GET /settings/manualreminders
List of manual reminders.
Get a manual reminder
GET /settings/manualreminders/:reminder_id
Get the details of a manual reminder.
Update a manual reminder
PUT /settings/manualreminders/:reminder_id
Update the details of a manual reminder.

List auto payment reminder

GET  /settings/autoreminders

List of automated payment reminders.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "autoreminders": [
    {
      "autoreminder_id": "460000000002001",
      "is_enabled": false,
      "type": "days_after_due_date",
      "address_type": "remind_me",
      "number_of_days": 0,
      "subject": "Payment Reminder",
      "body": "Dear Customer,\r\n\r\nMay 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\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\n\r\nThanks in advance for the payment.",
      "order": 1
    },
    {
      "autoreminder_id": "460000000002003",
      "is_enabled": false,
      "type": "days_after_due_date",
      "address_type": "remind_me",
      "number_of_days": 0,
      "subject": "Payment Reminder",
      "body": "Dear Customer,\r\n\r\nMay 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\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\n\r\nThanks in advance for the payment.",
      "order": 2
    },
    {
      "autoreminder_id": "460000000002005",
      "is_enabled": false,
      "type": "days_after_due_date",
      "address_type": "remind_me",
      "number_of_days": 0,
      "subject": "Payment Reminder",
      "body": "Dear Customer,\r\n\r\nMay 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\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\n\r\nThanks in advance for the payment.",
      "order": 3
    }
  ]
}

Get an auto payment reminder

GET  /settings/autoreminders/:template_id

Get the details of an automated payment reminder.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "autoreminder": {
    "autoreminder_id": "460000000002001",
    "is_enabled": false,
    "type": "days_after_due_date",
    "address_type": "remind_me",
    "number_of_days": 0,
    "subject": "Payment Reminder",
    "body": "Dear Customer,\r\n\r\nMay 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\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>. Feel free to get in touch with us for any clarifications.                      \r\n\r\nThanks in advance for the payment."
  },
  "placeholders": {
    "Invoice": [
      {
        "name": "Balance",
        "value": "%Balance%"
      },
      {
        "name": "DueDate",
        "value": "%DueDate%"
      },
      {
        "name": "InvoiceDate",
        "value": "%InvoiceDate%"
      },
      {
        "name": "InvoiceNumber",
        "value": "%InvoiceNumber%"
      },
      {
        "name": "Online payment",
        "value": "%InvoiceURL%"
      },
      {
        "name": "OverdueDays",
        "value": "%OverdueDays%"
      },
      {
        "name": "P.O. Number",
        "value": "%P.O.Number%"
      },
      {
        "name": "Total",
        "value": "%Total%"
      },
      {
        "name": "Shipping charge",
        "value": "%ShippingCharge%"
      },
      {
        "name": "Adjustment",
        "value": "%Adjustment%"
      }
    ],
    "Customer": [
      {
        "name": "Customer Name",
        "value": "'%CustomerName%'"
      },
      {
        "name": "Salutation",
        "value": "%Salutation%"
      },
      {
        "name": "FirstName",
        "value": "%FirstName%"
      },
      {
        "name": "LastName",
        "value": "%LastName%"
      },
      {
        "name": "Customer Balance",
        "value": "%CustomerBalance%"
      }
    ],
    "Organization": [
      {
        "name": "Name",
        "value": "%CompanyName%"
      },
      {
        "name": "User",
        "value": "%UserName%"
      },
      {
        "name": "Email",
        "value": "%CompanyEmail%"
      },
      {
        "name": "Phone#",
        "value": "%CompanyPhone%"
      },
      {
        "name": "Fax#",
        "value": "%CompanyFax%"
      },
      {
        "name": "Website",
        "value": "%CompanyWebSite%"
      }
    ]
  }
}

Enable auto reminder

POST  /settings/autoreminders/:reminder_id/enable

Enable an automated payment reminder.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Payment reminder has been enabled."
}

Disable auto reminder

POST  /settings/autoreminders/:reminder_id/disable

Disable an automated payment reminder.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Payment reminder has been disabled."
}

Update an auto reminder

PUT  /settings/autoreminders/:reminder_id

Update the details of an automated payment reminder.

Request attributes

is_enabled boolean To determine whether the payment reminder has been enabled or not.
type string Type to determine whether the email has to be sent before or after the due date of invoice.
Allowed Values: days_after_due_date and days_before_due_date
address_type string Notification type for the payment reminder with option to reminder you, your customer or both.
Allowed Values: remind_me, remind_customer and remind_customer_and_cc_me
number_of_days int Number of days before or after, the payment reminder email has to be sent.
subject string
[1000]
Subject of the email.
body string
[5000]
Message content or body of the email to be sent.

Sample Request

{
  "is_enabled": "",
  "type": "",
  "address_type": "",
  "number_of_days": "",
  "subject": "",
  "body": ""
}

Sample Response

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

List manual reminders

GET  /settings/manualreminders

List of manual reminders.

Parameters

type string Type to select between open or overdue reminder.
Allowed Values: overdue_reminder and open_reminder

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "manualreminders": [
    {
      "manualreminder_id": "460000000000067",
      "type": "overdue_reminder",
      "subject": "Payment Due - Invoice No. %InvoiceNumber%",
      "body": "Dear Customer,\r\n\r\nMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is overdue by %OverdueDays% days. If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.         \r\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>.         \r\n\r\nFeel free to get in touch with us for any clarifications. Thanks in advance for the payment.",
      "cc_me": false
    },
    {
      "manualreminder_id": "460000000000076",
      "type": "open_reminder",
      "subject": "Payment Reminder for Invoice#: %InvoiceNumber%",
      "body": "Dear Customer,         \r\n\r\nMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is due for payment. If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.         \r\n\r\nTo pay online for this invoice <a href= %OnlinePaymentURL% >click here</a>.         \r\n\r\nFeel free to get in touch with us for any clarifications. Thanks in advance for the payment.",
      "cc_me": false
    }
  ]
}

Get a manual reminder

GET  /settings/manualreminders/:reminder_id

Get the details of a manual reminder.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "manualreminder": {
    "manualreminder_id": "460000000000067",
    "type": "overdue_reminder",
    "subject": "Payment Due - Invoice No. %InvoiceNumber%",
    "body": "Dear Customer,\r\n\r\nMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is overdue by %OverdueDays% days. If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.         \r\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>.         \r\n\r\nFeel free to get in touch with us for any clarifications. Thanks in advance for the payment.",
    "cc_me": false
  },
  "placeholders": {
    "Invoice": [
      {
        "name": "Balance",
        "value": "%Balance%"
      },
      {
        "name": "DueDate",
        "value": "%DueDate%"
      },
      {
        "name": "InvoiceDate",
        "value": "%InvoiceDate%"
      },
      {
        "name": "InvoiceNumber",
        "value": "%InvoiceNumber%"
      },
      {
        "name": "Online payment",
        "value": "%InvoiceURL%"
      },
      {
        "name": "OverdueDays",
        "value": "%OverdueDays%"
      },
      {
        "name": "P.O. Number",
        "value": "%P.O.Number%"
      },
      {
        "name": "Total",
        "value": "%Total%"
      },
      {
        "name": "Shipping charge",
        "value": "%ShippingCharge%"
      },
      {
        "name": "Adjustment",
        "value": "%Adjustment%"
      }
    ],
    "Customer": [
      {
        "name": "Customer Name",
        "value": "'%CustomerName%'"
      },
      {
        "name": "Salutation",
        "value": "%Salutation%"
      },
      {
        "name": "FirstName",
        "value": "%FirstName%"
      },
      {
        "name": "LastName",
        "value": "%LastName%"
      },
      {
        "name": "Customer Balance",
        "value": "%CustomerBalance%"
      }
    ],
    "Organization": [
      {
        "name": "Name",
        "value": "%CompanyName%"
      },
      {
        "name": "User",
        "value": "%UserName%"
      },
      {
        "name": "Email",
        "value": "%CompanyEmail%"
      },
      {
        "name": "Phone#",
        "value": "%CompanyPhone%"
      },
      {
        "name": "Fax#",
        "value": "%CompanyFax%"
      },
      {
        "name": "Website",
        "value": "%CompanyWebSite%"
      }
    ]
  }
}

Update a manual reminder

PUT  /settings/manualreminders/:reminder_id

Update the details of a manual reminder.

Request attributes

subject string
[1000]
Subject of the email.
body string
[5000]
Message content or body of the email to be sent.
cc_me boolean To send a carbon copy of the email back to you.

Sample Request

{
  "subject": "Payment Due - Invoice No. %InvoiceNumber%",
  "body": "Dear Customer,\r\n\r\nMay we remind you that the invoice %InvoiceNumber% issued on %InvoiceDate% is overdue by %OverdueDays% days. If you have already paid for this invoice, accept our apologies and ignore this reminder. We have attached the invoice for your reference.         \r\n\r\nPay online for this invoice by following this <a href= %OnlinePaymentURL% >link</a>.         \r\n\r\nFeel free to get in touch with us for any clarifications. Thanks in advance for the payment.",
  "cc_me": false
}

Sample Response

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