LISA REACH SALES QUOTE LINES INTEGRATION

API Integration with LISA Reach Sales to enable the creation of Subscription Quote Lines.

Subscription Sales Quote Lines

Request Body Properties Definition

JSON Body Property	Definition
`key` (String)	For Authorization purposes, a key should be passed. This is set as an environmental variable in the D365 environment where the solution is used. Case sensitive. Required.
`keyValue` (String)	For Authorization purposes, a key value should be passed. This is set as an environmental variable in the D365 environment where the solution is used. Case sensitive. Required.
`create` (Boolean)	Determines whether a quote header will be created or updated. Set to "true" for create. Set to "false" for update. Required.
`updateQuoteLineID` (UUID)	The unique identifier of the Quote Line to update. Nullable.
`quoteID` (UUID)	The unique identifier of the Quote Header related to the Quote Line. Nullable.
`existingProductID` (UUID)	The unique identifier of the Product. Nullable.
`programType` (UUID)	The unique identifier of the Program Type to assign to the Subscription Quote Line. Nullable.
`lineSubscriptionStartDate` (Date)	The Subscription Start Date of the Subscription Quote Line. Nullable.
`months` (Number)	The number of Months to assign to the Subscription Quote Line. Decimal values are rounded. Nullable.
`unitID` (UUID)	The unique identifier of the Unit of Measure to assign to the Subscription Quote Line. Nullable.
`reason` (UUID)	The unique identifier for the reason code associated with the Subscription Quote Line. Nullable.
`pricingOptions` (Enum)	The Subscription Quote Line's pricing options. Options are as follows; Use Default [0] , Override Price [1]
`pricePerUnit` (Number)	The Subscription Quote Line's price per unit. Nullable.
`quantity` (Number)	The Subscription Quote Line's quantity. Nullable.
`manualDiscount` (Number)	The Subscription Quote Line's manual discount amount. Nullable.
`removeFromSubPlan` (Boolean)	Defines whether the Subscription Quote Line is to be removed from the Subscription Quote Plan.
`creditFrom` (Date)	Defines the date from which the Subscription Quote Line should be credited. Nullable.
`futureCancellation` (Boolean)	Determines whether Future cancellation is enabled for the Subscription Sales Quote Line.
`cancellationDate` (Date)	Determines the future cancellation date. Nullable.
`notificationDate` (Date)	Determines the date when a notification should be sent out to the upcoming cancellation. Nullable.
`cancellationReasonCode` (UUID)	The unique identifier of the Cancellation Reason Code to assign to the Subscription Sales Quote. Nullable.
`createCreditNote` (Boolean)	Determines whether to create a Credit Note upon Future Cancellation.
`useCancellationDateAsCreditDate` (Boolean)	Determines whether to use the Cancellation Date as the Credit Date.
`futureCreditFromDate` (Date)	The date to be used for future credit. Nullable.
`otfPriceType` (Enum)	The Subscription Quote Line's One Time Fee Price Type. The options are Per Month [347360000] , Fixed Price [347360001]
`customerMeterNumber` (String)	The value to set as the Customer Meter Number. Nullable. Max. length: 100 characters.

Schema Validation & Required Fields

Required Fields

json

"required": [
  "create",
  "key",
  "keyValue",
  "quoteID"
],

Validation

Below is a break down of the validations being done within the JSON request schema.

create (true)

json

{ "create": true }

Below schema validation is applied when "create" is set to true.

json

"required": [
  "existingProductID",
  "lineSubscriptionStartDate",
  "months",
  "reason",
  "pricePerUnit",
  "quantity"
],
"properties": {
  "reason": {
    "type": "string",
    "format": "uuid"
  },
  "lineSubscriptionStartDate": {
    "type": "string",
    "format": "date",
    "minLength": 10
  },
  "existingProductID": {
    "type": "string",
    "format": "uuid"
  }
}

create (false)

json

{ "create": false }

Below schema validation is applied when "create" is set to false.

json

"required": [
  "updateQuoteLineID"
],
"properties": {
  "updateQuoteID": {
    "type": "string",
    "format": "uuid"
  }
}

pricingOptions (1)

json

{ "pricingOptions" : 1 }

Below schema validation is applied when "pricingOptions" is set to 1.

json

"required": [
  "pricePerUnit"
],
"properties": {
  "pricePerUnit": {
  "type": "number"
 }
}

pricingOptions (0)

json

{ "pricingOptions" : 0 }

Below schema validation is applied when "pricingOptions" is set to 0.

json

