A Guide Tozycus REST API

A Guide Tozycus REST API

Zycus Integration Guide

-A Guide toZycus REST API

Version 1.0

Table of Content

1Getting Started

1.1Introduction

1.2What you need?

2Integration Overview

2.1Integration Overview Diagram

2.2iConsole Integration

3REST Resources

3.1List Api

3.2User API

3.3Company API

3.4eProc API

3.5SIM API

1Getting Started

1.1Introduction

Zycus REST API provides a way to integrate easily with Zycus Suite of Products. It the recommended way to get all the information that Zycus manages related to your suppliers. The API can be used to get the data in JSON (Javascript Object Notation) format which can be used to push it to any custom source systems or to develop mobile clients or Web 2.0 widgets.

1.2What you need?

  • A Zycus.com account.
  • Application Id to access the Zycus REST API. This can be obtained by using iConsole (Access to iConsole can be obtained by sending mail to )
  • Based on your account type the data can be requested from any of the Zycus products that you are licensed to.

2Integration Overview

Zycus Products expose web services within the internal network of Zycus. These web services are consumed by the Zycus Integration Server and are exposed over the web( RESTful web services pattern.

These web services can be consumed by any mobile device, Web 2.0 widgets or external source systems to push and pull the data to and from Zycus products via a secure authentication over HTTPS.

The customer looking for integration with Zycus tools needs to generate an API key to access data through web services.

Creation of API user and generating API key can be done via sending an email to . An Applicationid is required to be provided as request parameter with the REST Resource URL that the web service client is accessing. Zycus Security server receives the Application id and generates an access token which is valid for a particular session re-authentication happens only when the session times out.

2.1Integration Overview Diagram


2.2iConsole Integration

These APIs come with an API console with detailed steps to try sample requests, understand the request and response data structures. API Console is a great way to explore the API and speed up the development of the REST client being developed by the customers.

Typically, our customers use iConsole APIs to interact with the comprehensive suite of Zycus products, extract the data on a scheduled basis and in a standardized manner. This gives our customers complete control over the data sync frequency. iConsole APIs are a great way to save on the development efforts.

3REST Resources

3.1List Api

3.1.1List Services

HTTP METHOD / GET
API URL /
OUTPUT / [
{
"version": "v1",
"url": "\/rest\/v1\/user\/details",
"resource": "getAuthenticatedUser",
"description": "The following Rest API is used to retrieve the company details of a user. For Example: Email Address, First Name, Last Name etc.",
"source": "USER",
"method": "GET",
"operationType": "SEARCH",
"inputParams": [
]
},...
{
"version": "v1",
"url": "\/rest\/v1\/user\/update",
"resource": "updateUserDetails",
"description": "The following Rest API is used to update basic user details.",
"source": "USER",
"method": "POST",
"operationType": "UPDATE",
"inputParams": [
]
}
]

3.1.2List Resource

HTTP METHOD / GET
API URL /
OUTPUT / [{
"version": "v1",
"name": "COMPANY",
"url": "\/rest\/v1\/company",
"description": "Rest api which gives view of the user's company details",
"operations": [
"UPDATE",
"SEARCH"
]
},...
{
"version": "v1",
"name": "ONEVIEW",
"url": "\/rest\/v1\/oneview",
"description": null,
"operations": [
"UPDATE",
"CREATE",
"DELETE",
"SEARCH"
]
}
]

3.1.3List Services by Resource

HTTP METHOD / GET
API URL /
OUTPUT / [
{
"version": "v1",
"url": "\/rest\/v1\/sim\/vendors",
"resource": "createVendors",
"description": "The following Rest API creates a list of Vendors in SIM repository.",
"source": "SIM",
"method": "POST",
"operationType": "CREATE",
"inputParams": [
]
},...
{
"version": "v1",
"url": "\/rest\/v1\/sim\/referenceMasters",
"resource": "getReferenceMasterData",
"description": "The following Rest API is used to retrieve the reference master data. The master id parameter is required to retrieve the reference master data.",
"source": "SIM",
"method": "GET",
"operationType": "SEARCH",
"inputParams": [
"masterId"
]
}
]

3.1.4List Services by Resource and Operation

HTTP METHOD / GET
API URL /
OUTPUT / [
{
"version": "v1",
"url": "\/rest\/v1\/sim\/vendors",
"resource": "createVendors",
"description": "The following Rest API creates a list of Vendors in SIM repository.",
"source": "SIM",
"method": "POST",
"operationType": "CREATE",
"inputParams": [
]
}
]

3.2User API

3.2.1Get user details

HTTP METHOD / GET
API URL /
OUTPUT / {
"emailAddress": "",
"firstName": "Vivek1",
"middleName": "vivek2",
"lastName": "KT",
"displayName": "V.K.T",
"initials": "VKT",
"salutationName": "Mrs",
"companyName": "Zygrate Monitoring"
}

3.2.2Get allocated products

HTTP METHOD / GET
API URL /
OUTPUT / {
"name": [
"SIM",
"iConsole",
"TMS"
]
}

3.2.3Get user location details

HTTP METHOD / GET
API URL /
OUTPUT / {
"state": "",
"city": "",
"telephoneNumber": "",
"extension": "",
"alternateTelephoneNumber": "",
"locationName": "Ins"
}

3.2.4Change Password

HTTP METHOD / POST
API URL /
INPUT / {
"oldPassword": "pass@1234",
"newPassword": "pass@123",
}
OUTPUT / {
"oldPassword": "pass@1234",
"newPassword": "pass@123",
"message": "Password updated Successfully!!"
}

3.2.5Update user details

HTTP METHOD / POST
API URL /
INPUT / {
"emailAddress": "",
"firstName": "Vivek",
"middleName": "",
"lastName": "KT",
"displayName": "V.K.T",
"initials": "VKT",
"salutationName": "Mr",
"companyName": "Zygrate Monitoring"
}
OUTPUT / {
"emailAddress": "",
"firstName": "Vivek",
"middleName": "",
"lastName": "KT",
"displayName": "V.K.T",
"initials": "VKT",
"salutationName": "Mr",
"companyName": "Zygrate Monitoring"
}

3.2.6Update user location details

HTTP METHOD / POST
API URL /
INPUT / {
"state": "Maharashtra",
"city": "Mumbai",
"telephoneNumber": "9987654123",
"extension": "7314",
"alternateTelephoneNumber": "1234567890",
"locationName": "Ins"
}
OUTPUT / {
"state": "Maharashtra",
"city": "Mumbai",
"telephoneNumber": "9987654123",
"extension": "7314",
"alternateTelephoneNumber": "1234567890",
"locationName": "Ins"
}

3.3Company API

3.3.1Get company details

HTTP METHOD / GET
API URL /
OUTPUT / {
"companyName": "Zygrate Monitoring",
"mailHost": "webmail1.zycus.net",
"mailHostPort": "22"
}

3.3.2Get company location details

HTTP METHOD / GET
API URL /
OUTPUT / {
"address1": "",
"address2": "",
"country": "test",
"state": "Maharashtra",
"city": "Mumbai",
"zipCode": "400101",
"locationName": "Ins"
}

3.3.3Update company location details

HTTP METHOD / POST
API URL /
INPUT / {
"address1": "Seepz",
"address2": "",
"country": "India",
"state": "Maharashtra",
"city": "Mumbai",
"zipCode": "400101",
"locationName": "Ins"
}
OUTPUT / {
"address1": "Seepz",
"address2": "",
"country": "India",
"state": "Maharashtra",
"city": "Mumbai",
"zipCode": "400101",
"locationName": "Ins"
}

3.4eProc API

3.4.1Add or update master data services

3.4.1.1Add or update Cost Centers
HTTP METHOD / POST
API URL /
INPUT / [
{
"costCenterCode": "0010002",
"description": "001.0000..00000.0000.000",
"companyCode": "COM001",
"code": "COM001",
"name": "Hyperion BU001 R\/E and Orphan Code2"
}
]
OUTPUT / {
"status": "Success",
"description": "1 cost center(s) added\/updated",
"payload": [
{
"added\/updated cost center(s)": [
"COM048"
]
}
]
}
3.4.1.2Add or update GeneralLedgers
HTTP METHOD / POST
API URL /
INPUT / [
{
"accountTypeCode": "MN-EQ",
"companyGeneralLedgerCode": "123",
"companyCode": "ACMENG",
"description": "desc",
"code": "COM048",
"name": "GenLedger2"
}
]
OUTPUT / {
"status": "Success",
"description": "1 general ledger(s) added\/updated",
"payload": [
{
"added\/updated general ledger (s)": [
"COM048"
]
}
]
}
3.4.1.3Add or update GL Account Types
HTTP METHOD / POST
API URL /
INPUT / [
{
"description": "Some description",
"code": "CNEW",
"name": "Name12555"
}
]
OUTPUT / {
"status": "Success",
"description": "1 general ledger account type(s) added\/updated",
"payload": [
{
"added\/updated general ledger account type(s)": [
"CNEW"
]
}
]
}
3.4.1.4Update Users
HTTP METHOD / PUT
API URL /
INPUT / [
{
"type": 2,
"displayName": "displayName",
"firstName": "firstName",
"lastName": "lastName",
"designation": "DES001",
"department": "DEPT001",
"currency": "AFN",
"numberFormat": "#,###,###.##",
"fomattedNumberFormat": "fomattedNumberFormat",
"dateFormat": "dd\/mm\/yyyy",
"timeFormat": "24 Hours",
"salutation": "Mr",
"locale": "fr",
"timeZone": "Asia\/Calcutta",
"decimalPrecision": 2,
"reportingManagerId": "2059464a-c433-4707-90c6-048f7f2494bf",
"requestUserId": "df21497c-bd40-4b18-ba18-b9a803ebc590",
"emailAddress": "",
"name": "name",
"controlCurrency": "AFN",
"spendLimit": 15.23,
"approvalLimit": 55.22,
"companyCode": "COM001",
"businessUnitCode": "COM001-BU001",
"locationCode": "LOC001",
"costCenterCode": "COM001-CC006",
"purchasingScopeCode": "PUR005",
"deliveryScope": "SELF_BEHALF",
"behalfScope": "SELF_BEHALF",
"roleNames": [
"role1",
"role2"
],
"sendWelcomeEmail": true
}
]
OUTPUT / {
"status": "Success",
"description": "1 user(s) updated",
"payload": [
{
"added\/updated user(s)": [
""
]
}
]
}
3.4.1.5Update Cost Centers status
HTTP METHOD / PUT
API URL /
QUERY PARAMS / 1)Status : TRUE
2)deactivateAllOthers : FALSE
INPUT / ["001000"]
OUTPUT / {
"status": "Success",
"description": "1 cost center(s) activated successfully",
"payload": [
{
"Description": ""
}
]
}
3.4.1.6Add or update Departments
HTTP METHOD / POST
API URL /
INPUT / [
{
"description": "DeptDesc1",
"code": "CODE3",
"name": "Dept3"
}
]
OUTPUT / {
"status": "Success",
"description": "1 department(s) added\/updated",
"payload": [
{
"added\/updated department(s)": [
"CODE3"
]
}
]
}
3.4.1.7Add or update Designations
HTTP METHOD / POST
API URL /
INPUT / [
{
"level": 1,
"description": "SomeDesc",
"code": "CODE3",
"name": "DesName1"
}
]
OUTPUT / {
"status": "Success",
"description": "1 designation(s) added\/updated",
"payload": [
{
"added\/updated designation(s)": [
"CODE3"
]
}
]
}
3.4.1.8Add or update Companies
HTTP METHOD / POST
API URL /
INPUT / [
{
"legalName": "LN",
"locationCode": "LOC001",
"currency": "AED",
"code": "COM001",
"name": "COMNAME"
}
]
OUTPUT / {
"status": "Success",
"description": "1 company(ies) added\/updated",
"payload": [
{
"added\/updated company(ies)": [
"COM001"
]
}
]
}
3.4.1.9Add or update Business Units
HTTP METHOD / POST
API URL /
INPUT / [
{
"code": null,
"name": null,
"erpId": null,
"vendorBusinessUnit": {
"code": "COM048",
"name": "Some Name",
"erpId": null,
"companyCode": "COM001",
"locationCode": "LOC001"
},
"locationCodes": [
"LOC001",
"LOC001"
]
}
]
OUTPUT / {
"status": "Success",
"description": "1 business unit(s) added\/updated",
"payload": [
{
"added\/updated business unit(s)": [
"COM048"
]
}
]
}
3.4.1.10Add or update Locations
HTTP METHOD / POST
API URL /
INPUT / [
{
"code": "LOC001",
"name": "LOC001",
"erpId": null,
"shipToCode": "ADD001",
"billToCode": "ADD001",
"invoiceToCode": "ADD001",
"regionCode": "ADD001",
"apContact": "apCont"
}
]
OUTPUT / {
"status": "Success",
"description": "1 location(s) added\/updated",
"payload": [
{
"added\/updated location(s)": [
"LOC001"
]
}
]
}
3.4.1.11Add or update Addresses
HTTP METHOD / POST
API URL /
INPUT / [
{
"code": "code5",
"name": "name13",
"erpId": null,
"line1": "line1",
"line2": "line2",
"city": "city",
"county": "country",
"state": "state",
"zip": "4110093",
"country": "India",
"phone": "195236548",
"fax": "1521234",
"email": "",
"url": "http:\/\/
"shipTo": true,
"billTo": true,
"invoiceTo": true
}
]
OUTPUT / {
"status": "Success",
"description": "1 address(es) added\/updated",
"payload": [
{
"added\/updated address(es)": [
"code5"
]
}
]
}
3.4.1.12Add or update Currency Exchange Rates
HTTP METHOD / POST
API URL /
INPUT / [
{
"fromCurrency": "USD",
"toCurrency": "CAD",
"rate": 1.2,
"inverseRate": 0
}
]
OUTPUT / {
"status": "Success",
"description": "1 currency exchange rate(s) added\/updated",
"payload": [
{
"added\/updated currency exchange rate(s)": [
"USD:CAD"
]
}
]
}
3.4.1.13Add or update Taxes
HTTP METHOD / POST
API URL /
INPUT / [
{
"code": "TestTax",
"name": "Name44",
"erpId": null,
"type": "VAT_TAX",
"rate": 11.44,
"city": "Mumbai",
"state": "Maharashtra",
"country": "India",
"county": "Mumbai",
"alwaysApplicable": true
}
]
OUTPUT / {
"status": "Success",
"description": "1 tax(es) added\/updated",
"payload": [
{
"added\/updated tax(es)": [
"TestTax"
]
}
]
}
3.4.1.14Update General Ledger status
HTTP METHOD / POST
API URL /
QUERY PARAMS / 1)Status : FALSE
2)deactivateAllOthers : FALSE
3)companyCOde : ACMENG
INPUT / ["529298","629298","526008","256002","411502"]
OUTPUT / {
"status": "Success",
"description": "5 general ledger(s) activated successfully",
"payload": [
{
"Description": ""
}
]
}

