Top

Contacts

List contacts
GET /contacts
List all contacts with pagination.
Get contact
GET /contacts/:contact_id
Get details of a contact.
Create a contact
POST /contacts
Create a contact with given information.
Update a contact
PUT /contacts/:contact_id
Update an existing contact. To delete a contact person remove it from the contact_persons list.
Delete a contact
DELETE /contacts/:contact_id
Delete an existing contact.
Mark as active
POST /contacts/:contact_id/active
Mark a contact as active.
Mark as inactive
POST /contacts/:contact_id/inactive
Mark a contact as inactive.
Enable payment reminders
POST /contacts/:contact_id/paymentreminder/enable
Enable automated payment reminders for a contact.
Disable payment reminders
POST /contacts/:contact_id/paymentreminder/disable
Disable automated payment reminders for a contact.
Email statement
POST /contacts/:contact_id/statements/email
Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content.
Get statement mail content
GET /contacts/:contact_id/statements/email
Get the statement mail content.
Email contact
POST /contacts/:contact_id/email
Send email to contact.
List comments
GET /contacts/:contact_id/comments
List recent activities of a contact.
List refunds
GET /contacts/:contact_id/refunds
List the refund history of a contact.
Track 1099
POST /contacts/:contact_id/track1099
Track a contact for 1099 reporting. (Note: This API is only available when the organization's country is U.S.A)
Untrack 1099
POST /contacts/:contact_id/untrack1099
Use this API to stop tracking payments to a vendor for 1099 reporting. (Note: This API is only available when the organization's country is U.S.A)

List contacts

GET  /contacts

List all contacts with pagination.

Parameters

contact_name string
[100]
Search contacts by contact name.
Variants: contact_name_startswith and contact_name_contains
company_name string
[100]
Search contacts by company name.
Variants: company_name_startswith and company_name_contains
first_name string
[100]
Search contacts by first name of the contact person.
Variants: first_name_startswith and first_name_contains
last_name string
[100]
Search contacts by last name of the contact person.
Variants: last_name_startswith and last_name_contains
address string
[100]
Search contacts by any of the address fields.
Variants: address_startswith and address_contains
email string
[100]
Search contacts by email of the contact person.
Variants: email_startswith and email_contains
phone string
[100]
Search contacts by phone number of the contact person.
Variants: phone_startswith and phone_contains
filter_by string Filter contacts by status.
Allowed Values: Status.All, Status.Active, Status.Inactive, Status.Duplicate, Status.Customers, Status.Vendors and Status.Crm
search_text string
[100]
Search contacts by contact name or notes.
sort_column string Sort contacts.
Allowed Values: contact_name, first_name, last_name, email, outstanding_receivable_amount, outstanding_payable_amount, created_time and last_modified_time

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "contacts": [
    {
      "contact_id": "460000000026049",
      "contact_name": "Bowman and Co",
      "company_name": "Bowman and Co",
      "contact_type": "both",
      "status": "active",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "outstanding_receivable_amount": 250.00,
      "outstanding_payable_amount": 300.00,
      "unused_credits_receivable_amount": 1369.66,
      "unused_credits_payable_amount": 350.00,
      "first_name": "Will",
      "last_name": "Smith",
      "email": "willsmith@bowmanfurniture.com",
      "phone": "+1-925-921-9201",
      "mobile": "+1-4054439562",
      "created_time": "2013-08-05T12:06:10+0530",
      "last_modified_time": "2013-10-07T18:24:51+0530"
    },
    {
      "contact_id": "460000000044001",
      "contact_name": "Tom Cooper",
      "company_name": "Richards Electric Company",
      "contact_type": "customer",
      "status": "active",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "outstanding_receivable_amount": 48.75,
      "outstanding_payable_amount": 0.00,
      "unused_credits_receivable_amount": 123.00,
      "unused_credits_payable_amount": 0.00,
      "first_name": "Richards",
      "last_name": "John",
      "email": "john@exampletest.com",
      "phone": "+1-925-930-5640",
      "mobile": "+1-4835438543",
      "created_time": "2013-09-18T17:39:36+0530",
      "last_modified_time": "2013-10-08T10:11:28+0530"
    },
    {
      "contact_id": "460000000044011",
      "contact_name": "SAF Instruments Inc",
      "company_name": "SAF Instruments Inc",
      "contact_type": "both",
      "status": "active",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "outstanding_receivable_amount": 0.00,
      "outstanding_payable_amount": 0.00,
      "unused_credits_receivable_amount": 0.00,
      "unused_credits_payable_amount": 0.00,
      "first_name": "John",
      "last_name": "Peter",
      "email": "johnpeter@safinstruments.com",
      "phone": "+1-925-318-0937",
      "mobile": "+1-4387499182",
      "created_time": "2013-09-18T18:01:43+0530",
      "last_modified_time": "2013-10-08T10:06:43+0530"
    },
    {
      "contact_id": "460000000038029",
      "contact_name": "Will Cooper",
      "company_name": "SAF Instruments Inc",
      "contact_type": "vendor",
      "status": "active",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_id": "460000000000109",
      "currency_code": "EUR",
      "outstanding_receivable_amount": 0.00,
      "outstanding_payable_amount": 0.00,
      "unused_credits_receivable_amount": 0.00,
      "unused_credits_payable_amount": 0.00,
      "first_name": "Will",
      "last_name": "Cooper",
      "email": "willcooper@exampletest.com",
      "phone": "+1-925-129-9908",
      "mobile": "+1-4052339987",
      "created_time": "2013-09-04T12:02:16+0530",
      "last_modified_time": "2013-10-12T13:55:26+0530"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "applied_filter": "Status.All",
    "sort_column": "contact_name",
    "sort_order": "A"
  }
}

Get contact

GET  /contacts/:contact_id

Get details of a contact.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "contact": {
    "contact_id": "460000000026049",
    "contact_name": "Bowman and Co",
    "company_name": "Bowman and Co",
    "has_transaction": true,
    "contact_type": "both",
    "is_linked_with_zohocrm": false,
    "primary_contact_id": "460000000026051",
    "payment_terms": 15,
    "payment_terms_label": "Net 15",
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "outstanding_receivable_amount": 250.00,
    "outstanding_receivable_amount_bcy": 250.00,
    "outstanding_payable_amount": 300.00,
    "outstanding_payable_amount_bcy": 300.00,
    "unused_credits_receivable_amount": 1369.66,
    "unused_credits_receivable_amount_bcy": 1369.66,
    "unused_credits_payable_amount": 350.00,
    "unused_credits_payable_amount_bcy": 350.00,
    "status": "active",
    "payment_reminder_enabled": true,
    "website": "www.bowmanfurniture.com",
    "custom_fields": [
      {
        "index": 1,
        "value": "GBGD078",
        "label": "VAT ID"
      },
      {
        "index": 2,
        "value": "F6JSD86KH7G",
        "label": "Company ID"
      },
      {
        "index": 3,
        "value": "www.bowman.in",
        "label": "Website"
      }
    ],
    "billing_address": {
      "address": "4900 Hopyard Rd, Suite 310",
      "city": "Pleasanton",
      "state": "CA",
      "zip": "94588",
      "country": "USA",
      "fax": "+1-925-924-9600"
    },
    "shipping_address": {
      "address": "Suite 125, McMillan Avenue",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94134",
      "country": "USA",
      "fax": "+1-925-924-9600"
    },
    "contact_persons": [
      {
        "contact_person_id": "460000000026051",
        "salutation": "Mr.",
        "first_name": "Will",
        "last_name": "Smith",
        "email": "willsmith@bowmanfurniture.com",
        "phone": "+1-925-921-9201",
        "mobile": "+1-4054439562",
        "is_primary_contact": true
      },
      {
        "contact_person_id": "460000000031001",
        "salutation": "Mr.",
        "first_name": "Peter",
        "last_name": "Parker",
        "email": "peterparker@bowmanfurniture.com",
        "phone": "+1-925-929-7211",
        "mobile": "+1-4054439760",
        "is_primary_contact": false
      }
    ],
    "default_templates": {
      "invoice_template_id": "460000000052069",
      "invoice_template_name": "Custom Classic",
      "estimate_template_id": "460000000000179",
      "estimate_template_name": "Service - Professional",
      "creditnote_template_id": "460000000000211",
      "creditnote_template_name": "Fixed Cost - Professional",
      "invoice_email_template_id": "460000000052071",
      "invoice_email_template_name": "Custom Invoice Notification",
      "estimate_email_template_id": "460000000052073",
      "estimate_email_template_name": "Custom Estimate Notification",
      "creditnote_email_template_id": "460000000052075",
      "creditnote_email_template_name": "Custom Credit Note Notification"
    },
    "notes": "Payment option : Through check",
    "created_time": "2013-08-05T12:06:10+0530",
    "last_modified_time": "2013-10-07T18:24:51+0530"
  }
}

Create a contact

POST  /contacts

Create a contact with given information.

Request attributes

contact_name* string
[200]
Display Name of the contact.
company_name string
[200]
Company Name of the contact.
website string
[100]
Website of the contact.
custom_fields array Custom fields of the contact.
billing_address hash Billing address of the contact.
shipping_address hash Shipping address of the contact.
contact_persons array Contact persons of a contact.
email string
[100]
Email address of the contact person.
is_primary_contact boolean To mark contact person as primary for contact. Allowed value is true only.
track_1099 boolean Boolean to track a contact for 1099 reporting. (This node is only available when the organization's country is U.S.A)
tax_id_type string Tax ID type of the contact, it can be SSN, ATIN, ITIN or EIN. (This node is only available when the organization's country is U.S.A)
tax_id_value string Tax ID of the contact. (This node is only available when the organization's country is U.S.A)
is_taxable
(US Edition only)
boolean Boolean to track the taxability of the customer.
tax_id
(US Edition only)
string ID of the tax or tax group that can be collected from the contact. Tax can be given only if is_taxable is true.
tax_authority_id
(US Edition only)
string (Optional) ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
(US Edition only)
string (Optional) ID of the tax exemption.
invoice_template_id string Default invoice template id used for this contact while creating invoice.
estimate_template_id string Default estimate template id used for this contact while creating estimate.
creditnote_template_id string Default credit note template id used for this contact while creating credit note.
invoice_email_template_id string Default invoice email template id used for this contact while sending invoices.
estimate_email_template_id string Default estimate email template id used for this contact while sending estimates.
creditnote_email_template_id string Default credit note email template id used for this contact while sending credit notes.

Sample Request

{
      "contact_name": "Bowman and Co",
      "company_name": "Bowman and Co",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_id": "460000000000097",
      "website": "www.bowmanfurniture.com",
      "track_1099" : true,
      "tax_id_type" : "SSN",
      "tax_id_value" : "000-11-1111",
      "is_taxable" : false,
      "tax_authority_id" : "460000000000094",
      "tax_exemption_id" : "460000000000083",
      "custom_fields": [
        {
          "index": 1,
          "value": "GBGD078"
        },
        {
          "index": 2,
          "value": "F6JSD86KH7G"
        },
        {
          "index": 3,
          "value": "www.bowman.in"
        }
      ],
      "billing_address": {
        "address": "4900 Hopyard Rd, Suite 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": "94588",
        "country": "USA",
        "fax": "+1-925-924-9600"
      },
      "shipping_address": {
        "address": "Suite 125, McMillan Avenue",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94134",
        "country": "USA",
        "fax": "+1-925-924-9600"
      },
      "contact_persons": [
        {
          "salutation": "Mr.",
          "first_name": "Will",
          "last_name": "Smith",
          "email": "willsmith@bowmanfurniture.com",
          "phone": "+1-925-921-9201",
          "mobile": "+1-4054439562",
          "is_primary_contact": true
        },
        {
          "salutation": "Mr.",
          "first_name": "Peter",
          "last_name": "Parker",
          "email": "peterparker@bowmanfurniture.com",
          "phone": "+1-925-929-7211",
          "mobile": "+1-4054439760"
        }
      ],
      "default_templates": {
        "invoice_template_id": "460000000052069",
        "estimate_template_id": "460000000000179",
        "creditnote_template_id": "460000000000211",
        "invoice_email_template_id": "460000000052071",
        "estimate_email_template_id": "460000000052073",
        "creditnote_email_template_id": "460000000052075"
      },
      "notes": "Payment option : Through check"
    }

Sample Response


Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The contact has been added.",
      "contact": {
        "contact_id": "460000000026049",
        "contact_name": "Bowman and Co",
        "company_name": "Bowman and Co",
        "has_transaction": true,
        "contact_type": "none",
        "is_linked_with_zohocrm": false,
        "website": "www.bowmanfurniture.com",
        "primary_contact_id": "460000000026051",
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "currency_symbol": "$",
        "track_1099": true,
        "tax_id_type": "SSN",
        "tax_id_value": "000-11-1111",
        "is_taxable" : false,
        "tax_authority_id" : "460000000000094",
        "tax_authority_name" : "CA tax authority",
        "tax_exemption_id" : "460000000000083",
        "tax_exemption_code" : "RESELLER",
        "outstanding_receivable_amount": 0.00,
        "outstanding_receivable_amount_bcy": 0.00,
        "outstanding_payable_amount": 0.00,
        "outstanding_payable_amount_bcy": 0.00,
        "unused_credits_receivable_amount": 0.00,
        "unused_credits_receivable_amount_bcy": 0.00,
        "unused_credits_payable_amount": 0.00,
        "unused_credits_payable_amount_bcy": 0.00,
        "status": "active",
        "payment_reminder_enabled": true,
        "custom_fields": [
          {
            "index": 1,
            "value": "GBGD078",
            "label": "VAT ID"
          },
          {
            "index": 2,
            "value": "F6JSD86KH7G",
            "label": "Company ID"
          },
          {
            "index": 3,
            "value": "www.bowman.in",
            "label": "Website"
          }
        ],
        "billing_address": {
          "address": "4900 Hopyard Rd, Suite 310",
          "city": "Pleasanton",
          "state": "CA",
          "zip": "94588",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "shipping_address": {
          "address": "Suite 125, McMillan Avenue",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94134",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "contact_persons": [
          {
            "contact_person_id": "460000000026051",
            "salutation": "Mr.",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true
          },
          {
            "contact_person_id": "460000000031001",
            "salutation": "Mr.",
            "first_name": "Peter",
            "last_name": "Parker",
            "email": "peterparker@bowmanfurniture.com",
            "phone": "+1-925-929-7211",
            "mobile": "+1-4054439760",
            "is_primary_contact": false
          }
        ],
        "default_templates": {
          "invoice_template_id": "460000000052069",
          "invoice_template_name": "Custom Classic",
          "estimate_template_id": "460000000000179",
          "estimate_template_name": "Service - Professional",
          "creditnote_template_id": "460000000000211",
          "creditnote_template_name": "Fixed Cost - Professional",
          "invoice_email_template_id": "460000000052071",
          "invoice_email_template_name": "Custom Invoice Notification",
          "estimate_email_template_id": "460000000052073",
          "estimate_email_template_name": "Custom Estimate Notification",
          "creditnote_email_template_id": "460000000052075",
          "creditnote_email_template_name": "Custom Credit Note Notification"
        },
        "notes": "Payment option : Through check",
        "created_time": "2013-08-05T12:06:10+0530",
        "last_modified_time": "2013-10-07T18:24:51+0530"
      }
    }

Update a contact

PUT  /contacts/:contact_id

Update an existing contact. To delete a contact person remove it from the contact_persons list.

Request attributes

contact_name* string
[200]
Display Name of the contact
company_name string
[200]
Company Name of the contact.
website string
[100]
Website of the contact.
custom_fields array Custom fields of the contact.
billing_address hash Billing address of the contact.
shipping_address hash Shipping address of the contact.
contact_persons array Contact persons of a contact.
contact_person_id string ID of the contact person. Mandatory if the existing contact person has to be updated. If empty, a new contact person will be created.
email string
[100]
Email address of the contact person.
is_primary_contact boolean To mark contact person as primary for contact. Allowed value is true only.
track_1099 boolean Boolean to track a contact for 1099 reporting. (This node is only available when the organization's country is U.S.A)
tax_id_type string Tax ID type of the contact, it can be SSN, ATIN, ITIN or EIN.(This node is only available when the organization's country is U.S.A)
tax_id_value string Tax ID of the contact. (This node is only available when the organization's country is U.S.A)
is_taxable
(US Edition only)
boolean Boolean to track the taxability of the customer.
tax_id
(US Edition only)
string ID of the tax or tax group that can be collected from the contact.
tax_authority_id
(US Edition only)
string ID of the tax authority. Tax authority depends on the location of the contact. For example, if the contact is located in NY, then the tax authority is NY tax authority. tax_authority_id is mandatory if is_taxable is false.
tax_exemption_id
(US Edition only)
string ID of the tax exemption.
invoice_template_id string Default invoice template id used for this contact while creating invoice.
estimate_template_id string Default estimate template id used for this contact while creating estimate.
creditnote_template_id string Default credit note template id used for this contact while creating credit note.
invoice_email_template_id string Default invoice email template id used for this contact while sending invoices.
estimate_email_template_id string Default estimate email template id used for this contact while sending estimates.
creditnote_email_template_id string Default credit note email template id used for this contact while sending credit notes.

Sample Request

{
      "contact_name": "Bowman and Co",
      "company_name": "Bowman and Co",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_id": "460000000000097",
      "website": "www.bowmanfurniture.com",
      "track_1099": true,
      "tax_id_type": "SSN",
      "tax_id_value": "000-11-1111",
      "is_taxable" : true,
      "tax_id" : "460000000000085",
      "billing_address": {
        "address": "4900 Hopyard Rd, Suite 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": "94588",
        "country": "USA",
        "fax": "+1-925-924-9600"
      },
      "shipping_address": {
        "address": "Suite 125, McMillan Avenue",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94134",
        "country": "USA",
        "fax": "+1-925-924-9600"
      },
      "contact_persons": [
        {
          "contact_person_id": "460000000026051",
          "salutation": "Mr.",
          "first_name": "Will",
          "last_name": "Smith",
          "email": "willsmith@bowmanfurniture.com",
          "phone": "+1-925-921-9201",
          "mobile": "+1-4054439562"
        },
        {
          "contact_person_id": "460000000031001",
          "salutation": "Mr.",
          "first_name": "Peter",
          "last_name": "Parker",
          "email": "peterparker@bowmanfurniture.com",
          "phone": "+1-925-929-7211",
          "mobile": "+1-4054439760",
          "is_primary_contact": true
        }
      ],
      "default_templates": {
        "invoice_template_id": "460000000052069",
        "estimate_template_id": "460000000000179",
        "creditnote_template_id": "460000000000211",
        "invoice_email_template_id": "460000000052071",
        "estimate_email_template_id": "460000000052073",
        "creditnote_email_template_id": "460000000052075"
      },
      "notes": "Payment option : Through check"
    }

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Contact information has been saved.",
      "contact": {
        "contact_id": "460000000026049",
        "contact_name": "Bowman and Co",
        "company_name": "Bowman and Co",
        "has_transaction": true,
        "contact_type": "both",
        "is_linked_with_zohocrm": false,
        "website": "www.bowmanfurniture.com",
        "primary_contact_id": "460000000026051",
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "currency_symbol": "$",
        "track_1099": true,
        "tax_id_type": "SSN",
        "tax_id_value": "000-11-1111",
        "is_taxable" : true,
        "tax_id" : "460000000000085",
        "tax_name" : "California Sales Tax"
        "tax_percentage" : "8.25"
        "outstanding_receivable_amount": 250.00,
        "outstanding_receivable_amount_bcy": 250.00,
        "outstanding_payable_amount": 300.00,
        "outstanding_payable_amount_bcy": 300.00,
        "unused_credits_receivable_amount": 1369.66,
        "unused_credits_receivable_amount_bcy": 1369.66,
        "unused_credits_payable_amount": 350.00,
        "unused_credits_payable_amount_bcy": 350.00,
        "status": "active",
        "payment_reminder_enabled": true,
        "billing_address": {
          "address": "4900 Hopyard Rd, Suite 310",
          "city": "Pleasanton",
          "state": "CA",
          "zip": "94588",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "shipping_address": {
          "address": "Suite 125, McMillan Avenue",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94134",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "contact_persons": [
          {
            "contact_person_id": "460000000026051",
            "salutation": "Mr.",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": false
          },
          {
            "contact_person_id": "460000000031001",
            "salutation": "Mr.",
            "first_name": "Peter",
            "last_name": "Parker",
            "email": "peterparker@bowmanfurniture.com",
            "phone": "+1-925-929-7211",
            "mobile": "+1-4054439760",
            "is_primary_contact": true
          }
        ],
        "default_templates": {
          "invoice_template_id": "460000000052069",
          "invoice_template_name": "Custom Classic",
          "estimate_template_id": "460000000000179",
          "estimate_template_name": "Service - Professional",
          "creditnote_template_id": "460000000000211",
          "creditnote_template_name": "Fixed Cost - Professional",
          "invoice_email_template_id": "460000000052071",
          "invoice_email_template_name": "Custom Invoice Notification",
          "estimate_email_template_id": "460000000052073",
          "estimate_email_template_name": "Custom Estimate Notification",
          "creditnote_email_template_id": "460000000052075",
          "creditnote_email_template_name": "Custom Credit Note Notification"
        },
        "notes": "Payment option : Through check",
        "created_time": "2013-08-05T12:06:10+0530",
        "last_modified_time": "2013-10-07T18:24:51+0530"
      }
    }

Delete a contact

DELETE  /contacts/:contact_id

Delete an existing contact.

Sample Response


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

Mark as active

POST  /contacts/:contact_id/active

Mark a contact as active.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The contact has been marked as active."
}

Mark as inactive

POST  /contacts/:contact_id/inactive

Mark a contact as inactive.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The contact has been marked as inactive."
}

Enable payment reminders

POST  /contacts/:contact_id/paymentreminder/enable

Enable automated payment reminders for a contact.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "All reminders associated with this contact have been enabled."
}

Disable payment reminders

POST  /contacts/:contact_id/paymentreminder/disable

Disable automated payment reminders for a contact.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "All reminders associated with this contact have been stopped."
}

Email statement

POST  /contacts/:contact_id/statements/email

Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content.

Parameters

start_date string
[yyyy-MM-dd]
If start_date and end_date are not given, current month's statement will be sent to contact.
end_date string
[yyyy-MM-dd]
End date for the statement.

multipart/form-data

attachments file Files to be attached along with the statement.

Request attributes

send_from_org_email_id boolean Boolean to trigger the email from the organization's email address.
to_mail_ids* array Array of email address of the recipients.
cc_mail_ids array Array of email address of the recipients to be cced.
subject* string
[2000]
Subject of an email has to be sent.
body* string
[5000]
Body of an email has to be sent.

Sample Request

{
      "send_from_org_email_id": true,
      "to_mail_ids": [
        "willsmith@bowmanfurniture.com"
      ],
      "cc_mail_ids": [
        "peterparker@bowmanfurniture.com"
      ],
      "subject": "Statement of transactions with Zillium Inc",
      "body": "
        "body": "Dear Customer,     \r\n\r\nWe have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications.     \r\n\r\nThanks for your business.<br><br><br>\nRegards<br>\nZillium Inc<br>\n"
    }

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Statement has been sent to the customer."
}

Get statement mail content

GET  /contacts/:contact_id/statements/email

Get the statement mail content.

Parameters

start_date* string
[yyyy-MM-dd]
Start date for statement.
end_date* string
[yyyy-MM-dd]
End date for statement.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "body": "Dear Customer,     \r\n\r\nWe have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications.     \r\n\r\nThanks for your business.<br><br><br>\nRegards<br>\nZillium Inc<br>\n",
    "error_list": [],
    "subject": "Statement of transactions with Zillium Inc",
    "to_contacts": [
      {
        "first_name": "Will",
        "selected": true,
        "phone": "+1-925-921-9201",
        "email": "willsmith@bowmanfurniture.com",
        "contact_person_id": "460000000026051",
        "last_name": "Smith",
        "salutation": "Mr.",
        "mobile": "+1-4054439562"
      },
      {
        "first_name": "Peter",
        "selected": false,
        "phone": "+1-925-929-7211",
        "email": "peterparker@bowmanfurniture.com",
        "contact_person_id": "460000000031001",
        "last_name": "Parker",
        "salutation": "Mr.",
        "mobile": "+1-4054439760"
      }
    ],
    "file_name": "statement_BowmanandCo.pdf",
    "from_emails": [
      {
        "user_name": "John Smith",
        "selected": true,
        "email": "johnsmith@zilliuminc.com"
      },
      {
        "user_name": "John David",
        "selected": false,
        "email": "johndavid@zilliuminc.com"
      }
    ],
    "contact_id": "460000000026049"
  }
}