"properties": {
  "pricePerUnit": {
    "const": null
}

createCreditNote (false)

json

{ "createCreditNote" : false }

Below schema validation is applied when "createCreditNote" is set to false.

json

"properties": {
  "useCancellationDateAsCreditDate": {
    "const": false
  },
  "futureCreditFromDate": {
    "const": null
  }
}

createCreditNote (true) and useCancellationDateAsCreditDate (false)

json

{ 
  "createCreditNote": true,
  "useCancellationDateAsCreditDate" : false
}

Below schema validation is applied when "createCreditNote" is set to true and "useCancellationDateAsCreditDate" is set to false.

json

"required": [
  "futureCreditFromDate"
],
"properties": {
  "futureCreditFromDate": {
    "type": "string",
    "format": "date",
    "minLength": 10
  }
}

useCancellationDateAsCreditDate (true)

json

{ "useCancellationDateAsCreditDate" : true }

Below schema validation is applied when "useCancelationDateAsCreditDate" is set to true

json

"properties": {
  "futureCreditFromDate": {
    "const": null
  }
}

futureCancellation (false)

json

{ "futureCancellation" : false }

Below schema validation is applied when "futureCancellation" is set to false

json

"properties": {
  "cancellationDate": {
    "const": null
  },
  "notificationDate": {
    "const": null
  },
  "cancellationReasonCode": {
    "const": null
  },
  "createCreditNote": {
    "const": false
  },
  "useCancellationDateAsCreditDate": {
    "const": false
  },
  "futureCreditFromDate": {
    "const": null
  }
}

futureCancellation (true)

json

{ "futureCancellation" : true }

Below schema validation is applied when "futureCancellation" is set to true

json

"required": [
  "cancellationReasonCode",
  "cancellationDate"
],
"properties": {
  "futureCreditFromDate": {
    "anyOf": [
    {
      "type": "string",
      "format": "date",
      "minLength": 10
    },
    {
      "const": null
    }
    ]
  },
  "cancellationDate": {
    "type": "string",
    "format": "date",
    "minLength": 10
  },
  "notificationDate": {
    "type": "string",
    "format": "date",
    "minLength": 10
  },
  "cancellationReasonCode": {
    "type": "string",
    "format": "uuid"
  }
}

POSTNew Quote Line

Add a new Subscription Quote Line.

Bodyraw (json)

json

{
  "key": "myHTTPkey",
  "keyValue": "keyvalue", 
  "create": true,
  "updateQuoteLineID": "00000000-0000-0000-0000-000000000000",
  "quoteID": "a17d1f7c-86fc-ee11-a1fe-000d3a4add07",
  "existingProductID": "1eac50bf-cc07-ec11-b6e6-002248824a34",
  "programType": "303a7be7-a535-ec11-8c64-000d3a4a8d9c",
  "lineSubscriptionStartDate": "2024-04-01",
  "months": 1,
  "unitID": "f1318d53-bf7d-eb11-a812-000d3abfabcf",
  "reason": "4a43e16a-8055-ed11-bba1-6045bd8c56a7",
  "pricingOptions": "1",
  "pricePerUnit": 152,
  "quantity": 1,
  "manualDiscount": 0,
  "removeFromSubPlan": false,
  "CreditFrom": "",
  "futureCancellation": false,
  "cancellationDate": null,
  "notificationDate": null,
  "cancellationReasonCode": null,
  "createCreditNote": true,
  "useCancellationDateAsCreditDate": false,
  "futureCreditFromDate": null,
  "otfPriceType": "347360001",
  "customerMeterNumber": "MTNO54542"
}

Example Request

curl

curl --location -g '{{QuoteLineAPIURL}}' \
--data '{
  "key": "myHTTPkeys",
  "keyValue": "keyvalue", 
  "create": true,
  "updateQuoteLineID": "00000000-0000-0000-0000-000000000000",
  "quoteID": "76ba1add-08f7-ee11-a1fd-000d3a4add07",
  "existingProductID": "f95054cb-cc07-ec11-b6e6-002248824a34",
  "programType": "303a7be7-a535-ec11-8c64-000d3a4a8d9c",
  "lineSubscriptionStartDate": "2024-04-01",
  "months": 1,
  "unitID": "f1318d53-bf7d-eb11-a812-000d3abfabcf",
  "reason": "4a43e16a-8055-ed11-bba1-6045bd8c56a7",
  "pricingOptions": "1",
  "pricePerUnit": 152,
  "quantity": 1,
  "manualDiscount": 0,
  "removeFromSubPlan": false,
  "CreditFrom": "",
  "futureCancellation": false,
  "cancellationDate": null,
  "notificationDate": null,
  "cancellationReasonCode": null,
  "createCreditNote": false,
  "useCancellationDateAsCreditDate": false,
  "futureCreditFromDate": null,
  "otfPriceType": "347360001",
  "customerMeterNumber": "MTNO54542"
}'

202 Accepted

Example Response

No response body

This request doesn't return any response body

Cache-Control

no-cache

Pragma

no-cache

Expires

-1

x-ms-execution-location

westeurope

x-ms-workflow-system-id

/locations/westeurope/scaleunits/prod-241/workflows/16db621a75fb4cbda3a5928e7242f670

x-ms-workflow-id

16db621a75fb4cbda3a5928e7242f670

x-ms-workflow-version

08584882659690137109

x-ms-workflow-name

e2b1d389-4cdd-a16c-cd30-941471401a97

x-ms-tracking-id

66c556a8-95ca-42f9-9e29-d3d771b71b6f

x-ms-ratelimit-burst-remaining-workflow-writes

1499

