Tuhund - Register Company API

API List

• API Introduction
• Authentication Key API
• Server Date and Time
• Register Quotation API
• Register Delivery Order
• Embed Image API
• List of companies with basic details
• Complete details of a company
• List of customers of a branch with basic details
• Register company
• Register address
• Login ID availability check
• Customer Login API
• Common lookups
• Delivery Order Tracking API
• List of Commercial Invoices
• Number of Commercial Invoices

Shopping Cart Integration API

• Price List API
• Create Shopping Cart Order
• Add product to shopping cart
• Update payment details
• Get order in shopping cart
• List of orders in shopping cart

API # : 8010 | API Name : registercompany

This API is used to register a company in Tuhund along with multiple addresses, contact persons and relations. Relations are of four types :

CUSTOMER

VENDOR

AGENT

OTHERS

URL : <domain>/apic/registercompany
Methods Allowed : POST

Payload Schema :

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "companyname": { "type": "string", "description": "Full legal name of the company" }, "tag": { "type": "string", "description": "A short label to identify where multiple companies are with the same legal name" }, "shortname": { "type": "string", "description": "Two to eight character short name. Short name is useful in tables, charts and reports where space is limited" }, "cin": { "type": "string", "description": "Corporate Identity Number or Legal Registration Number, depending on the country." }, "cstnumber": { "type": "string", "description": "CST Number of the company" }, "gstin": { "type": "string", "description": "GST Number of the company" }, "parentid": { "type": "string", "description": "Group ID if the company is part of a group of companies" }, "companyid": { "type": "string", "description": "Company ID as in the calling system. If not sent, system will return the ID auto created." }, "tin": { "type": "string", "description": "TIN (Tax Identification Number) of the company" }, "pan": { "type": "string", "description": "PAN of the company" }, "tan": { "type": "string", "description": "Tax Account Number of the company" }, "contactpersons": { "type": "array", "description": "Array of multiple contact persons of the company. Single element array where single contact perosn is to be added", "items": [ { "type": "object", "description": "Details of a contact person as JSON Object", "properties": { "title": { "type": "string", "description": "Mr., Ms., Mrs. etc." }, "countrycode": { "type": "string", "description": "Two letter country code. Please refer to country lookup API for Country codes" }, "middlename": { "type": "string", "description": "Middle Name" }, "email": { "type": "string", "description": "Email address of the contact person" }, "address": { "type": "string", "description": "Street and Building address" }, "nickname": { "type": "string", "description": "Nickname" }, "designation": { "type": "string", "description": "Designation of the contact person in the company" }, "lastname": { "type": "string", "description": "Last Name" }, "branchid": { "type": "array",, "description": "IDs of all the branches where this person is a contact person" "items": [ { "type": "string", "description": "Branch ID" }, { "type": "string", "description": "Branch ID" } ] }, "firstname": { "type": "string", "description": "First Name of the contact person" }, "postcode": { "type": "string", "description": "Post code / Pin Code / Zip Code" }, "mobile": { "type": "string", "description": "Mobile Number" }, "phone1": { "type": "string", "description": "Phone Number" }, "phone2": { "type": "string", "description": "Alternate Phone Number" }, "stateid": { "type": "string", "description": "State ID where available. Please refer to state lookup API for list of states for each country" }, "state": { "type": "string", "description": "Name of the state" }, "city": { "type": "string", "description": "City" }, "loginid": { "type": "string", "description": "Unique Login ID to create login account for customer and e-Commerce Portals" }, "password": { "type": "string", "description": "Password" } }, "required": [ "title", "countrycode", "branchid", "firstname" ] } ] }, "relations": { "type": "array", "description": "Array with data of relations to be created for the said company. Relations include CUSTOMER and VENDOR.", "items": [ { "type": "object", "description": "Data for a relation. This sample represents data required for CUSTOMER relation", "properties": { "assignedto": { "type": "string", "description": "ID of the sales person whom this customer is assigned to for the specified branch." }, "zoneid": { "type": "string", "description": "ID of the marketing zone" }, "branchid": { "type": "string", "description": "Branch ID for this record" }, "groupid": { "type": "string", "description": "Customer Group ID for this record at the specified branch" }, "type": { "type": "string", "description": "Type of relation. CUSTOMER or VENDOR. For this sample it will be CUSTOMER" } }, "required": [ "branchid", "type" ] }, { "type": "object", "properties": { "assignedto": { "type": "string", "description": "ID of the person whom this vendor is assigned to for the specified branch." }, "branchid": { "type": "string", "description": "Branch ID for this record" }, "type": { "type": "string", "description": "Type of relation. CUSTOMER or VENDOR. For this sample it will be VENDOR" } }, "required": [ "branchid", "type" ] } ] }, "addresses": { "type": "array", "description": "Array of multiple addresses of the company", "items": [ { "type": "object", "properties": { "stateid": { "type": "string", "description": "State ID where available. Please refer to state lookup API for list of states for each country" }, "title": { "type": "string", "description": "A short descriptive title for the address. Required and useful where multiple addresses are being added." }, "fax": { "type": "string", "description": "Fax number" }, "countrycode": { "type": "string", "description": "Two letter country code. Please refer to country lookup API for list of countries with codes." }, "email": { "type": "string", "description": "Email address of the company." }, "address": { "type": "string", "description": "Building and Street address. Please combine if you have multiple line address." }, "state": { "type": "string", "description": "Name of the state." }, "phone2": { "type": "string", "description": "Alternate phone number" }, "postcode": { "type": "string", "description": "Post Code / Pin Code / ZIP Code" }, "phone1": { "type": "string", "description": "Primary phone number" }, "mobile": { "type": "string", "description": "Mobile Number" }, "city": { "type": "string", "description": "Name of the city" } }, "required": [ "countrycode", "stateid - for countries where tax rates or rules vary according to states" ] } ] } }, "required": [ "companyname" ] }