Email contact

POST  /contacts/:contact_id/email

Send email to contact.

Parameters

send_customer_statement boolean Send customer statement pdf with email.

multipart/form-data

attachments file Files to be attached with the email.

Request attributes

to_mail_ids* array Array of email address of the recipients.
subject* string
[2000]
Subject of an email has to be sent.
body* string
[5000]
Body of an email has to be sent.

Sample Request

{
      "to_mail_ids": [
        "willsmith@bowmanfurniture.com"
      ],
      "subject": "Welcome to Zillium Inc",
      "body": "Thank you for your business with us. We value your relationship and wish you good luck.  We'd like to inform you that the "Payment Terms" for all your invoice would be 15 days.

    For any assistance, please contact us."
    }

Sample Response


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

List comments

GET  /contacts/:contact_id/comments

List recent activities of a contact.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "contact_comments": [
    {
      "comment_id": "460000000053225",
      "contact_id": "460000000026049",
      "contact_name": "Bowman and Co",
      "description": "Bill payment of amount $500.00 recorded",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-10-07",
      "date_description": "4 days ago",
      "time": "6:04 PM",
      "transaction_id": "460000000053219",
      "transaction_type": "vendor_payment",
      "is_entity_deleted": false,
      "operation_type": "added"
    },
    {
      "comment_id": "460000000053205",
      "contact_id": "460000000026049",
      "contact_name": "Bowman and Co",
      "description": "Bill 1000 created",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-10-07",
      "date_description": "4 days ago",
      "time": "6:03 PM",
      "transaction_id": "460000000053199",
      "transaction_type": "bill",
      "is_entity_deleted": false,
      "operation_type": "added"
    },
    {
      "comment_id": "460000000053131",
      "contact_id": "460000000026049",
      "contact_name": "Bowman and Co",
      "description": "Invoice payment of amount $800.00 recorded",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-10-07",
      "date_description": "4 days ago",
      "time": "6:03 PM",
      "transaction_id": "460000000053123",
      "transaction_type": "customer_payment",
      "is_entity_deleted": false,
      "operation_type": "added"
    },
    {
      "comment_id": "460000000053045",
      "contact_id": "460000000026049",
      "contact_name": "Bowman and Co",
      "description": "Credit note CN-00004 of amount $270.00 created",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-10-07",
      "date_description": "5 days ago",
      "time": "1:59 PM",
      "transaction_id": "460000000053039",
      "transaction_type": "credit_notes",
      "is_entity_deleted": false,
      "operation_type": "added"
    },
    {
      "comment_id": "460000000052121",
      "contact_id": "460000000026049",
      "contact_name": "Bowman and Co",
      "description": "Recurring invoice profile Premium Plan created",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-10-03",
      "date_description": "8 days ago",
      "time": "7:11 PM",
      "transaction_id": "460000000052117",
      "transaction_type": "recurring_invoice",
      "is_entity_deleted": false,
      "operation_type": "added"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "applied_filter": "RecentActivity.All",
    "sort_column": "date",
    "sort_order": "D"
  }
}

