Embedded Files
The below API is used to create Entity.
Request: POST
Signature: /api/mobile/CreateEntity?Token={Login_Token}
Body:
{ "Code":"ENTITY_CODE", "Name":"ENTITY_NAME", "Type":"ENTITY_TYPE", "Country":"ENTITY_COUNTRY_NAME", "Address":"ENTITY_ADDRESS", "Phone":"ENTITY_PHONE", "Email":"ENTITY_EMAIL1;ENTITY_EMAIL2;ENTITY_EMAIL3;", "AccountNumber":"ENTITY_ACCOUNT_NUMBER", "Currency":"ENTITY_CURRENCEY_CODE", "TIN":"ENTITY_TIN", "ContactPerson":"ENTITY_CONTACT_PERSON", "Remarks":"ENTITY_REMARK", "Disable": BOOLEAN_VALUE, "EnableAPIAccess": BOOLEAN_VALUE}Response:
{ "Code": 1, "Info": "Entity created successfully", "RowsAffected": 1, "Scalar": null, "Identity": 0, "RetInfo": null}Sample : /api/mobile/CreateEntity?Token=VomYEMiECFFyAQ3==
CASE 1: When the user is trying to create a Customer / Transporter / Clearing Agent / Bond Agent / Authority / Other Vendor.
Body:
{ "Code":"LOG12", "Name":"Logistic Pvt. Ltd.", "Type":"Customer", "Country":"Japan", "Address":"30-107,Mineyamacho Hisatsugi,Kyotango-shi,Kyoto", "Phone":"01554-54639", "Email":"info@logistics.com;sales@logistics.com",}Note: Code, Name, Type and Country are mandatory fields.
CASE 2: When the user is trying to create a Bank.
Body:
{ "Code":"Bank12", "Name":"Union Bank", "Type":"Bank", "Country":"Japan", "AccountNumber":"UNION1234BNK", "Currency":"ZEN", "ContactPerson":"Ogata Shigemori", "Remarks":"Established in 1990",}Note: Code, Name, Type, Country, Account Number and Currency are mandatory fields.CASE 3: When the user is trying to create a Carrier.
Body:
{ "Code":"Air123", "Name":"Air Asia", "Type":"Carrier", "Disable": False, "EnableAPIAccess": True}Note: Code, Name and Type are mandatory fields.Things to know about this API:
- Token - You can use Login API to get token displayed under Info
- EntityType - You can use Get Entity Types API to get the list of entity types under Value
- Multiple emails are be entered separated by comma(,) or semi-colon(;)
Page updated
Report abuse