x-ms-ratelimit-remaining-workflow-download-contentsize

107373568

x-ms-ratelimit-remaining-workflow-upload-contentsize

107372677

x-ms-ratelimit-time-remaining-directapirequests

4999962

x-ms-request-id

westeurope:66c556a8-95ca-42f9-9e29-d3d771b71b6f

Strict-Transport-Security

max-age=31536000; includeSubDomains

Date

Wed, 17 Apr 2024 08:36:06 GMT

Content-Length

POSTUpdate Quote Line

Update a Subscription Quote Line.

Bodyraw (json)

json

{
  "key": "myHTTPkey",
  "keyValue": "keyvalue", 
  "create": false,
  "updateQuoteLineID": "85e0f829-96fc-ee11-a1ff-002248842ce8",
  "quoteID": "a17d1f7c-86fc-ee11-a1fe-000d3a4add07",
  "company": "ebbe13d7-221c-ec11-b6e6-6045bd8dee12",
  "existingProductID": "1eac50bf-cc07-ec11-b6e6-002248824a34",
  "programType": "303a7be7-a535-ec11-8c64-000d3a4a8d9c",
  "lineSubscriptionStartDate": "2024-06-01",
  "months": 4,
  "unitID": "f1318d53-bf7d-eb11-a812-000d3abfabcf",
  "reason": "916fb2e3-221c-ec11-b6e6-6045bd8dee12",
  "pricingOptions": "1",
  "pricePerUnit": 200,
  "quantity": 20,
  "manualDiscount": 0,
  "removeFromSubPlan": false,
  "CreditFrom": "",
  "futureCancellation": false,
  "cancellationDate": null,
  "notificationDate": null,
  "cancellationReasonCode": null,
  "createCreditNote": false,
  "useCancellationDateAsCreditDate": false,
  "futureCreditFromDate": null,
  "otfPriceType": "347360000",
  "customerMeterNumber": "MTNO54542"
}

Example Request

curl

curl --location -g '{{QuoteLineAPIURL}}' \
--data '{
  "key": "myHTTPkey",
  "keyValue": "keyvalue", 
  "create": false,
  "updateQuoteLineID": "85e0f829-96fc-ee11-a1ff-002248842ce8",
  "quoteID": "a17d1f7c-86fc-ee11-a1fe-000d3a4add07",
  "company": "ebbe13d7-221c-ec11-b6e6-6045bd8dee12",
  "existingProductID": "1eac50bf-cc07-ec11-b6e6-002248824a34",
  "programType": "303a7be7-a535-ec11-8c64-000d3a4a8d9c",
  "lineSubscriptionStartDate": "2024-06-01",
  "months": 4,
  "unitID": "f1318d53-bf7d-eb11-a812-000d3abfabcf",
  "reason": "916fb2e3-221c-ec11-b6e6-6045bd8dee12",
  "pricingOptions": "1",
  "pricePerUnit": 200,
  "quantity": 20,
  "manualDiscount": 0,
  "removeFromSubPlan": false,
  "CreditFrom": "",
  "futureCancellation": false,
  "cancellationDate": null,
  "notificationDate": null,
  "cancellationReasonCode": null,
  "createCreditNote": false,
  "useCancellationDateAsCreditDate": false,
  "futureCreditFromDate": null,
  "otfPriceType": "347360000",
  "customerMeterNumber": "MTNO54542"
}'

200 OK

Example Response

json

{
  "FlowStatus": "Successful",
  "Result": "85e0f829-96fc-ee11-a1ff-002248842ce8"
}

Cache-Control

no-cache

Pragma

no-cache

Transfer-Encoding

chunked

Content-Type

application/json; charset=utf-8

Content-Encoding

gzip

Expires

-1

Vary

Accept-Encoding

x-ms-workflow-run-id

08584882632941689850036842138CU183

x-ms-correlation-id

15c2fd2e-ec92-4187-af63-e5bb82529186

x-ms-client-tracking-id

08584882632941689850036842138CU183

x-ms-trigger-history-name

08584882632941689850036842138CU183

x-ms-execution-location

westeurope

x-ms-workflow-system-id

/locations/westeurope/scaleunits/prod-241/workflows/16db621a75fb4cbda3a5928e7242f670

x-ms-workflow-id

16db621a75fb4cbda3a5928e7242f670

x-ms-workflow-version

08584882659690137109

x-ms-workflow-name

e2b1d389-4cdd-a16c-cd30-941471401a97

x-ms-tracking-id

15c2fd2e-ec92-4187-af63-e5bb82529186

x-ms-ratelimit-burst-remaining-workflow-writes

1495

x-ms-ratelimit-remaining-workflow-download-contentsize

107373121

x-ms-ratelimit-remaining-workflow-upload-contentsize

107369047

x-ms-ratelimit-time-remaining-directapirequests

4957616

x-ms-request-id

westeurope:15c2fd2e-ec92-4187-af63-e5bb82529186

Strict-Transport-Security

max-age=31536000; includeSubDomains

Date

Wed, 17 Apr 2024 08:46:50 GMT