v1

latestOpenAPI 3.1.02026-08-045901.5 MB

Add Contact

post/contact

Request body

contact_namestring required

The full name of the contact person or entity, such as a customer, vendor, or business associate.

salutationstring

A formal title or prefix used before the contact's name, such as Mr., Ms., Mrs., Dr., or Prof..

entitystring

Represents the type or classification of the contact within the system, such as an individual, company, partnership, or organization.

business_namestring

The registered or trading name of the business or organization associated with the contact.

display_namestring

The name shown in the user interface or on documents to represent the contact.

gstinstring

The Goods and Services Tax Identification Number assigned to a registered business under India’s GST system.

panstring

The Permanent Account Number issued by the Indian Income Tax Department.

tanstring

The Tax Deduction and Collection Account Number issued by the Indian Income Tax Department.

tds_slab_ratenumber double

The applicable Tax Deducted at Source (TDS) rate as per the relevant income tax slab.This percentage determines how much tax should be deducted from payments made to a party (like a vendor or contractor) before remitting the amount.

emailstring

The contact’s valid email address used for communication, notifications, and system correspondence.

mobilenumber float

The contact’s mobile phone number, used for communication, verification, or alerts.

phonenumber float

The contact’s landline or alternate phone number, used for communication purposes.

currency'INR' | 'CNY' | 'USD' | 'IDR' | 'PKR' | 'NGN' | 'BRL' | 'BDT' | 'RUB' | 'ETB' | 'MXN' | 'JPY' | 'PHP' | 'EGP' | 'CDF' | 'VND' | 'IRR' | 'TRY' | 'EUR' | 'THB' | 'TZS' | 'GBP' | 'ZAR' | 'KES' | 'MMK' | 'COP' | 'KRW' | 'UGX' | 'SDG' | 'IQD' | 'DZD' | 'ARS' | 'AFN' | 'PLN' | 'CAD' | 'MAD' | 'UAH' | 'AOA' | 'SAR' | 'UZS' | 'YER' | 'MZN' | 'GHS' | 'PEN' | 'MYR' | 'NPR' | 'MGA' | 'VES' | 'XAF' | 'XOF' | 'AUD' | 'KPW' | 'SYP' | 'TWD' | 'LKR' | 'MWK' | 'ZMW' | 'KZT' | 'CLP' | 'RON' | 'SOS' | 'GTQ' | 'KHR' | 'ZWB' | 'GNF' | 'RWF' | 'BIF' | 'BOB' | 'TND' | 'HTG' | 'DOP' | 'JOD' | 'SSP' | 'CUP' | 'HNL' | 'SEK' | 'PGK' | 'CZK' | 'AZN' | 'TJS' | 'HUF' | 'AED' | 'BYN' | 'ILS' | 'SLL' | 'CHF' | 'LAK' | 'HKD' | 'NIO' | 'RSD' | 'LYD' | 'PYG' | 'KGS' | 'BGN' | 'TMT' | 'SGD' | 'DKK' | 'LRD' | 'NOK' | 'NZD' | 'CRC' | 'LBP' | 'MRU' | 'OMR' | 'PAB' | 'KWD' | 'ERN' | 'GEL' | 'MNT' | 'UYU' | 'MDL' | 'BAM' | 'GMD' | 'ALL' | 'JMD' | 'AMD' | 'QAR' | 'BWP' | 'NAD' | 'LSL' | 'MKD' | 'TTD' | 'BHD' | 'MUR' | 'SZL' | 'DJF' | 'FJD' | 'KMF' | 'GYD' | 'BTN' | 'SBD' | 'MOP' | 'SRD' | 'CVE' | 'MVR' | 'BND' | 'BZD' | 'BSD' | 'ISK' | 'VUV' | 'XPF' | 'BBD' | 'STN' | 'WST' | 'XCD' | 'KID' | 'JEP' | 'TOP' | 'SCR' | 'AWG' | 'IMP' | 'KYD' | 'BMD' | 'GGP' | 'ANG' | 'GIP' | 'CKD' | 'TVD' | 'FKP'

Specifies the currency associated with the contact for transactions.

opening_payableinteger

The amount that the organization initially owes to the contact (such as a vendor or supplier) at the start of the accounting period.

opening_receivableinteger

The amount that the contact (such as a customer or client) initially owes to the organization at the start of the accounting period.

business_countrystring

The name or ISO code of the country where the contact’s business is legally registered or primarily operates.

msme_numberstring

The official registration number provided to a business entity upon successful registration under the MSME Act in India. This number helps in identifying and validating the enterprise's MSME status for availing government benefits and schemes.

Response

200

statusstring

messagestring

contact_idinteger

Example response

{
  "status": "success",
  "message": "Contact Added Successfully",
  "contact_id": 5249
}