Tuhund - Register Invoice API

API List

• API Introduction
• Authentication Key API
• Server Date and Time
• Embed Image API
• Attachment Download API
• Common lookups API

CRM Integration API

• List of companies with basic details
• Complete details of a company
• List of customers of a branch with basic details
• Register Person
• Register company
• Register address
• Register contact query
• Login ID availability check
• Customer Login API

Delivery / Shipment Order API

• Register Delivery Order
• Delivery Order Tracking API

Expense Claims Integration API

• Register Expense Claim
• Add expense item to claim
• Save and present claim for approval
• Get list of claims with basic details
• Get claim with all details

Inventory Module Integration API

• Register Delivery Note
• Consumer side Stock Utilization Status Update

Sales Module Integration API

• Register Quotation API
• List of Commercial Invoices
• Number of Commercial Invoices
• Register Invoice API

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

Procurement Module API

• Purchase Order List
• Purchase Order Details

Manufacturing Module API

• Get job order list
• Get job order details
• Bills of material of a Product
• Bill of material

API # : 8030 | API Name : registerci

This API is used to register a commercial invoice / tax invoice (new or old) for a customer in Tuhund.

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

Register Commercial Invoice API and all similar API like Quotation, Proforma Invoice, Inquiry, Purchase Order, RFQ, Purchase Invoice and Leads, etc can be used to register new records during mormal working or old records at the time of data entry into the system. Payload for both are slightly different. For the real time entry all entities like customer, address, product, record type and tax type will be identified only with their respective ID. However, for the old data entry ID or the names can be used.

Payload Schema :

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "branchid": { "type": "string" }, "companyid": { "type": "string" }, "companynumber": { "type": "integer" }, "currency": { "type": "string" }, "terms": { "type": "string" }, "adiscount": { "type": "integer" }, "shippingaddressid": { "type": "string" }, "payment": { "type": "string" }, "remarks": { "type": "string" }, "reference": { "type": "string" }, "discount": { "type": "integer" }, "validtill": { "type": "string" }, "items": { "type": "array", "items": [ { "type": "object", "description": "Object to add a product", "properties": { "adiscount": { "type": "integer" }, "price": { "type": "integer" }, "productid": { "type": "string" }, "taxrate4": { "type": "integer" }, "taxrate3": { "type": "integer" }, "taxrate2": { "type": "integer" }, "taxrate1": { "type": "integer" }, "quantity": { "type": "integer" }, "discount": { "type": "integer" }, "serials": { "type": "JSON Array" } }, "required": [ "price", "productid" ] }, { "type": "object", "description": "Object to add a service", "properties": { "adiscount": { "type": "integer" }, "price": { "type": "integer" }, "serviceid": { "type": "string" }, "description": { "type": "string", "description": "Description of the service item", "example": "Subscription charges for the month of June 2023 for package Airtel-Black 2499" }, "taxrate4": { "type": "integer" }, "taxrate3": { "type": "integer" }, "taxrate2": { "type": "integer" }, "taxrate1": { "type": "integer" }, "quantity": { "type": "integer" }, "discount": { "type": "integer" } }, "required": [ "price", "serviceid" ] } ] }, "personid": { "type": "string" }, "billingaddressid": { "type": "string" }, "cidate": { "type": "string" }, "taxtype": { "type": "string" }, "ciprefixid": { "type": "string" }, "secondarytax": [ { "id": { "type": "string", "description": "Tax type ID" }, "inclusive": { "type": "boolean", "description": "If tax is included in price" } } ] }, "required": [ "terms", "branchid", "currency", "companyid", "companynumber", "items", "cidate", "ciprefixid" ] }

Sample Payload for Real Time entry :

{ "adiscount": 0, "shippingaddressid": "cggr23344", "payment": "50% advance, 50% on delivery", "terms": "CIF Sea", "branchid": "b12aaa1", "remarks": "Packing must be waterproof as the shipment may have to wait in open warehouse for few days", "reference": "PO 22366623", "discount": 0, "currency": "MYR", "companyid": "Wl61Nt", "companynumber": 1251, "validtill": "20/06/2021", "items": [ { "adiscount": 0, "price": 4554.55, "productid": "P15665566566", "taxrate4": 0, "taxrate3": 0, "taxrate2": 9, "taxrate1": 9, "quantity": 10, "discount": 0 }, { "adiscount": 0, "price": 125, "productid": "P3305566566", "taxrate4": 0, "taxrate3": 0, "taxrate2": 6, "taxrate1": 6, "quantity": 25, "discount": 0 }, { "adiscount": 0, "price": 800, "serviceid": "S3305566566", "taxrate4": 0, "taxrate3": 0, "taxrate2": 9, "taxrate1": 9, "quantity": 1, "discount": 0 } ], "personid": "645465464", "billingaddressid": "cggr23344", "cidate": "20/05/2021", "taxtype": "INTERSTATE", "ciprefixid": "qy887q" }

companyid or companynumber, any one of the two can be provided in payload.

Sample Payload for old record :

