Overview
Volody Products is a technology company that provides software solutions to help businesses automate and manage their legal contracts. Their flagship product is contract lifecycle management (CLM) followed by Litigation management, e-sign and Insider Trading Compliance Software. Volody`s solutions aim to enhance operational efficiency, reduce risks, and ensure compliance with regulatory standards for enterprises. The company serves a wide range of industries, including banking, financial services, and manufacturing, offering cloud-based platforms that enable easy collaboration and document management.
Volody`s APIs belong to the Representational State Transfer (REST) category. They allow you to perform `RESTful` operations such as reading, modifying, adding, or deleting data from your helpdesk. The APIs also support Cross-Origin Resource Sharing (CORS).
What API commands are used by Volody?
Volody`s APIs are plain JSON over HTTP and use the following HTTP verbs:
Command | Purpose |
---|---|
POST | Create an object |
GET | Fetch one or more objects |
PUT | Update an object |
DELETE | Remove an object |
Authentication
The Authentication API provides secure access control for users of the CLM software. It enables user registration, login, and management of user sessions, ensuring that only authorized individuals can access sensitive contract data. This API is essential for maintaining a secure and user-friendly authentication process within the CLM system.
URL:
JSON Request
{ "email": "c2ltcGx5QGNvbnN1bHRsYW5lLmNvbQ==", "password": "UGFzc3dkQDEyMw==" },
JSON Response
{ "passwd_changed": "false", "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYWktY2xtLXByZS52b2xvZHkuY29tXC9hcGlcL3YxXC9sb2dpbiIsImlhdCI6MTcyOTA4ODM1NiwiZXhwIjoxNzI5MDkwMTU2LCJuYmYiOjE3MjkwODgzNTYsImp0aSI6Imx2VXhuNFJaZkVwWlVXemEiLCJzdWIiOjEsInBydiI6IjIzYmQ1Yzg5NDlmNjAwYWRiMzllNzAxYzQwMDg3MmRiN2E1OTc2ZjcifQ.drFTaUOD7g2xQaUnHgUxmsJQpO_UKpPlWHJ7qe6B338", "token_type": "bearer", "expires_in": 1800000 }
Please use this access token in the header of all API requests.
access_token received in the login response have to be used as Bearer Token in all Authenticated Request Headers under the HEADER Authorization: Bearer access_token
Users API
The User Master API provides endpoints to manage user-related data within the system. It allows for creating, retrieving, updating, and deleting user information. This API is designed to handle various aspects of user management, including authentication, role assignment, and profile details.
Key Features:
Common Use Cases:
The User Master API ensures secure and efficient user management, enabling seamless integration with various systems requiring user-related functionalities.
Create User
The Create User API allows for adding new users to the system. This endpoint is used to register users by capturing essential details such as personal information, credentials, and role assignments. The API ensures secure user creation with input validation and optional integration with authentication mechanisms.
Key Features:
Common Use Cases:
The Create User API simplifies the process of user registration, ensuring that users are securely added to the system with appropriate access controls.
URL:
JSON Request
{ "first_name": "test", "last_name": "test2", "email": "test11152029@gmail.com", "phone": "7454545", "designation": "Owner2", "departmentaccess": "", "userlevel": 1, "type_of_user": 1, "parent_user_id": [ 1 ], "approver": "1", "role": 1, "company_access": [ 7 ], "branchname": "", "profile_picture_url": "", "branchdetails": "", "permission_json": "" }
JSON Response
{ "status": true, "message": "User Added Successfully!", "httpscode": 200, "Userlastid": 226 }
Update User
The Update User API allows for modifying existing user information in the system. This endpoint is designed to update user profiles, credentials, and roles while maintaining data integrity and security. It ensures that any changes to user data are validated and applied seamlessly.
Key Features:
Common Use Cases:
The Update User API ensures secure, efficient modification of user information, allowing administrators and users to keep profiles up-to-date while maintaining system integrity.
URL:
JSON Request
{ "first_name": "test", "last_name": "test2", "email": "test11102025@gmail.com", "phone": "7454545", "designation": "Owner2", "departmentaccess": 1, "userlevel": 1, "type_of_user": 1, "parent_user_id": [ 1 ], "approver": "1", "role": 1, "company_access": [ 7 ], "branchname": null, "permission_json": "{\"Contracts\":\"Complete\",\"Request Create\":\"Allow\",\"Request Delete\":\"All\",\"Physical Copy Upload\":\"Allow\",\"Stamp Paper Menu\":\"Allow\",\"MIS Export\":\"Allow\",\"Request Data Export\":\"Allow\",\"Supporting Document Delete\":\"Allow\",\"Request Email\":\"Allow\",\"Contract Expiry\":\"Allow\",\"Reports\":\"Allow\",\"Obligations\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Counter Party\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Template\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Company\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Workflow\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Contract Type\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Department\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Users\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Roles\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Clause Library\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Clause Collaboration\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Dms\":{\"Edit\":true,\"Delete\":true,\"View\":true,\"Add\":true},\"Workflow Edit\":\"Edit Complete\",\"Workflow Delete\":\"Delete Complete\"}", "location": null, "region": null, "profile_picture_url": "" }
JSON Response
{ "status": true, "message": "User updated successfully!", "data": { "id": 205, "parent_user_id": 1, "user_id": 262, "type_of_user": 1, "full_name": "test test2", "first_name": "test", "last_name": "test2", "display_names": null, "email": "test11102025@gmail.com", "phone": "7454545", "designation": "Owner2", "approver": "1", "erpcode": null, "notes": "test", "parent_group_id": 1, "expiry_date": null, "app_type": "india", "profile_picture": "test_test2_Owner2_1729077323", "company_access": "1", "company_id": 7, "branch_id": null, "role": 1, "userlevel": 1, "departmentaccess": 1, "status": 1, "passwd_changed": "false", "created_at": "11/10/2024", "updated_at": "16/10/2024", "deleted_at": null, "permission_json": { "Contracts": "Complete", "Request Create": "Allow", "Request Delete": "All", "Physical Copy Upload": "Allow", "Stamp Paper Menu": "Allow", "MIS Export": "Allow", "Request Data Export": "Allow", "Supporting Document Delete": "Allow", "Request Email": "Allow", "Contract Expiry": "Allow", "Reports": "Allow", "Obligations": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Counter Party": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Template": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Company": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Workflow": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Contract Type": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Department": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Users": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Roles": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Clause Library": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Clause Collaboration": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Dms": { "Edit": true, "Delete": true, "View": true, "Add": true }, "Workflow Edit": "Edit Complete", "Workflow Delete": "Delete Complete" }, "user_journey": { "dashboard": true, "viewcontract": true, "comapny": true, "user": true, "department": true, "legacycontract": true, "createcontract": true, "templete": true, "company": true, "companyaddeditid": true, "department_listid": true, "adddepartmentid": true, "userid": true, "adduser": true, "templetedid": true, "addtempletenew": true, "contracttypepage": true }, "location": null, "region": null, "label": "test test2 - Owner2", "display_name": "test test2" } }
Counter Party API
The Counterparty API provides endpoints to manage counterparty information within the Contract Lifecycle Management (CLM) software. This API facilitates the creation, retrieval, updating, and deletion of counterparties, ensuring that all relevant details about parties involved in contracts are accurately maintained and easily accessible.
Key Features:
Common Use Cases:
The Counterparty API ensures efficient management of counterparty data, providing a structured approach to handle all aspects of parties involved in contracts within the CLM software. This enables users to maintain accurate records and foster effective business relationships.
Create Counterparty
The Create Counterparty API enables users to add new counterparties to the Contract Lifecycle Management (CLM) software. This endpoint is designed to capture essential details about parties involved in contracts, ensuring that all relevant information is collected accurately and efficiently at the time of creation.
Key Features:
Common Use Cases:
The Create Counterparty API simplifies the process of adding new counterparties to the CLM software, ensuring that all necessary information is captured effectively and that relationships can be managed efficiently from the outset.
URL:
Request
{ "slug": "counterpartynew", "state": "1619", "counterparty_name": "test new2", "counterparty_gst": "test", "responsible_user_id": "1", "addrone": "test", "pin": "1111", "country": "103", "city": "mumbai", "counterparty_email": "test2@gmail.com", "counterparty_phone": "88555", "party_type": "1", "is_legacy": true }
Response
{ "status": true, "masterdetails": { "id": 2, "slug": "counterpartynew", "table_name": "App\\Models\\CounterPartyMaster", "api": "/counter_party", "form_json": { "form": [ { "name": "Counter Party Details", "sequence": "1", "stepfields": [ { "type": "text", "typeid": 3, "html_id": "counterparty_name", "label": "Counter Party Name", "mandatory": "", "readonlyfield": "", "mandatoryid": true, "db_column_name": "counterparty_name" }, { "type": "text", "typeid": 3, "html_id": "counterparty_gst", "label": "Counter Party Identification Number", "mandatory": "", "readonlyfield": "", "db_column_name": "counterparty_gst" }, { "type": "text", "typeid": 3, "html_id": "identifier", "label": "Additional Identifier", "mandatory": "", "readonlyfield": "", "db_column_name": "identifier" }, { "type": "Select with table", "typeid": 17, "html_id": "responsible_user_id", "name": "responsible_user_id", "label": "Responsible User", "mandatory": "", "readonlyfield": "", "db_column_name": "responsible_user_id", "option": [], "ref_table": "WebRegisterUser" } ] }, { "name": "Counter Party Contact Details", "sequence": "2", "stepfields": [ { "type": "text", "typeid": 3, "html_id": "addrone", "label": "Address Line 1 : Street Number & Name", "mandatory": "", "readonlyfield": "", "db_column_name": "addrone", "name": "point_contact_detail" }, { "type": "text", "typeid": 3, "html_id": "unit_number", "label": "Unit Number", "mandatory": "", "readonlyfield": "", "name": "addrtwo" }, { "type": "text", "typeid": 3, "html_id": "addrthree", "label": "Area", "mandatory": "", "readonlyfield": "", "db_column_name": "addrthree" }, { "type": "text", "typeid": 3, "html_id": "pin", "label": "Zip / Postal Code", "mandatory": "", "readonlyfield": "", "name": "pin" }, { "type": "Select with table", "typeid": 17, "html_id": "country", "name": "country", "label": "Country", "mandatory": "", "readonlyfield": "", "db_column_name": "country", "option": [], "ref_table": "CountryMaster" }, { "type": "Select with table", "typeid": 17, "html_id": "state", "name": "state", "label": "State", "mandatory": "", "readonlyfield": "", "db_column_name": "state", "option": [], "ref_table": "StateMaster", "additional_filter": "country", "whereCondition": "&country_id=form?.country" }, { "type": "text", "typeid": 3, "html_id": "city", "name": "city", "label": "City/ Town", "mandatory": "", "readonlyfield": "", "db_column_name": "city" }, { "type": "text", "typeid": 3, "html_id": "counterparty_email", "label": "Company Email", "mandatory": "", "readonlyfield": "", "db_column_name": "counterparty_email" }, { "type": "text", "typeid": 3, "html_id": "counterparty_phone", "label": "Company Phone", "mandatory": "", "readonlyfield": "", "db_column_name": "counterparty_phone" } ] }, { "name": "Contact Person Details", "sequence": "2", "stepfields": [ { "id": null, "type": "Table - Horizontal", "label": "", "option": [ { "input": 1, "label": "Name", "value": 0, "width": 100 }, { "input": 1, "label": "Email", "value": 1, "width": 100 }, { "input": 1, "label": "Phone", "value": 2, "width": 100 }, { "input": 1, "label": "Designation", "value": 3, "width": 100 } ], "typeid": 14, "checked": false, "html_id": "label", "labelid": true, "db_column_name": "contact_details" } ] }, { "name": "Advance Details", "sequence": "2", "stepfields": [ { "type": "Select with table", "typeid": 17, "html_id": "party_type", "name": "party_type", "label": "Counter Party Type", "mandatory": "", "readonlyfield": "", "db_column_name": "party_type", "option": [], "ref_table": "PartyType", "mandatoryid": true } ] }, { "name": "Add Additional Files", "sequence": "2", "stepfields": [ { "id": null, "type": "Table - Horizontal", "label": "", "option": [ { "input": 1, "label": "Filename", "value": 0, "width": 100 }, { "input": 2, "label": "Upload file", "value": 1, "width": 100 } ], "typeid": 14, "checked": false, "html_id": "ContactDetails", "labelid": true, "db_column_name": "contact_details" } ] } ], "listview": [], "validation": { "counterparty_name": "required", "party_type": "required" }, "validation_message": { "counterparty_name": "Counter Party field is required.", "party_type": "Counter Party Type field is required." } }, "created_at": "2024-04-30T13:28:04.000000Z", "updated_at": "2024-04-30T13:28:04.000000Z", "helpers": null, "name": "Counter Party" } }
Create Counterparty
The Create Counterparty API enables users to add new counterparties to the Contract Lifecycle Management (CLM) software. This endpoint is designed to capture essential details about parties involved in contracts, ensuring that all relevant information is collected accurately and efficiently at the time of creation.
Key Features:
Common Use Cases:
The Create Counterparty API simplifies the process of adding new counterparties to the CLM software, ensuring that all necessary information is captured effectively and that relationships can be managed efficiently from the outset.
URL:
Request
{ "slug": "counterpartynew", "state": "1619", "counterparty_name": "test new2", "counterparty_gst": "test", "responsible_user_id": "1", "addrone": "test", "pin": "1111", "country": "103", "city": "mumbai", "counterparty_email": "test2@gmail.com", "counterparty_phone": "88555", "party_type": "1", "is_legacy": true }
Response
{ "status": true, "masterdetails": { "id": 2, "slug": "counterpartynew", "table_name": "App\\Models\\CounterPartyMaster", "api": "/counter_party", "form_json": { "form": [ { "name": "Counter Party Details", "sequence": "1", "stepfields": [ { "type": "text", "typeid": 3, "html_id": "counterparty_name", "label": "Counter Party Name", "mandatory": "", "readonlyfield": "", "mandatoryid": true, "db_column_name": "counterparty_name" }, { "type": "text", "typeid": 3, "html_id": "counterparty_gst", "label": "Counter Party Identification Number", "mandatory": "", "readonlyfield": "", "db_column_name": "counterparty_gst" }, { "type": "text", "typeid": 3, "html_id": "identifier", "label": "Additional Identifier", "mandatory": "", "readonlyfield": "", "db_column_name": "identifier" }, { "type": "Select with table", "typeid": 17, "html_id": "responsible_user_id", "name": "responsible_user_id", "label": "Responsible User", "mandatory": "", "readonlyfield": "", "db_column_name": "responsible_user_id", "option": [], "ref_table": "WebRegisterUser" } ] }, { "name": "Counter Party Contact Details", "sequence": "2", "stepfields": [ { "type": "text", "typeid": 3, "html_id": "addrone", "label": "Address Line 1 : Street Number & Name", "mandatory": "", "readonlyfield": "", "db_column_name": "addrone", "name": "point_contact_detail" }, { "type": "text", "typeid": 3, "html_id": "unit_number", "label": "Unit Number", "mandatory": "", "readonlyfield": "", "name": "addrtwo" }, { "type": "text", "typeid": 3, "html_id": "addrthree", "label": "Area", "mandatory": "", "readonlyfield": "", "db_column_name": "addrthree" }, { "type": "text", "typeid": 3, "html_id": "pin", "label": "Zip / Postal Code", "mandatory": "", "readonlyfield": "", "name": "pin" }, { "type": "Select with table", "typeid": 17, "html_id": "country", "name": "country", "label": "Country", "mandatory": "", "readonlyfield": "", "db_column_name": "country", "option": [], "ref_table": "CountryMaster" }, { "type": "Select with table", "typeid": 17, "html_id": "state", "name": "state", "label": "State", "mandatory": "", "readonlyfield": "", "db_column_name": "state", "option": [], "ref_table": "StateMaster", "additional_filter": "country", "whereCondition": "&country_id=form?.country" }, { "type": "text", "typeid": 3, "html_id": "city", "name": "city", "label": "City/ Town", "mandatory": "", "readonlyfield": "", "db_column_name": "city" }, { "type": "text", "typeid": 3, "html_id": "counterparty_email", "label": "Company Email", "mandatory": "", "readonlyfield": "", "db_column_name": "counterparty_email" }, { "type": "text", "typeid": 3, "html_id": "counterparty_phone", "label": "Company Phone", "mandatory": "", "readonlyfield": "", "db_column_name": "counterparty_phone" } ] }, { "name": "Contact Person Details", "sequence": "2", "stepfields": [ { "id": null, "type": "Table - Horizontal", "label": "", "option": [ { "input": 1, "label": "Name", "value": 0, "width": 100 }, { "input": 1, "label": "Email", "value": 1, "width": 100 }, { "input": 1, "label": "Phone", "value": 2, "width": 100 }, { "input": 1, "label": "Designation", "value": 3, "width": 100 } ], "typeid": 14, "checked": false, "html_id": "label", "labelid": true, "db_column_name": "contact_details" } ] }, { "name": "Advance Details", "sequence": "2", "stepfields": [ { "type": "Select with table", "typeid": 17, "html_id": "party_type", "name": "party_type", "label": "Counter Party Type", "mandatory": "", "readonlyfield": "", "db_column_name": "party_type", "option": [], "ref_table": "PartyType", "mandatoryid": true } ] }, { "name": "Add Additional Files", "sequence": "2", "stepfields": [ { "id": null, "type": "Table - Horizontal", "label": "", "option": [ { "input": 1, "label": "Filename", "value": 0, "width": 100 }, { "input": 2, "label": "Upload file", "value": 1, "width": 100 } ], "typeid": 14, "checked": false, "html_id": "ContactDetails", "labelid": true, "db_column_name": "contact_details" } ] } ], "listview": [], "validation": { "counterparty_name": "required", "party_type": "required" }, "validation_message": { "counterparty_name": "Counter Party field is required.", "party_type": "Counter Party Type field is required." } }, "created_at": "2024-04-30T13:28:04.000000Z", "updated_at": "2024-04-30T13:28:04.000000Z", "helpers": null, "name": "Counter Party" } }
Update Counterparty
The Update Counterparty API allows users to modify existing counterparty information within the Contract Lifecycle Management (CLM) software. This endpoint is designed to ensure that all details related to counterparties remain accurate and up-to-date throughout the lifecycle of their relationships with the organization.
Key Features:
Common Use Cases:
The Update Counterparty API ensures that all modifications to counterparty data are managed securely and efficiently, enabling organizations to keep accurate records and maintain effective relationships with their business partners.
URL:
Request
{ "id": 346, "slug": "counterpartynew", "state": "1619", "counterparty_name": "test new3", "counterparty_gst": "test", "responsible_user_id": "1", "addrone": "test", "pin": "1111", "country": "103", "city": "mumbai", "counterparty_email": "teste22@gmail.com", "counterparty_phone": "88555", "party_type": "1", "is_legacy": true }
Response
{ "status": true, "masterdetails": { "id": 2, "slug": "counterpartynew", "table_name": "App\\Models\\CounterPartyMaster", "api": "/counter_party", "form_json": "{\r\n\r\n \"form\" :[\r\n {\r\n \"name\": \"Counter Party Details\",\r\n \"sequence\": \"1\",\r\n \"stepfields\": [\r\n \r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"counterparty_name\",\r\n \"label\": \"Counter Party Name\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"mandatoryid\": true,\r\n \"db_column_name\": \"counterparty_name\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n\r\n \"typeid\": 3,\r\n \"html_id\": \"counterparty_gst\",\r\n \"label\": \"Counter Party Identification Number\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"counterparty_gst\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"identifier\",\r\n \"label\": \"Additional Identifier\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"identifier\"\r\n },\r\n {\r\n \"type\": \"Select with table\",\r\n \"typeid\": 17,\r\n \"html_id\": \"responsible_user_id\",\r\n \"name\": \"responsible_user_id\",\r\n \"label\": \"Responsible User\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"responsible_user_id\",\r\n \"option\": [],\r\n \"ref_table\": \"WebRegisterUser\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"Counter Party Contact Details\",\r\n \"sequence\": \"2\",\r\n \"stepfields\": [\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"addrone\",\r\n \"label\": \"Address Line 1 : Street Number & Name\",\r\n \"mandatory\": \"\",\r\n \"mandatoryid\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"addrone\",\r\n \"name\": \"point_contact_detail\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"unit_number\",\r\n \"label\": \"Unit Number\",\r\n \"mandatoryid\": \"\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"name\": \"addrtwo\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"addrthree\",\r\n \"label\": \"Area\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"addrthree\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"pin\",\r\n \"label\": \"Zip / Postal Code\",\r\n \"mandatoryid\": \"\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"name\": \"pin\"\r\n },\r\n {\r\n \"type\": \"Select with table\",\r\n \"typeid\": 17,\r\n \"html_id\": \"country\",\r\n \"name\": \"country\",\r\n \"label\": \"Country \",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"country\",\r\n \"option\": [],\r\n \"ref_table\": \"CountryMaster\",\r\n \"max_length\": 0,\r\n \"min_length\": 0,\r\n \"reftableid\": false,\r\n \"mandatoryid\": \"\",\r\n \"onchangefnctn\": null,\r\n \"readonlyfieldid\": false,\r\n \"ref_table_alias\": \"\",\r\n \"regex_validation\": \"\",\r\n \"required_condition\": \"\",\r\n \"visibility_condition\": \"\"\r\n },\r\n {\r\n \"type\": \"Select with table\",\r\n \"typeid\": 17,\r\n \"html_id\": \"state\",\r\n \"name\": \"state\",\r\n \"label\": \"State\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"state\",\r\n \"option\": [],\r\n \"ref_table\": \"StateMaster\",\r\n \"max_length\": 0,\r\n \"min_length\": 0,\r\n \"reftableid\": false,\r\n \"mandatoryid\": \"\",\r\n \"onchangefnctn\": null,\r\n \"readonlyfieldid\": false,\r\n \"ref_table_alias\": \"\",\r\n \"regex_validation\": \"\",\r\n \"required_condition\": \"\",\r\n \"visibility_condition\": \"\",\r\n \"additional_filter_value\": null,\r\n \"additional_filter_criteria\": \"&country_id=\",\r\n \"additional_filter\": \"country\",\r\n \"whereCondition\": \"&country_id=form?.country\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"city\",\r\n \"name\": \"city\",\r\n \"label\": \"City/ Town\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"city\",\r\n \"option\": [],\r\n \"ref_table\": \"\",\r\n \"max_length\": 0,\r\n \"min_length\": 0,\r\n \"reftableid\": false,\r\n \"mandatoryid\": \"\",\r\n \"onchangefnctn\": null,\r\n \"readonlyfieldid\": false,\r\n \"ref_table_alias\": \"\",\r\n \"regex_validation\": \"\",\r\n \"required_condition\": \"\",\r\n \"visibility_condition\": \"\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"counterparty_email\",\r\n \"label\": \"Company Email\",\r\n \"mandatoryid\": \"\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"counterparty_email\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"typeid\": 3,\r\n \"html_id\": \"counterparty_phone\",\r\n \"label\": \"Company Phone\",\r\n \"mandatory\": \"\",\r\n \"mandatoryid\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"counterparty_phone\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"Contact Person Details\",\r\n \"sequence\": \"2\",\r\n \"stepfields\": [\r\n {\r\n \"id\": null, \r\n \"type\": \"Table - Horizontal\", \r\n \"label\": \"\", \r\n \"option\": \r\n [\r\n {\r\n \"input\": 1, \r\n \"label\": \"Name\", \r\n \"value\": 0, \r\n \"width\": 100\r\n }, \r\n {\"input\": 1, \r\n \"label\": \"Email\", \r\n \"value\": 1, \r\n \"width\": 100\r\n }, \r\n {\r\n \"input\": 1, \r\n \"label\": \"Phone\", \r\n \"value\": 2, \r\n \"width\": 100\r\n }, \r\n {\r\n \"input\": 1, \r\n \"label\": \"Designation\", \r\n \"value\": 3, \r\n \"width\": 100\r\n }\r\n ], \r\n \"typeid\": 14, \r\n \"checked\": false, \r\n \"html_id\": \"label\", \r\n \"labelid\": true, \r\n \"data_size\": \"\", \r\n \"fieldsize\": 3, \r\n \"mandatory\": \"\", \r\n \"max_value\": 0, \r\n \"min_value\": 0, \r\n \"ref_table\": null, \r\n \"max_length\": 0, \r\n \"min_length\": 0, \r\n \"reftableid\": false, \r\n \"mandatoryid\": false, \r\n \"onchangefnctn\": null, \r\n \"readonlyfield\": \"\", \r\n \"db_column_name\": \"contact_details\", \r\n \"readonlyfieldid\": false, \r\n \"ref_table_alias\": \"\", \r\n \"regex_validation\": \"\", \r\n \"required_condition\": \"\", \r\n \"visibility_condition\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"Advance Details\",\r\n \"sequence\": \"2\",\r\n \"stepfields\": [\r\n {\r\n \"type\": \"Select with table\",\r\n \"typeid\": 17,\r\n \"html_id\": \"party_type\",\r\n \"name\": \"party_type\",\r\n \"label\": \"Counter Party Type\",\r\n \"mandatory\": \"\",\r\n \"readonlyfield\": \"\",\r\n \"db_column_name\": \"party_type\",\r\n \"option\": [],\r\n \"ref_table\": \"PartyType\",\r\n \"max_length\": 0,\r\n \"min_length\": 0,\r\n \"reftableid\": false,\r\n \"mandatoryid\": true,\r\n \"onchangefnctn\": null,\r\n \"readonlyfieldid\": false,\r\n \"ref_table_alias\": \"\",\r\n \"regex_validation\": \"\",\r\n \"required_condition\": \"\",\r\n \"visibility_condition\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\":\"Add Additional Files\",\r\n \"sequence\":\"2\",\r\n \"stepfields\":[\r\n {\r\n \"id\":null,\r\n \"type\":\"Table - Horizontal\",\r\n \"label\":\"\",\r\n \"option\":[\r\n {\r\n \"input\":1,\r\n \"label\":\"Filename\",\r\n \"value\":0,\r\n \"width\":100\r\n },\r\n {\r\n \"input\":2,\r\n \"label\":\"Upload file\",\r\n \"value\":1,\r\n \"width\":100\r\n }\r\n ],\r\n \"typeid\":14,\r\n \"checked\":false,\r\n \"html_id\":\"ContactDetails\",\r\n \"labelid\":true,\r\n \"data_size\":\"\",\r\n \"fieldsize\":3,\r\n \"mandatory\":\"\",\r\n \"max_value\":0,\r\n \"min_value\":0,\r\n \"ref_table\":null,\r\n \"max_length\":0,\r\n \"min_length\":0,\r\n \"reftableid\":false,\r\n \"mandatoryid\":false,\r\n \"onchangefnctn\":null,\r\n \"readonlyfield\":\"\",\r\n \"db_column_name\":\"contact_details\",\r\n \"readonlyfieldid\":false,\r\n \"ref_table_alias\":\"\",\r\n \"regex_validation\":\"\",\r\n \"required_condition\":\"\",\r\n \"visibility_condition\":\"\"\r\n }\r\n ]\r\n }\r\n ],\r\n\r\n \"listview\" : [],\r\n\r\n \"validation\" : {\r\n \"counterparty_name\": \"required\",\r\n \"party_type\": \"required\"\r\n },\r\n \"validation_message\" : {\r\n \"counterparty_name\": \"Counter Party field is required.\",\r\n \"party_type\": \"Counter Party Type field is required.\"\r\n }\r\n }", "created_at": "2024-04-30T13:28:04.000000Z", "updated_at": "2024-04-30T13:28:04.000000Z", "helpers": null, "name": "Counter Party" }, "message": "Counter Party Added", "data": { "state": "1619", "counterparty_name": "test new2", "counterparty_gst": "test", "responsible_user_id": "1", "addrone": "test", "pin": "1111", "country": "103", "city": "mumbai", "counterparty_email": "test2@gmail.com", "counterparty_phone": "88555", "party_type": "1", "jsonFieldData": "{\"state\":\"1619\",\"counterparty_name\":\"test new2\",\"counterparty_gst\":\"test\",\"responsible_user_id\":\"1\",\"addrone\":\"test\",\"pin\":\"1111\",\"country\":\"103\",\"city\":\"mumbai\",\"counterparty_email\":\"test2@gmail.com\",\"counterparty_phone\":\"88555\",\"party_type\":\"1\",\"is_legacy\":true}", "user_id": 1, "updated_at": "2024-10-16T13:49:30.000000Z", "created_at": "2024-10-16T13:49:30.000000Z", "id": 366, "contact_person_details": null } }
Contract
The Contract API provides endpoints to manage contracts within the system, allowing for the creation, retrieval, updating, and deletion of contract-related information. It enables users to handle all aspects of contract lifecycle management, including details such as contract terms, parties involved, financials, and status tracking.
Key Features:
Common Use Cases:
The Contract API streamlines contract lifecycle management by providing a comprehensive set of features for creating, updating, and maintaining contract data, ensuring efficient handling of business agreements and obligations.
Create a Contract
The Create Contract API allows for the addition of new contracts to the system, facilitating the capture of all necessary details required for managing agreements between parties. This endpoint is designed to ensure that all essential contract information, including financials, parties involved, and terms, are properly captured and validated.
Key Features:
Common Use Cases:
The Create Contract API simplifies the process of adding new agreements to the system, ensuring that all necessary information is captured accurately while supporting validation and customization for various contract types.
URL:
Request
{ "Company": 1, "department_name": 1, "Contract": 33204, "CounterParty": 252, "StartDate": "2024-10-10", "EndDate": "2024-10-12", "Currency": 1, "Amount": 101, "country": 103, "state": 1619, "City": "mumbai2", "person_responsible": 1, "expiry_reminder_days": 78, "is_legacy": true, "slug": "legacycontractnew" }
Response
{ "status": true, "masterdetails": { "id": 1, "slug": "legacycontractnew", "table_name": "App\\Models\\LegacyMaster", "api": "/legacy_contracts", "form_json": "{\n \"form\": [\n {\n \"name\": \"Legacy Contracts\",\n \"sequence\": \"1\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Company\",\n \"labelid\": true,\n \"html_id\": \"Company\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConCompanymaster\",\n \"reftableid\": false,\n \"db_column_name\": \"company_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Contract Name\",\n \"labelid\": true,\n \"html_id\": \"Contract\",\n \"name\": \"contractname\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"MasterAgreement\",\n \"reftableid\": false,\n \"db_column_name\": \"maid\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Department Name\",\n \"labelid\": true,\n \"html_id\": \"department_name\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConDept\",\n \"reftableid\": false,\n \"db_column_name\": \"dept_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Counterparty details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Counter Party\",\n \"labelid\": true,\n \"html_id\": \"CounterParty\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConCounterpartymaster\",\n \"reftableid\": false,\n \"db_column_name\": \"cparty_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Contract details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 7,\n \"label\": \"Start Date\",\n \"labelid\": true,\n \"html_id\": \"StartDate\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"startdate\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 7,\n \"label\": \"End Date\",\n \"labelid\": true,\n \"html_id\": \"EndDate\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"enddate\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Currency\",\n \"labelid\": true,\n \"html_id\": \"Currency\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"MasterCurrency\",\n \"reftableid\": false,\n \"db_column_name\": \"currency\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Amount\",\n \"labelid\": true,\n \"html_id\": \"Amount\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"amount\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Location details\",\n \"sequence\": \"1\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"html_id\": \"country\",\n \"name\": \"country\",\n \"label\": \"Country\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"country\",\n \"option\": [],\n \"ref_table\": \"CountryMaster\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"html_id\": \"state\",\n \"name\": \"state\",\n \"label\": \"State\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"state\",\n \"option\": [],\n \"ref_table\": \"StateMaster\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \n \"whereCondition\": \"&country_id=form?.country\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"html_id\": \"City\",\n \"name\": \"city\",\n \"label\": \"City\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"city\",\n \"option\": [],\n \"ref_table\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\"\n }\n ]\n },\n {\n \"name\": \"Responsibility and Expiry details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Person Responsible\",\n \"labelid\": true,\n \"html_id\": \"person_responsible\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"WebRegisterUser\",\n \"reftableid\": false,\n \"db_column_name\": \"person_responsible\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"number\",\n \"typeid\": 11,\n \"label\": \"Expiry Reminder Days\",\n \"labelid\": true,\n \"html_id\": \"expiry_reminder_days\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": true,\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"expiry_reminder_days\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Remarks\",\n \"labelid\": true,\n \"html_id\": \"remarks\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"remarks\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Parent id\",\n \"labelid\": true,\n \"html_id\": \"parent_id\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"parent_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Contract Type\",\n \"labelid\": true,\n \"html_id\": \"contract_type\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"contract_type\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Upload Document\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"type\": \"file\",\n \"label\": \"upload\",\n \"option\": [],\n \"typeid\": 99,\n \"html_id\": \"upload\",\n \"labelid\": true,\n \"data_size\": \"\",\n \"fieldsize\": 3,\n \"mandatory\": \"\",\n \"max_value\": 0,\n \"min_value\": 0,\n \"ref_table\": null,\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": false,\n \"onchangefnctn\": null,\n \"readonlyfield\": \"\",\n \"db_column_name\": \"upload\",\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"showname\": true\n }\n ]\n }\n ],\n \"listview\": [],\n \"validation\": {\n \"Company\": \"required\",\n \"Contract\": \"required\",\n \"department_name\": \"required\",\n \"CounterParty\": \"required\",\n \"StartDate\": \"required\",\n \"EndDate\": \"required\",\n \"Currency\": \"required\",\n \"Amount\": \"required \",\n \"country\": \"required\",\n \"state\": \"required\",\n \"City\": \"required\",\n \"person_responsible\": \"required\",\n \"expiry_reminder_days\": \"required\"\n },\n \"validation_message\": {\n \"Company\": \"Company field is required.\",\n \"Contract\": \"Contract Name field is required.\",\n \"department_name\": \"Department Name field is required.\",\n \"CounterParty\": \"Counter Party field is required.\",\n \"StartDate\": \"Start Date field is required.\",\n \"EndDate\": \"End Date field is required.\",\n \"Currency\": \"Currency field is required.\",\n \"Amount\": \"Amount field is required.\",\n \"country\": \"Country field is required.\",\n \"state\": \"State field is required.\",\n \"City\": \"City field is required.\",\n \"person_responsible\": \"Person Responsible field is required.\",\n \"expiry_reminder_days\": \"Expiry Reminder Days field is required\"\n }\n}", "created_at": "2024-04-30T13:28:00.000000Z", "updated_at": "2024-10-09T09:07:35.000000Z", "helpers": "App\\Services\\Legacy\\Creator", "name": "Legacy Contract" }, "message": "Legacy Contract Added", "data": { "department_name": "1", "country": "103", "state": "1619", "person_responsible": "1", "expiry_reminder_days": "78", "jsonFieldData": "{\"Company\":\"1\",\"department_name\":\"1\",\"Contract\":\"33204\",\"CounterParty\":\"252\",\"StartDate\":\"2024-10-10\",\"EndDate\":\"2024-10-12\",\"Currency\":\"1\",\"Amount\":\"101\",\"country\":\"103\",\"state\":\"1619\",\"City\":\"mumbai2\",\"person_responsible\":\"1\",\"expiry_reminder_days\":\"78\",\"is_legacy\":\"true\"}", "user_id": 1, "updated_at": "2024-10-17T05:37:06.000000Z", "created_at": "2024-10-17T05:37:06.000000Z", "id": 854 } }
Create a Contract
The Create Contract API allows for the addition of new contracts to the system, facilitating the capture of all necessary details required for managing agreements between parties. This endpoint is designed to ensure that all essential contract information, including financials, parties involved, and terms, are properly captured and validated.
Key Features:
Common Use Cases:
The Create Contract API simplifies the process of adding new agreements to the system, ensuring that all necessary information is captured accurately while supporting validation and customization for various contract types.
URL:
Request
{ "Company": 1, "department_name": 1, "Contract": 33204, "CounterParty": 252, "StartDate": "2024-10-10", "EndDate": "2024-10-12", "Currency": 1, "Amount": 101, "country": 103, "state": 1619, "City": "mumbai2", "person_responsible": 1, "expiry_reminder_days": 78, "is_legacy": true, "slug": "legacycontractnew" }
Response
{ "status": true, "masterdetails": { "id": 1, "slug": "legacycontractnew", "table_name": "App\\Models\\LegacyMaster", "api": "/legacy_contracts", "form_json": "{\n \"form\": [\n {\n \"name\": \"Legacy Contracts\",\n \"sequence\": \"1\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Company\",\n \"labelid\": true,\n \"html_id\": \"Company\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConCompanymaster\",\n \"reftableid\": false,\n \"db_column_name\": \"company_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Contract Name\",\n \"labelid\": true,\n \"html_id\": \"Contract\",\n \"name\": \"contractname\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"MasterAgreement\",\n \"reftableid\": false,\n \"db_column_name\": \"maid\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Department Name\",\n \"labelid\": true,\n \"html_id\": \"department_name\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConDept\",\n \"reftableid\": false,\n \"db_column_name\": \"dept_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Counterparty details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Counter Party\",\n \"labelid\": true,\n \"html_id\": \"CounterParty\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConCounterpartymaster\",\n \"reftableid\": false,\n \"db_column_name\": \"cparty_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Contract details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 7,\n \"label\": \"Start Date\",\n \"labelid\": true,\n \"html_id\": \"StartDate\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"startdate\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 7,\n \"label\": \"End Date\",\n \"labelid\": true,\n \"html_id\": \"EndDate\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"enddate\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Currency\",\n \"labelid\": true,\n \"html_id\": \"Currency\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"MasterCurrency\",\n \"reftableid\": false,\n \"db_column_name\": \"currency\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Amount\",\n \"labelid\": true,\n \"html_id\": \"Amount\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"amount\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Location details\",\n \"sequence\": \"1\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"html_id\": \"country\",\n \"name\": \"country\",\n \"label\": \"Country\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"country\",\n \"option\": [],\n \"ref_table\": \"CountryMaster\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"html_id\": \"state\",\n \"name\": \"state\",\n \"label\": \"State\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"state\",\n \"option\": [],\n \"ref_table\": \"StateMaster\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \n \"whereCondition\": \"&country_id=form?.country\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"html_id\": \"City\",\n \"name\": \"city\",\n \"label\": \"City\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"city\",\n \"option\": [],\n \"ref_table\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\"\n }\n ]\n },\n {\n \"name\": \"Responsibility and Expiry details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Person Responsible\",\n \"labelid\": true,\n \"html_id\": \"person_responsible\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"WebRegisterUser\",\n \"reftableid\": false,\n \"db_column_name\": \"person_responsible\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"number\",\n \"typeid\": 11,\n \"label\": \"Expiry Reminder Days\",\n \"labelid\": true,\n \"html_id\": \"expiry_reminder_days\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": true,\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"expiry_reminder_days\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Remarks\",\n \"labelid\": true,\n \"html_id\": \"remarks\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"remarks\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Parent id\",\n \"labelid\": true,\n \"html_id\": \"parent_id\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"parent_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Contract Type\",\n \"labelid\": true,\n \"html_id\": \"contract_type\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"contract_type\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Upload Document\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"type\": \"file\",\n \"label\": \"upload\",\n \"option\": [],\n \"typeid\": 99,\n \"html_id\": \"upload\",\n \"labelid\": true,\n \"data_size\": \"\",\n \"fieldsize\": 3,\n \"mandatory\": \"\",\n \"max_value\": 0,\n \"min_value\": 0,\n \"ref_table\": null,\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": false,\n \"onchangefnctn\": null,\n \"readonlyfield\": \"\",\n \"db_column_name\": \"upload\",\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"showname\": true\n }\n ]\n }\n ],\n \"listview\": [],\n \"validation\": {\n \"Company\": \"required\",\n \"Contract\": \"required\",\n \"department_name\": \"required\",\n \"CounterParty\": \"required\",\n \"StartDate\": \"required\",\n \"EndDate\": \"required\",\n \"Currency\": \"required\",\n \"Amount\": \"required \",\n \"country\": \"required\",\n \"state\": \"required\",\n \"City\": \"required\",\n \"person_responsible\": \"required\",\n \"expiry_reminder_days\": \"required\"\n },\n \"validation_message\": {\n \"Company\": \"Company field is required.\",\n \"Contract\": \"Contract Name field is required.\",\n \"department_name\": \"Department Name field is required.\",\n \"CounterParty\": \"Counter Party field is required.\",\n \"StartDate\": \"Start Date field is required.\",\n \"EndDate\": \"End Date field is required.\",\n \"Currency\": \"Currency field is required.\",\n \"Amount\": \"Amount field is required.\",\n \"country\": \"Country field is required.\",\n \"state\": \"State field is required.\",\n \"City\": \"City field is required.\",\n \"person_responsible\": \"Person Responsible field is required.\",\n \"expiry_reminder_days\": \"Expiry Reminder Days field is required\"\n }\n}", "created_at": "2024-04-30T13:28:00.000000Z", "updated_at": "2024-10-09T09:07:35.000000Z", "helpers": "App\\Services\\Legacy\\Creator", "name": "Legacy Contract" }, "message": "Legacy Contract Added", "data": { "department_name": "1", "country": "103", "state": "1619", "person_responsible": "1", "expiry_reminder_days": "78", "jsonFieldData": "{\"Company\":\"1\",\"department_name\":\"1\",\"Contract\":\"33204\",\"CounterParty\":\"252\",\"StartDate\":\"2024-10-10\",\"EndDate\":\"2024-10-12\",\"Currency\":\"1\",\"Amount\":\"101\",\"country\":\"103\",\"state\":\"1619\",\"City\":\"mumbai2\",\"person_responsible\":\"1\",\"expiry_reminder_days\":\"78\",\"is_legacy\":\"true\"}", "user_id": 1, "updated_at": "2024-10-17T05:37:06.000000Z", "created_at": "2024-10-17T05:37:06.000000Z", "id": 854 } }
Update Contract
The Update Contract API allows for modifying existing contract information within the system. This endpoint is designed to enable users to change various aspects of a contract, ensuring that all details remain accurate and up-to-date throughout the contract`s lifecycle.
Key Features:
Common Use Cases:
The Update Contract API ensures that all modifications to contract data are handled securely and efficiently, enabling users to keep contract information accurate and aligned with current business needs.
URL:
Request
{ "Company": 1, "department_name": 1, "Contract": 33204, "CounterParty": 252, "StartDate": "2024-10-10", "EndDate": "2024-10-12", "Currency": 1, "Amount": 101, "country": 103, "state": 1619, "City": "mumbai2", "person_responsible": 1, "expiry_reminder_days": 78, "is_legacy": true, "slug": "legacycontractnew", "id": 853 }
Response
{ "status": true, "masterdetails": { "id": 1, "slug": "legacycontractnew", "table_name": "App\\Models\\LegacyMaster", "api": "/legacy_contracts", "form_json": "{\n \"form\": [\n {\n \"name\": \"Legacy Contracts\",\n \"sequence\": \"1\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Company\",\n \"labelid\": true,\n \"html_id\": \"Company\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConCompanymaster\",\n \"reftableid\": false,\n \"db_column_name\": \"company_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Contract Name\",\n \"labelid\": true,\n \"html_id\": \"Contract\",\n \"name\": \"contractname\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"MasterAgreement\",\n \"reftableid\": false,\n \"db_column_name\": \"maid\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Department Name\",\n \"labelid\": true,\n \"html_id\": \"department_name\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConDept\",\n \"reftableid\": false,\n \"db_column_name\": \"dept_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Counterparty details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Counter Party\",\n \"labelid\": true,\n \"html_id\": \"CounterParty\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"ConCounterpartymaster\",\n \"reftableid\": false,\n \"db_column_name\": \"cparty_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Contract details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 7,\n \"label\": \"Start Date\",\n \"labelid\": true,\n \"html_id\": \"StartDate\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"startdate\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 7,\n \"label\": \"End Date\",\n \"labelid\": true,\n \"html_id\": \"EndDate\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"enddate\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Currency\",\n \"labelid\": true,\n \"html_id\": \"Currency\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"MasterCurrency\",\n \"reftableid\": false,\n \"db_column_name\": \"currency\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Amount\",\n \"labelid\": true,\n \"html_id\": \"Amount\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"amount\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Location details\",\n \"sequence\": \"1\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"html_id\": \"country\",\n \"name\": \"country\",\n \"label\": \"Country\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"country\",\n \"option\": [],\n \"ref_table\": \"CountryMaster\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"html_id\": \"state\",\n \"name\": \"state\",\n \"label\": \"State\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"state\",\n \"option\": [],\n \"ref_table\": \"StateMaster\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \n \"whereCondition\": \"&country_id=form?.country\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"html_id\": \"City\",\n \"name\": \"city\",\n \"label\": \"City\",\n \"mandatory\": \"\",\n \"readonlyfield\": \"\",\n \"db_column_name\": \"city\",\n \"option\": [],\n \"ref_table\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": true,\n \"onchangefnctn\": null,\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\"\n }\n ]\n },\n {\n \"name\": \"Responsibility and Expiry details\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"id\": null,\n \"type\": \"Select with table\",\n \"typeid\": 17,\n \"label\": \"Person Responsible\",\n \"labelid\": true,\n \"html_id\": \"person_responsible\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": \"WebRegisterUser\",\n \"reftableid\": false,\n \"db_column_name\": \"person_responsible\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"number\",\n \"typeid\": 11,\n \"label\": \"Expiry Reminder Days\",\n \"labelid\": true,\n \"html_id\": \"expiry_reminder_days\",\n \"fieldsize\": 3,\n \"mandatoryid\": true,\n \"mandatory\": true,\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"expiry_reminder_days\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Remarks\",\n \"labelid\": true,\n \"html_id\": \"remarks\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"remarks\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Parent id\",\n \"labelid\": true,\n \"html_id\": \"parent_id\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"parent_id\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n },\n {\n \"id\": null,\n \"type\": \"text\",\n \"typeid\": 3,\n \"label\": \"Contract Type\",\n \"labelid\": true,\n \"html_id\": \"contract_type\",\n \"fieldsize\": 3,\n \"mandatoryid\": false,\n \"mandatory\": \"\",\n \"readonlyfieldid\": false,\n \"readonlyfield\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"max_length\": 0,\n \"min_length\": 0,\n \"max_value\": 0,\n \"min_value\": 0,\n \"regex_validation\": \"\",\n \"option\": [],\n \"ref_table\": null,\n \"reftableid\": false,\n \"db_column_name\": \"contract_type\",\n \"ref_table_alias\": \"\",\n \"data_size\": \"\"\n }\n ]\n },\n {\n \"name\": \"Upload Document\",\n \"sequence\": \"2\",\n \"stepfields\": [\n {\n \"type\": \"file\",\n \"label\": \"upload\",\n \"option\": [],\n \"typeid\": 99,\n \"html_id\": \"upload\",\n \"labelid\": true,\n \"data_size\": \"\",\n \"fieldsize\": 3,\n \"mandatory\": \"\",\n \"max_value\": 0,\n \"min_value\": 0,\n \"ref_table\": null,\n \"max_length\": 0,\n \"min_length\": 0,\n \"reftableid\": false,\n \"mandatoryid\": false,\n \"onchangefnctn\": null,\n \"readonlyfield\": \"\",\n \"db_column_name\": \"upload\",\n \"readonlyfieldid\": false,\n \"ref_table_alias\": \"\",\n \"regex_validation\": \"\",\n \"required_condition\": \"\",\n \"visibility_condition\": \"\",\n \"showname\": true\n }\n ]\n }\n ],\n \"listview\": [],\n \"validation\": {\n \"Company\": \"required\",\n \"Contract\": \"required\",\n \"department_name\": \"required\",\n \"CounterParty\": \"required\",\n \"StartDate\": \"required\",\n \"EndDate\": \"required\",\n \"Currency\": \"required\",\n \"Amount\": \"required \",\n \"country\": \"required\",\n \"state\": \"required\",\n \"City\": \"required\",\n \"person_responsible\": \"required\",\n \"expiry_reminder_days\": \"required\"\n },\n \"validation_message\": {\n \"Company\": \"Company field is required.\",\n \"Contract\": \"Contract Name field is required.\",\n \"department_name\": \"Department Name field is required.\",\n \"CounterParty\": \"Counter Party field is required.\",\n \"StartDate\": \"Start Date field is required.\",\n \"EndDate\": \"End Date field is required.\",\n \"Currency\": \"Currency field is required.\",\n \"Amount\": \"Amount field is required.\",\n \"country\": \"Country field is required.\",\n \"state\": \"State field is required.\",\n \"City\": \"City field is required.\",\n \"person_responsible\": \"Person Responsible field is required.\",\n \"expiry_reminder_days\": \"Expiry Reminder Days field is required\"\n }\n}", "created_at": "2024-04-30T13:28:00.000000Z", "updated_at": "2024-10-09T09:07:35.000000Z", "helpers": "App\\Services\\Legacy\\Creator", "name": "Legacy Contract" }, "message": "Legacy Contract Updated", "data": { "id": 853, "rqid": 1769, "user_id": 1, "company": null, "contract": null, "department_name": "1", "counterparty": null, "startdate": null, "enddate": null, "currency": null, "amount": 0, "state": "1619", "city": null, "country": "103", "person_responsible": "1", "expiry_reminder_days": "78", "remarks": null, "upload": null, "jsonFieldData": "{\"Company\":\"1\",\"department_name\":\"1\",\"Contract\":\"33204\",\"CounterParty\":\"252\",\"StartDate\":\"2024-10-10\",\"EndDate\":\"2024-10-12\",\"Currency\":\"1\",\"Amount\":\"101\",\"country\":\"103\",\"state\":\"1619\",\"City\":\"mumbai2\",\"person_responsible\":\"1\",\"expiry_reminder_days\":\"78\",\"is_legacy\":\"true\"}", "status": 0, "created_at": "2024-10-16T14:19:25.000000Z", "updated_at": "2024-10-16T14:21:08.000000Z" } }
Error Code
In addition to the the error message, the error response will also contain a error code that is machine-parseable. The following table lists the error codes and their descriptions.
Command | Purpose |
---|---|
missing_field | A mandatory attribute is missing. For example, calling Create a Contact without the mandatory email field in the request will result in this error. |
invalid_value | This code indicates that a request contained an incorrect or blank value, or was in an invalid format. |
duplicate_value | Indicates that this value already exists. This error is applicable to fields that require unique values such as the email address in a contact or the name in a company. |
datatype_mismatch | Indicates that the field value doesn`t match the expected data type. Entering text in a numerical field would trigger this error. |
ChangeLog
Oct 2024
- This changelog outlines the major features introduced, the structure of the API, and any standard functionalities or error handling mechanisms added. Since it’s the first version, there are no previous bug fixes or deprecated features. This includes endpoints in the API documentation relating to authentication, user master, counterparty master, contract data and error logs.