3.4.2Transactional services

3.4.2.1Get Purchase Order by id
HTTP METHOD / GET
API URL /
QUERY PARAMS / Version : 1
OUTPUT / {
"status": "Success",
"description": "purchase order found for given PO id",
"payload": [
{
"1988630e-08c7-11e4-acfb-525400854f2f": {
"purchaseOrder": {
"purchaseOrderId": "1988630e-08c7-11e4-acfb-525400854f2f",
"parentPurchaseOrderId": "",
. . .
"type": 1,
"releaseNumber": -1,
"status": 11
}
}
}
]
}

3.5SIM API

3.5.1Create Vendors

HTTP METHOD / POST
API URL /
INPUT / [
{
"zycusSupplierId": 587749,
"gsId": 34,
"vendorStatus": "DEACTIVE",
"creationDate": 1205087400000,
"modifiedDate": 1205087400000,
"approvalStatus": 1,
"isActive": false,
"systemCode": "1",
"plantId": 9931,
"zycusTokenId": "ZS_587749",
"erpTokenIds": {
"1": "520"
},
"customViews": {
"CERTIFICATIONDETAILS": {
"displayName": "Diversity Details",
"customFieldList": [],
"addToListView": true
},
"SMDMHIERARCHYTBL": {
"displayName": "Manage hierarchy",
"customFieldList": [],
"addToListView": false
},
"INSURANCEDETAILS": {
"displayName": "Insurance Details",
"customFieldList": [],
"addToListView": false
},
"COMPANYDETAILSSUPPORTDOC": {
"displayName": "Supporting Documents",
"customFieldList": [],
"addToListView": true
},
"COMPANYREFERENCES": {
"displayName": "Company References",
"customFieldList": [],
"addToListView": true
},
"PAYMENTTERMS": {
"displayName": "Payment Terms ",
"customFieldList": [],
"addToListView": false
},
"EXPORTTEST_2": {
"displayName": "EXPORTTEST_2",
"customFieldList": [],
"addToListView": true
},
"EXPORTTEST_1": {
"displayName": "EXPORTTEST_1",
"customFieldList": [],
"addToListView": false
},
"FINANCIALRATIO": {
"displayName": "Financial Ratio",
"customFieldList": [],
"addToListView": false
},
"COMPANYDETAILS": {
"displayName": "Company Details",
"customFieldList": [
{
"KEYWORD": {
"displayName": "Keyword",
"value": "ThisisKeyword"
},
"WX_RECVD_DATE": {
"displayName": "W8/W9 Received Date",
"value": null
},
"YEAR_COMP_ESTD": {
"displayName": "Year Company Established",
"value": null
},
"WEBSITE": {
"displayName": "Website",
"value": null
},
"DUNS_NUMBER": {
"displayName": "DUNs Number",
"value": ""
},
"LEGAL_COMP_NAME": {
"displayName": "Legal Name",
"value": "Pradeep"
},
"GROSS_ANNUAL_SALES": {
"displayName": "Gross Annual Sales for the last 3 yrs.",
"value": null
},
"NO_EMP": {
"displayName": "Number of Employees",
"value": null
},
"WX_FORM": {
"displayName": "W8/W9 Form",
"value": null
},
"PARENT_IDENTIFIER": {
"displayName": "Parent Identifier",
"value": null
},
"TAXID": {
"displayName": "Tax ID",
"value": ""
},
"CONF_AGREE_DOC": {
"displayName": "Confidentiality Agreement Document",
"value": null
},
"DBAID": {
"displayName": "DBAID",
"value": "587749"
},
"ULT_PARENT_NAME": {
"displayName": "Ultimate Parent Name",
"value": null
},
"NNNN_COMP_INDIC": {
"displayName": "Are you a 1099 Company ?",
"value": null
},
"SUPPLIERTOKENID": {
"displayName": "Zycus Token ID",
"value": null
},
"ZYCUSSUPPLIERID": {
"displayName": "ZYCUSSUPPLIERID",
"value": "587749"
},
"COMMENTS": {
"displayName": "Comments",
"value": null
},
"ULT_PARENT_IDENTFIER": {
"displayName": "Ultimate Parent Identifier",
"value": null
},
"LEGAL_STRUCTURE": {
"displayName": "Legal Structure",
"value": "Limited"
},
"NNNN_COMP_EXEMPTED": {
"displayName": "Is Company 1099 Exempted ?",
"value": null
},
"DISPLAYGSID": {
"displayName": "Global Supplier Identifier",
"value": "34"
},
"PARENT_NAME": {
"displayName": "Parent Name",
"value": null
},
"COMPANY_ERPID": {
"displayName": "ERP ID",
"value": null
},
"TAXID_AND_WXFORM_REQUIRED": {
"displayName": "Tax ID / W8 / W9 form not required",
"value": "Y"
},
"FORMER_COMP_NAME": {
"displayName": "Former Company Name",
"value": null
},
"GLOBAL_SUPP_IDENT": {
"displayName": "Global Supplier Identifier",
"value": "587749"
},
"TAX_ID_FORMAT": {
"displayName": "Tax ID Format",
"value": null
}
}
],
"addToListView": false
},
"BANKDETAILS": {
"displayName": "Bank Details",
"customFieldList": [],
"addToListView": false
},
"PURCHASINGDETAILS": {
"displayName": "Purchasing Details",
"customFieldList": [],
"addToListView": false
},
"ADDRESSVIEWSUPPORTDOC": {
"displayName": "Supporting Documents",
"customFieldList": [],
"addToListView": true
},
"SMDMCATEGORYTBL": {
"displayName": "Product & Services",
"customFieldList": [],
"addToListView": true
},
"SMDMMASTERTBL": {
"displayName": "DBA/Alias",
"customFieldList": [],
"addToListView": true
},
"DNB": {
"displayName": "D & B",
"customFieldList": [],
"addToListView": false
},
"CORPORATEFIELDS": {
"displayName": "Corporate Fields",
"customFieldList": [],
"addToListView": true
},
"FINANCIALINFORMATION": {
"displayName": "Financial Information",
"customFieldList": [],
"addToListView": false
},
"SMDMSPENDTBL": {
"displayName": "Spend Information",
"customFieldList": [],
"addToListView": true
}
},
"addresses": [
{
"dbaId": "",
"zycusSupplierId": "",
"addressId": "",
"isHQAddress": "N",
"isOrderToAddress": "N",
"isRemitToAddress": "Y",
"addressLine1": "ASD",
"addressLine2": null,
"addressLine3": "",
"country": "BEN",
"state": "BJ-AL",
"city": "3",
"zip": "3",
"pobox": "3",
"addressType": null,
"phone": "3",
"phoneExtension": null,
"fax": null,
"faxExtension": null,
"remitAddressId": null,
"normalizedAddress": "",
"dbaKey": null,
"editType": "1",
"addressTokenId": "",
"acctGrpId": null,
"addressErpIds": {},
"contacts": [
{
"addressId": "",
"contactType": "AR",
"firstName": "s",
"lastName": "s",
"title": "",
"email": "",
"phoneNumber": null,
"phoneExtension": null,
"cellNumber": null,
"fax": null,
"faxExtension": null,
"createPortalLogin": "N",
"portalLoginStatus": null,
"userId": null,
"portalUserId": null,
"contactId": "203653",
"zycusSupplierId": "",
"allowedPortalSideProducts": null,
"editType": "1",
"middleName": null,
"timeZone": null,
"numberFormat": null,
"dateFormat": null,
"currency": null,
"language": null,
"contactTokenId": "",
"contactErpIds": {}
}
],
"customViews": {
"SMDMADDRESSTBL": {
"displayName": "AllLocations",
"customFieldList": [],
"addToListView": true
},
"SMDMADDRESSINFACILITYTBL": {
"displayName": "MyLocations",
"customFieldList": [],
"addToListView": true
},
"ContactDetails": {
"displayName": "ContactDetails",
"customFieldList": [],
"addToListView": true
},
"RTDETAILS": {
"displayName": "RemitToAddressDetails",
"customFieldList": [],
"addToListView": true
}
}
}
]
}
]
OUTPUT / {
"status": "Success",
"description": "1 vendor(s) created successfully",
"payload": [
{
"Created Vendors": [
{
"vendor": {
"1": "520"
}
}
]
}
]
}

