{"info":{"_postman_id":"568ce182-9980-4177-9aba-afc390b5bfe6","name":"LISA API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"28927204","collectionId":"568ce182-9980-4177-9aba-afc390b5bfe6","publishedId":"2sAXxLDaAP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-04T07:49:40.000Z"},"item":[{"name":"Create customer meter","id":"bc164903-7cfd-4629-a4e7-12557b0c5049","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":"bc164903-7cfd-4629-a4e7-12557b0c5049"},{"name":"Create customer","id":"f4cfa5d6-17e1-4591-a142-32cadc1806ac","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":"f4cfa5d6-17e1-4591-a142-32cadc1806ac"},{"name":"Create subscription plan","id":"638f0df7-8406-4e45-8c29-72a692827a38","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":"638f0df7-8406-4e45-8c29-72a692827a38"},{"name":"Publish subscription Plan","id":"59ecbdf3-fe22-4586-977a-3199af7f33d9","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":"59ecbdf3-fe22-4586-977a-3199af7f33d9"},{"name":"Cancel Subscription Plan","id":"4e5a34bb-1f54-4aa0-9f5d-7dabf3a37016","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":"4e5a34bb-1f54-4aa0-9f5d-7dabf3a37016"},{"name":"Un-publish Subscription Plan","id":"d8e033b0-4c54-43b1-808c-7b6f080c36b7","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":"d8e033b0-4c54-43b1-808c-7b6f080c36b7"},{"name":"Firm subscription plan actions","id":"d4a19397-6150-42e2-9b23-0927fcaf5c4a","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":"d4a19397-6150-42e2-9b23-0927fcaf5c4a"},{"name":"Get subscription products","id":"8a6ed72a-5b2e-4e76-a552-94e108110bb1","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":"8a6ed72a-5b2e-4e76-a552-94e108110bb1"},{"name":"Create customer meter consumption","id":"19cc2602-fd28-432e-a296-ffec3f1dc77f","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":"19cc2602-fd28-432e-a296-ffec3f1dc77f"},{"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":"035b1536-38f5-460b-a5fe-10d6d4abbfd6","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":"035b1536-38f5-460b-a5fe-10d6d4abbfd6"},{"name":"Get AAD TOKEN","id":"5e1ec861-393c-4a4f-9ff6-02ac835fe248","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":"5e1ec861-393c-4a4f-9ff6-02ac835fe248"},{"name":"Validate customer bank account","id":"f399733c-3f78-49da-aac3-64020f32e49b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"_request\": {\r\n \"Company\": \"GBSI\",\r\n \"CustBankAccountId\": \"Test\",\r\n \"CustAccount\": \"Test customer\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTGoCardLess/BFTGoCardLessWebService/ValidateBankDetails","description":"

Validate customer bank account

This API endpoint is used to validate bank account details for a specific customer.

Request Body

_request (object)
\n
- Company (string, required): The company name.
  \n
- CustBankAccountId (string, required): The customer's bank account ID.
  \n
- CustAccount (string, required): The customer's account number.
  \n
\n

Response

The response is a JSON object with the following properties:

$id (string): The ID of the response.
\n
isValid (boolean): Indicates whether the bank details are valid.
\n
Status (string): The status of the validation.
\n
Message (string): Any additional message related to the validation.
\n

JSON Schema

{\n  \"$id\": \"string\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"isValid\": {\n      \"type\": \"boolean\"\n    },\n    \"Status\": {\n      \"type\": \"string\"\n    },\n    \"Message\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

\n","urlObject":{"path":["api","services","BFTGoCardLess","BFTGoCardLessWebService","ValidateBankDetails"],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"f399733c-3f78-49da-aac3-64020f32e49b"},{"name":"Trigger GoCardless payments reconciliation by customer","event":[{"listen":"test","script":{"id":"47cb99cd-a243-4721-840d-51671ca9006e","exec":[""],"type":"text/javascript","packages":{}}}],"id":"cc9623bc-2c3c-4d51-9d79-920909aeb305","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"_request\" :\r\n {\r\n \"Company\" : \"GBSI\",\r\n \"CustAccount\": \"Test Customer\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"[link_to_environment]/api/services/BFTGoCardLess/BFTGoCardLessWebService/ReconcilePayments","description":"

Get Customer GoCardless payments

This endpoint is used to reconcile GoCardless payments using an HTTP POST request.

Request Body

_request (object)
\n
- Company (string, required): The company information.
  \n
- CustAccount (string, required): The customer account information.
  \n
\n

Response

The response is in the form of a JSON schema:

{\n  \"$id\": \"\",\n  \"isValid\": true,\n  \"Status\": \"\",\n  \"Errors\": 0,\n  \"Message\": \"\"\n}\n\n

The response contains the following fields:

$id (string): The identifier.
\n
isValid (boolean): Indicates whether the reconciliation is valid.
\n
Status (string): The status of the reconciliation.
\n
Errors (number): The number of errors encountered during reconciliation.
\n
Message (string): Any additional message related to the reconciliation process.
\n

\n","urlObject":{"path":["api","services","BFTGoCardLess","BFTGoCardLessWebService","ReconcilePayments"],"host":["[link_to_environment]"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc9623bc-2c3c-4d51-9d79-920909aeb305"}]}