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
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
Human Resuorce Management Module
Inventory Module Integration API
Risk Management and Mitigation
Sales Module Integration API
- Register Quotation API
- Register Proforma Invoice API
- List of Commercial Invoices
- Number of Commercial Invoices
- Register Invoice API
Services Module Integration 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
- Purchase Invoice List
- Purchase Invoice Details
- Register Purchase Invoice
Manufacturing Module API
API # : 8033 | API Name : purchaseorder
Module : Procurement
Get details of an existing Purchase Order.
URL : <domain>/apic/purchaseorder
Methods Allowed : POST
Payload Schema :
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Purchase Order ID."
}
},
"required": [
"id"
]
}
}
Sample Payload :
{
"id": "rKeEGD"
}
Response Schema :
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Generated schema for Root",
"type": "object",
"properties": {
"result": {
"type": "number"
},
"data": {
"type": "object",
"description":"All data of purchase order bundled in single object",
"properties": {
"poid": {
"type": "string",
"description": "Purchase order ID"
},
"branchid": {
"type": "string",
"description": "Branch ID from which the purchase order is raised."
},
"ponumber": {
"type": "string",
"description": "Purchase order number"
},
"podate": {
"type": "string",
"description": "Purchase order date."
},
"createddate": {
"type": "string",
"description": "Date of creation of the record."
},
"discount": {
"type": "double",
"description": "Discount on purchase order in terms of percentage on gross total level."
},
"entityid": {
"type": "string",
"description": "Entity ID for the branch from which purchase order is raised."
},
"sstid": {
"type": "string",
"description": "Tax Type ID. This list is country / taxation system specific. "
},
"daysallowed": {
"type": "number",
"description": "Maximum days permitted for the vendor for the fulfilment"
},
"isimport": {
"type": "integer",
"description": "Is the transaction an import transaction.",
"values": [
{
"code": 0,
"meaning": "Local / Domestic Transaction"
},
{
"code": 1,
"meaning": "Probaby an import transaction. Not specified yet"
},
{
"code": 2,
"meaning": "Import Transaction"
}
]
},
"approvedby": {
"type": "string",
"description": "ID of the person who has approved the purchase order"
},
"vendorid": {
"type": "string",
"description": "Vendor ID"
},
"grosstotal": {
"type": "double",
"description": "Gross total value of the purchase order in the original currency."
},
"nettotal": {
"type": "double",
"description": "Net total value of the purchase order in the original currency."
},
"currency": {
"type": "string",
"description": "Currency code. Three letter upper case."
},
"exchange": {
"type": "double",
"description": "Exchange rate for foreign currency transactions. For local currency this value will always be 1.0"
},
"effectivetotal": {
"type": "double",
"description": "Net toal of the purchase order exchanged into local currency"
},
"inventorystatus": {
"type": "integer",
"description": "Status of stock in (in case of stock PO).",
"values": [
{
"code": 0,
"meaning": "Not Initiated"
},
{
"code": 1,
"meaning": "Process Initiated"
},
{
"code": 2,
"meaning": "Goods stocked in"
}
]
},
"creditperiod": {
"type": "integer",
"description": "Number of days for the payment"
},
"poprefixid": {
"type": "string",
"description": "Purchase order type ID"
},
"shortname": {
"type": "string",
"description": "Short or coded name of the vendor"
},
"daysleft": {
"type": "integer",
"description": "Days left for the dispatch of the goods"
},
"revision": {
"type": "integer",
"description": "Revision number in case purchase order has been revised. This value will be zero if purchase order was not revised"
},
"statusmessage": {
"type": "string",
"description": "System generated status label"
},
"expecteddate": {
"type": "string",
"description": "Expected date of the arrival of the goods / execution of the services"
},
"validity": {
"type": "integer",
"description": "Validity of the purchase order in terms of days remaining"
},
"raisedby": {
"type": "string",
"description": "ID of the purchase executive"
},
"vendorname": {
"type": "string",
"description": "Name of the Vendor"
},
"items": {
"type": "integer",
"description": "Number of line items"
},
"usetype": {
"type": "integer",
"description": "Use type. 0 for Stock / Inventory. 1 for Assets / Consumables / Expenses"
},
"status": {
"type": "integer",
"description": "Status code."
},
"shipmentterms": {
"type": "string",
"description": "Shipment terms."
},
"type": {
"type": "integer",
"description": "Type of items where products and services in the same purchase order are blocked by policy.",
"values": [
{
"code":0,
"meaning": "Not locked to any type. Policy not enabled."
},
{
"code":1,
"meaning": "Only goods"
},
{
"code":2,
"meaning": "Only services."
}
]
},
"ltype": {
"type": "integer",
"description": "Code for the type of direct parent of the purchase invoice. Please refer to ltype code table."
},
"lid": {
"type": "string",
"description": "ID for the direct parent of the purchase invoice"
},
"taxtype": {
"type": "integer",
"description": "Tax Type"
},
"validtill": {
"type": "string",
"description": "Date of validity"
},
"adiscount": {
"type": "double",
"description": "Discount given as amount on the net total."
},
"accountstatus": {
"type": "integer",
"description": "Status code for the accounting transaction.",
"values": [
{
"code":0,
"meaning": "Not ready and not initiated."
},
{
"code":1,
"meaning": "Ready but not initiated."
},
{
"code":2,
"meaning": "Awaiting approval for posting."
},
{
"code":3,
"meaning": "Posted to the books of accounts as finalized transaction."
},
{
"code":5,
"meaning": "Posted to the books of accounts but mandatory post-process pending. Examples would be IRN, e-Invoice and VFD, etc. "
}
]
},
"tdsapp": {
"type": "boolean",
"description": "Flag to specify if TDS / With holding tax / Advance Tax is applicable on the services."
},
"tag": {
"type": "string",
"description": "Short label appended to the vendor name for internal records to identify vendors / uints / branches with same legal name"
},
"roundoff": {
"type": "double",
"description": "Amount rounded from net total. If 123.21 is rounded off to 123 then roundoff value would be -0.21"
},
"approveddate": {
"type": "string",
"description": "Date on which the record was approved. Last date of approval in case or multi-level approval rule"
},
"itemlist": {
"type": "array",
"description": "List of line items. Products, Services and other types.",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"quantity": {
"type": "number"
},
"productid": {
"type": "string"
},
"description": {
"type": "string"
},
"receivedquantity": {
"type": "number"
},
"poid": {
"type": "string"
},
"producttype": {
"type": "number"
},
"itemid": {
"type": "string"
},
"unit": {
"type": "string"
},
"pda4": {
"type": "string"
},
"price": {
"type": "number"
},
"productname": {
"type": "string"
},
"unitid": {
"type": "string"
},
"packtype": {
"type": "number"
},
"itc": {
"type": "number"
},
"handleid": {
"type": "string"
},
"ischild": {
"type": "boolean"
},
"categoryid": {
"type": "string"
},
"status": {
"type": "number"
},
"productdescription": {
"type": "string"
},
"vbrand": {
"type": "string"
},
"model": {
"type": "string"
},
"vmodel": {
"type": "string"
},
"brand": {
"type": "string"
},
"hscode": {
"type": "string"
},
"cname": {
"type": "string"
},
"slabid": {
"type": "string"
},
"taxrate": {
"type": "number"
},
"tax": {
"type": "number"
},
"hsnid": {
"type": "string"
},
"taxrate1": {
"type": "number"
}
},
"required": [
"amount",
"quantity",
"productid",
"description",
"producttype",
"itemid",
"unit",
"price",
"productname"
]
}
},
"billing": {
"type": "object",
"description": "Billing Address. From the perspective of a purchase order / GRN / purchase invoice or any other input record, a billing address is the address from which the vendor would be generating the invoice.",
"properties": {
"address": {
"type": "string",
"description": "Street Address"
},
"city": {
"type": "string",
"description": "City"
},
"addresstitle": {
"type": "string",
"description": "Title given to an address to identify different address of single entity"
},
"stateid": {
"type": "string",
"description": "State ID. Please refer to the State list in Tuhund."
},
"countrycode": {
"type": "string",
"description": "2 letter, small case, country code"
},
"postcode": {
"type": "string",
"description": "Post code / Zip Code / Pin Code"
},
"countryname": {
"type": "string",
"description": "Expanded country name"
},
"phone1": {
"type": "string",
"description": "Primary phone number"
},
"phone2": {
"type": "string",
"description": "Alternate phone number"
},
"mobile": {
"type": "string",
"description": "Mobile number"
},
"fax": {
"type": "string",
"description": "Fax Number"
},
"email": {
"type": "string",
"description": "Email address"
},
"yc": {
"type": "number",
"description": "Longitude of the location on the geo-map"
},
"xc": {
"type": "number",
"description": "Latitude of the location on the geo-map"
},
"iscurrent": {
"type": "boolean",
"description": "Flag to identify if the location is the current primary address"
},
"statecode": {
"type": "string",
"description": "2 letter, capital case, state code"
},
"addressid": {
"type": "string",
"description": "Address ID. Unique identifier for each address."
},
"statenumber": {
"type": "string",
"description": "State number."
},
"addresstype": {
"type": "string",
"description": "Type of location, like Work Address, Home Address, etc."
},
"state": {
"type": "string",
"description": "Expanded state name"
}
}
},
"shipping": {
"type": "object",
"description": "Shipping Address. From the perspective of a purchase order / GRN / purchase invoice or any other input record, a shipping address is the address from which the vendor would be dispatching the goods and / or executing the services.",
"properties": {
"address": {
"type": "string",
"description": "Street Address"
},
"city": {
"type": "string",
"description": "City"
},
"addresstitle": {
"type": "string",
"description": "Title given to an address to identify different address of single entity"
},
"stateid": {
"type": "string",
"description": "State ID. Please refer to the State list in Tuhund."
},
"countrycode": {
"type": "string",
"description": "2 letter, small case, country code"
},
"postcode": {
"type": "string",
"description": "Post code / Zip Code / Pin Code"
},
"countryname": {
"type": "string",
"description": "Expanded country name"
},
"phone1": {
"type": "string",
"description": "Primary phone number"
},
"phone2": {
"type": "string",
"description": "Alternate phone number"
},
"mobile": {
"type": "string",
"description": "Mobile number"
},
"fax": {
"type": "string",
"description": "Fax Number"
},
"email": {
"type": "string",
"description": "Email address"
},
"yc": {
"type": "number",
"description": "Longitude of the location on the geo-map"
},
"xc": {
"type": "number",
"description": "Latitude of the location on the geo-map"
},
"iscurrent": {
"type": "boolean",
"description": "Flag to identify if the location is the current primary address"
},
"statecode": {
"type": "string",
"description": "2 letter, capital case, state code"
},
"addressid": {
"type": "string",
"description": "Address ID. Unique identifier for each address."
},
"statenumber": {
"type": "string",
"description": "State number."
},
"addresstype": {
"type": "string",
"description": "Type of location, like Work Address, Home Address, etc."
},
"state": {
"type": "string",
"description": "Expanded state name"
}
}
},
"oem": {
"type": "object",
"description": "Original manufacturer in case the original manufacturer is different from the vendor and the date is needed for any purpose.",
"properties": {
"tan": {
"type": "string"
},
"address": {
"type": "string"
},
"cstnumber": {
"type": "string"
},
"city": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"phone2": {
"type": "string"
},
"postcode": {
"type": "string"
},
"countryname": {
"type": "string"
},
"companynumber": {
"type": "number"
},
"isagent": {
"type": "boolean"
},
"statename": {
"type": "string"
},
"priority": {
"type": "number"
},
"gstin": {
"type": "string"
},
"shortname": {
"type": "string"
},
"phone1": {
"type": "string"
},
"companyid": {
"type": "string"
},
"children": {
"type": "number"
},
"companyname": {
"type": "string"
},
"logoimage": {
"type": "string"
},
"tin": {
"type": "string"
},
"tag": {
"type": "string"
},
"fax": {
"type": "string"
},
"pan": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"delivery": {
"type": "object",
"description": "Delivery Address. From the perspective of a purchase order / GRN / purchase invoice or any other input record, a delivery address is the address to which the goods would be delivered.",
"properties": {
"address": {
"type": "string",
"description": "Street Address"
},
"city": {
"type": "string",
"description": "City"
},
"addresstitle": {
"type": "string",
"description": "Title given to an address to identify different address of single entity"
},
"stateid": {
"type": "string",
"description": "State ID. Please refer to the State list in Tuhund."
},
"countrycode": {
"type": "string",
"description": "2 letter, small case, country code"
},
"postcode": {
"type": "string",
"description": "Post code / Zip Code / Pin Code"
},
"countryname": {
"type": "string",
"description": "Expanded country name"
},
"phone1": {
"type": "string",
"description": "Primary phone number"
},
"phone2": {
"type": "string",
"description": "Alternate phone number"
},
"mobile": {
"type": "string",
"description": "Mobile number"
},
"fax": {
"type": "string",
"description": "Fax Number"
},
"email": {
"type": "string",
"description": "Email address"
},
"yc": {
"type": "number",
"description": "Longitude of the location on the geo-map"
},
"xc": {
"type": "number",
"description": "Latitude of the location on the geo-map"
},
"iscurrent": {
"type": "boolean",
"description": "Flag to identify if the location is the current primary address"
},
"statecode": {
"type": "string",
"description": "2 letter, capital case, state code"
},
"addressid": {
"type": "string",
"description": "Address ID. Unique identifier for each address."
},
"statenumber": {
"type": "string",
"description": "State number."
},
"addresstype": {
"type": "string",
"description": "Type of location, like Work Address, Home Address, etc."
},
"state": {
"type": "string",
"description": "Expanded state name"
}
}
}
},
"required": [
"poid",
"branchid",
"podate",
"ponumber",
"createddate",
"entityid",
"sstid",
"daysallowed",
"isimport",
"approvedby",
"vendorid",
"grosstotal",
"nettotal",
"currency",
"effectivetotal",
"inventorystatus",
"exchange",
"raisedby",
"vendorname",
"items",
"usetype",
"status",
"shipmentterms",
"type",
"validtill",
"accountstatus"
]
}
},
"required": [
"result",
"data"
]
}
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": {
"poid": "p9Tj1u",
"branchid": "ENTERPRISE",
"podate": "07/09/2023",
"ponumber": "ECS/23-24/132",
"createddate": "07/09/2023",
"discount": 0,
"entityid": "ENTERPRISE",
"sstid": "LOCALIN",
"daysallowed": 7,
"isimport": 0,
"approvedby": "w2ggjG",
"vendorid": "JgfM7v",
"grosstotal": 116203.94,
"nettotal": 129164,
"currency": "INR",
"effectivetotal": 129164,
"inventorystatus": 0,
"creditperiod": 15,
"poprefixid": "K4rR9n",
"shortname": "A S",
"daysleft": -24,
"revision": 0,
"statusmessage": "Partially Invoiced",
"exchange": 1,
"expecteddate": "14/09/2023",
"validity": 7,
"raisedby": "sCG99o",
"vendorname": "A S Computers",
"items": 7,
"usetype": 0,
"status": 45,
"shipmentterms": "Local Delivery",
"type": 0,
"ltype": 0,
"taxtype": 5,
"validtill": "14/09/2023",
"adiscount": 0,
"accountstatus": 1,
"tdsapp": false,
"tag": "A S",
"roundoff": 0.06,
"approveddate": "04/10/2023",
"itemlist": [
{
"amount": 2400,
"quantity": 20,
"productid": "S09091841",
"description": "/AC Inverter 2HP/ 3PH Input- 3PH Output, 1.5 KW, 415V.",
"receivedquantity": 20,
"poid": "p9Tj1u",
"producttype": 2,
"itemid": "riASdW",
"unit": "Nos",
"pda4": "INVERTER",
"price": 120,
"productname": "/AC Inverter 2HP/ 3PH Input- 3PH Output, 1.5 KW, 415V.",
"unitid": "t9SmnN",
"packtype": 0,
"itc": 0,
"handleid": "S09091841",
"ischild": false,
"categoryid": "NOCAT",
"status": 0
},
{
"amount": 1000,
"quantity": 5,
"productid": "S09091536",
"description": "0.5 HP 960 FOOT",
"receivedquantity": 5,
"poid": "p9Tj1u",
"producttype": 2,
"itemid": "riAVBe",
"unit": "Nos",
"pda4": "ELECTRICAL MOTORS , PUMPS ,GEA",
"price": 200,
"productname": "0.5 HP 960 FOOT",
"unitid": "t9SmnN",
"packtype": 0,
"itc": 0,
"handleid": "S09091536",
"ischild": false,
"categoryid": "NOCAT",
"status": 0
},
{
"amount": 163.94,
"quantity": 2,
"productid": "S09092711",
"description": "\"KI\" Make Pressure Gauge (Utility), Dial Size :2\" (50mm) Range:0-14 kg/cm2/ 0-200 PSI,",
"poid": "p9Tj1u",
"producttype": 2,
"itemid": "riAXqf",
"unit": "Nos",
"pda4": "PRESSURE GAUGE",
"price": 81.97,
"productname": "\"KI\" Make Pressure Gauge (Utility), Dial Size :2\" (50mm) Range:0-14 kg/cm2/ 0-200 PSI, Mounting: Bottom, Connection:1/8\"",
"unitid": "t9SmnN",
"packtype": 0,
"itc": 0,
"handleid": "S09092711",
"ischild": false,
"categoryid": "NOCAT",
"status": 0
},
{
"amount": 240,
"quantity": 20,
"productid": "S09091553",
"description": "0.75 HP 2800 FLANGE 3PH 415 V",
"receivedquantity": 20,
"poid": "p9Tj1u",
"producttype": 2,
"itemid": "riAZlc",
"unit": "Nos",
"pda4": "ELECTRICAL MOTORS , PUMPS ,GEA",
"price": 12,
"productname": "0.75 HP 2800 FLANGE 3PH 415 V",
"unitid": "t9SmnN",
"packtype": 0,
"itc": 0,
"handleid": "S09091553",
"ischild": false,
"categoryid": "NOCAT",
"status": 0
},
{
"amount": 4000,
"quantity": 20,
"productid": "150720211317",
"productdescription": "02-4560-0 02-1590-0 + 87-1730-0 Kansai Orginal",
"vbrand": "MySleepyHead",
"description": "02-1590-0 + 87-1730-0 Kansai Orginal Spares",
"receivedquantity": 20,
"poid": "p9Tj1u",
"producttype": 2,
"itemid": "riAjFq",
"unit": "Pcs",
"price": 200,
"productname": "02-1590-0 + 87-1730-0 Kansai Orginal Spares",
"unitid": "PIECES",
"packtype": 0,
"itc": 0,
"model": "02-4560-0",
"vmodel": "02-4560-0",
"handleid": "150720211317",
"brand": "MySleepyHead",
"ischild": false,
"categoryid": "NOCAT",
"status": 0
},
{
"amount": 400,
"quantity": 2,
"productid": "150720211770",
"productdescription": "05-2050-0 00-6083-0 Kansai Orginal",
"vbrand": "MySleepyHead",
"description": "00-6083-0 Kansai Orginal Spares",
"receivedquantity": 2,
"poid": "p9Tj1u",
"producttype": 2,
"itemid": "riAkpw",
"unit": "Pcs",
"price": 200,
"productname": "00-6083-0 Kansai Orginal Spares",
"unitid": "PIECES",
"packtype": 0,
"itc": 0,
"model": "05-2050-0",
"vmodel": "05-2050-0",
"handleid": "150720211770",
"brand": "MySleepyHead",
"ischild": false,
"categoryid": "NOCAT",
"status": 0
},
{
"hscode": "852530",
"productid": "1377192423334",
"productdescription": "10 مجموعة كاملة من آلة قطع النسيج",
"cname": "Electronics",
"description": "10'' Fabric Cutting Machine complete set",
"slabid": "GST12",
"receivedquantity": 60,
"producttype": 1,
"itemid": "riAwro",
"price": 1800,
"productname": "10'' Fabric Cutting Machine complete set",
"packtype": 0,
"itc": 0,
"model": "JK-T103 10X",
"handleid": "1377192423334",
"brand": "Brother",
"categoryid": "q9y43K",
"taxrate": 6,
"amount": 108000,
"quantity": 60,
"vbrand": "Brother",
"tax": 12960,
"poid": "p9Tj1u",
"hsnid": "t9EX41",
"unit": "Pcs",
"taxrate1": 6,
"unitid": "PIECES",
"vmodel": "JK-T103 10X",
"ischild": false,
"status": 0
}
],
"billing": {
"address": "Some road",
"city": "Bangalore",
"addresstitle": "BILLING",
"stateid": "91012",
"countrycode": "in",
"postcode": "560004",
"countryname": "India",
"phone2": "678768",
"mobile": "6876876",
"yc": 0,
"iscurrent": false,
"xc": 0,
"statecode": "KA",
"parentid": "JgfM7v",
"addressid": "RWaiUw",
"phone1": "686",
"applicationcode": 0,
"statenumber": "29",
"addresstype": "Work",
"state": "Karnataka",
"fax": "668768768",
"email": "test@test.com"
},
"shipping": {
"address": "#7, Leonard Lane, Richmond Town",
"city": "Bangalore",
"addresstitle": "WORK",
"countrycode": "sg",
"postcode": "560025",
"countryname": "Singapore",
"phone2": "76786",
"mobile": "56576444",
"yc": 0,
"iscurrent": true,
"xc": 0,
"parentid": "JgfM7v",
"addressid": "RWRgPy",
"phone1": "67868",
"applicationcode": 0,
"addresstype": "Work",
"state": "dskafaklsdjfklsjfklsjfklsdjfkl",
"fax": "4654646",
"email": "irfan.qazi@gmail.com"
},
"oem": {
"tan": "AST124445354",
"address": "#7, Leonard Lane, Richmond Town",
"cstnumber": "ASC453466",
"city": "Bangalore",
"countrycode": "sg",
"phone2": "76786",
"postcode": "560025",
"countryname": "Singapore",
"companynumber": 1231,
"isagent": true,
"statename": "dskafaklsdjfklsjfklsjfklsdjfkl",
"priority": 4,
"gstin": "29AACCE1831A1Z71",
"shortname": "A S",
"phone1": "67868",
"companyid": "JgfM7v",
"children": 1,
"companyname": "A S Computers",
"logoimage": "oOU7wH.png",
"tin": "AST2558961",
"tag": "A S",
"fax": "4654646",
"pan": "ASP5464564",
"email": "irfan.qazi@gmail.com"
},
"delivery": {
"address": "No. 4 Alexander Street , Richmond Town",
"city": "Bangalore",
"addresstitle": "Head Office",
"stateid": "91012",
"countrycode": "in",
"postcode": "560025",
"countryname": "India",
"yc": 12.962244987487793,
"iscurrent": true,
"xc": 77.6047134399414,
"statecode": "KA",
"parentid": "ENTERPRISE",
"addressid": "ENTERPRISE",
"phone1": "09845978698",
"applicationcode": 0,
"statenumber": "29",
"addresstype": "Registered",
"state": "Karnataka"
}
}
}
Sample failure response :
{
"result": -1,
"message": "Operation failed.",
"errors": [
{
"code": 404,
"error": "No such record found"
}
]
}