3.5.2Search Vendors by ID

HTTP METHOD / GET
API URL / rest/v1/sim/vendors/<vendorId>/<54
QUERY PARAMS / includeDeleted = TRUE; includePotential = TRUE
OUTPUT / {
"status": "Success",
"description": "Vendor found for vendorId : 54",
"payload": [
{
"54": {
"zycusSupplierId": 587818,
"gsId": 54,
"vendorStatus": "ACTIVE",
"creationDate": 1205173800000,
"modifiedDate": 1407349800000,
"approvalStatus": 1,
"isActive": false,
"systemCode": "2",
"plantId": 9938,
"zycusTokenId": "ZS_587818",
"erpTokenIds": {
"2": null
},
. . .
}
]
}

3.5.3Search Vendors by ID & Contacts

HTTP METHOD / GET
API URL /
QUERY PARAMS / includeDeleted = TRUE; includePotential = TRUE; searchKey = firstname; searchKeyValue = gaurav
OUTPUT / {
"status": "Success",
"description": "1 contact(s) found for vendorId = 54 and firstname = gaurav",
"payload": [
{
"203662": {
"addressId": "247727",
"contactType": "AR",
"firstName": "gaurav",
"lastName": "shah",
"title": "mr",
"email": "",
"phoneNumber": null,
"phoneExtension": null,
"cellNumber": null,
"fax": null,
"faxExtension": null,
"createPortalLogin": "N",
"portalLoginStatus": null,
"userId": null,
"portalUserId": null,
"contactId": "203662",
"zycusSupplierId": "587818",
"allowedPortalSideProducts": null,
"editType": "1",
"middleName": null,
"timeZone": null,
"numberFormat": null,
"dateFormat": null,
"currency": null,
"language": null,
"contactTokenId": "ZC_203662",
"contactErpIds": {
"2": null
}
}
}
]
}

3.5.4Search Vendors by ID & Contact ID

HTTP METHOD / GET
API URL / QUERY PARAMS / includeDeleted = TRUE; includePotential = TRUE.
OUTPUT / {
"status": "Success",
"description": "1 contact(s) found for vendorId = 54 and contactId = 203662",
"payload": [
{
"203662": {
"addressId": "247727",
"contactType": "AR",
"firstName": "gaurav",
"lastName": "shah",
"title": "mr",
"email": "",
"phoneNumber": null,
"phoneExtension": null,
"cellNumber": null,
"fax": null,
"faxExtension": null,
"createPortalLogin": "N",
"portalLoginStatus": null,
"userId": null,
"portalUserId": null,
"contactId": "203662",
"zycusSupplierId": "587818",
"allowedPortalSideProducts": null,
"editType": "1",
"middleName": null,
"timeZone": null,
"numberFormat": null,
"dateFormat": null,
"currency": null,
"language": null,
"contactTokenId": "ZC_203662",
"contactErpIds": {
"2": null
}
}
}
]
}

3.5.5Search Vendor Addresses

HTTP METHOD / GET
API URL / QUERY PARAMS / includeDeleted = TRUE; includePotential = TRUE.
OUTPUT / {
"status": "Success",
"description": "1 addresss(es) found for vendorId : 54",
"payload": [
{
"247727": {
"dbaId": "587818",
"zycusSupplierId": "587818",
"addressId": "247727",
"isHQAddress": "N",
"isOrderToAddress": "N",
"isRemitToAddress": "N",
"addressLine1": "ADDRESS",
...
"editType": "1",
"addressTokenId": "ZA_247727",
"acctGrpId": null,
"addressErpIds": {
"2": null
},
"contacts": [
{
"addressId": "247727",
"contactType": "AR",
"firstName": "gaurav",
"lastName": "shah",
"title": "mr",
"email": "",
"phoneNumber": null,
"phoneExtension": null,
"cellNumber": null,
...
"language": null,
"contactTokenId": "ZC_203662",
"contactErpIds": {
"2": null
}
}
],
"customViews": {
"SMDMADDRESSTBL": {
"displayName": "All Locations",
"customFieldList": [
],
"addToListView": true
},
"SMDMADDRESSINFACILITYTBL": {
"displayName": "My Locations",
"customFieldList": [
],
"addToListView": true
},
"ContactDetails": {
"displayName": "Contact Details",
"customFieldList": [
],
"addToListView": true
},
"RTDETAILS": {
"displayName": "Remit To Address Details",
"customFieldList": [
],
"addToListView": true
}
}
}
}
]
}

3.5.6Search MetaData

HTTP METHOD / GET
API URL / OUTPUT / {
"status": "Success",
"description": "26 MetaData view(s) found",
"payload": [
{
"MetaData Map": {
"COMPANYDETAILS": {
"simAPITag": "COMPANYDETAILS",
"viewDisplayName": "Company Details",
"templateName": "COMPANYDETAILS_245",
. . .
}
]
}

3.5.7Search Reference MetaData

HTTP METHOD / GET
API URL / QUERY PARAMS / MasterID= SMDMCOUNTRYMASTERTBL
OUTPUT / {
"status": "Success",
"description": "reference master data found",
"payload": [
{
"SMDMCOUNTRYMASTERTBL": "{\"data\":{\"result\":[{\"COUNTRYCODE\":. . .
}
]
}

3.5.8Search Vendors

HTTP METHOD / GET
API URL / OUTPUT / {
"status": "Success",
"description": "20 vendor(s) added in payload. Total vendor(s) found for given criteria : 75005",
"payload": [
{
"54": {
"zycusSupplierId": 587818,
"gsId": 54,
"vendorStatus": "ACTIVE",
"creationDate": 1205173800000,
"modifiedDate": 1407349800000,
"approvalStatus": 1,
"isActive": false,
"systemCode": "2",
"plantId": 9938,
"zycusTokenId": "ZS_587818",
"erpTokenIds": {
"2": null
}. . .
}
]
}

3.5.9Update Vendors

HTTP METHOD / POST
API URL / INPUT / [
{
"zycusSupplierId": 587818,
"gsId": 54,
"vendorStatus": "ACTIVE",
"creationDate": 1205173800000,
"modifiedDate": 1407349800000,
"approvalStatus": 1,
"isActive": false,
"systemCode": "2",
"plantId": 9938,
"zycusTokenId": "ZS_587818",
"erpTokenIds": {
"2": null
},
"customViews": {
"CERTIFICATIONDETAILS": {
"displayName": "Diversity Details",
"customFieldList": [],
"addToListView": true
},
"SMDMHIERARCHYTBL": {
"displayName": "Manage hierarchy",
"customFieldList": [],
"addToListView": false
},
"INSURANCEDETAILS": {
"displayName": "Insurance Details",
"customFieldList": [],
"addToListView": false
},
"COMPANYDETAILSSUPPORTDOC": {
"displayName": "Supporting Documents",
"customFieldList": [],
"addToListView": true
},
"COMPANYREFERENCES": {
"displayName": "Company References",
"customFieldList": [],
"addToListView": true
},
"PAYMENTTERMS": {
"displayName": "Payment Terms ",
"customFieldList": [],
"addToListView": false
},
"EXPORTTEST_2": {
"displayName": "EXPORTTEST_2",
"customFieldList": [],
"addToListView": true
},
"EXPORTTEST_1": {
"displayName": "EXPORTTEST_1",
"customFieldList": [],
"addToListView": false
},
"SUBVALUE1": {
"displayName": "subvalue1",
"customFieldList": [],
"addToListView": false
},
"FINANCIALRATIO": {
"displayName": "Financial Ratio",
"customFieldList": [],
"addToListView": false
},
"TEST": {
"displayName": "test21",
"customFieldList": [],
"addToListView": false
},
"BANKDETAILS": {
"displayName": "Bank Details",
"customFieldList": [],
"addToListView": false
},
"COMPANYDETAILS": {
"displayName": "Company Details",
"customFieldList": [
{
"KEYWORD": {
"displayName": "Keyword",
"value": null
},
"WX_RECVD_DATE": {
"displayName": "W8/W9 Received Date",
"value": null
},
"YEAR_COMP_ESTD": {
"displayName": "Year Company Established",
"value": null
},
"WEBSITE": {
"displayName": "Website",
"value": null
},
"DUNS_NUMBER": {
"displayName": "DUNs Number",
"value": ""
},
"LEGAL_COMP_NAME": {
"displayName": "Legal Name",
"value": "DD 1"
},
"GROSS_ANNUAL_SALES": {
"displayName": "Gross Annual Sales for the last 3 yrs.",
"value": null
},
"NO_EMP": {
"displayName": "Number of Employees",
"value": null
},
"WX_FORM": {
"displayName": "W8/W9 Form",
"value": null
},
"PARENT_IDENTIFIER": {
"displayName": "Parent Identifier",
"value": null
},
"TAXID": {
"displayName": "Tax ID",
"value": ""
},
"CONF_AGREE_DOC": {
"displayName": "Confidentiality Agreement Document",
"value": null
},
"DBAID": {
"displayName": "DBAID",
"value": "587818"
},
"ULT_PARENT_NAME": {
"displayName": "Ultimate Parent Name",
"value": null
},
"NNNN_COMP_INDIC": {
"displayName": "Are you a 1099 Company ?",
"value": null
},
"SUPPLIERTOKENID": {
"displayName": "Zycus Token ID",
"value": null
},
"ZYCUSSUPPLIERID": {
"displayName": "ZYCUSSUPPLIERID",
"value": "587818"
},
"COMMENTS": {
"displayName": "Comments",
"value": null
},
"ULT_PARENT_IDENTFIER": {
"displayName": "Ultimate Parent Identifier",
"value": null
},
"LEGAL_STRUCTURE": {
"displayName": "Legal Structure",
"value": "Corp"
},
"DISPLAYGSID": {
"displayName": "Global Supplier Identifier",
"value": "54"
},
"NNNN_COMP_EXEMPTED": {
"displayName": "Is Company 1099 Exempted ?",
"value": null
},
"PARENT_NAME": {
"displayName": "Parent Name",
"value": null
},
"COMPANY_ERPID": {
"displayName": "ERP ID",
"value": null
},
"TAXID_AND_WXFORM_REQUIRED": {
"displayName": "Tax ID / W8 / W9 form not required",
"value": null
},
"FORMER_COMP_NAME": {
"displayName": "Former Company Name",
"value": null
},
"GLOBAL_SUPP_IDENT": {
"displayName": "Global Supplier Identifier",
"value": "587818"
},
"TAX_ID_FORMAT": {
"displayName": "Tax ID Format",
"value": "Othr"
}
}
],
"addToListView": false
},
"PURCHASINGDETAILS": {
"displayName": "Purchasing Details",
"customFieldList": [],
"addToListView": false
},
"ADDRESSVIEWSUPPORTDOC": {
"displayName": "Supporting Documents",
"customFieldList": [],
"addToListView": true
},
"SMDMCATEGORYTBL": {
"displayName": "Product & Services",
"customFieldList": [],
"addToListView": true
},
"SMDMMASTERTBL": {
"displayName": "DBA/Alias",
"customFieldList": [],
"addToListView": true
},
"DNB": {
"displayName": "D & B",
"customFieldList": [],
"addToListView": false
},
"CORPORATEFIELDS": {
"displayName": "Corporate Fields",
"customFieldList": [],
"addToListView": true
},
"FINANCIALINFORMATION": {
"displayName": "Financial Information",
"customFieldList": [],
"addToListView": false
},
"SMDMSPENDTBL": {
"displayName": "Spend Information",
"customFieldList": [],
"addToListView": true
},
"MENULIST": {
"displayName": "MENULIST",
"customFieldList": [],
"addToListView": false
}
},
"addresses": [
{
"dbaId": "587818",
"zycusSupplierId": "587818",
"addressId": "247727",
"isHQAddress": "N",
"isOrderToAddress": "N",
"isRemitToAddress": "N",
"addressLine1": "ADDRESS",
"addressLine2": "",
"addressLine3": "",
"country": "USA",
"state": "US-MN",
"city": "TEST",
"zip": "123",
"pobox": "123",
"addressType": null,
"phone": "123",
"phoneExtension": null,
"fax": null,
"faxExtension": null,
"remitAddressId": null,
"normalizedAddress": "ADDRESS, 123, TEST, US-MN, 123, USA",
"dbaKey": null,
"editType": "1",
"addressTokenId": "ZA_247727",
"acctGrpId": null,
"addressErpIds": {
"2": null
},
"contacts": [
{
"addressId": "247727",
"contactType": "AR",
"firstName": "gaurav",
"lastName": "shah",
"title": "mr",
"email": "",
"phoneNumber": null,
"phoneExtension": null,
"cellNumber": null,
"fax": null,
"faxExtension": null,
"createPortalLogin": "N",
"portalLoginStatus": null,
"userId": null,
"portalUserId": null,
"contactId": "203662",
"zycusSupplierId": "587818",
"allowedPortalSideProducts": null,
"editType": "1",
"middleName": null,
"timeZone": null,
"numberFormat": null,
"dateFormat": null,
"currency": null,
"language": null,
"contactTokenId": "ZC_203662",
"contactErpIds": {
"2": null
}
}
],
"customViews": {
"SMDMADDRESSTBL": {
"displayName": "All Locations",
"customFieldList": [],
"addToListView": true
},
"SMDMADDRESSINFACILITYTBL": {
"displayName": "My Locations",
"customFieldList": [],
"addToListView": true
},
"ContactDetails": {
"displayName": "Contact Details",
"customFieldList": [],
"addToListView": true
},
"RTDETAILS": {
"displayName": "Remit To Address Details",
"customFieldList": [],
"addToListView": true
}
}
}
]
}
]
OUTPUT / {
"status": "Success",
"description": "1 vendor(s) updated successfully",
"payload": [
{
"Updated Vendors": [
{
"54": {
"2": null
}
}
]
}
]
}

3.5.10Update Vendor Company Details

Top View