List refunds

GET  /contacts/:contact_id/refunds

List the refund history of a contact.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "creditnote_refunds": [
    {
      "creditnote_refund_id": "460000000053057",
      "creditnote_id": "460000000053039",
      "date": "2013-10-07",
      "refund_mode": "check",
      "reference_number": "RE#00124",
      "creditnote_number": "CN-00004",
      "customer_name": "Bowman and Co",
      "description": "",
      "amount_bcy": 120.00,
      "amount_fcy": 120.00
    },
    {
      "creditnote_refund_id": "460000000032001",
      "creditnote_id": "460000000029003",
      "date": "2013-08-22",
      "refund_mode": "cash",
      "reference_number": "RE#00123",
      "creditnote_number": "CN-00001",
      "customer_name": "Bowman and Co",
      "description": "",
      "amount_bcy": 57.15,
      "amount_fcy": 57.15
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "report_name": "Credit Notes Refund",
    "sort_column": "date",
    "sort_order": "D"
  }
}

Track 1099

POST /contacts/:contact_id/track1099

Track a contact for 1099 reporting. (Note: This API is only available when the organization's country is U.S.A)

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "1099 tracking is enabled."
}

Untrack 1099

POST /contacts/:contact_id/untrack1099

Use this API to stop tracking payments to a vendor for 1099 reporting. (Note: This API is only available when the organization's country is U.S.A)

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "1099 tracking is disabled."
}