API

Add Customers

POST sme.tradefinex/api/v1.0/Customer/MasterAdd

This endpoint allows you to add customers.

Headers

Name	Type	Description
authorization	string	JWT Token

Request Body

Name	Type	Description
emailid	string	Email ID of Customer
designationid	string	Designation
mobileno	number	Mobile Number
lastname	string	Last Name
firstname	string	First Name
noofemp	number	Number of employees
annturnover	number	Turn over of Company
currencyid	string	Currency of Country
website	string	Website Name
inccountryid	string	Country ID
telno	number	Contact Number
busactivity	string	Business Activities
incdate	string	Incorporation Date
licauth	string	License Authority name
licexpdate	string	Expiration date of license
licno	string	License number
companytypeid	integer	Type of Company
name	string	Name of customer as on trade license
customertypeid	integer	Type of Customer

200 Successful Response.

{
    "success": true,
    "message": "successful",
    "Id": 37
}

400 Any Parameter is missing it's value or improper value is added.

{
    "success": false,
    "message": "400 - Bad Request."
}

Other Details of Customer

POST sme.tradefinex/api/v1.0/Customer/DetailsAdd

This endpoint allows us to add more details of Customer.

Headers

Name	Type	Description
authorization	string	JWT Token

Request Body

Name	Type	Description
tempcustomerid	number	Customer ID
name	string	Customer's Name
countryid	number	Country Code
website	string	Website
industryid	number	Type of Industry
project	string	Projects
currencyid	number	Type of Currency
annsales	number	Annual Sales Volume
commterms	string	Commercial Terms
firstname	string	Name of Customer
lastname	string	Last Name of Customer
designationid	string	Designation of Customer
otherdesignation	string	Other designation
mobileno	number	Contact Details
emailid	string	Email ID of Customer
otherindustry	string	Other Industry details
othercommterms	string	Other Commercial terms

200 Successful Response.

{
    "success": true,
    "message": "successful",
    "Id": 15
}

400 Any parameter is missing it's value or improper value is added.

{
    "success": false,
    "message": "400 - Bad Request."
}

Customer Details

GET sme.tradefinex/api/v1.0/Customer/MasterListAll/0

Get all the Details of the Customer

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

{
        "tempcustomerid": 1,
        "uniquekey": "IND00000000000000001",
        "name": "XYZ",
        "customertypeid": 1,
        "companytypeid": 4,
        "othercompanytype": "",
        "licno": "rwetre",
        "licexpdate": "2019-02-11T18:30:00.000Z",
        "licauth": "fddg",
        "inccountryid": 101,
        "incdate": "2019-02-01T18:30:00.000Z",
        "busactivity": "test",
        "telno": "[phone]",
        "website": "test.com",
        "currencyid": 2,
        "annturnover": 34535,
        "noofemp": "434",
        "firstname": "test",
        "lastname": "test",
        "mobileno": "[phone]",
        "designationid": 17,
        "otherdesignation": "",
        "emailid": "[e-mail]",
        "status": "RR",
        "createdate": "2019-02-04T21:58:19.560Z",
        "createip": "::ffff:5.133.176.54"
    }

Detail Customer list

GET sme.tradefinex/api/v1.0/Customer/DetailsListAll/2

Get detailed customer list

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

{
        "tempcustomerdetid": 2,
        "tempcustomerid": 2,
        "uniquekey": "",
        "name": "Abc Company 123",
        "countryid": 1,
        "website": "",
        "industryid": 1,
        "otherindustry": "",
        "project": "project",
        "currencyid": 12,
        "annsales": 0,
        "commterms": "30-60 days",
        "othercommterms": "",
        "firstname": "hgfdsafhsj",
        "lastname": "30-60 days",
        "designationid": 13,
        "otherdesignation": "",
        "mobileno": "[phone]",
        "emailid": "[e-mail]",
        "createdate": "2019-02-04T22:06:05.163Z",
        "createip": "::ffff:5.133.176.54"
    }

Company Type List

GET sme.tradefinex/api/v1.0/Common/CompanyTypeList/0

Get Company Type List

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

{
        "companytypeid": 4,
        "companytypename": "General Partnership",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:19:15.190Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:19:15.190Z",
        "updateip": "192.168.1.1"
    },

Country List

GET sme.tradefinex/api/v1.0/Common/CountryList/0

Get Country List

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

{
        "countryid": 13,
        "countrycode": "AUS",
        "countryname": "Australia",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:24:39.050Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:24:39.050Z",
        "updateip": "192.168.1.1"
    }

Currency List

GET sme.tradefinex/api/v1.0/Common/CurrencyList/0

Get Currency List

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

{
        "currencyid": 11,
        "currencycode": "EUR",
        "currencyname": "Euro",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:26:26.163Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:26:26.163Z",
        "updateip": "192.168.1.1"
    }

Customer Type List

GET sme.tradefinex/api/v1.0/Common/CustomerTypeList/0

Get Customer Type List

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

[
    {
        "customertypeid": 1,
        "code": "     ",
        "name": "Beneficiery",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:22:59.770Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:22:59.770Z",
        "updateip": "192.168.1.1"
    },
    {
        "customertypeid": 2,
        "code": "     ",
        "name": "Suppliers",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:22:59.770Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:22:59.770Z",
        "updateip": "192.168.1.1"
    }
]

Customer's Designation List

GET sme.tradefinex/api/v1.0/Common/DesignationList/0

Get Customer's Designation List

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

 {
        "designationid": 9,
        "designationname": "Administration Manager",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:08:21.000Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:08:21.000Z",
        "updateip": "192.168.1.1"
    },

Industry List

GET sme.tradefinex/api/v1.0/Common/IndustryList/0

Get Industry List

Headers

Name	Type	Description
authorization	string	JWT Token

200 Successful Response

{
        "industryid": 1,
        "industryname": "Advertising and marketing / printing and publishing",
        "isactive": true,
        "createby": 1,
        "createdate": "2018-12-19T14:12:57.990Z",
        "createip": "192.168.1.1",
        "updateby": 1,
        "updatedate": "2018-12-19T14:12:57.990Z",
        "updateip": "192.168.1.1"
    }