API Reference
Log In
API Reference

Add Customer

Body Params
string
required

Name of contact used for invoicing and accounting. In case of duplicates, API will provide an error-message "Contact Name Exists" and can be overridden by setting allow duplicates to YES.

string

Email used to send various types of communications and notifications to the contact. In case of duplicates, API will provide an error-message "Email Exists" and can be overridden by setting allow duplicates to YES.

string

Mobile number for sending various types of SMS or WhatsApp messages and notifications to the contact. Provide mobile number with country code. If no country code is passed, the number will be taken as India. In case of duplicates, API will provide an error-message "Mobile Exists" and can be overridden by setting allow duplicates to YES.

string

Phone number for the contact. Provide phone number with country code. If no country code is passed, the number will be taken as India. In case of duplicates, API will provide an error-message "Phone Number Exists" and can be overridden by setting allow duplicates to YES.

string

The name of the customer's business or entity.

string

GSTIN of the contact, if applicable. If the contact is a business and has GST registration, you can update GSTIN to ensure the contact automatically received GST Input Tax Credit on all invoices. GSTIN when passed through API is validated and stored if valid. If GSTIN passed is Invalid, API will provide an error-message "Invalid GSTIN".

string

PAN or Permanent Account Number of the contact. This can be passed optionally. If PAN is passed, the format of PAN is validated and store.

string

Entity type of the business like individual, company, LLP, partnership firm, Trust can be stored. If no entity type is passed, the system will default to Individual. If gstin is passed and no entity type is passed, system will default to GSTIN entity type.

string

Address line 1 of the billing address. A maximum of 100 characters can be stored under the billing address line 1 variable.

string

Address line 2 of the billing address. A maximum of 100 characters can be stored under the billing address line 2 variable.

string

The billing city in which the address is located.

string

The billing state in which the address is located. The state to be passed as per the State List provided in the documentation.

string

The billing country in which the address is located. The country to be passed should be as per the Country List provided in the documentation.

int32

Billing pincode

string

Address line 1 of the shipping address. A maximum of 100 characters can be stored under the shipping address line 1 variable.

string

Address line 2 of the shipping address. A maximum of 100 characters can be stored under the shipping address line 2 variable.

string

The shipping city in which the address is located.

string

The shipping state in which the address is located. The state to be passed as per the State List provided in the documentation.

string

The shipping country in which the address is located. The country to be passed should be as per the Country List provided in the documentation.

int32

Shipping_pincode

string

Name which is present in bank

int64

Account number

string

Bank name

string

IFSC code

string

The bank account type (Current or Savings) related to the account number and IFSC code passed.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json