Request Headers :

Name	Description
device	A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted.
Authentication	Authentication code generated for API call.

Sample Payload :

{ "tag": "BLR", "gstin": "G2333223322333", "parentid": "ecentric", "tin": "T34343577556", "companyname": "ECS Business Software Solutions Pvt. Ltd.", "pan": "AACCP2234K", "contactpersons": [ { "title": "Mr.", "countrycode": "uk", "middlename": "J", "email": "harry@samplemail.com", "address": "66 Vicarage Ave, White Notley, Witham CM8 1SA", "nickname": "Harry P", "designation": "General Manager", "lastname": "Porter", "branchid": [ "branch1id", "branch2id" ], "firstname": "Harry", "postcode": "CM8 1SA", "mobile": "+4456665556654", "loginid": "harryp", "password": "hkAh87HHk6@66" }, { "stateid": "9608", "countrycode": "sa", "fax": "+966569874597", "nickname": "Lujjayn", "designation": "Purchase Manager", "state": "Eastern Province", "branchid": [ "branch1id" ], "phone2": "+966569874599", "firstname": "Lujjayn", "postcode": "23045", "phone1": "+966569874598", "city": "Dammam", "title": "Ms.", "email": "lujjayn3655@cmail.com", "address": "14th Street, Okbah Bin Nafel, Al Amamrah", "mobile": "+96646005644" } ], "companyid": "1622471232179", "relations": [ { "assignedto": "w2ggjG", "zoneid": "R6RjsT", "branchid": "ENTERPRISE", "groupid": "XN4ekv", "type": "CUSTOMER" }, { "assignedto": "w2ggjG", "branchid": "xMrYzo", "type": "VENDOR" } ], "shortname": "ECS", "cstnumber": "C89897787877", "cin": "C898977dd3344ghh444587877", "addresses": [ { "stateid": "91012", "title": "Billing Address", "fax": "+91800000000", "countrycode": "in", "email": "sampleemail@domain.com", "address": "#67, Church Street, Brigade Road", "state": "Karnataka", "phone2": "+91800000000", "postcode": "560001", "phone1": "+91800000000", "mobile": "+919800000000", "city": "Bangalore" }, { "stateid": "91012", "title": "Shipping Address", "fax": "+91800000000", "countrycode": "in", "email": "sampleemail2@domain.com", "address": "No.44, Beside Innovative Multiplex Theater, Opp Bhagini Plaza, Munnekolal, Marathahalli", "state": "Karnataka", "phone2": "+91800000000", "postcode": "560037", "phone1": "+91800000000", "mobile": "+91800000000", "city": "Bangalore" } ], "tan": "T678764433" }

Sample success response :

{ "result": 1, "message": "Company Registered.", "companyid": "1622481914058" }

Sample failure response :

Case 1: Company Name missing

{ "message":"Error while inserting records in database.", "response":-1, "errorcode":406, "errors":[ "Company Name as companyname is mandatory." ] } <p><strong>Case 2: Duplicate Login ID</p> <textarea style="height: 100px;" readonly> { "message":"Error while inserting records in database.", "response":-1, "errorcode":406, "errors":[ "Duplicate Login ID." ] }