{"info":{"_postman_id":"4af9c6b0-a928-4847-b9cd-63adddf69b82","name":"LISA API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"32592925","collectionId":"4af9c6b0-a928-4847-b9cd-63adddf69b82","publishedId":"2sA35EZ33d","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-09T08:19:52.000Z"},"item":[{"name":"Create customer meter","id":"c7e363cf-cbbd-4b38-9fe0-96badde02f07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","value":"http://tempuri.org/BFTLicensingWebService/createCustomerMeter","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"_createCustomermeterRequestDataContract\":{\r\n \"CustAccount\":\"000002\",\r\n \"Model\":\"ABCDEFG\",\r\n \"MeterNumber\": 112345678,\r\n \"Description\": \"Test Description\",\r\n \"SerialNumber\": \"987654321\",\r\n \"Enabled\": true,\r\n \"Party\": 5637145327,\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/createCustomerMeter/","description":"

Creates a customer meter. 'CustAccount', 'Model', 'Party', 'BFTCompany' are all reference fields to other tables.

\n","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","createCustomerMeter",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7e363cf-cbbd-4b38-9fe0-96badde02f07"},{"name":"Create customer","id":"10368c2f-5653-4d01-bbf0-90de242e066a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/createCustomerMeter"}],"body":{"mode":"raw","raw":"{\r\n \"_createCustomerRequestDataContract\":{\r\n \"CompanyName\":\"Test Company\",\r\n \"VATNum\":\"MT123456\",\r\n \"ZipCode\": \"ABC1234\",\r\n \"City\": \"Naxxar\",\r\n \"Country\": \"Malta\",\r\n \"StreetNumber\": \"5\",\r\n \"Street\": \"Triq l-Oratorju\",\r\n \"FirstName\": \"Bluefort\",\r\n \"LastName\": \"Limited\",\r\n \"Phone\": \"+356 9902 8483\",\r\n \"Email\": \"info@bluefort.com.mt\",\r\n \"URL\": \"bluefort.eu\",\r\n \"D365Company\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/createCustomer/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","createCustomer",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"10368c2f-5653-4d01-bbf0-90de242e066a"},{"name":"Create subscription plan","id":"04ff535e-7b18-4838-bf73-cbc53b3f567e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/createCustomerMeter"}],"body":{"mode":"raw","raw":"{\r\n \"_createSubscriptionPlanDataContract\":{\r\n \"CustAccount\":\"000017\",\r\n \"ItemId\":\"CSP-0003\",\r\n \"SalesQty\": 5,\r\n \"StartDate\": \"2020-09-07T00:00:00\",\r\n \"SendEmail\": true,\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/createSubscriptionPlan/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","createSubscriptionPlan",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"04ff535e-7b18-4838-bf73-cbc53b3f567e"},{"name":"Publish subscription Plan","id":"4b6fe523-f56e-48a1-9bb3-5060788c8c3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/publishSubscriptionPlan"}],"body":{"mode":"raw","raw":"{\r\n \"_publishSubscriptionPlanRequestDataContract\":{\r\n \"SubscriptionPlan\":\"BFMT-LG-000000315\",\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/publishSubscriptionPlan/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","publishSubscriptionPlan",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b6fe523-f56e-48a1-9bb3-5060788c8c3c"},{"name":"Cancel Subscription Plan","id":"44eec6c7-53a3-4876-bb64-df6d96018929","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/publishSubscriptionPlan"}],"body":{"mode":"raw","raw":"{\r\n \"_cancelSubscriptionPlanRequestDataContract\":{\r\n \"SubscriptionPlan\":\"BFMT-LG-000000433\",\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/cancelSubscriptionPlan/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","cancelSubscriptionPlan",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"44eec6c7-53a3-4876-bb64-df6d96018929"},{"name":"Un-publish Subscription Plan","id":"095a78b1-247e-437c-a6bd-12ccf54a511c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/publishSubscriptionPlan"}],"body":{"mode":"raw","raw":"{\r\n \"_unpublishSubscriptionPlanRequestDataContract\":{\r\n \"SubscriptionPlan\":\"BFMT-LG-000000423\",\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/unpublishSubscriptionPlan/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","unpublishSubscriptionPlan",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"095a78b1-247e-437c-a6bd-12ccf54a511c"},{"name":"Firm subscription plan actions","id":"591ad48a-f353-4efd-8713-f80ce26aa55a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/publishSubscriptionPlan"}],"body":{"mode":"raw","raw":"{\r\n \"_firmActionRequestDataContract\":{\r\n \"SubscriptionPlan\":\"BFMT-LG-000000423\",\r\n \"SubscriptionActionId\": \"BFMT-LA-000001958\",\r\n \"InvoiceDate\": \"2020-09-03T00:00:00\",\r\n \"PostingDate\": \"2020-09-03T00:00:00\",\r\n \"InvoiceAmountExclSalesTax\": 115.70,\r\n \"SalesQty\": 5,\r\n \"VendorInvoiceId\": \"INTWOR\",\r\n \"FromDate\": \"2020-09-03T00:00:00\",\r\n \"ToDate\": \"2020-09-03T00:00:00\",\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/firmAction/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","firmAction",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"591ad48a-f353-4efd-8713-f80ce26aa55a"},{"name":"Get subscription products","id":"0e873886-0aa1-40e4-b619-470484203c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/getSubscriptionProducts"}],"body":{"mode":"raw","raw":"{\r\n \"_getSubscriptionProductsResquestDataContract\":{\r\n \"BFTCompany\": \"BFMT\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/getSubscriptionProducts/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","getSubscriptionProducts",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e873886-0aa1-40e4-b619-470484203c73"},{"name":"Create customer meter consumption","id":"28c5f2f8-c1e4-48c5-ac5e-c1d3b7566483","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","type":"text","value":"http://tempuri.org/BFTLicensingWebService/createCustMeterConsumption"}],"body":{"mode":"raw","raw":"{\r\n \"_custMeterConsumptionsList\":[\r\n {\r\n \"MeterNumber\": 23456789,\r\n \"FromDate\": \"2020-11-01T00:00:00\",\r\n \"ToDate\": \"2020-10-30T00:00:00\",\r\n \"MeterConsumptionType\": 1,\r\n \"QuantityToBill\": 2,\r\n \"ItemId\": \"CSP-0002\",\r\n \"MeterConsumptionSourceType\": 1,\r\n \"PreviousReading\": 1.1,\r\n \"CurrentReading\": 1.5,\r\n \"CalculatedConsumption\": 1,\r\n \"ConsumptionAdjustment\": 0.5,\r\n \"LicenseAction\": 5637144576,\r\n \"BFTCompany\": \"BFMT\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/createCustMeterConsumption/","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","createCustMeterConsumption",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"28c5f2f8-c1e4-48c5-ac5e-c1d3b7566483"},{"name":"Create subscription product","event":[{"listen":"test","script":{"id":"d9306979-07fb-4361-8e71-c711ee614bfe","exec":["pm.test('Response status code is 500', function () {\r"," pm.expect(pm.response.code).to.equal(500);\r","})\r","\r","pm.test('Response has the required fields - Message, ExceptionType, and ActivityId', function () {\r"," const responseData = pm.response.json();\r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.property('Message');\r"," pm.expect(responseData).to.have.property('ExceptionType');\r"," pm.expect(responseData).to.have.property('ActivityId');\r","})\r","\r","pm.test('Message is a non-empty string', function () {\r"," const responseData = pm.response.json();\r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData.Message).to.be.a('string').and.to.have.lengthOf.at.least(1, 'Message should not be empty');\r","})\r","\r","pm.test('ExceptionType is a non-empty string', function () {\r"," const responseData = pm.response.json();\r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData.ExceptionType).to.be.a('string').and.to.have.lengthOf.at.least(1, 'ExceptionType should be a non-empty string');\r","})\r","\r","pm.test(\"ActivityId is in a valid format\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData.ActivityId).to.eql('2f8277b2-0c09-0003-435c-882f090cda01', \"ActivityId should be in a valid UUID format\");\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"20932a02-8f9c-4cb9-98f8-d054af460eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"SOAPAction","value":"http://tempuri.org/BFTLicensingWebService/createSubscriptionProduct"}],"body":{"mode":"raw","raw":"{\r\n \"_createSubscriptionProductRequestDataContract\": {\r\n \"D365Company\": \"USMF\",\r\n \"ProductNumber\": \"APIproduct1\",\r\n \"ProductName\": \"APIproductname1\",\r\n \"Description\": \"APIproductDesc1\",\r\n \"ProgramType\": \"CSP Standard\",\r\n \"LicenseTypes\": \"NamedUsersSubscriptions\",\r\n \"OneTimeFee\" : \"No\",\r\n \"OneTimeFeePriceType\": \"FixedPrice\",\r\n \"ItemGroup\": \"CarAudio\",\r\n \"SalesPrice\": \"11.50\",\r\n \"IsPromotionProduct\": \"Yes\",\r\n \"PromotionLengthInCycles\": \"3\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTLicensing/BFTLicensingWebService/createSubscriptionProduct/","description":"

Creates a subscription product - This is an upsert method.

The following fields can be updated once created:

Product name
\n
Product description
\n
Program type
\n
Subscription type/License type
\n
One time fee
\n
One time fee price type
\n
Item group
\n
Sales price
\n
Is promotion product
\n
Promotion length in cycles
\n

The following fields cannot be updated:

Company identifier
Product number

\n","urlObject":{"path":["api","services","BFTLicensing","BFTLicensingWebService","createSubscriptionProduct",""],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"20932a02-8f9c-4cb9-98f8-d054af460eeb"},{"name":"Get AAD TOKEN","id":"3bf1eb83-7d3b-48f8-aba3-5bee8aee6d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"app_key","type":"text"},{"key":"client_secret","value":"app_secret","type":"text"},{"key":"resource","value":"[link_to_environment]","type":"text"},{"key":"username","value":"","type":"text","disabled":true}]},"url":"https://login.microsoftonline.com/[tenant]/oauth2/token","urlObject":{"protocol":"https","path":["[tenant]","oauth2","token"],"host":["login","microsoftonline","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bf1eb83-7d3b-48f8-aba3-5bee8aee6d8b"}]}