{ "countrycode": "my", "gstin": "29AAGGE1851A1Z7", "terms": "CIF Sea", "state": "WP Kuala Lumpur", "remarks": "Packing must be waterproof as the shipment may have to wait in open warehouse for few days", "branchid": "b12aaa1", "tin": "TSSD3445553", "city": "Kuala Lumpur", "currency": "MYR", "companyid": "Wl61Nt", "cstnumber": "CST2333242424", "taxtype": "INTERSTATE", "cin": "C542234AADDE443434444", "adiscount": 0, "shippingaddressid": "cggr23344", "payment": "50% advance, 50% on delivery", "postcode": "56025", "create": true, "companyname": "ECS Business Software Solutions", "reference": "PO 22366623", "discount": 0, "pan": "AAGGE1851A", "salesman": "Andrew Wong", "validtill": "20/06/2021", "items": [ { "model": "T-8422D-405-N64D", "adiscount": 0, "pda1": "Japan", "pda2": "H7786", "pda3": "A", "pda4": "B", "discount": 0, "unit": "Pcs", "price": 4554.55, "productid": "P15665566566", "taxrate4": 0, "description": "New Generation DIRECT DRIVE Twin Needle with thread trimmer, wiper & control panel. Dual feed technology-needle feed and drop", "taxrate3": 0, "taxrate2": 9, "brand": "Brother", "taxrate1": 9, "quantity": 10, "producttype": 1, "productname": "DIRECT DRIVE Twin Needle with thread trimmer" }, { "adiscount": 0, "price": 125, "productid": "P3305566566", "taxrate4": 0, "taxrate3": 0, "taxrate2": 6, "taxrate1": 6, "quantity": 25, "discount": 0 }, { "adiscount": 0, "price": 800, "serviceid": "S3305566566", "taxrate4": 0, "taxrate3": 0, "taxrate2": 9, "taxrate1": 9, "quantity": 1, "discount": 0 } ], "address": "#255, Street 3, Jalan Chan Sow Lin", "email": "ecsmalaysia@ecsbss.com", "personid": "645465464", "billingaddressid": "cggr23344", "cidate": "20/05/2021", "tan": "T23311AADD33", "ciprefixid": "qy887q" }

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 success response :

{ "result": 1, "data": { "dispatch": "Immediate dispatch after receiving PO and Payment", "discount": 0, "entityid": "ENTERPRISE", "stpercent": 0, "type": 0, "companyid": "JgfM7v", "adiscount": 0, "accountstatus": 0, "createdby": "demon", "typeid": "DEFAULT", "tag": "A S", "cpodate": "10/05/2023", "filingcount": 0, "groupid": "XX1nRZ", "tax": 0, "shortname": "A S", "ciid": "1683732416127", "revision": 0, "autoround": false, "creditdays": 0, "deliverystatus": 0, "companyname": "A S Computers", "zoneid": "OTnjVL", "exchange": 1, "items": [ { "hscode": "444555", "productid": "xfmp8G", "dim3": 0, "dim2": 0, "dim1": 0, "cname": "Other Services", "description": "xfmp8G", "slabid": "GST05", "discount": 0, "producttype": 3, "itemid": "1683732416136", "adiscount": 0, "price": 200, "discountedprice": 200, "basetax": 0, "productname": "Cable TV New Connection", "discountedamount": 200, "categoryid": "xflw8N", "actual": 0, "amount": 200, "quantity": 1, "packquantity": 0, "ciid": "1683732416127", "hsnid": "LVgiW0", "unitid": "qVeB9x" } ], "status": 30, "branchid": "ENTERPRISE", "createddate": "10/05/2023", "freight": 0, "shipmentterms": "NA", "statuslabel": "Entered as it is", "sttype": 0, "taxtype": "0", "products": 0, "billingaddress": { "address": "Some road", "city": "Bangalore", "stateid": "91012", "countrycode": "in", "postcode": "560004", "countryname": "India", "phone2": "678768", "statecode": "KA", "addressid": "RWaiUw", "phone1": "686", "statenumber": "29", "state": "Karnataka", "email": "test@test.com" }, "nettotal": 200, "currency": "INR", "commission": 0, "roundoff": 0, "shippingaddress": { "address": "Some road", "city": "Bangalore", "stateid": "91012", "countrycode": "in", "postcode": "560004", "countryname": "India", "phone2": "678768", "statecode": "KA", "addressid": "RWaiUw", "phone1": "686", "statenumber": "29", "state": "Karnataka", "email": "test@test.com" }, "amount": 200, "stpercent2": 0, "services": 1, "stpercent3": 0, "assignedto": "fAP3mZ", "taxpercent": 0, "cidate": "10/05/2023", "cinumber": "TEMP91", "raisedby": "demon", "othercharges": 0 }, "id": "ciid", "message": "New Invoice registered" }

Sample failure response :

Case 1: Mandatory fields missing

{ "response": -1, "errorcode": 412, "errors": [ { "param": "ciprefixid", "error": "ciprefixid (ID for the type of CI) missing.", "errorcode": 412 }, { "param": "branchid", "error": "branchid (Branch ID) not found or could not be translated", "errorcode": 412 }, { "param": "companyid", "error": "Company ID could not be translated or created.Company ID, Company Number or details to register a new customer are mandatory.", "errorcode": 412 }, { "param": "addressid", "error": "Address ID not found.", "errorcode": 412 } ] }

Case 2: Unspecified database error

{ "result": -1, "message": "Error while inserting records in database", "errorcode": 500 }