{ "info": { "name": "Lokta API", "description": "The Lokta API, version 2026.11.0. Set the username, password and tenant variables on the collection before the first request. Reference: https://developer.lokta.ai/api/", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{username}}", "type": "string" }, { "key": "password", "value": "{{password}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://default.lokta.tech" }, { "key": "username", "value": "" }, { "key": "password", "value": "" }, { "key": "tenant", "value": "default" } ], "item": [ { "name": "Borrowers", "item": [ { "name": "Customers", "description": "The people and businesses who borrow: onboarding, identifiers, addresses, family members, charges and search.", "item": [ { "name": "Retrieve client address template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/client/addresses/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "client", "addresses", "template" ] }, "description": "Returns the address template: the code-value options offered when adding a client address.\n\nhttps://developer.lokta.ai/api/customers/retrieve-template-client-address/" } }, { "name": "List all addresses for a Client", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/client/:clientid/addresses", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "client", ":clientid", "addresses" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "status" }, { "key": "type", "value": "", "disabled": true, "description": "type" } ], "variable": [ { "key": "clientid", "value": "" } ] }, "description": "Lists the addresses stored for one client.\n\nhttps://developer.lokta.ai/api/customers/retrieve-all-client-addresses/" } }, { "name": "Create an address for a Client", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/client/:clientid/addresses", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "client", ":clientid", "addresses" ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "type" } ], "variable": [ { "key": "clientid", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"addressId\": 1,\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"addressTypeId\": 1,\n \"city\": \"string\",\n \"countryId\": 1,\n \"countyDistrict\": \"string\",\n \"createdBy\": \"string\",\n \"createdOn\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds an address to a client.\n\nhttps://developer.lokta.ai/api/customers/create-client-address/" } }, { "name": "Update an address for a Client", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/client/:clientid/addresses", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "client", ":clientid", "addresses" ], "variable": [ { "key": "clientid", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"addressId\": 1,\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"addressTypeId\": 1,\n \"city\": \"string\",\n \"countryId\": 1,\n \"countyDistrict\": \"string\",\n \"createdBy\": \"string\",\n \"createdOn\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "All the address fields can be updated by using update client address API.\n\nhttps://developer.lokta.ai/api/customers/update-client-address/" } }, { "name": "List Clients", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients" ], "query": [ { "key": "officeId", "value": "", "disabled": true, "description": "officeId" }, { "key": "externalId", "value": "", "disabled": true, "description": "externalId" }, { "key": "displayName", "value": "", "disabled": true, "description": "displayName" }, { "key": "firstName", "value": "", "disabled": true, "description": "firstName" }, { "key": "lastName", "value": "", "disabled": true, "description": "lastName" }, { "key": "status", "value": "", "disabled": true, "description": "status" }, { "key": "underHierarchy", "value": "", "disabled": true, "description": "underHierarchy" }, { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" }, { "key": "orderBy", "value": "", "disabled": true, "description": "orderBy" }, { "key": "sortOrder", "value": "", "disabled": true, "description": "sortOrder" }, { "key": "legalForm", "value": "", "disabled": true }, { "key": "staffId", "value": "", "disabled": true, "description": "staffId" } ] }, "description": "The list capability of clients can support pagination and sorting.\n\nhttps://developer.lokta.ai/api/customers/retrieve-all-clients/" } }, { "name": "Create a Client", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients" ] }, "body": { "mode": "raw", "raw": "{\n \"activationDate\": \"04 March 2009\",\n \"active\": true,\n \"address\": [\n {\n \"addressId\": 1,\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\"\n }\n ],\n \"datatables\": [\n {\n \"data\": \"data\",\n \"registeredTableName\": \"Client Beneficiary information\"\n }\n ],\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dateOfBirth\": \"19 August 2026\",\n \"emailAddress\": \"test@test.com\",\n \"externalId\": \"123\",\n \"firstname\": \"Client_FirstName\",\n \"fullname\": \"Client full name\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a client, the borrower record that loans are applied against.\n\nhttps://developer.lokta.ai/api/customers/create-client/" } }, { "name": "Retrieve Client Details Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", "template" ], "query": [ { "key": "officeId", "value": "", "disabled": true, "description": "officeId" }, { "key": "commandParam", "value": "", "disabled": true, "description": "commandParam" }, { "key": "staffInSelectedOfficeOnly", "value": "", "disabled": true, "description": "staffInSelectedOfficeOnly" } ] }, "description": "Returns the field defaults and allowed values for creating a client.\n\nhttps://developer.lokta.ai/api/customers/retrieve-template-client/" } }, { "name": "Retrieve a Client", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId" ], "query": [ { "key": "staffInSelectedOfficeOnly", "value": "", "disabled": true, "description": "staffInSelectedOfficeOnly" } ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "Returns one client by id, with the client's status, office and contact details.\n\nhttps://developer.lokta.ai/api/customers/retrieve-one-client/" } }, { "name": "Update a Client", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId" ], "variable": [ { "key": "clientId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"786444UUUYYH7\",\n \"firstname\": \"Client_FirstName\",\n \"lastname\": \"Client_LastName\",\n \"resourceExternalId\": \"123-456\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Changing the relationship between a client and its office is not supported through this API. An API specific to handling transfers of clients between offices is available for the same.\n\nhttps://developer.lokta.ai/api/customers/update-client/" } }, { "name": "Delete a Client", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId" ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "If a client is in Pending state, you are allowed to Delete it. The delete is a 'hard delete' and cannot be recovered from. Once clients become active or have loans associated with them, you cannot delete the client but you may Close the client if they have left the program.\n\nhttps://developer.lokta.ai/api/customers/delete-client/" } }, { "name": "Retrieve client accounts overview", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/accounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "accounts" ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application.\n\nhttps://developer.lokta.ai/api/customers/retrieve-all-client-accounts/" } }, { "name": "List all client family members", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/familymembers", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "familymembers" ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "Lists the family members recorded for a client.\n\nhttps://developer.lokta.ai/api/customers/retrieve-all-client-family-members/" } }, { "name": "Add a client family member", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/familymembers", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "familymembers" ], "variable": [ { "key": "clientId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"age\": 1,\n \"clientId\": 1,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dateOfBirth\": \"19 August 2026\",\n \"familyMembers\": \"string\",\n \"firstName\": \"string\",\n \"genderId\": 1,\n \"id\": 1,\n \"isDependent\": true,\n \"lastName\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds a family member to a client.\n\nhttps://developer.lokta.ai/api/customers/create-client-family-member/" } }, { "name": "Retrieve client family member template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/familymembers/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "familymembers", "template" ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "Returns the options offered when adding a client family member.\n\nhttps://developer.lokta.ai/api/customers/retrieve-template-client-family-member/" } }, { "name": "Retrieve a client family member", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/familymembers/:familyMemberId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "familymembers", ":familyMemberId" ], "variable": [ { "key": "clientId", "value": "" }, { "key": "familyMemberId", "value": "" } ] }, "description": "Returns one family member of a client.\n\nhttps://developer.lokta.ai/api/customers/retrieve-one-client-family-member/" } }, { "name": "Update a client family member", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/familymembers/:familyMemberId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "familymembers", ":familyMemberId" ], "variable": [ { "key": "clientId", "value": "" }, { "key": "familyMemberId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"age\": 1,\n \"clientId\": 1,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dateOfBirth\": \"19 August 2026\",\n \"familyMembers\": \"string\",\n \"firstName\": \"string\",\n \"genderId\": 1,\n \"id\": 1,\n \"isDependent\": true,\n \"lastName\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a family member recorded against a client.\n\nhttps://developer.lokta.ai/api/customers/update-client-family-member/" } }, { "name": "Delete a client family member", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/familymembers/:familyMemberId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "familymembers", ":familyMemberId" ], "variable": [ { "key": "clientId", "value": "" }, { "key": "familyMemberId", "value": "" } ] }, "description": "Removes a family member from a client.\n\nhttps://developer.lokta.ai/api/customers/delete-client-family-member/" } }, { "name": "List all Identifiers for a Client", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/identifiers", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "identifiers" ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "Lists the identity documents recorded for a client, each an identifier type and its number.\n\nhttps://developer.lokta.ai/api/customers/retrieve-all-client-identifiers/" } }, { "name": "Create an Identifier for a Client", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/identifiers", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "identifiers" ], "variable": [ { "key": "clientId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Document has been verified\",\n \"documentKey\": \"KA-54677\",\n \"documentTypeId\": 1,\n \"status\": \"Active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds an identity document to a client, such as a national ID number.\n\nhttps://developer.lokta.ai/api/customers/create-client-identifier/" } }, { "name": "Retrieve Client Identifier Details Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/identifiers/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "identifiers", "template" ], "variable": [ { "key": "clientId", "value": "" } ] }, "description": "This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of.\n\nhttps://developer.lokta.ai/api/customers/retrieve-template-client-identifier/" } }, { "name": "Retrieve a Client Identifier", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/identifiers/:identifierId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "identifiers", ":identifierId" ], "variable": [ { "key": "clientId", "value": "" }, { "key": "identifierId", "value": "" } ] }, "description": "Returns one identity document recorded for a client.\n\nhttps://developer.lokta.ai/api/customers/retrieve-one-client-identifier/" } }, { "name": "Update a Client Identifier", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/identifiers/:identifierId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "identifiers", ":identifierId" ], "variable": [ { "key": "clientId", "value": "" }, { "key": "identifierId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Document has been verified\",\n \"documentKey\": \"KA-54677\",\n \"documentTypeId\": 1,\n \"status\": \"Active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an identity document recorded for a client.\n\nhttps://developer.lokta.ai/api/customers/update-client-identifier/" } }, { "name": "Delete a Client Identifier", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/clients/:clientId/identifiers/:identifierId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "clients", ":clientId", "identifiers", ":identifierId" ], "variable": [ { "key": "clientId", "value": "" }, { "key": "identifierId", "value": "" } ] }, "description": "Removes an identity document from a client.\n\nhttps://developer.lokta.ai/api/customers/delete-client-identifier/" } }, { "name": "Search Clients by text", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/clients/search", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "clients", "search" ] }, "body": { "mode": "raw", "raw": "{\n \"page\": 1,\n \"request\": {\n \"text\": \"string\"\n },\n \"size\": 1,\n \"sorts\": [\n {\n \"direction\": \"ASC\",\n \"property\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Searches clients by free text and returns the matching client records.\n\nhttps://developer.lokta.ai/api/customers/search-clients-by-text/" } } ] } ] }, { "name": "Loans", "item": [ { "name": "Loan Accounts", "description": "A loan from application through closure: create, approve, disburse, and manage the account lifecycle.", "item": [ { "name": "List Loans", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans" ], "query": [ { "key": "externalId", "value": "", "disabled": true, "description": "externalId" }, { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" }, { "key": "orderBy", "value": "", "disabled": true, "description": "orderBy" }, { "key": "sortOrder", "value": "", "disabled": true, "description": "sortOrder" }, { "key": "accountNo", "value": "", "disabled": true, "description": "accountNo" }, { "key": "associations", "value": "", "disabled": true, "description": "associations" }, { "key": "clientId", "value": "", "disabled": true, "description": "clientId" }, { "key": "status", "value": "", "disabled": true, "description": "status" }, { "key": "sourcedBy", "value": "", "disabled": true, "description": "Sourcing facet, repeatable: own | partner | not_recorded" }, { "key": "sourcingPartnerId", "value": "", "disabled": true, "description": "Sourcing partner facet, repeatable: opaque spr_ ids" } ] }, "description": "The list capability of loans can support pagination and sorting.\n\nhttps://developer.lokta.ai/api/loan-accounts/retrieve-all-loans/" } }, { "name": "Submit a loan application or calculate its schedule", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ] }, "body": { "mode": "raw", "raw": "{\n \"allowFullTermForTranche\": false,\n \"amortizationType\": 1,\n \"buyDownFeeCalculationType\": \"FLAT\",\n \"buyDownFeeIncomeType\": \"FEE\",\n \"buyDownFeeStrategy\": \"EQUAL_AMORTIZATION\",\n \"capitalizedIncomeCalculationType\": \"FLAT\",\n \"capitalizedIncomeStrategy\": \"EQUAL_AMORTIZATION\",\n \"capitalizedIncomeType\": {\n \"code\": \"string\",\n \"id\": \"string\",\n \"value\": \"string\"\n },\n \"charges\": [\n {\n \"amount\": 1,\n \"chargeId\": 1\n }\n ],\n \"clientId\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "It calculates the loan repayment Schedule.\n\nhttps://developer.lokta.ai/api/loan-accounts/calculate-or-submit-loan-application/" } }, { "name": "Retrieve Loan Details Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", "template" ], "query": [ { "key": "clientId", "value": "", "disabled": true, "description": "clientId" }, { "key": "productId", "value": "", "disabled": true, "description": "productId" }, { "key": "templateType", "value": "", "disabled": true, "description": "templateType" }, { "key": "staffInSelectedOfficeOnly", "value": "", "disabled": true, "description": "staffInSelectedOfficeOnly" }, { "key": "activeOnly", "value": "", "disabled": true, "description": "activeOnly" } ] }, "description": "Returns the field defaults and allowed values for a loan application.\n\nhttps://developer.lokta.ai/api/loan-accounts/retrieve-template-loan/" } }, { "name": "Retrieve a Loan", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId" ], "query": [ { "key": "staffInSelectedOfficeOnly", "value": "", "disabled": true, "description": "staffInSelectedOfficeOnly" }, { "key": "associations", "value": "", "disabled": true, "description": "Loan object relations to be included in the response" }, { "key": "exclude", "value": "", "disabled": true, "description": "Optional Loan object relation list to be filtered in the response" }, { "key": "fields", "value": "", "disabled": true, "description": "Optional Loan attribute list to be in the response" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Returns one loan by id, with its status, terms and balances.\n\nhttps://developer.lokta.ai/api/loan-accounts/retrieve-one-loan/" } }, { "name": "Run a command on a loan, such as approve or disburse", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"actualDisbursementDate\": \"28 June 2022\",\n \"adjustRepaymentDate\": \"28 July 2022\",\n \"approvedLoanAmount\": 1000,\n \"approvedOnDate\": \"28 June 2022\",\n \"assignmentDate\": \"02 September 2014\",\n \"dateFormat\": \"dd MMMM yyyy\",\n \"disbursementData\": [\n {\n \"expectedDisbursementDate\": \"19 August 2026\",\n \"principal\": 22000\n }\n ],\n \"expectedDisbursementDate\": \"28 June 2022\",\n \"externalId\": \"3e7791ce-aa10-11ec-b909-0242ac120002\",\n \"fixedEmiAmount\": 500\n}", "options": { "raw": { "language": "json" } } }, "description": "Allows you to assign Loan Officer for existing Loan.\n\nhttps://developer.lokta.ai/api/loan-accounts/handle-commands-loan/" } }, { "name": "Modify a loan application", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"allowFullTermForTranche\": false,\n \"amortizationType\": 1,\n \"charges\": [\n {\n \"amount\": 1,\n \"chargeCalculationType\": 1,\n \"chargeId\": 1,\n \"chargePaymentMode\": 1\n }\n ],\n \"clientId\": 1,\n \"collateral\": [\n {\n \"clientCollateralId\": 1,\n \"quantity\": 1\n }\n ],\n \"dateFormat\": \"dd MMMM yyyy\",\n \"disbursedAmountPercentageForDownPayment\": 0,\n \"disbursementData\": [\n {\n \"dateFormat\": \"dd MMMM yyyy\",\n \"expectedDisbursementDate\": \"19 August 2026\",\n \"interestType\": 1,\n \"isEqualAmortization\": true\n }\n ],\n \"enableAutoRepaymentForDownPayment\": false,\n \"enableDownPayment\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.\n\nhttps://developer.lokta.ai/api/loan-accounts/update-loan-application/" } }, { "name": "Delete a Loan Application", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId" ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Deletes a loan application.\n\nhttps://developer.lokta.ai/api/loan-accounts/delete-loan-application/" } }, { "name": "Retrieve Loan Approval Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "template" ], "query": [ { "key": "templateType", "value": "", "disabled": true, "description": "templateType" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Returns the approval template for a loan, used to prefill the approval step.\n\nhttps://developer.lokta.ai/api/loan-accounts/retrieve-approval-template/" } } ] }, { "name": "Loan Products", "description": "The lending catalogue: product definitions, terms, charges and accounting mappings.", "item": [ { "name": "List Loan Products", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loanproducts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loanproducts" ] }, "description": "Lists every loan product configured on the tenant.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-all-loan-products/" } }, { "name": "Create a Loan Product", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loanproducts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loanproducts" ] }, "body": { "mode": "raw", "raw": "{\n \"accountMovesOutOfNPAOnlyOnArrearsCompletion\": false,\n \"accountingRule\": 3,\n \"allowApprovedDisbursedAmountsOverApplied\": true,\n \"allowAttributeOverrides\": {\n \"amortizationType\": true,\n \"graceOnArrearsAgeing\": true,\n \"graceOnPrincipalAndInterestPayment\": true,\n \"inArrearsTolerance\": true\n },\n \"allowCompoundingOnEod\": false,\n \"allowFullTermForTranche\": false,\n \"allowPartialPeriodInterestCalculation\": true,\n \"allowVariableInstallments\": false,\n \"amortizationType\": 1,\n \"buyDownExpenseAccountId\": 27\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a loan product, the terms that loans are created from.\n\nhttps://developer.lokta.ai/api/loan-products/create-loan-product/" } }, { "name": "List Loan Products with basic details", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loanproducts/basic-details", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loanproducts", "basic-details" ] }, "description": "Lists Loan Products with basic details to be listed.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-all-loan-products-details/" } }, { "name": "Retrieve Loan Product Details Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loanproducts/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loanproducts", "template" ], "query": [ { "key": "isProductMixTemplate", "value": "", "disabled": true, "description": "isProductMixTemplate" } ] }, "description": "Returns the field defaults and allowed values for creating a loan product.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-template-loan-product/" } }, { "name": "Retrieve a Loan Product", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loanproducts/:productId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loanproducts", ":productId" ], "variable": [ { "key": "productId", "value": "" } ] }, "description": "Returns one loan product with its terms, charges and accounting configuration.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-one-loan-product/" } }, { "name": "Update a Loan Product", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loanproducts/:productId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loanproducts", ":productId" ], "variable": [ { "key": "productId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountMovesOutOfNPAOnlyOnArrearsCompletion\": false,\n \"accountingRule\": 3,\n \"allowApprovedDisbursedAmountsOverApplied\": true,\n \"allowAttributeOverrides\": {\n \"amortizationType\": true,\n \"graceOnArrearsAgeing\": true,\n \"graceOnPrincipalAndInterestPayment\": true,\n \"inArrearsTolerance\": true\n },\n \"allowCompoundingOnEod\": false,\n \"allowFullTermForTranche\": false,\n \"allowPartialPeriodInterestCalculation\": true,\n \"allowVariableInstallments\": false,\n \"amortizationType\": 1,\n \"buyDownExpenseAccountId\": 27\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a loan product.\n\nhttps://developer.lokta.ai/api/loan-products/update-loan-product/" } }, { "name": "List loan products (draft workflow)", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts" ] }, "description": "Lists loan products using the V2 response shape.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-all-loan-products-v2/" } }, { "name": "Create a draft loan product", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts" ] }, "body": { "mode": "raw", "raw": "{\n \"loanScheduleType\": \"CUMULATIVE\",\n \"accountMovesOutOfNPAOnlyOnArrearsCompletion\": false,\n \"accountingRule\": 3,\n \"allowApprovedDisbursedAmountsOverApplied\": true,\n \"allowAttributeOverrides\": {\n \"amortizationType\": true,\n \"graceOnArrearsAgeing\": true,\n \"graceOnPrincipalAndInterestPayment\": true,\n \"inArrearsTolerance\": true\n },\n \"allowCompoundingOnEod\": false,\n \"allowFullTermForTranche\": false,\n \"allowPartialPeriodInterestCalculation\": true,\n \"allowVariableInstallments\": false,\n \"amortizationType\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a Loan Product through the V2 contract.\n\nhttps://developer.lokta.ai/api/loan-products/create-loan-product-v2/" } }, { "name": "List draft loan products", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts/drafts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts", "drafts" ] }, "description": "Lists Loan Products still in DRAFT, exactly those the standard listing excludes.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-all-draft-loan-products-v2/" } }, { "name": "Retrieve the loan product template (draft workflow)", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts", "template" ], "query": [ { "key": "isProductMixTemplate", "value": "", "disabled": true, "description": "isProductMixTemplate" } ] }, "description": "Returns the field defaults and allowed values for creating a loan product, using the V2 response shape.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-template-loan-product-v2/" } }, { "name": "Retrieve a loan product (draft workflow)", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts/:productId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts", ":productId" ], "variable": [ { "key": "productId", "value": "" } ] }, "description": "Returns one loan product using the V2 response shape.\n\nhttps://developer.lokta.ai/api/loan-products/retrieve-one-loan-product-v2/" } }, { "name": "Update a loan product (draft workflow)", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts/:productId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts", ":productId" ], "variable": [ { "key": "productId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountMovesOutOfNPAOnlyOnArrearsCompletion\": false,\n \"accountingRule\": 3,\n \"allowApprovedDisbursedAmountsOverApplied\": true,\n \"allowAttributeOverrides\": {\n \"amortizationType\": true,\n \"graceOnArrearsAgeing\": true,\n \"graceOnPrincipalAndInterestPayment\": true,\n \"inArrearsTolerance\": true\n },\n \"allowCompoundingOnEod\": false,\n \"allowFullTermForTranche\": false,\n \"allowPartialPeriodInterestCalculation\": true,\n \"allowVariableInstallments\": false,\n \"amortizationType\": 1,\n \"buyDownExpenseAccountId\": 27\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a Loan Product through the V2 contract. Preserves V1 partial-update semantics: omitted fields (including loanScheduleType) leave the existing configuration unchanged.\n\nhttps://developer.lokta.ai/api/loan-products/update-loan-product-v2/" } }, { "name": "Activate a draft loan product", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v2/loanproducts/:productId/activate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v2", "loanproducts", ":productId", "activate" ], "variable": [ { "key": "productId", "value": "" } ] }, "description": "Releases the product for use.\n\nhttps://developer.lokta.ai/api/loan-products/activate-loan-product-v2/" } } ] }, { "name": "Loan Charges", "description": "Fees and penalties on a live loan: add, pay, waive, adjust and reverse.", "item": [ { "name": "List Loan Charges", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges" ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "It lists all the Loan Charges specific to a Loan.\n\nhttps://developer.lokta.ai/api/loan-charges/retrieve-all-loan-charges/" } }, { "name": "Create a loan charge or deactivate overdue charges", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 100,\n \"chargeId\": 2,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dueDate\": \"29 April 2013\",\n \"externalId\": \"786444UUUYYH7\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a Loan Charge | Deactivate overdue Loan Charges.\n\nhttps://developer.lokta.ai/api/loan-charges/create-or-pay-loan-charge/" } }, { "name": "Retrieve Loan Charges Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges", "template" ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Returns the field defaults and allowed values for adding a charge to a loan.\n\nhttps://developer.lokta.ai/api/loan-charges/retrieve-template-loan-charge/" } }, { "name": "Retrieve a Loan Charge", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges/:loanChargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges", ":loanChargeId" ], "variable": [ { "key": "loanId", "value": "" }, { "key": "loanChargeId", "value": "" } ] }, "description": "Retrieves Loan Charge according to the Loan ID and Loan Charge IDExample Requests.\n\nhttps://developer.lokta.ai/api/loan-charges/retrieve-one-loan-charge/" } }, { "name": "Waive / Adjustment for Loan Charge", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges/:loanChargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges", ":loanChargeId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" }, { "key": "loanChargeId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"acc123\",\n \"amount\": 100,\n \"bankNumber\": \"ban123\",\n \"chargeId\": 1,\n \"checkNumber\": \"che123\",\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dueDate\": \"19 September 2013\",\n \"externalId\": \"786444UUUYYH7\",\n \"installmentNumber\": 1,\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Waive Loan Charge | Add Charge Adjustment.\n\nhttps://developer.lokta.ai/api/loan-charges/execute-loan-charge-on-existing-charge/" } }, { "name": "Update a Loan Charge", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges/:loanChargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges", ":loanChargeId" ], "variable": [ { "key": "loanId", "value": "" }, { "key": "loanChargeId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 60,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dueDate\": \"27 March 2013\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Currently Loan Charges may be updated only if the Loan is not yet approved.\n\nhttps://developer.lokta.ai/api/loan-charges/update-loan-charge/" } }, { "name": "Delete a Loan Charge", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/charges/:loanChargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "charges", ":loanChargeId" ], "variable": [ { "key": "loanId", "value": "" }, { "key": "loanChargeId", "value": "" } ] }, "description": "Deletes a charge from a loan.\n\nhttps://developer.lokta.ai/api/loan-charges/delete-loan-charge/" } } ] }, { "name": "Charges", "description": "Fee and penalty definitions that products and accounts draw from.", "item": [ { "name": "Retrieve Charges", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/charges", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "charges" ] }, "description": "Lists the fee and penalty definitions on the tenant.\n\nhttps://developer.lokta.ai/api/charges/retrieve-all-charges/" } }, { "name": "Create/Define a Charge", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/charges", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "charges" ] }, "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"amount\": 0,\n \"capitalizable\": true,\n \"capitalizeByDefault\": true,\n \"chargeAppliesTo\": 1,\n \"chargeCalculationType\": 1,\n \"chargePaymentMode\": 1,\n \"chargeTimeType\": 1,\n \"code\": \"string\",\n \"currencyCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Define a new charge that can later be associated with loans through their product definitions or directly on each account instance.\n\nhttps://developer.lokta.ai/api/charges/create-charge/" } }, { "name": "Retrieve Charge Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/charges/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "charges", "template" ], "query": [ { "key": "chargeAppliesTo", "value": "", "disabled": true }, { "key": "chargeTimeType", "value": "", "disabled": true } ] }, "description": "Returns the field defaults and allowed values for creating a charge definition.\n\nhttps://developer.lokta.ai/api/charges/retrieve-template-charge/" } }, { "name": "Retrieve a Charge", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "charges", ":chargeId" ], "variable": [ { "key": "chargeId", "value": "" } ] }, "description": "Returns the details of a defined Charge.\n\nhttps://developer.lokta.ai/api/charges/retrieve-one-charge/" } }, { "name": "Update a Charge", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "charges", ":chargeId" ], "variable": [ { "key": "chargeId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"amount\": 0,\n \"capitalizable\": true,\n \"capitalizeByDefault\": true,\n \"chargeAppliesTo\": 1,\n \"chargeCalculationType\": 1,\n \"chargePaymentMode\": 1,\n \"chargeTimeType\": 1,\n \"code\": \"string\",\n \"currencyCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a charge definition.\n\nhttps://developer.lokta.ai/api/charges/update-charge/" } }, { "name": "Delete a Charge", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "charges", ":chargeId" ], "variable": [ { "key": "chargeId", "value": "" } ] }, "description": "Deletes a charge definition.\n\nhttps://developer.lokta.ai/api/charges/delete-charge/" } } ] }, { "name": "Tax on Charges", "description": "Tax components and tax groups applied through charges.", "item": [ { "name": "List Tax Components", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/component", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "component" ] }, "description": "Lists the tax components defined on the tenant.\n\nhttps://developer.lokta.ai/api/tax-on-charges/retrieve-all-tax-components/" } }, { "name": "Create a new Tax Component", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/component", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "component" ] }, "body": { "mode": "raw", "raw": "{\n \"creditAccountId\": 4,\n \"creditAccountType\": 4,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"debitAccountId\": 4,\n \"debitAccountType\": 2,\n \"locale\": \"en\",\n \"name\": \"tax component 1\",\n \"percentage\": 10,\n \"startDate\": \"11 April 2016\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a tax component that a tax group can use.\n\nhttps://developer.lokta.ai/api/tax-on-charges/create-tax-component/" } }, { "name": "Retrieve Tax Component Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/component/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "component", "template" ] }, "description": "Returns the options offered when creating a tax component.\n\nhttps://developer.lokta.ai/api/tax-on-charges/retrieve-template-tax-component/" } }, { "name": "Retrieve Tax Component", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/component/:taxComponentId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "component", ":taxComponentId" ], "variable": [ { "key": "taxComponentId", "value": "" } ] }, "description": "Returns one tax component.\n\nhttps://developer.lokta.ai/api/tax-on-charges/retrieve-one-tax-component/" } }, { "name": "Update Tax Component", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/component/:taxComponentId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "component", ":taxComponentId" ], "variable": [ { "key": "taxComponentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\",\n \"name\": \"tax component 2\",\n \"percentage\": 15,\n \"startDate\": \"15 April 2016\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.\n\nhttps://developer.lokta.ai/api/tax-on-charges/update-tax-component/" } }, { "name": "List Tax Group", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/group", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "group" ] }, "description": "Lists the tax groups defined on the tenant. A tax group bundles tax components.\n\nhttps://developer.lokta.ai/api/tax-on-charges/retrieve-all-tax-groups/" } }, { "name": "Create a new Tax Group", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/group", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "group" ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\",\n \"name\": \"tax group 1\",\n \"taxComponents\": [\n {\n \"startDate\": \"11 April 2016\",\n \"taxComponentId\": 7\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a tax group from a set of tax components.\n\nhttps://developer.lokta.ai/api/tax-on-charges/create-tax-group/" } }, { "name": "Retrieve Tax Group Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/group/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "group", "template" ] }, "description": "Returns the options offered when creating a tax group.\n\nhttps://developer.lokta.ai/api/tax-on-charges/retrieve-template-tax-group/" } }, { "name": "Retrieve Tax Group", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/group/:taxGroupId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "group", ":taxGroupId" ], "variable": [ { "key": "taxGroupId", "value": "" } ] }, "description": "Returns one tax group with its tax components.\n\nhttps://developer.lokta.ai/api/tax-on-charges/retrieve-one-tax-group/" } }, { "name": "Update Tax Group", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/taxes/group/:taxGroupId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "taxes", "group", ":taxGroupId" ], "variable": [ { "key": "taxGroupId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\",\n \"name\": \"tax group 2\",\n \"taxComponents\": [\n {\n \"endDate\": \"22 April 2016\",\n \"id\": 7,\n \"taxComponentId\": 7\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates Tax Group. Only end date can be up-datable and can insert new tax components.\n\nhttps://developer.lokta.ai/api/tax-on-charges/update-tax-group/" } } ] } ] }, { "name": "Repayments and collections", "item": [ { "name": "Loan Transactions", "description": "Money movements on a loan: repayments, adjustments, waivers, write-offs and their undo commands.", "item": [ { "name": "Retrieve Transactions", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions" ], "query": [ { "key": "excludedTypes", "value": "", "disabled": true, "description": "excludedTypes" }, { "key": "page", "value": "", "disabled": true, "description": "page" }, { "key": "size", "value": "", "disabled": true, "description": "size" }, { "key": "sort", "value": "", "disabled": true, "description": "sort" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Lists the transactions posted to a loan.\n\nhttps://developer.lokta.ai/api/loan-transactions/retrieve-all-loan-transactions/" } }, { "name": "Post a loan transaction, such as a repayment", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"acc123\",\n \"bankNumber\": \"ban123\",\n \"chargeOffReasonId\": 1,\n \"checkNumber\": \"che123\",\n \"classificationId\": 1,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dueDate\": \"28 June 2022\",\n \"externalId\": \"3e7791ce-aa10-11ec-b909-0242ac120002\",\n \"frequencyNumber\": 1,\n \"frequencyType\": \"frequencyType\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API covers the major loan transaction functionality.\n\nhttps://developer.lokta.ai/api/loan-transactions/handle-commands-loan-transaction/" } }, { "name": "Preview Re-Age Schedule", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions/reage-preview?frequencyNumber=&frequencyType=&startDate=&numberOfInstallments=&dateFormat=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions", "reage-preview" ], "query": [ { "key": "frequencyNumber", "value": "", "disabled": false, "description": "The frequency number for the re-aging schedule" }, { "key": "frequencyType", "value": "", "disabled": false, "description": "The frequency type (DAYS, WEEKS, MONTHS, YEARS)" }, { "key": "startDate", "value": "", "disabled": false, "description": "The start date for the re-aging schedule" }, { "key": "numberOfInstallments", "value": "", "disabled": false, "description": "The number of installments for the re-aged loan" }, { "key": "dateFormat", "value": "", "disabled": false, "description": "The date format used for the startDate parameter" }, { "key": "locale", "value": "", "disabled": false, "description": "The locale to use for formatting" }, { "key": "reAgeInterestHandling", "value": "", "disabled": true, "description": "The interest handling type. Applied only for progressive interest-bearing loans. DEFAULT if not provided." } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Generates a preview of the re-aged loan schedule based on the provided parameters without creating any transactions or modifying the loan.\n\nhttps://developer.lokta.ai/api/loan-transactions/preview-re-age-loan-schedule/" } }, { "name": "Preview Re-Amortized Schedule", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions/reamortization-preview?reAmortizationInterestHandling=", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions", "reamortization-preview" ], "query": [ { "key": "reAmortizationInterestHandling", "value": "", "disabled": false, "description": "The interest handling type (DEFAULT, WAIVE_INTEREST, EQUAL_AMORTIZATION_INTEREST_SPLIT)" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Generates a preview of the re-amortized loan schedule based on the provided parameters without creating any transactions or modifying the loan.\n\nhttps://developer.lokta.ai/api/loan-transactions/preview-re-amortize-loan-schedule/" } }, { "name": "Retrieve Loan Transaction Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions", "template" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" }, { "key": "dateFormat", "value": "", "disabled": true, "description": "dateFormat" }, { "key": "transactionDate", "value": "", "disabled": true, "description": "transactionDate" }, { "key": "locale", "value": "", "disabled": true, "description": "locale" }, { "key": "transactionId", "value": "", "disabled": true, "description": "transactionId" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Returns the field defaults and allowed values for a transaction on a loan, for the command you name.\n\nhttps://developer.lokta.ai/api/loan-transactions/retrieve-template-loan-transaction/" } }, { "name": "Retrieve a Transaction Details", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions", ":transactionId" ], "query": [ { "key": "fields", "value": "", "disabled": true, "description": "Optional Loan Transaction attribute list to be in the response" } ], "variable": [ { "key": "loanId", "value": "" }, { "key": "transactionId", "value": "" } ] }, "description": "Returns one transaction on a loan.\n\nhttps://developer.lokta.ai/api/loan-transactions/retrieve-one-loan-transaction/" } }, { "name": "Adjust a Transaction", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions", ":transactionId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" }, { "key": "transactionId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"externalId\": \"4ff9b1cb988b7\",\n \"locale\": \"en_GB\",\n \"note\": \"An optional note about why your adjusting or changing the transaction.\",\n \"paymentTypeId\": 1,\n \"reversalExternalId\": \"95174ff9-1a75-4d72-a413-6f9b1cb988b7\",\n \"transactionAmount\": 0,\n \"transactionDate\": \"28 June 2022\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adjusts an earlier transaction on a loan. Send the corrected transactionDate and transactionAmount.\n\nhttps://developer.lokta.ai/api/loan-transactions/adjust-loan-transaction/" } }, { "name": "Undo a Waive Charge Transaction", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "transactions", ":transactionId" ], "variable": [ { "key": "loanId", "value": "" }, { "key": "transactionId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"loanId\": 2\n}", "options": { "raw": { "language": "json" } } }, "description": "Undoes a waive-charge transaction on a loan.\n\nhttps://developer.lokta.ai/api/loan-transactions/undo-waive-charge-loan-transaction/" } } ] }, { "name": "Delinquency", "description": "Delinquency ranges and buckets: how overdue loans are classified for collections and early warning.", "item": [ { "name": "List all Delinquency Buckets", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/buckets", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "buckets" ] }, "description": "Lists delinquency buckets. A bucket groups ranges of days past due and is assigned to loan products.\n\nhttps://developer.lokta.ai/api/delinquency/get-buckets/" } }, { "name": "Create Delinquency Bucket", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/buckets", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "buckets" ] }, "body": { "mode": "raw", "raw": "{\n \"bucketType\": \"string\",\n \"minimumPaymentPeriodAndRule\": {\n \"frequency\": 1,\n \"frequencyType\": \"string\",\n \"minimumPayment\": 0,\n \"minimumPaymentType\": \"string\"\n },\n \"name\": \"string\",\n \"ranges\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a delinquency bucket from a set of delinquency ranges.\n\nhttps://developer.lokta.ai/api/delinquency/create-bucket/" } }, { "name": "Template for Delinquency Buckets", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/buckets/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "buckets", "template" ] }, "description": "Returns the template used when creating a delinquency bucket.\n\nhttps://developer.lokta.ai/api/delinquency/get-bucket-template/" } }, { "name": "Retrieve a Delinquency Bucket", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/buckets/:delinquencyBucketId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "buckets", ":delinquencyBucketId" ], "variable": [ { "key": "delinquencyBucketId", "value": "" } ] }, "description": "Returns one delinquency bucket with its ranges.\n\nhttps://developer.lokta.ai/api/delinquency/get-bucket/" } }, { "name": "Update Delinquency Bucket based on the Id", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/buckets/:delinquencyBucketId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "buckets", ":delinquencyBucketId" ], "variable": [ { "key": "delinquencyBucketId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"bucketType\": \"string\",\n \"minimumPaymentPeriodAndRule\": {\n \"frequency\": 1,\n \"frequencyType\": \"string\",\n \"minimumPayment\": 0,\n \"minimumPaymentType\": \"string\"\n },\n \"name\": \"string\",\n \"ranges\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a delinquency bucket.\n\nhttps://developer.lokta.ai/api/delinquency/update-bucket/" } }, { "name": "Delete Delinquency Bucket based on the Id", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/buckets/:delinquencyBucketId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "buckets", ":delinquencyBucketId" ], "variable": [ { "key": "delinquencyBucketId", "value": "" } ] }, "description": "Deletes a delinquency bucket.\n\nhttps://developer.lokta.ai/api/delinquency/delete-bucket/" } }, { "name": "List all Delinquency Ranges", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/ranges", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "ranges" ] }, "description": "Lists delinquency ranges. A range is a band of days past due used to classify overdue loans.\n\nhttps://developer.lokta.ai/api/delinquency/get-ranges/" } }, { "name": "Create Delinquency Range", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/ranges", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "ranges" ] }, "body": { "mode": "raw", "raw": "{\n \"classification\": \"string\",\n \"locale\": \"en\",\n \"maximumAgeDays\": 1,\n \"minimumAgeDays\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a delinquency range, a band of days past due.\n\nhttps://developer.lokta.ai/api/delinquency/create-range/" } }, { "name": "Retrieve a specific Delinquency Range based on the Id", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/ranges/:delinquencyRangeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "ranges", ":delinquencyRangeId" ], "variable": [ { "key": "delinquencyRangeId", "value": "" } ] }, "description": "Returns one delinquency range.\n\nhttps://developer.lokta.ai/api/delinquency/get-range/" } }, { "name": "Update Delinquency Range based on the Id", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/ranges/:delinquencyRangeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "ranges", ":delinquencyRangeId" ], "variable": [ { "key": "delinquencyRangeId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"classification\": \"string\",\n \"locale\": \"en\",\n \"maximumAgeDays\": 1,\n \"minimumAgeDays\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a delinquency range.\n\nhttps://developer.lokta.ai/api/delinquency/update-range/" } }, { "name": "Delete Delinquency Range based on the Id", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/delinquency/ranges/:delinquencyRangeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "delinquency", "ranges", ":delinquencyRangeId" ], "variable": [ { "key": "delinquencyRangeId", "value": "" } ] }, "description": "Deletes a delinquency range.\n\nhttps://developer.lokta.ai/api/delinquency/delete-range/" } } ] }, { "name": "Interest Pause", "description": "Pause interest accrual on a loan for a set period, and manage those pauses.", "item": [ { "name": "Retrieve all interest pause periods for a loan", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/interest-pauses", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "interest-pauses" ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Fetches a list of all active interest pause periods for a specific loan.\n\nhttps://developer.lokta.ai/api/interest-pause/retrieve-all-loan-interest-pauses/" } }, { "name": "Create a new interest pause period for a loan", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/interest-pauses", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "interest-pauses" ], "variable": [ { "key": "loanId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"yyyy-MM-dd\",\n \"endDate\": \"2024-01-11\",\n \"locale\": \"en\",\n \"startDate\": \"2024-01-01\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Allows users to define a period during which no interest will be accrued for a specific loan.\n\nhttps://developer.lokta.ai/api/interest-pause/create-loan-interest-pause/" } }, { "name": "Update an interest pause period", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/interest-pauses/:variationId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "interest-pauses", ":variationId" ], "variable": [ { "key": "loanId", "value": "" }, { "key": "variationId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"yyyy-MM-dd\",\n \"endDate\": \"2024-01-11\",\n \"locale\": \"en\",\n \"startDate\": \"2024-01-01\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a specific interest pause period by its variation ID.\n\nhttps://developer.lokta.ai/api/interest-pause/update-loan-interest-pause/" } }, { "name": "Delete an interest pause period", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/interest-pauses/:variationId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "interest-pauses", ":variationId" ], "variable": [ { "key": "loanId", "value": "" }, { "key": "variationId", "value": "" } ] }, "description": "Deletes a specific interest pause period by its variation ID.\n\nhttps://developer.lokta.ai/api/interest-pause/delete-loan-interest-pause/" } } ] }, { "name": "Loan Rescheduling", "description": "Term changes to a live loan: reschedule requests, approvals and schedule variations.", "item": [ { "name": "Calculate, update or reset a loan schedule", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loans/:loanId/schedule", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loans", ":loanId", "schedule" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "loanId", "value": "" } ] }, "description": "Calculate loan repayment schedule based on Loan term variations.\n\nhttps://developer.lokta.ai/api/loan-rescheduling/handle-commands-loan-schedule/" } } ] } ] }, { "name": "Accounting", "item": [ { "name": "General Ledger", "description": "The chart of accounts: ledger accounts assets, liabilities, income and expenses post to.", "item": [ { "name": "List General Ledger Account", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glaccounts" ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "type" }, { "key": "searchParam", "value": "", "disabled": true, "description": "searchParam" }, { "key": "usage", "value": "", "disabled": true, "description": "usage" }, { "key": "manualEntriesAllowed", "value": "", "disabled": true, "description": "manualEntriesAllowed" }, { "key": "disabled", "value": "", "disabled": true, "description": "disabled" }, { "key": "fetchRunningBalance", "value": "", "disabled": true, "description": "fetchRunningBalance" } ] }, "description": "Lists the general ledger accounts in the chart of accounts.\n\nhttps://developer.lokta.ai/api/general-ledger/retrieve-all-accounts/" } }, { "name": "Create a General Ledger Account", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glaccounts" ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Desc\",\n \"glCode\": \"100001\",\n \"manualEntriesAllowed\": true,\n \"name\": \"Cash at Bangalore\",\n \"parentId\": 1,\n \"tagId\": 10,\n \"type\": 1,\n \"usage\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a general ledger account in the chart of accounts.\n\nhttps://developer.lokta.ai/api/general-ledger/create-glaccount/" } }, { "name": "Retrieve GL Accounts Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glaccounts/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glaccounts", "template" ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "type" } ] }, "description": "Returns the field defaults and allowed values for creating a general ledger account.\n\nhttps://developer.lokta.ai/api/general-ledger/retrieve-new-account-details/" } }, { "name": "Retrieve a General Ledger Account", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glaccounts/:glAccountId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glaccounts", ":glAccountId" ], "query": [ { "key": "fetchRunningBalance", "value": "", "disabled": true, "description": "fetchRunningBalance" } ], "variable": [ { "key": "glAccountId", "value": "" } ] }, "description": "Returns one general ledger account from the chart of accounts.\n\nhttps://developer.lokta.ai/api/general-ledger/retreive-account/" } }, { "name": "Update a GL Account", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glaccounts/:glAccountId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glaccounts", ":glAccountId" ], "variable": [ { "key": "glAccountId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Desc\",\n \"disabled\": false,\n \"glCode\": \"100001\",\n \"manualEntriesAllowed\": true,\n \"name\": \"Cash at Bangalore\",\n \"parentId\": 1,\n \"tagId\": 10,\n \"type\": 1,\n \"usage\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a general ledger account.\n\nhttps://developer.lokta.ai/api/general-ledger/update-glaccount/" } }, { "name": "Delete a GL Account", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glaccounts/:glAccountId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glaccounts", ":glAccountId" ], "variable": [ { "key": "glAccountId", "value": "" } ] }, "description": "Deletes a general ledger account.\n\nhttps://developer.lokta.ai/api/general-ledger/delete-glaccount/" } } ] }, { "name": "Journal Entries", "description": "Double-entry postings: search, create and reverse journal entries.", "item": [ { "name": "List Journal Entries", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/journalentries", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "journalentries" ], "query": [ { "key": "officeId", "value": "", "disabled": true, "description": "officeId" }, { "key": "glAccountId", "value": "", "disabled": true, "description": "glAccountId" }, { "key": "manualEntriesOnly", "value": "", "disabled": true, "description": "manualEntriesOnly" }, { "key": "fromDate", "value": "", "disabled": true, "description": "fromDate" }, { "key": "toDate", "value": "", "disabled": true, "description": "toDate" }, { "key": "submittedOnDateFrom", "value": "", "disabled": true, "description": "submittedOnDateFrom" }, { "key": "submittedOnDateTo", "value": "", "disabled": true, "description": "submittedOnDateTo" }, { "key": "transactionId", "value": "", "disabled": true, "description": "transactionId" }, { "key": "entityType", "value": "", "disabled": true, "description": "entityType" }, { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" }, { "key": "orderBy", "value": "", "disabled": true, "description": "orderBy" }, { "key": "sortOrder", "value": "", "disabled": true, "description": "sortOrder" }, { "key": "locale", "value": "", "disabled": true, "description": "locale" }, { "key": "dateFormat", "value": "", "disabled": true, "description": "dateFormat" }, { "key": "loanId", "value": "", "disabled": true, "description": "loanId" }, { "key": "runningBalance", "value": "", "disabled": true, "description": "runningBalance" }, { "key": "transactionDetails", "value": "", "disabled": true, "description": "transactionDetails" } ] }, "description": "The list capability of journal entries can support pagination and sorting.\n\nhttps://developer.lokta.ai/api/journal-entries/retrieve-all-journal-entries/" } }, { "name": "Create \"Balanced\" Journal Entries", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/journalentries", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "journalentries" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"string\",\n \"accountingRuleId\": 1,\n \"amount\": 0,\n \"bankNumber\": \"string\",\n \"checkNumber\": \"string\",\n \"comments\": \"string\",\n \"credits\": [\n {\n \"amount\": 0,\n \"comments\": \"string\",\n \"commentsChanged\": true,\n \"glAccountId\": 1\n }\n ],\n \"currencyCode\": \"string\",\n \"dateFormat\": \"dd MMMM yyyy\",\n \"debits\": [\n {\n \"amount\": 0,\n \"comments\": \"string\",\n \"commentsChanged\": true,\n \"glAccountId\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal.\n\nhttps://developer.lokta.ai/api/journal-entries/create-gljournal-entry/" } }, { "name": "Retrieve Opening Balance", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/journalentries/openingbalance", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "journalentries", "openingbalance" ], "query": [ { "key": "officeId", "value": "", "disabled": true }, { "key": "currencyCode", "value": "", "disabled": true } ] }, "description": "Returns the opening balance for a specific office and currency.\n\nhttps://developer.lokta.ai/api/journal-entries/retrieve-opening-balance/" } }, { "name": "Retrieve Journal Entries for Provisioning", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/journalentries/provisioning", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "journalentries", "provisioning" ], "query": [ { "key": "offset", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "entryId", "value": "", "disabled": true } ] }, "description": "Returns journal entries related to provisioning entries based on entry ID.\n\nhttps://developer.lokta.ai/api/journal-entries/retrieve-journal-entries/" } }, { "name": "Retrieve a single Entry", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/journalentries/:journalEntryId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "journalentries", ":journalEntryId" ], "query": [ { "key": "runningBalance", "value": "", "disabled": true, "description": "runningBalance" }, { "key": "transactionDetails", "value": "", "disabled": true, "description": "transactionDetails" } ], "variable": [ { "key": "journalEntryId", "value": "" } ] }, "description": "Returns one journal entry with its debit and credit lines.\n\nhttps://developer.lokta.ai/api/journal-entries/retrieve-journal-entry-by-id/" } }, { "name": "Update Running balances for Journal Entries", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/journalentries/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "journalentries", ":transactionId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "transactionId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"officeId\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices.\n\nhttps://developer.lokta.ai/api/journal-entries/create-reversal-journal-entry/" } } ] }, { "name": "Accounting Setup", "description": "Accounting closures, rules and the financial-activity to ledger mappings.", "item": [ { "name": "Retrieve Accounting Rules", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/accountingrules", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "accountingrules" ] }, "description": "Returns the list of defined accounting rules.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-all-accounting-rules/" } }, { "name": "Create/Define a Accounting rule", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/accountingrules", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "accountingrules" ] }, "body": { "mode": "raw", "raw": "{\n \"accountToCredit\": 1,\n \"accountToDebit\": 1,\n \"description\": \"string\",\n \"name\": \"string\",\n \"officeId\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Defines an accounting rule: a preset debit and credit pair that lets a user post a manual entry without choosing the accounts.\n\nhttps://developer.lokta.ai/api/accounting-setup/create-accounting-rule/" } }, { "name": "Retrieve Accounting Rule Details Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/accountingrules/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "accountingrules", "template" ] }, "description": "Returns the field defaults and allowed values for creating an accounting rule.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-template-accounting-rule/" } }, { "name": "Retrieve a Accounting rule", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/accountingrules/:accountingRuleId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "accountingrules", ":accountingRuleId" ], "variable": [ { "key": "accountingRuleId", "value": "" } ] }, "description": "Returns the details of a defined Accounting rule.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-one-accounting-rule/" } }, { "name": "Update a Accounting Rule", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/accountingrules/:accountingRuleId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "accountingrules", ":accountingRuleId" ], "variable": [ { "key": "accountingRuleId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountToCredit\": 1,\n \"accountToDebit\": 1,\n \"description\": \"string\",\n \"name\": \"string\",\n \"officeId\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the details of a Accounting rule.\n\nhttps://developer.lokta.ai/api/accounting-setup/update-accounting-rule/" } }, { "name": "Delete a Accounting Rule", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/accountingrules/:accountingRuleId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "accountingrules", ":accountingRuleId" ], "variable": [ { "key": "accountingRuleId", "value": "" } ] }, "description": "Deletes an accounting rule.\n\nhttps://developer.lokta.ai/api/accounting-setup/delete-accounting-rule/" } }, { "name": "List Financial Activities to Accounts Mappings", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/financialactivityaccounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "financialactivityaccounts" ] }, "description": "Lists the mappings from organisation-level financial activities to general ledger accounts.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-all/" } }, { "name": "Create a new Financial Activity to Accounts Mapping", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/financialactivityaccounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "financialactivityaccounts" ] }, "body": { "mode": "raw", "raw": "{\n \"financialActivityId\": 200,\n \"glAccountId\": 2\n}", "options": { "raw": { "language": "json" } } }, "description": "Maps a financial activity to the general ledger account it posts to.\n\nhttps://developer.lokta.ai/api/accounting-setup/create-glaccount-mapping-financial-activity-account/" } }, { "name": "Retrieve financial activity mapping template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/financialactivityaccounts/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "financialactivityaccounts", "template" ] }, "description": "Returns the financial activities and ledger accounts available for a mapping.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-template/" } }, { "name": "Retrieve a Financial Activity to Account Mapping", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/financialactivityaccounts/:mappingId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "financialactivityaccounts", ":mappingId" ], "variable": [ { "key": "mappingId", "value": "" } ] }, "description": "Returns one financial activity to ledger account mapping.\n\nhttps://developer.lokta.ai/api/accounting-setup/retreive/" } }, { "name": "Update a Financial Activity to Account Mapping", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/financialactivityaccounts/:mappingId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "financialactivityaccounts", ":mappingId" ], "variable": [ { "key": "mappingId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"financialActivityId\": 200,\n \"glAccountId\": 2\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the ledger account linked to a financial activity.\n\nhttps://developer.lokta.ai/api/accounting-setup/update-glaccount-mapping-financial-activity-account/" } }, { "name": "Delete a Financial Activity to Account Mapping", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/financialactivityaccounts/:mappingId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "financialactivityaccounts", ":mappingId" ], "variable": [ { "key": "mappingId", "value": "" } ] }, "description": "Deletes a financial activity to ledger account mapping.\n\nhttps://developer.lokta.ai/api/accounting-setup/delete-glaccount-mapping-financial-activity-account/" } }, { "name": "List Accounting closures", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glclosures", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glclosures" ], "query": [ { "key": "officeId", "value": "", "disabled": true } ] }, "description": "Lists accounting closures. A closure stops journal entries from being posted or reversed prior to its closing date.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-all-glclosures/" } }, { "name": "Create an Accounting Closure", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glclosures", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glclosures" ] }, "body": { "mode": "raw", "raw": "{\n \"closingDate\": \"19 August 2026\",\n \"comments\": \"The accountants are heading for a Caribbean vacation\",\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\",\n \"officeId\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Closes accounting for an office at a closing date. Entries prior to that date can no longer be posted or reversed.\n\nhttps://developer.lokta.ai/api/accounting-setup/create-glclosure/" } }, { "name": "Retrieve an Accounting Closure", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glclosures/:glClosureId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glclosures", ":glClosureId" ], "variable": [ { "key": "glClosureId", "value": "" } ] }, "description": "Returns one accounting closure.\n\nhttps://developer.lokta.ai/api/accounting-setup/retrieve-one-glclosure/" } }, { "name": "Update an Accounting closure", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glclosures/:glClosureId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glclosures", ":glClosureId" ], "variable": [ { "key": "glClosureId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"comments\": \"All transactions verified by Johnny Cash\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Once an accounting closure is created, only the comments associated with it may be edited.\n\nhttps://developer.lokta.ai/api/accounting-setup/update-glclosure/" } }, { "name": "Delete an accounting closure", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/glclosures/:glClosureId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "glclosures", ":glClosureId" ], "variable": [ { "key": "glClosureId", "value": "" } ] }, "description": "Deletes an accounting closure.\n\nhttps://developer.lokta.ai/api/accounting-setup/delete-glclosure/" } } ] }, { "name": "Provisioning & Accruals", "description": "Provisioning criteria, categories and entries, plus periodic income accrual.", "item": [ { "name": "List provisioning categories", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcategory", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcategory" ] }, "description": "Lists provisioning categories, the classes of loan that carry a provisioning percentage.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/list-provisioningcategory/" } }, { "name": "createProvisioningCategory", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcategory", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcategory" ] }, "description": "Creates a provisioning category.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/create-provisioning-category/" } }, { "name": "updateProvisioningCategory", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcategory/:categoryId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcategory", ":categoryId" ], "variable": [ { "key": "categoryId", "value": "" } ] }, "description": "Updates a provisioning category.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/update-provisioning-category/" } }, { "name": "deleteProvisioningCategory", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcategory/:categoryId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcategory", ":categoryId" ], "variable": [ { "key": "categoryId", "value": "" } ] }, "description": "Deletes a provisioning category.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/delete-provisioning-category/" } }, { "name": "Retrieves all created Provisioning Criterias", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcriteria", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcriteria" ] }, "description": "Retrieves all created Provisioning Criterias.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/retrieve-all-provisioning-criteria/" } }, { "name": "Create a new Provisioning Criteria", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcriteria", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcriteria" ] }, "body": { "mode": "raw", "raw": "{\n \"criteriaName\": \"High Risk Products Criteria\",\n \"loanProducts\": [\n {\n \"accountMovesOutOfNPAOnlyOnArrearsCompletion\": true,\n \"accountingMappingOptions\": {},\n \"accountingMappings\": {},\n \"accountingRule\": {}\n }\n ],\n \"provisioningcriteria\": [\n {\n \"categoryId\": 1,\n \"categoryName\": \"string\",\n \"expenseAccount\": 1,\n \"expenseCode\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a provisioning criteria: the rules that set provisioning percentages for the selected loan products.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/create-provisioning-criteria/" } }, { "name": "Retrieve provisioning criteria template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcriteria/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcriteria", "template" ] }, "description": "Returns the options offered when creating a provisioning criteria.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/retrieve-provisioningcriteria-template/" } }, { "name": "Retrieves a Provisioning Criteria", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcriteria/:criteriaId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcriteria", ":criteriaId" ], "variable": [ { "key": "criteriaId", "value": "" } ] }, "description": "Returns one provisioning criteria.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/retrieve-one-provisioning-criteria/" } }, { "name": "Updates a new Provisioning Criteria", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcriteria/:criteriaId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcriteria", ":criteriaId" ], "variable": [ { "key": "criteriaId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"criteriaName\": \"High Risk Products Criteria\",\n \"loanProducts\": [\n {\n \"accountMovesOutOfNPAOnlyOnArrearsCompletion\": true,\n \"accountingMappingOptions\": {},\n \"accountingMappings\": {},\n \"accountingRule\": {}\n }\n ],\n \"provisioningcriteria\": [\n {\n \"categoryId\": 1,\n \"categoryName\": \"string\",\n \"expenseAccount\": 1,\n \"expenseCode\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a provisioning criteria.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/update-provisioning-criteria/" } }, { "name": "Deletes Provisioning Criteria", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningcriteria/:criteriaId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningcriteria", ":criteriaId" ], "variable": [ { "key": "criteriaId", "value": "" } ] }, "description": "Deletes a provisioning criteria.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/delete-provisioning-criteria/" } }, { "name": "List all Provisioning Entries Metadata", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningentries", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningentries" ], "query": [ { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" } ] }, "description": "Lists the provisioning entries that have been generated.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/retrieve-all-provisioning-entries/" } }, { "name": "Create new Provisioning Entries", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningentries", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningentries" ] }, "body": { "mode": "raw", "raw": "{\n \"createjournalentries\": true,\n \"date\": \"19 August 2026\",\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generates provisioning entries for a date, optionally creating the matching journal entries.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/create-provisioning-entries/" } }, { "name": "Retrieve provisioning entries by loan product", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningentries/entries", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningentries", "entries" ], "query": [ { "key": "entryId", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "officeId", "value": "", "disabled": true }, { "key": "productId", "value": "", "disabled": true }, { "key": "categoryId", "value": "", "disabled": true } ] }, "description": "Returns the provisioning entries by loan product, for a query.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/retrieve-provisioning-entries-loan-products/" } }, { "name": "Retrieves a Provisioning Entry Metadata", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningentries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningentries", ":entryId" ], "variable": [ { "key": "entryId", "value": "" } ] }, "description": "Returns the metadata of a generated Provisioning Entry.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/retrieve-one-provisioning-entry/" } }, { "name": "Recreates Provisioning Entry", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/provisioningentries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "provisioningentries", ":entryId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command=createjournalentry\ncommand=recreateprovisioningentry" } ], "variable": [ { "key": "entryId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"recreateprovisioningentry\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Recreates Provisioning Entry | createjournalentry.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/modify-provisioning-entry/" } }, { "name": "Executes Periodic Accrual Accounting", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/runaccruals", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "runaccruals" ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\",\n \"tillDate\": \"04 June 2014\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Runs periodic accrual accounting: accrues loan income up to the date you give.\n\nhttps://developer.lokta.ai/api/provisioning-accruals/execute-periodic-accrual-accounting/" } } ] } ] }, { "name": "Partners", "item": [ { "name": "Sourcing Partners", "description": "The partners who source loans: onboarding, activation, bank accounts, contacts, documents, terms and state changes.", "item": [ { "name": "Retrieve reference data", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "If-None-Match", "value": "", "disabled": true } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partner-reference-data", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partner-reference-data" ] }, "description": "Returns every lookup the sourcing partner endpoints use, as code and label pairs.\n\nhttps://developer.lokta.ai/api/sourcing-partners/retrieve-reference-data/" } }, { "name": "Retrieve the wire and schema fingerprints", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partner-version", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partner-version" ] }, "description": "Returns the fingerprints a client uses to tell whether a published shape has changed.\n\nhttps://developer.lokta.ai/api/sourcing-partners/retrieve-version/" } }, { "name": "List sourcing partners", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "pending | active | inactive; repeatable" }, { "key": "partner_type", "value": "", "disabled": true, "description": "Partner type code, e.g. DSA" }, { "key": "search", "value": "", "disabled": true, "description": "Name or external id, minimum 2 characters" }, { "key": "parent_partner_id", "value": "", "disabled": true, "description": "Public id of the parent partner" }, { "key": "limit", "value": "", "disabled": true, "description": "Default 25, maximum 100" }, { "key": "cursor", "value": "", "disabled": true, "description": "Opaque; never parse it" } ] }, "description": "Lists sourcing partners, with filters for status and a search on name or external id.\n\nhttps://developer.lokta.ai/api/sourcing-partners/list-sourcing-partners/" } }, { "name": "Create a sourcing partner", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"external_id\": \"string\",\n \"partner_type\": \"string\",\n \"details\": {},\n \"contacts\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a sourcing partner in the pending state.\n\nhttps://developer.lokta.ai/api/sourcing-partners/create-sourcing-partners/" } }, { "name": "Retrieve one sourcing partner", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one sourcing partner with its details, contacts, current terms and status history.\n\nhttps://developer.lokta.ai/api/sourcing-partners/retrieve-sourcing-partners/" } }, { "name": "Correct a partner's details", "request": { "method": "PATCH", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"external_id\": \"string\",\n \"details\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Corrects the details of a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/update-sourcing-partners/" } }, { "name": "Activate a partner", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/activation", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "activation" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Activates a sourcing partner, so loans can be attributed to it.\n\nhttps://developer.lokta.ai/api/sourcing-partners/activate/" } }, { "name": "Deactivate a partner", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/activation", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "activation" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Deactivates a sourcing partner, with a reason.\n\nhttps://developer.lokta.ai/api/sourcing-partners/deactivate/" } }, { "name": "List a partner's activity", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/activity", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "activity" ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "Default 25, maximum 100" }, { "key": "cursor", "value": "", "disabled": true, "description": "Opaque; never parse it" } ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists everything that happened to a sourcing partner, newest first.\n\nhttps://developer.lokta.ai/api/sourcing-partners/get/" } }, { "name": "List a partner's payout accounts", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "bank-accounts" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists the payout accounts of a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/list-sourcing-partners-bank-accounts/" } }, { "name": "Add a payout account", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "bank-accounts" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"beneficiary_name\": \"string\",\n \"bank_name\": \"string\",\n \"branch_name\": \"string\",\n \"account_type\": \"savings\",\n \"account_number\": \"string\",\n \"ifsc\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds a payout account to a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/create-sourcing-partners-bank-accounts/" } }, { "name": "List changes to a partner's payout accounts", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/bank-accounts/history", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "bank-accounts", "history" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists every change to the payout accounts of a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/history/" } }, { "name": "Correct a payout account's details", "request": { "method": "PATCH", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "bankAccountId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\",\n \"beneficiary_name\": \"string\",\n \"bank_name\": \"string\",\n \"branch_name\": \"string\",\n \"account_type\": \"savings\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Corrects the details of a payout account, with a reason.\n\nhttps://developer.lokta.ai/api/sourcing-partners/update-sourcing-partners-bank-accounts/" } }, { "name": "Make this the payout account", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/bank-accounts/:bankAccountId/primary", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "bank-accounts", ":bankAccountId", "primary" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "bankAccountId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Makes a payout account the primary one for a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/make-primary/" } }, { "name": "List a partner's contacts", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "contacts" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists the contacts of a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/list-sourcing-partners-contacts/" } }, { "name": "Add contacts to a partner", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "contacts" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"purpose\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds one contact, or several in one call, to a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/create-sourcing-partners-contacts/" } }, { "name": "Remove a contact", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "contacts", ":contactId" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "contactId", "value": "" } ] }, "description": "Removes a contact from a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/delete-sourcing-partners-contacts/" } }, { "name": "Edit a contact", "request": { "method": "PATCH", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "contacts", ":contactId" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "contactId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"purpose\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Edits a contact of a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/update-sourcing-partners-contacts/" } }, { "name": "Make this the primary contact", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/contacts/:contactId/primary", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "contacts", ":contactId", "primary" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "contactId", "value": "" } ] }, "description": "Makes a contact the primary one for a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/make-primary-sourcing-partners-contacts/" } }, { "name": "Retrieve the onboarding document checklist", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/document-checklist", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "document-checklist" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Returns the onboarding document checklist for a sourcing partner, one row per requirement.\n\nhttps://developer.lokta.ai/api/sourcing-partners/checklist/" } }, { "name": "List the documents held for a partner", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/documents", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "documents" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists every document held for a sourcing partner, newest first.\n\nhttps://developer.lokta.ai/api/sourcing-partners/documents/" } }, { "name": "Receive a document", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/documents", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "documents" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "document_type", "type": "text", "value": "" }, { "key": "title", "type": "text", "value": "" }, { "key": "reference_number", "type": "text", "value": "" }, { "key": "issued_on", "type": "text", "value": "" }, { "key": "valid_from", "type": "text", "value": "" }, { "key": "valid_to", "type": "text", "value": "" } ] }, "description": "Uploads a document for a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/receive/" } }, { "name": "Remove a document filed in error", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "documents", ":documentId" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "documentId", "value": "" } ] }, "description": "Removes a document that was filed in error.\n\nhttps://developer.lokta.ai/api/sourcing-partners/remove/" } }, { "name": "Download a partner document", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/documents/:documentId/content", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "documents", ":documentId", "content" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "documentId", "value": "" } ] }, "description": "Downloads the file of a partner document.\n\nhttps://developer.lokta.ai/api/sourcing-partners/content/" } }, { "name": "Verify or reject a document", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/documents/:documentId/verification", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "documents", ":documentId", "verification" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"verified\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Verifies or rejects a partner document.\n\nhttps://developer.lokta.ai/api/sourcing-partners/verify/" } }, { "name": "Retrieve a partner's fee position", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/fee-summary", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "fee-summary" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Returns the fee position of a sourcing partner.\n\nhttps://developer.lokta.ai/api/sourcing-partners/retrieve-sourcing-partners-fee-summary/" } }, { "name": "List a partner's state-change requests", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/state-change-requests", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "state-change-requests" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists the state-change requests of a sourcing partner, newest first.\n\nhttps://developer.lokta.ai/api/sourcing-partners/list-sourcing-partners-state-change-requests/" } }, { "name": "Request a state change", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/state-change-requests", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "state-change-requests" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"requested_state\": \"on_hold\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Requests a change of state for a sourcing partner, with a reason.\n\nhttps://developer.lokta.ai/api/sourcing-partners/request/" } }, { "name": "Withdraw a state-change request", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/state-change-requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "state-change-requests", ":requestId" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "requestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Withdraws a state-change request. Only the person who made it can.\n\nhttps://developer.lokta.ai/api/sourcing-partners/withdraw/" } }, { "name": "Approve a state-change request", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/state-change-requests/:requestId/approval", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "state-change-requests", ":requestId", "approval" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "requestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Approves a state-change request and applies the change.\n\nhttps://developer.lokta.ai/api/sourcing-partners/approve-sourcing-partners-state-change-requests/" } }, { "name": "Reject a state-change request", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/state-change-requests/:requestId/rejection", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "state-change-requests", ":requestId", "rejection" ], "variable": [ { "key": "partnerId", "value": "" }, { "key": "requestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Rejects a state-change request, with a reason.\n\nhttps://developer.lokta.ai/api/sourcing-partners/reject-sourcing-partners-state-change-requests/" } }, { "name": "List a partner's terms versions", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/terms", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "terms" ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "Default 25, maximum 100" }, { "key": "cursor", "value": "", "disabled": true, "description": "Opaque; never parse it" } ], "variable": [ { "key": "partnerId", "value": "" } ] }, "description": "Lists every terms version a sourcing partner has had, newest first.\n\nhttps://developer.lokta.ai/api/sourcing-partners/list-sourcing-partners-terms/" } }, { "name": "Revise a partner's terms", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/sourcing-partners/:partnerId/terms", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "sourcing-partners", ":partnerId", "terms" ], "variable": [ { "key": "partnerId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"product_id\": 1,\n \"effective_from\": \"string\",\n \"method\": \"string\",\n \"accrual_frequency\": \"string\",\n \"guarantee\": {\n \"form\": \"string\"\n },\n \"lines\": [\n {\n \"basis\": \"string\",\n \"slabs\": []\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Writes a new terms version for a sourcing partner and closes the one it supersedes.\n\nhttps://developer.lokta.ai/api/sourcing-partners/revise/" } } ] }, { "name": "Partner Invoicing", "description": "Partner fee runs, draft invoices and invoices: generate, approve, pay and reverse.", "item": [ { "name": "List draft invoices", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/draft-invoices", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "draft-invoices" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Repeatable" }, { "key": "partner_id", "value": "", "disabled": true }, { "key": "fee_run_id", "value": "", "disabled": true }, { "key": "period_start", "value": "", "disabled": true }, { "key": "period_end", "value": "", "disabled": true }, { "key": "produced_by", "value": "", "disabled": true, "description": "system | user" }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true } ] }, "description": "Lists draft invoices, newest first.\n\nhttps://developer.lokta.ai/api/partner-invoicing/list/" } }, { "name": "Retrieve one draft invoice, with its lines", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/draft-invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "draft-invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one draft invoice with its lines and the basis of each.\n\nhttps://developer.lokta.ai/api/partner-invoicing/retrieve-draft-invoices/" } }, { "name": "Approve a draft invoice", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/draft-invoices/:id/approval", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "draft-invoices", ":id", "approval" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Approves a draft invoice, which creates the invoice and gives it an invoice number.\n\nhttps://developer.lokta.ai/api/partner-invoicing/approve/" } }, { "name": "The loan-level evidence behind a draft", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/draft-invoices/:id/evidence", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "draft-invoices", ":id", "evidence" ], "query": [ { "key": "line_no", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Lists the accruals behind a draft invoice, one row per accrual.\n\nhttps://developer.lokta.ai/api/partner-invoicing/evidence/" } }, { "name": "Reject a draft invoice", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/draft-invoices/:id/rejection", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "draft-invoices", ":id", "rejection" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Rejects a draft invoice, with a reason.\n\nhttps://developer.lokta.ai/api/partner-invoicing/reject/" } }, { "name": "List fee runs", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/fee-runs", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "fee-runs" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Repeatable" }, { "key": "period_start", "value": "", "disabled": true, "description": "ISO date, inclusive lower bound" }, { "key": "period_end", "value": "", "disabled": true, "description": "ISO date, inclusive upper bound" }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true } ] }, "description": "Lists fee runs, newest first.\n\nhttps://developer.lokta.ai/api/partner-invoicing/list-fee-runs/" } }, { "name": "Run fees for a period and produce draft invoices", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/fee-runs", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "fee-runs" ] }, "body": { "mode": "raw", "raw": "{\n \"period_start\": \"string\",\n \"period_end\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Computes partner fees for a period and produces a draft invoice for each partner and currency.\n\nhttps://developer.lokta.ai/api/partner-invoicing/compute/" } }, { "name": "Retrieve one fee run", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/fee-runs/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "fee-runs", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one fee run.\n\nhttps://developer.lokta.ai/api/partner-invoicing/retrieve-fee-runs/" } }, { "name": "List the accruals a fee run produced", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/fee-runs/:id/accruals", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "fee-runs", ":id", "accruals" ], "query": [ { "key": "partner_id", "value": "", "disabled": true, "description": "Opaque partner id, spr_…" }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Lists the accruals a fee run produced.\n\nhttps://developer.lokta.ai/api/partner-invoicing/accruals/" } }, { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/invoices", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "invoices" ], "query": [ { "key": "partner_id", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "period_start", "value": "", "disabled": true }, { "key": "period_end", "value": "", "disabled": true }, { "key": "overdue", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true } ] }, "description": "Lists partner invoices, with filters for partner, status, period and overdue.\n\nhttps://developer.lokta.ai/api/partner-invoicing/list-invoices/" } }, { "name": "Retrieve one invoice, with its lines", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one partner invoice with its lines.\n\nhttps://developer.lokta.ai/api/partner-invoicing/retrieve-invoices/" } }, { "name": "Cancel an invoice", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/invoices/:id/cancellation", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "invoices", ":id", "cancellation" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancels a partner invoice, with a reason.\n\nhttps://developer.lokta.ai/api/partner-invoicing/cancel/" } }, { "name": "List the payments recorded against an invoice", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/invoices/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "invoices", ":id", "payments" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Lists the payments recorded against one invoice.\n\nhttps://developer.lokta.ai/api/partner-invoicing/payments/" } }, { "name": "Record a payment", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/invoices/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "invoices", ":id", "payments" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount_paid\": \"string\",\n \"bank_account_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Records a payment already made against a partner invoice.\n\nhttps://developer.lokta.ai/api/partner-invoicing/record-payment/" } }, { "name": "Reverse a recorded payment", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/invoices/:invoiceId/payments/:paymentId/reversal", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "invoices", ":invoiceId", "payments", ":paymentId", "reversal" ], "variable": [ { "key": "invoiceId", "value": "" }, { "key": "paymentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Reverses a payment recorded against a partner invoice, with a reason.\n\nhttps://developer.lokta.ai/api/partner-invoicing/reverse-payment/" } } ] }, { "name": "Loan Attribution", "description": "Attribute each loan to the partner that sourced it, and correct that attribution with a record.", "item": [ { "name": "List the attribution trail for a loan", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attribution-corrections?loan_id=", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attribution-corrections" ], "query": [ { "key": "loan_id", "value": "", "disabled": false, "description": "Core numeric loan id" } ] }, "description": "Lists every change of partner for one loan, newest first.\n\nhttps://developer.lokta.ai/api/loan-attribution/by-loan/" } }, { "name": "List loan attributions", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attributions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attributions" ], "query": [ { "key": "loan_id", "value": "", "disabled": true, "description": "Core numeric loan id" }, { "key": "partner_id", "value": "", "disabled": true, "description": "Opaque partner id, spr_…" }, { "key": "loan_external_id", "value": "", "disabled": true, "description": "The loan's external id" }, { "key": "limit", "value": "", "disabled": true, "description": "Default 25, maximum 100" }, { "key": "cursor", "value": "", "disabled": true, "description": "Opaque; never parse it" } ] }, "description": "Lists loan attributions, newest first.\n\nhttps://developer.lokta.ai/api/loan-attribution/list-loan-attributions/" } }, { "name": "Attribute a loan to a partner", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attributions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attributions" ] }, "body": { "mode": "raw", "raw": "{\n \"loan_id\": 1,\n \"partner_id\": \"string\",\n \"source\": \"at_origination\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Attributes a loan to the active partner that sourced it.\n\nhttps://developer.lokta.ai/api/loan-attribution/create-loan-attributions/" } }, { "name": "Retrieve one attribution", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attributions/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attributions", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one loan attribution: which partner a loan is attributed to, and how.\n\nhttps://developer.lokta.ai/api/loan-attribution/retrieve-loan-attributions/" } }, { "name": "Detach a loan from its partner", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attributions/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attributions", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Detaches a loan from its partner, which corrects the loan to Direct.\n\nhttps://developer.lokta.ai/api/loan-attribution/detach/" } }, { "name": "List the corrections for an attributed loan", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attributions/:id/corrections", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attributions", ":id", "corrections" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Lists the corrections made to the loan an attribution belongs to.\n\nhttps://developer.lokta.ai/api/loan-attribution/corrections/" } }, { "name": "Correct an attribution", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/loan-attributions/:id/corrections", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "loan-attributions", ":id", "corrections" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\",\n \"partner_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Moves a loan to a different partner, or back to Direct.\n\nhttps://developer.lokta.ai/api/loan-attribution/correct/" } } ] } ] }, { "name": "Platform", "item": [ { "name": "Authentication", "description": "How a session begins: HTTP Basic authentication against the tenant.", "item": [ { "name": "Verify authentication", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/authentication", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "authentication" ] }, "body": { "mode": "raw", "raw": "{\n \"password\": \"password\",\n \"username\": \"admin\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Authenticates the credentials provided and returns the set roles and permissions allowed.\n\nhttps://developer.lokta.ai/api/authentication/authenticate/" } } ] }, { "name": "User Management", "description": "Application user accounts: creation, updates and passwords.", "item": [ { "name": "Retrieve list of users", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users" ] }, "description": "Lists the user accounts on the tenant.\n\nhttps://developer.lokta.ai/api/user-management/retrieve-all-users/" } }, { "name": "Create a User", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users" ] }, "body": { "mode": "raw", "raw": "{\n \"clients\": [\n 2,\n 3\n ],\n \"email\": \"user@example.com\",\n \"firstname\": \"Test\",\n \"isLoginRetriesEnabled\": true,\n \"isPasswordResetAllowed\": true,\n \"lastname\": \"User\",\n \"officeId\": 1,\n \"password\": \"password\",\n \"passwordNeverExpires\": true,\n \"repeatPassword\": \"repeatPassword\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds new application user.\n\nhttps://developer.lokta.ai/api/user-management/create-user/" } }, { "name": "Retrieve User Details Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users", "template" ] }, "description": "Returns the field defaults and allowed values for creating a user.\n\nhttps://developer.lokta.ai/api/user-management/retrieve-template-user/" } }, { "name": "Retrieve a User", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "" } ] }, "description": "Returns one user account.\n\nhttps://developer.lokta.ai/api/user-management/retrieve-one-user/" } }, { "name": "Update a User", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"clients\": [\n 2,\n 3\n ],\n \"email\": \"user@example.com\",\n \"firstname\": \"Test\",\n \"isLoginRetriesEnabled\": true,\n \"isPasswordResetAllowed\": true,\n \"lastname\": \"User\",\n \"officeId\": 1,\n \"password\": \"password\",\n \"repeatPassword\": \"repeatPassword\",\n \"roles\": [\n 2,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the details of one user account.\n\nhttps://developer.lokta.ai/api/user-management/update-user/" } }, { "name": "Delete a User", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users", ":userId" ], "variable": [ { "key": "userId", "value": "" } ] }, "description": "Removes the user and the associated roles and permissions.\n\nhttps://developer.lokta.ai/api/user-management/delete-user/" } }, { "name": "Change the password of a User", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/users/:userId/pwd", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "users", ":userId", "pwd" ], "variable": [ { "key": "userId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"password\": \"password\",\n \"repeatPassword\": \"repeatPassword\"\n}", "options": { "raw": { "language": "json" } } }, "description": "When updating a password you must provide the repeatPassword parameter also.\n\nhttps://developer.lokta.ai/api/user-management/change-password-user/" } } ] }, { "name": "Roles & Permissions", "description": "What a user may do: roles and the permission catalogue.", "item": [ { "name": "List Application Permissions", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/permissions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "permissions" ] }, "description": "ARGUMENTS makerCheckerableoptional, Values are true, false. Default is false.\n\nhttps://developer.lokta.ai/api/roles-permissions/retrieve-all-permissions/" } }, { "name": "List Roles", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles" ] }, "description": "Lists the roles defined on the tenant.\n\nhttps://developer.lokta.ai/api/roles-permissions/retrieve-all-roles/" } }, { "name": "Create a New Role", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles" ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"A description outlining the purpose of this role in relation to the application.\",\n \"name\": \"Another Role Name\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a role. Grant it permissions afterwards with the role permissions endpoint.\n\nhttps://developer.lokta.ai/api/roles-permissions/create-role/" } }, { "name": "Retrieve a Role", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "" } ] }, "description": "Returns one role, found by its id.\n\nhttps://developer.lokta.ai/api/roles-permissions/retrieve-one-role/" } }, { "name": "Update a Role", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"some description(changed)\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates one role, found by its id.\n\nhttps://developer.lokta.ai/api/roles-permissions/update-role/" } }, { "name": "Delete a Role", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "" } ] }, "description": "Description : Delete the role in case role is not associated with any users.\n\nhttps://developer.lokta.ai/api/roles-permissions/delete-role/" } }, { "name": "Retrieve a Role's Permissions", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles/:roleId/permissions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles", ":roleId", "permissions" ], "variable": [ { "key": "roleId", "value": "" } ] }, "description": "Lists the permissions granted to a role.\n\nhttps://developer.lokta.ai/api/roles-permissions/retrieve-role-permissions/" } }, { "name": "Update a Role's Permissions", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/roles/:roleId/permissions", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "roles", ":roleId", "permissions" ], "variable": [ { "key": "roleId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"permissions\": \"\\\"CREATE_GUARANTOR\\\":true,\\n \\\"CREATE_CLIENT\\\":true\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Grants or revokes permissions on a role.\n\nhttps://developer.lokta.ai/api/roles-permissions/update-role-permissions/" } } ] }, { "name": "Staff", "description": "Branch staff and loan officers.", "item": [ { "name": "Retrieve Staff", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/staff", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "staff" ], "query": [ { "key": "officeId", "value": "", "disabled": true, "description": "officeId" }, { "key": "staffInOfficeHierarchy", "value": "", "disabled": true, "description": "staffInOfficeHierarchy" }, { "key": "loanOfficersOnly", "value": "", "disabled": true, "description": "loanOfficersOnly" }, { "key": "status", "value": "", "disabled": true, "description": "status" } ] }, "description": "Returns the list of staff members.\n\nhttps://developer.lokta.ai/api/staff/retrieve-all-staff/" } }, { "name": "Create a staff member", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/staff", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "staff" ] }, "body": { "mode": "raw", "raw": "{\n \"firstname\": \"string\",\n \"lastname\": \"string\",\n \"officeId\": 1,\n \"dateFormat\": \"dd MMMM yyyy\",\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"forceStatus\": true,\n \"isActive\": true,\n \"isLoanOfficer\": true,\n \"joiningDate\": \"19 August 2026\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a staff member, such as a loan officer, at an office.\n\nhttps://developer.lokta.ai/api/staff/create-staff/" } }, { "name": "Retrieve a Staff Member", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/staff/:staffId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "staff", ":staffId" ], "variable": [ { "key": "staffId", "value": "" } ] }, "description": "Returns one staff member.\n\nhttps://developer.lokta.ai/api/staff/retrieve-one-staff/" } }, { "name": "Update a Staff Member", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/staff/:staffId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "staff", ":staffId" ], "variable": [ { "key": "staffId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"firstname\": \"string\",\n \"forceStatus\": true,\n \"isActive\": true,\n \"isLoanOfficer\": true,\n \"joiningDate\": \"19 August 2026\",\n \"lastname\": \"string\",\n \"mobileNo\": \"string\",\n \"officeId\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a staff member.\n\nhttps://developer.lokta.ai/api/staff/update-staff/" } } ] }, { "name": "Codes & Code Values", "description": "System and custom lookup lists that dropdowns are built from.", "item": [ { "name": "Retrieve Codes", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes" ] }, "description": "Lists the codes on the tenant. A code is a lookup list, and its values fill dropdowns.\n\nhttps://developer.lokta.ai/api/codes-code-values/retrieve-all-codes/" } }, { "name": "Create a Code", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"MyNewCode\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a code. Codes created through api are always 'user defined' and so system defined is marked as false.\n\nhttps://developer.lokta.ai/api/codes-code-values/create-code/" } }, { "name": "Retrieve a Code by name", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes/name/:codeName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes", "name", ":codeName" ], "variable": [ { "key": "codeName", "value": "" } ] }, "description": "Returns one code, found by its name.\n\nhttps://developer.lokta.ai/api/codes-code-values/retrieve-one-code-by-name/" } }, { "name": "List Code Values by code name", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes/name/:codeName/codevalues", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes", "name", ":codeName", "codevalues" ], "variable": [ { "key": "codeName", "value": "" } ] }, "description": "Lists the values of a code, found by the code name.\n\nhttps://developer.lokta.ai/api/codes-code-values/retrieve-all-code-values-by-code-name/" } }, { "name": "Retrieve a Code by id", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes/:codeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes", ":codeId" ], "variable": [ { "key": "codeId", "value": "" } ] }, "description": "Returns one code, found by its id.\n\nhttps://developer.lokta.ai/api/codes-code-values/retrieve-one-code/" } }, { "name": "Update a Code", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes/:codeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes", ":codeId" ], "variable": [ { "key": "codeId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"MyNewCode(changed)\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the details of a code if it is not system defined.\n\nhttps://developer.lokta.ai/api/codes-code-values/update-code/" } }, { "name": "Delete a Code", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes/:codeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes", ":codeId" ], "variable": [ { "key": "codeId", "value": "" } ] }, "description": "Deletes a code if it is not system defined.\n\nhttps://developer.lokta.ai/api/codes-code-values/delete-code/" } }, { "name": "List Code Values by code id", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/codes/:codeId/codevalues", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "codes", ":codeId", "codevalues" ], "variable": [ { "key": "codeId", "value": "" } ] }, "description": "Lists the values of a code, found by the code id.\n\nhttps://developer.lokta.ai/api/codes-code-values/retrieve-all-code-values/" } } ] }, { "name": "Documents", "description": "Files attached to platform entities: upload, list, download.", "item": [ { "name": "List document category mappings", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/documentcategories", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "documentcategories" ], "query": [ { "key": "entityType", "value": "", "disabled": true } ] }, "description": "Reports mappings whose code value has since been deactivated as well; an administrator has to be able to see the mapping that stopped working. An unknown entityType is a 400 here, unlike on the entity-scoped template read, because a typo on a configuration screen should be reported rather than answered with an empty list.\n\nhttps://developer.lokta.ai/api/documents/list-documentcategories/" } }, { "name": "Offer a document category to an entity type", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/documentcategories", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "documentcategories" ] }, "body": { "mode": "raw", "raw": "{\n \"documentCategoryId\": 1,\n \"entityType\": \"string\",\n \"active\": true,\n \"documentTagIds\": [\n 1\n ],\n \"orderPosition\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "One category may be offered to one entity type once; a second attempt is a 403.\n\nhttps://developer.lokta.ai/api/documents/create/" } }, { "name": "Retrieve the document category configuration template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/documentcategories/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "documentcategories", "template" ] }, "description": "Returns the entity types that support document categories and the active category and tag values.\n\nhttps://developer.lokta.ai/api/documents/template/" } }, { "name": "Retrieve one document category mapping", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/documentcategories/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "documentcategories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one document category mapping.\n\nhttps://developer.lokta.ai/api/documents/retrieve-one/" } }, { "name": "Update a document category mapping", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/documentcategories/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "documentcategories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"active\": true,\n \"documentTagIds\": [\n 1\n ],\n \"orderPosition\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Updatable fields: documentTagIds, orderPosition, active.\n\nhttps://developer.lokta.ai/api/documents/update/" } }, { "name": "Withdraw a document category from an entity type", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/documentcategories/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "documentcategories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Removes the mapping and the tags under it.\n\nhttps://developer.lokta.ai/api/documents/delete/" } }, { "name": "List documents", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/:entityType/:entityId/documents", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", ":entityType", ":entityId", "documents" ], "variable": [ { "key": "entityType", "value": "" }, { "key": "entityId", "value": "" } ] }, "description": "Lists the documents attached to one entity, such as a client or a loan.\n\nhttps://developer.lokta.ai/api/documents/retrieve-all-documents/" } }, { "name": "Create a Document", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/:entityType/:entityId/documents", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", ":entityType", ":entityId", "documents" ], "variable": [ { "key": "entityType", "value": "" }, { "key": "entityId", "value": "" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "description", "type": "text", "value": "" }, { "key": "documentCategory", "type": "text", "value": "" }, { "key": "documentTag", "type": "text", "value": "" }, { "key": "file", "type": "file", "src": [] }, { "key": "name", "type": "text", "value": "" } ] }, "description": "Uploads a document and attaches it to an entity, as a multipart form.\n\nhttps://developer.lokta.ai/api/documents/create-document/" } }, { "name": "Retrieve the document classification template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/:entityType/:entityId/documents/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", ":entityType", ":entityId", "documents", "template" ], "variable": [ { "key": "entityType", "value": "" }, { "key": "entityId", "value": "" } ] }, "description": "The document categories, and the tags under each, that this entity type's documents may be filed as.\n\nhttps://developer.lokta.ai/api/documents/retrieve-classification-template/" } }, { "name": "Retrieve a Document", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/:entityType/:entityId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", ":entityType", ":entityId", "documents", ":documentId" ], "variable": [ { "key": "entityType", "value": "" }, { "key": "entityId", "value": "" }, { "key": "documentId", "value": "" } ] }, "description": "Returns the details of one document attached to an entity.\n\nhttps://developer.lokta.ai/api/documents/get-document/" } }, { "name": "Update a Document", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/:entityType/:entityId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", ":entityType", ":entityId", "documents", ":documentId" ], "variable": [ { "key": "entityType", "value": "" }, { "key": "entityId", "value": "" }, { "key": "documentId", "value": "" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "description", "type": "text", "value": "" }, { "key": "documentCategory", "type": "text", "value": "" }, { "key": "documentTag", "type": "text", "value": "" }, { "key": "file", "type": "file", "src": [] }, { "key": "name", "type": "text", "value": "" } ] }, "description": "Classification follows the same rules as on create. Omitting both leaves the document filed where it already was; sending a documentCategory refiles it, and sending a documentCategory without a documentTag clears the tag.\n\nhttps://developer.lokta.ai/api/documents/update-document/" } }, { "name": "Remove a Document", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/:entityType/:entityId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", ":entityType", ":entityId", "documents", ":documentId" ], "variable": [ { "key": "entityType", "value": "" }, { "key": "entityId", "value": "" }, { "key": "documentId", "value": "" } ] }, "description": "Removes a document from an entity.\n\nhttps://developer.lokta.ai/api/documents/delete-document/" } } ] }, { "name": "Payment Types", "description": "The payment instrument catalogue: cash, transfer, cheque and friends.", "item": [ { "name": "Retrieve all Payment Types", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/paymenttypes", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "paymenttypes" ], "query": [ { "key": "onlyWithCode", "value": "", "disabled": true } ] }, "description": "Lists the payment types, the instruments a repayment can be recorded against.\n\nhttps://developer.lokta.ai/api/payment-types/get-all-payment-types/" } }, { "name": "Create a Payment Type", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/paymenttypes", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "paymenttypes" ] }, "body": { "mode": "raw", "raw": "{\n \"isSystemDefined\": true,\n \"name\": \"string\",\n \"codeName\": \"string\",\n \"description\": \"string\",\n \"isCashPayment\": true,\n \"position\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a payment type that repayments can use.\n\nhttps://developer.lokta.ai/api/payment-types/create-payment-type/" } }, { "name": "Retrieve a Payment Type", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/paymenttypes/:paymentTypeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "paymenttypes", ":paymentTypeId" ], "variable": [ { "key": "paymentTypeId", "value": "" } ] }, "description": "Returns one payment type.\n\nhttps://developer.lokta.ai/api/payment-types/retrieve-one-payment-type/" } }, { "name": "Update a Payment Type", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/paymenttypes/:paymentTypeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "paymenttypes", ":paymentTypeId" ], "variable": [ { "key": "paymentTypeId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"isSystemDefined\": true,\n \"name\": \"string\",\n \"codeName\": \"string\",\n \"description\": \"string\",\n \"isCashPayment\": true,\n \"position\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates one payment type, found by its id.\n\nhttps://developer.lokta.ai/api/payment-types/update-payment-type/" } }, { "name": "Delete a Payment Type", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/paymenttypes/:paymentTypeId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "paymenttypes", ":paymentTypeId" ], "variable": [ { "key": "paymentTypeId", "value": "" } ] }, "description": "Deletes one payment type, found by its id.\n\nhttps://developer.lokta.ai/api/payment-types/delete-code-payment-type/" } } ] }, { "name": "Reports", "description": "The reporting engine: catalogue, parameters, and execution.", "item": [ { "name": "List Reports", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/reports", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "reports" ] }, "description": "Lists the reports available on the tenant.\n\nhttps://developer.lokta.ai/api/reports/retrieve-all-reports/" } }, { "name": "Create a Report", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/reports", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "reports" ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Just An Example\",\n \"reportCategory\": \"Loan\",\n \"reportName\": \"Completely New Report\",\n \"reportParameters\": [\n {}\n ],\n \"reportSql\": \"select 'very good sql' as AComment\",\n \"reportSubType\": \"string\",\n \"reportType\": \"Table\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a report definition.\n\nhttps://developer.lokta.ai/api/reports/create-report/" } }, { "name": "Retrieve Report Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/reports/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "reports", "template" ] }, "description": "Returns the field defaults and allowed values for creating a report definition.\n\nhttps://developer.lokta.ai/api/reports/retrieve-template-report/" } }, { "name": "Retrieve a Report", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "reports", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns one report definition, with its parameters.\n\nhttps://developer.lokta.ai/api/reports/retrieve-one-report/" } }, { "name": "Update a Report", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "reports", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reportName\": \"Completely New Report\",\n \"reportParameters\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Only the useReport description can be updated for core reports.\n\nhttps://developer.lokta.ai/api/reports/update-report/" } }, { "name": "Delete a Report", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "reports", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Deletes a report definition.\n\nhttps://developer.lokta.ai/api/reports/delete-report/" } }, { "name": "Run a predefined report", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/runreports/:reportName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "runreports", ":reportName" ], "query": [ { "key": "exportCSV", "value": "", "disabled": true, "description": "Set to true to export results as CSV" }, { "key": "parameterType", "value": "", "disabled": true, "description": "Indicates if this is a parameter type request" }, { "key": "output-type", "value": "", "disabled": true, "description": "Output format type (HTML, XLS, CSV, PDF)" }, { "key": "R_officeId", "value": "", "disabled": true, "description": "Office ID filter" }, { "key": "R_loanOfficerId", "value": "", "disabled": true, "description": "Loan officer ID filter" }, { "key": "R_fromDate", "value": "", "disabled": true, "description": "Start date filter (yyyy-MM-dd)" }, { "key": "R_toDate", "value": "", "disabled": true, "description": "End date filter (yyyy-MM-dd)" }, { "key": "R_currencyId", "value": "", "disabled": true, "description": "Currency ID filter" }, { "key": "R_accountNo", "value": "", "disabled": true, "description": "Account number filter" } ], "variable": [ { "key": "reportName", "value": "" } ] }, "description": "This resource allows you to run and receive output from pre-defined Lokta reports.\n\nhttps://developer.lokta.ai/api/reports/run-report/" } } ] }, { "name": "Tenant Info", "description": "Read-only facts about the tenant the request is running against.", "item": [ { "name": "Registry facts for the signed-in tenant", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/tenant-info", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "tenant-info" ] }, "description": "Returns the identifier, the name and the expiry of the tenant the request runs against.\n\nhttps://developer.lokta.ai/api/tenant-info/retrieve-tenant-info/" } } ] } ] }, { "name": "Governance", "item": [ { "name": "Maker Checker", "description": "Four-eye approval: review and act on commands waiting for a second person.", "item": [ { "name": "List Maker Checker Entries", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/makercheckers", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "makercheckers" ], "query": [ { "key": "actionName", "value": "", "disabled": true }, { "key": "entityName", "value": "", "disabled": true }, { "key": "resourceId", "value": "", "disabled": true }, { "key": "makerId", "value": "", "disabled": true }, { "key": "makerDateTimeFrom", "value": "", "disabled": true }, { "key": "makerDateTimeTo", "value": "", "disabled": true }, { "key": "clientId", "value": "", "disabled": true }, { "key": "loanid", "value": "", "disabled": true }, { "key": "officeId", "value": "", "disabled": true }, { "key": "dateFormat", "value": "", "disabled": true }, { "key": "locale", "value": "", "disabled": true } ] }, "description": "Get a list of entries that can be checked by the requestor that match the criteria supplied.\n\nhttps://developer.lokta.ai/api/maker-checker/retrieve-commands/" } }, { "name": "Maker Checker Search Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/makercheckers/searchtemplate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "makercheckers", "searchtemplate" ] }, "description": "Returns the users, actions and entities you can filter pending approvals by.\n\nhttps://developer.lokta.ai/api/maker-checker/retrieve-makercheckers-searchtemplate/" } }, { "name": "Approve or reject a Maker Checker entry", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/makercheckers/:auditId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "makercheckers", ":auditId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "auditId", "value": "" } ] }, "description": "Approves or rejects a command that is waiting for a second person, chosen with the command query parameter.\n\nhttps://developer.lokta.ai/api/maker-checker/approve-maker-checker-entry/" } }, { "name": "Delete Maker Checker Entry", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/makercheckers/:auditId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "makercheckers", ":auditId" ], "variable": [ { "key": "auditId", "value": "" } ] }, "description": "Deletes a command that is waiting for approval.\n\nhttps://developer.lokta.ai/api/maker-checker/delete-maker-checker-entry/" } } ] }, { "name": "Audit Trail", "description": "The record of who did what: search and retrieve audit entries.", "item": [ { "name": "List Audits", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/audits", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "audits" ], "query": [ { "key": "actionName", "value": "", "disabled": true }, { "key": "entityName", "value": "", "disabled": true }, { "key": "resourceId", "value": "", "disabled": true }, { "key": "makerId", "value": "", "disabled": true }, { "key": "makerDateTimeFrom", "value": "", "disabled": true }, { "key": "makerDateTimeTo", "value": "", "disabled": true }, { "key": "checkerId", "value": "", "disabled": true }, { "key": "checkerDateTimeFrom", "value": "", "disabled": true }, { "key": "checkerDateTimeTo", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "clientId", "value": "", "disabled": true }, { "key": "loanId", "value": "", "disabled": true }, { "key": "officeId", "value": "", "disabled": true }, { "key": "processingResult", "value": "", "disabled": true }, { "key": "dateFormat", "value": "", "disabled": true }, { "key": "locale", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" }, { "key": "orderBy", "value": "", "disabled": true, "description": "orderBy" }, { "key": "sortOrder", "value": "", "disabled": true, "description": "sortOrder" }, { "key": "paged", "value": "", "disabled": true, "description": "paged" } ] }, "description": "Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope. Also it supports pagination and sorting.\n\nhttps://developer.lokta.ai/api/audit-trail/retrieve-audit-entries/" } }, { "name": "Audit Search Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/audits/searchtemplate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "audits", "searchtemplate" ] }, "description": "Returns the users, actions and entities you can filter audit entries by.\n\nhttps://developer.lokta.ai/api/audit-trail/retrieve-audit-search-template/" } }, { "name": "Retrieve an Audit Entry", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/audits/:auditId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "audits", ":auditId" ], "variable": [ { "key": "auditId", "value": "" } ] }, "description": "Returns one audit entry, found by its id.\n\nhttps://developer.lokta.ai/api/audit-trail/retrieve-audit-entry/" } } ] }, { "name": "Hooks & Events", "description": "Push changes out: webhooks and external event configuration.", "item": [ { "name": "List all external event configurations", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/externalevents/configuration", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "externalevents", "configuration" ] }, "description": "Lists which external events the platform posts, and whether each is enabled.\n\nhttps://developer.lokta.ai/api/hooks-events/get-external-event-configurations/" } }, { "name": "Enable/Disable external events posting", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/externalevents/configuration", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "externalevents", "configuration" ] }, "body": { "mode": "raw", "raw": "{\n \"externalEventConfigurations\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Turns the posting of individual external events on or off.\n\nhttps://developer.lokta.ai/api/hooks-events/update-external-event-configurations/" } }, { "name": "Retrieve Hooks", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/hooks", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "hooks" ] }, "description": "Lists the hooks that push platform events to another system.\n\nhttps://developer.lokta.ai/api/hooks-events/retrieve-all-hooks/" } }, { "name": "Create a Hook", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/hooks", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "hooks" ] }, "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"displayName\": \"string\",\n \"events\": [\n {\n \"actionName\": \"string\",\n \"entityName\": \"string\"\n }\n ],\n \"isActive\": true,\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a hook that pushes platform events to another system.\n\nhttps://developer.lokta.ai/api/hooks-events/create-hook/" } }, { "name": "Retrieve Hooks Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/hooks/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "hooks", "template" ] }, "description": "This is a convenience resource. It can be useful when building maintenance user interface screens for client applications.\n\nhttps://developer.lokta.ai/api/hooks-events/retrieve-template-hook/" } }, { "name": "Retrieve a Hook", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/hooks/:hookId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "hooks", ":hookId" ], "query": [ { "key": "template", "value": "", "disabled": true, "description": "template" } ], "variable": [ { "key": "hookId", "value": "" } ] }, "description": "Returns one hook, found by its id.\n\nhttps://developer.lokta.ai/api/hooks-events/retrieve-one-hook/" } }, { "name": "Update a Hook", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/hooks/:hookId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "hooks", ":hookId" ], "variable": [ { "key": "hookId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"displayName\": \"string\",\n \"events\": [\n {\n \"actionName\": \"string\",\n \"entityName\": \"string\"\n }\n ],\n \"id\": 1,\n \"isActive\": true,\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates one hook, found by its id.\n\nhttps://developer.lokta.ai/api/hooks-events/update-hook/" } }, { "name": "Delete a Hook", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/hooks/:hookId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "hooks", ":hookId" ], "variable": [ { "key": "hookId", "value": "" } ] }, "description": "Deletes one hook, found by its id.\n\nhttps://developer.lokta.ai/api/hooks-events/delete-hook/" } } ] } ] }, { "name": "Advanced", "item": [ { "name": "Scheduler", "description": "Scheduled jobs: list, run, activate and inspect their history.", "item": [ { "name": "Retrieve Scheduler Jobs", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs" ] }, "description": "Lists the scheduled jobs and their current state.\n\nhttps://developer.lokta.ai/api/scheduler/retrieve-all-scheduler-jobs/" } }, { "name": "Retrieve a Job by short name", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/short-name/:shortName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", "short-name", ":shortName" ], "variable": [ { "key": "shortName", "value": "" } ] }, "description": "Returns the details of a Job bu shortName.\n\nhttps://developer.lokta.ai/api/scheduler/retrieve-by-short-name/" } }, { "name": "Run a Job by short name", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/short-name/:shortName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", "short-name", ":shortName" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "shortName", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"jobParameters\": \"Update loan Summary\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Runs a scheduled job now, found by its short name.\n\nhttps://developer.lokta.ai/api/scheduler/execute-job-by-short-name/" } }, { "name": "Update a Job by short name", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/short-name/:shortName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", "short-name", ":shortName" ], "variable": [ { "key": "shortName", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": false,\n \"cronExpression\": \"0 0 22 1/1 * ? *\",\n \"displayName\": \"Update loan Summary\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a scheduled job, found by its short name.\n\nhttps://developer.lokta.ai/api/scheduler/update-job-detail-by-short-name/" } }, { "name": "Retrieve Job Run History by short name", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/short-name/:shortName/runhistory", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", "short-name", ":shortName", "runhistory" ], "query": [ { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" }, { "key": "orderBy", "value": "", "disabled": true, "description": "orderBy" }, { "key": "sortOrder", "value": "", "disabled": true, "description": "sortOrder" } ], "variable": [ { "key": "shortName", "value": "" } ] }, "description": "Lists the past runs of a scheduled job, found by its short name.\n\nhttps://developer.lokta.ai/api/scheduler/retrieve-history-by-short-name/" } }, { "name": "Retrieve a Job by id", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobId" ], "variable": [ { "key": "jobId", "value": "" } ] }, "description": "Returns one scheduled job, found by its id.\n\nhttps://developer.lokta.ai/api/scheduler/retrieve-one-scheduler-job/" } }, { "name": "Run a Job by id", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobId" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ], "variable": [ { "key": "jobId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"jobParameters\": \"Update loan Summary\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Runs a scheduled job now, found by its id.\n\nhttps://developer.lokta.ai/api/scheduler/execute-job/" } }, { "name": "Update a Job by id", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobId" ], "variable": [ { "key": "jobId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": false,\n \"cronExpression\": \"0 0 22 1/1 * ? *\",\n \"displayName\": \"Update loan Summary\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a scheduled job, found by its id.\n\nhttps://developer.lokta.ai/api/scheduler/update-job-detail/" } }, { "name": "Retrieve Job Run History by id", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobId/runhistory", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobId", "runhistory" ], "query": [ { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" }, { "key": "orderBy", "value": "", "disabled": true, "description": "orderBy" }, { "key": "sortOrder", "value": "", "disabled": true, "description": "sortOrder" } ], "variable": [ { "key": "jobId", "value": "" } ] }, "description": "Lists the past runs of a scheduled job, found by its id.\n\nhttps://developer.lokta.ai/api/scheduler/retrieve-history/" } }, { "name": "Retrieve Scheduler Status", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/scheduler", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "scheduler" ] }, "description": "Returns whether the job scheduler is running.\n\nhttps://developer.lokta.ai/api/scheduler/retrieve-scheduler-status/" } }, { "name": "Activate Scheduler Jobs | Suspend Scheduler Jobs", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/scheduler", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "scheduler" ], "query": [ { "key": "command", "value": "", "disabled": true, "description": "command" } ] }, "description": "Activates the scheduler job service. | Suspends the scheduler job service.\n\nhttps://developer.lokta.ai/api/scheduler/handle-commands-scheduler/" } } ] }, { "name": "Data Tables", "description": "Custom fields: register data tables against entities and read or write their rows.", "item": [ { "name": "List Data Tables", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables" ], "query": [ { "key": "apptable", "value": "", "disabled": true, "description": "apptable" } ] }, "description": "Lists registered data tables and the application table they are registered to.\n\nhttps://developer.lokta.ai/api/data-tables/get-datatables/" } }, { "name": "Create Data Table", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables" ] }, "body": { "mode": "raw", "raw": "{\n \"apptableName\": \"l_client\",\n \"columns\": [\n {\n \"name\": \"DOB\",\n \"type\": \"String\",\n \"code\": \"Gender\",\n \"indexed\": true\n }\n ],\n \"datatableName\": \"extra_client_details\",\n \"entitySubType\": \"abc\",\n \"multiRow\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a new data table and registers it with the application table.\n\nhttps://developer.lokta.ai/api/data-tables/create-datatable/" } }, { "name": "Deregister Data Table", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/deregister/:datatable", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", "deregister", ":datatable" ], "variable": [ { "key": "datatable", "value": "" } ] }, "description": "Deregisters a data table. It will no longer be available through the API.\n\nhttps://developer.lokta.ai/api/data-tables/deregister-datatable/" } }, { "name": "Register Data Table", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/register/:datatable/:apptable", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", "register", ":datatable", ":apptable" ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptable", "value": "" } ] }, "description": "Registers a data table with the application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200).\n\nhttps://developer.lokta.ai/api/data-tables/register-datatable/" } }, { "name": "Update Data Table", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatableName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatableName" ], "variable": [ { "key": "datatableName", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"addColumns\": [\n {\n \"code\": \"Gender\",\n \"indexed\": true,\n \"mandatory\": true,\n \"name\": \"Question\"\n }\n ],\n \"apptableName\": \"l_client\",\n \"changeColumns\": [\n {\n \"code\": \"Gender\",\n \"indexed\": true,\n \"mandatory\": true,\n \"name\": \"Question\"\n }\n ],\n \"dropColumns\": [\n {\n \"name\": \"Gender_cd_Question\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Modifies fields of a data table. If the apptableName parameter is passed, data table is deregistered and registered with the new application table.\n\nhttps://developer.lokta.ai/api/data-tables/update-datatable/" } }, { "name": "Delete Data Table", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatableName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatableName" ], "variable": [ { "key": "datatableName", "value": "" } ] }, "description": "Deletes a data table and deregisters it from the application table.\n\nhttps://developer.lokta.ai/api/data-tables/delete-datatable/" } }, { "name": "Retrieve Data Table Details", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable" ], "variable": [ { "key": "datatable", "value": "" } ] }, "description": "Lists a registered data table details and the application table they are registered to.\n\nhttps://developer.lokta.ai/api/data-tables/get-datatable/" } }, { "name": "Query Data Table values", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/query", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", "query" ], "query": [ { "key": "columnFilter", "value": "", "disabled": true, "description": "columnFilter" }, { "key": "valueFilter", "value": "", "disabled": true, "description": "valueFilter" }, { "key": "resultColumns", "value": "", "disabled": true, "description": "resultColumns" } ], "variable": [ { "key": "datatable", "value": "" } ] }, "description": "Queries a registered data table using columnFilter, valueFilter and resultColumns query parameters.\n\nhttps://developer.lokta.ai/api/data-tables/query-values/" } }, { "name": "Query Data Table values with a request body", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/query", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", "query" ], "variable": [ { "key": "datatable", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dateTimeFormat\": \"19 August 2026\",\n \"locale\": \"en\",\n \"localeObject\": {\n \"country\": \"string\",\n \"displayCountry\": \"string\",\n \"displayLanguage\": \"string\",\n \"displayName\": \"string\"\n },\n \"page\": 1,\n \"request\": {\n \"columnFilters\": [\n {}\n ],\n \"nonNullFilters\": [\n {}\n ],\n \"nonNullResultColumns\": [\n \"string\"\n ],\n \"resultColumns\": [\n \"string\"\n ]\n },\n \"size\": 1,\n \"sorts\": [\n {\n \"direction\": \"ASC\",\n \"property\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Queries a registered data table using the filters supplied in the request body.\n\nhttps://developer.lokta.ai/api/data-tables/advanced-query/" } }, { "name": "Retrieve Entry(s) from Data Table", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId" ], "query": [ { "key": "order", "value": "", "disabled": true, "description": "order" } ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" } ] }, "description": "Gets the entry (if it exists) for data tables that are one to one with the application table. Gets the entries (if they exist) for data tables that are one to many with the application table.\n\nhttps://developer.lokta.ai/api/data-tables/get-datatable-entries/" } }, { "name": "Create Entry in Data Table", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId" ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" } ] }, "description": "Adds a row to the data table.\n\nhttps://developer.lokta.ai/api/data-tables/create-datatable-entry/" } }, { "name": "Update Entry in Data Table (One to One)", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId" ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" } ] }, "description": "Updates the one-to-one data table row for the specified application table record.\n\nhttps://developer.lokta.ai/api/data-tables/update-datatable-entry-oneto-one/" } }, { "name": "Delete Entry(s) in Data Table", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId" ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" } ] }, "description": "Deletes the entry (if it exists) for data tables that are one-to-one with the application table. Deletes the entries (if they exist) for data tables that are one-to-many with the application table.\n\nhttps://developer.lokta.ai/api/data-tables/delete-datatable-entries/" } }, { "name": "Retrieve Entry from Data Table (One to Many)", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId/:datatableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId", ":datatableId" ], "query": [ { "key": "order", "value": "", "disabled": true }, { "key": "genericResultSet", "value": "", "disabled": true, "description": "Optional flag to format the response" } ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" }, { "key": "datatableId", "value": "" } ] }, "description": "Gets the entry (if it exists) for data tables that are one-to-many with the application table, by the datatable entry id. Returns the stored row as a JSON object keyed by column name.\n\nhttps://developer.lokta.ai/api/data-tables/get-datatable-many-entry/" } }, { "name": "Update Entry in Data Table (One to Many)", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId/:datatableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId", ":datatableId" ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" }, { "key": "datatableId", "value": "" } ] }, "description": "Updates one row in a one-to-many data table using its data table row ID and application table record ID.\n\nhttps://developer.lokta.ai/api/data-tables/update-datatable-entry-one-to-many/" } }, { "name": "Delete Entry in Datatable (One to Many)", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/datatables/:datatable/:apptableId/:datatableId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "datatables", ":datatable", ":apptableId", ":datatableId" ], "variable": [ { "key": "datatable", "value": "" }, { "key": "apptableId", "value": "" }, { "key": "datatableId", "value": "" } ] }, "description": "Deletes the entry (if it exists) for data tables that are one to many with the application table.\n\nhttps://developer.lokta.ai/api/data-tables/delete-datatable-entry/" } }, { "name": "List Entity-Datatable Checks", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/entityDatatableChecks", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "entityDatatableChecks" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "status" }, { "key": "entity", "value": "", "disabled": true, "description": "entity" }, { "key": "productId", "value": "", "disabled": true, "description": "productId" }, { "key": "offset", "value": "", "disabled": true, "description": "offset" }, { "key": "limit", "value": "", "disabled": true, "description": "limit" } ] }, "description": "The list capability of Entity-Datatable Checks can support pagination.\n\nhttps://developer.lokta.ai/api/data-tables/retrieve-all-entity-datatable-checks/" } }, { "name": "Create Entity-Datatable Checks", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/entityDatatableChecks", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "entityDatatableChecks" ] }, "body": { "mode": "raw", "raw": "{\n \"datatableName\": \"Additional Details\",\n \"entity\": \"l_loan\",\n \"productId\": 1,\n \"status\": 100\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a check that requires a data table entry before an entity can move to a given status.\n\nhttps://developer.lokta.ai/api/data-tables/create-entity-datatable-check/" } }, { "name": "Retrieve Entity-Datatable Checks Template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/entityDatatableChecks/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "entityDatatableChecks", "template" ] }, "description": "This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of.\n\nhttps://developer.lokta.ai/api/data-tables/retrieve-template-entity-datatable-checks/" } }, { "name": "Delete Entity-Datatable Checks", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/entityDatatableChecks/:entityDatatableCheckId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "entityDatatableChecks", ":entityDatatableCheckId" ], "variable": [ { "key": "entityDatatableCheckId", "value": "" } ] }, "description": "Deletes an existing Entity-Datatable Check.\n\nhttps://developer.lokta.ai/api/data-tables/delete-entity-datatable-check/" } } ] }, { "name": "Business Date & Steps", "description": "The business date and the ordered business steps of the close-of-business run.", "item": [ { "name": "List all business dates", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/businessdate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "businessdate" ] }, "description": "Lists the business dates set on the tenant.\n\nhttps://developer.lokta.ai/api/business-date-steps/get-business-dates/" } }, { "name": "Update Business Date", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/businessdate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "businessdate" ] }, "body": { "mode": "raw", "raw": "{\n \"date\": \"19 August 2026\",\n \"dateFormat\": \"dd MMMM yyyy\",\n \"locale\": \"en\",\n \"type\": \"BUSINESS_DATE\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets the business date of the given type.\n\nhttps://developer.lokta.ai/api/business-date-steps/update-business-date/" } }, { "name": "Retrieve a specific Business date", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/businessdate/:type", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "businessdate", ":type" ], "variable": [ { "key": "type", "value": "" } ] }, "description": "Returns one business date, by its type.\n\nhttps://developer.lokta.ai/api/business-date-steps/get-business-date/" } }, { "name": "List Business Jobs", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/names", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", "names" ] }, "description": "Lists the jobs that can be configured with business steps.\n\nhttps://developer.lokta.ai/api/business-date-steps/retrieve-all-configured-business-jobs/" } }, { "name": "List available Business Steps for a Job", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobName/available-steps", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobName", "available-steps" ], "variable": [ { "key": "jobName", "value": "" } ] }, "description": "Returns the available Business Steps for a job.\n\nhttps://developer.lokta.ai/api/business-date-steps/retrieve-all-available-business-step/" } }, { "name": "List configured Business Steps for a Job", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobName/steps", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobName", "steps" ], "variable": [ { "key": "jobName", "value": "" } ] }, "description": "Returns the configured Business Steps for a job.\n\nhttps://developer.lokta.ai/api/business-date-steps/retrieve-all-configured-business-step/" } }, { "name": "Update the Business Steps for a Job", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/jobs/:jobName/steps", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "jobs", ":jobName", "steps" ], "variable": [ { "key": "jobName", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"businessSteps\": [\n {\n \"order\": 1,\n \"stepName\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the Business steps execution order for a job.\n\nhttps://developer.lokta.ai/api/business-date-steps/update-job-business-step-config/" } } ] }, { "name": "Global Configuration", "description": "Tenant-wide settings that change how the platform behaves.", "item": [ { "name": "List global configurations", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/configurations", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "configurations" ], "query": [ { "key": "survey", "value": "", "disabled": true, "description": "survey" } ] }, "description": "Returns the list global enable/disable configurations.\n\nhttps://developer.lokta.ai/api/global-configuration/retrieve-configuration/" } }, { "name": "Update Global Configuration by name", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/configurations/name/:configName", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "configurations", "name", ":configName" ], "variable": [ { "key": "configName", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dateValue\": \"20 September 2011\",\n \"enabled\": true,\n \"locale\": \"en\",\n \"stringValue\": \"random text\",\n \"value\": 2\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an enable/disable global configuration item by name.\n\nhttps://developer.lokta.ai/api/global-configuration/update-configuration-by-name/" } }, { "name": "Retrieve Global Configuration by name", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/configurations/name/:name", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "configurations", "name", ":name" ], "variable": [ { "key": "name", "value": "" } ] }, "description": "Returns a global enable/disable configuration.\n\nhttps://developer.lokta.ai/api/global-configuration/retrieve-one-by-name/" } }, { "name": "Retrieve Global Configuration by id", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/configurations/:configId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "configurations", ":configId" ], "variable": [ { "key": "configId", "value": "" } ] }, "description": "Returns a global enable/disable configurations.\n\nhttps://developer.lokta.ai/api/global-configuration/retrieve-one-global-configuration/" } }, { "name": "Update Global Configuration", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/configurations/:configId", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "configurations", ":configId" ], "variable": [ { "key": "configId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"dateValue\": \"20 September 2011\",\n \"enabled\": true,\n \"locale\": \"en\",\n \"stringValue\": \"random text\",\n \"value\": 2\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an enable/disable global configuration item.\n\nhttps://developer.lokta.ai/api/global-configuration/update-global-configuration/" } } ] }, { "name": "Search", "description": "Search across clients, loans and other records.", "item": [ { "name": "Search Resources", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/search", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "search" ], "query": [ { "key": "query", "value": "", "disabled": true, "description": "query" }, { "key": "resource", "value": "", "disabled": true, "description": "resource" }, { "key": "exactMatch", "value": "", "disabled": true, "description": "exactMatch" } ] }, "description": "Searches loans, clients and other records for a text query, optionally limited to chosen resources.\n\nhttps://developer.lokta.ai/api/search/search-data/" } }, { "name": "Adhoc query search", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/search/advance", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "search", "advance" ] }, "body": { "mode": "raw", "raw": "{\n \"dateFormat\": \"dd MMMM yyyy\",\n \"includeOutStandingAmountPercentage\": true,\n \"includeOutstandingAmount\": true,\n \"loanDateOption\": \"approvalDate\",\n \"loanFromDate\": \"2013-01-01\",\n \"loanToDate\": \"2014-01-27\",\n \"locale\": \"en\",\n \"maxOutstandingAmount\": 10000,\n \"minOutstandingAmount\": 100,\n \"outStandingAmountPercentage\": 80\n}", "options": { "raw": { "language": "json" } } }, "description": "AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters.\n\nhttps://developer.lokta.ai/api/search/advanced-search/" } }, { "name": "Retrive Adhoc Search query template", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/search/template", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "search", "template" ] }, "description": "Returns the template for an ad hoc search query.\n\nhttps://developer.lokta.ai/api/search/retrieve-ad-hoc-search-query-template/" } } ] }, { "name": "Tenant Security", "description": "Tenant OIDC configuration and two-factor authentication.", "item": [ { "name": "Retrieve OIDC configuration for a tenant", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/tenants/:tenantId/oidc-config", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "tenants", ":tenantId", "oidc-config" ], "variable": [ { "key": "tenantId", "value": "" } ] }, "description": "Returns the current OIDC/IdP configuration for the given tenant. The clientSecret is never included in the response.\n\nhttps://developer.lokta.ai/api/tenant-security/retrieve-tenants-oidc-config/" } }, { "name": "Create OIDC configuration for a tenant", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/tenants/:tenantId/oidc-config", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "tenants", ":tenantId", "oidc-config" ], "variable": [ { "key": "tenantId", "value": "" } ] }, "description": "Creates a new OIDC/IdP configuration for the given tenant. The clientSecret is encrypted at rest and never returned in responses. The issuerUri must be globally unique across all tenants.\n\nhttps://developer.lokta.ai/api/tenant-security/create-tenants-oidc-config/" } }, { "name": "Update OIDC configuration for a tenant", "request": { "method": "PUT", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/tenants/:tenantId/oidc-config", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "tenants", ":tenantId", "oidc-config" ], "variable": [ { "key": "tenantId", "value": "" } ] }, "description": "Updates the existing OIDC/IdP configuration for the given tenant. If clientSecret is omitted in the request body, the existing encrypted secret is preserved.\n\nhttps://developer.lokta.ai/api/tenant-security/update-tenants-oidc-config/" } }, { "name": "Delete OIDC configuration for a tenant", "request": { "method": "DELETE", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/tenants/:tenantId/oidc-config", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "tenants", ":tenantId", "oidc-config" ], "variable": [ { "key": "tenantId", "value": "" } ] }, "description": "Removes the OIDC/IdP configuration for the given tenant. After deletion, authentication via this tenant's IdP will no longer work.\n\nhttps://developer.lokta.ai/api/tenant-security/delete-tenants-oidc-config/" } }, { "name": "List one-time password delivery methods", "request": { "method": "GET", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/twofactor", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "twofactor" ] }, "description": "Lists the one-time password delivery methods.\n\nhttps://developer.lokta.ai/api/tenant-security/get-otpdelivery-methods/" } }, { "name": "Request a one-time password token", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/twofactor", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "twofactor" ], "query": [ { "key": "deliveryMethod", "value": "", "disabled": true }, { "key": "extendedToken", "value": "", "disabled": true } ] }, "description": "Requests a one-time password token for a delivery method.\n\nhttps://developer.lokta.ai/api/tenant-security/request-token/" } }, { "name": "Invalidate a one-time password token", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/twofactor/invalidate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "twofactor", "invalidate" ] }, "description": "Invalidates a one-time password token.\n\nhttps://developer.lokta.ai/api/tenant-security/update-configuration/" } }, { "name": "Validate a one-time password token", "request": { "method": "POST", "header": [ { "key": "Tenant-Identifier", "value": "{{tenant}}" } ], "url": { "raw": "{{baseUrl}}/lokta-lms/api/v1/twofactor/validate", "host": [ "{{baseUrl}}" ], "path": [ "lokta-lms", "api", "v1", "twofactor", "validate" ], "query": [ { "key": "token", "value": "", "disabled": true } ] }, "description": "Validates a one-time password token.\n\nhttps://developer.lokta.ai/api/tenant-security/validate/" } } ] } ] } ] }