POST api/v3/QPS/add

Add QPS (Max 2000 records can be updated in one request)

Request Information

URI Parameters

None.

Body Parameters

List of all the Quantity Purchase Scheme data to be added

Collection of QPS
NameDescriptionTypeAdditional information
OutletERPID

ErpId of the outlet whose ledger is to be added.

 string

Required
StatusDate

Date on which the outlet's current status is reflected in the ledger. Eg: 06-01-2020 for 1st June 2020

 date

Required
Schemes

List of all the schemes applicable on the outlet.

 Collection of QPSScheme

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OutletERPID": "sample string 1",
    "StatusDate": "2025-04-04T04:58:22.6881157+00:00",
    "Schemes": [
      {
        "Name": "sample string 1",
        "ERPId": "sample string 2",
        "Description": "sample string 3",
        "Type": "sample string 4",
        "Achievement": "sample string 5",
        "Payout": "sample string 6",
        "StartDate": "2025-04-04T04:58:22.6881157+00:00",
        "EndDate": "2025-04-04T04:58:22.6881157+00:00",
        "Slabs": [
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          },
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          }
        ]
      },
      {
        "Name": "sample string 1",
        "ERPId": "sample string 2",
        "Description": "sample string 3",
        "Type": "sample string 4",
        "Achievement": "sample string 5",
        "Payout": "sample string 6",
        "StartDate": "2025-04-04T04:58:22.6881157+00:00",
        "EndDate": "2025-04-04T04:58:22.6881157+00:00",
        "Slabs": [
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          },
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          }
        ]
      }
    ]
  },
  {
    "OutletERPID": "sample string 1",
    "StatusDate": "2025-04-04T04:58:22.6881157+00:00",
    "Schemes": [
      {
        "Name": "sample string 1",
        "ERPId": "sample string 2",
        "Description": "sample string 3",
        "Type": "sample string 4",
        "Achievement": "sample string 5",
        "Payout": "sample string 6",
        "StartDate": "2025-04-04T04:58:22.6881157+00:00",
        "EndDate": "2025-04-04T04:58:22.6881157+00:00",
        "Slabs": [
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          },
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          }
        ]
      },
      {
        "Name": "sample string 1",
        "ERPId": "sample string 2",
        "Description": "sample string 3",
        "Type": "sample string 4",
        "Achievement": "sample string 5",
        "Payout": "sample string 6",
        "StartDate": "2025-04-04T04:58:22.6881157+00:00",
        "EndDate": "2025-04-04T04:58:22.6881157+00:00",
        "Slabs": [
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          },
          {
            "ConstraintValue": "sample string 1",
            "ConstraintOn": "sample string 2",
            "PayoutValue": "sample string 3",
            "PayoutDesc": "sample string 4",
            "ActiveSlab": true
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfQPS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <QPS>
    <OutletERPID>sample string 1</OutletERPID>
    <Schemes>
      <QPSScheme>
        <Achievement>sample string 5</Achievement>
        <Description>sample string 3</Description>
        <ERPId>sample string 2</ERPId>
        <EndDate>2025-04-04T04:58:22.6881157+00:00</EndDate>
        <Name>sample string 1</Name>
        <Payout>sample string 6</Payout>
        <Slabs>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
        </Slabs>
        <StartDate>2025-04-04T04:58:22.6881157+00:00</StartDate>
        <Type>sample string 4</Type>
      </QPSScheme>
      <QPSScheme>
        <Achievement>sample string 5</Achievement>
        <Description>sample string 3</Description>
        <ERPId>sample string 2</ERPId>
        <EndDate>2025-04-04T04:58:22.6881157+00:00</EndDate>
        <Name>sample string 1</Name>
        <Payout>sample string 6</Payout>
        <Slabs>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
        </Slabs>
        <StartDate>2025-04-04T04:58:22.6881157+00:00</StartDate>
        <Type>sample string 4</Type>
      </QPSScheme>
    </Schemes>
    <StatusDate>2025-04-04T04:58:22.6881157+00:00</StatusDate>
  </QPS>
  <QPS>
    <OutletERPID>sample string 1</OutletERPID>
    <Schemes>
      <QPSScheme>
        <Achievement>sample string 5</Achievement>
        <Description>sample string 3</Description>
        <ERPId>sample string 2</ERPId>
        <EndDate>2025-04-04T04:58:22.6881157+00:00</EndDate>
        <Name>sample string 1</Name>
        <Payout>sample string 6</Payout>
        <Slabs>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
        </Slabs>
        <StartDate>2025-04-04T04:58:22.6881157+00:00</StartDate>
        <Type>sample string 4</Type>
      </QPSScheme>
      <QPSScheme>
        <Achievement>sample string 5</Achievement>
        <Description>sample string 3</Description>
        <ERPId>sample string 2</ERPId>
        <EndDate>2025-04-04T04:58:22.6881157+00:00</EndDate>
        <Name>sample string 1</Name>
        <Payout>sample string 6</Payout>
        <Slabs>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
          <QPSSlab>
            <ActiveSlab>true</ActiveSlab>
            <ConstraintOn>sample string 2</ConstraintOn>
            <ConstraintValue>sample string 1</ConstraintValue>
            <PayoutDesc>sample string 4</PayoutDesc>
            <PayoutValue>sample string 3</PayoutValue>
          </QPSSlab>
        </Slabs>
        <StartDate>2025-04-04T04:58:22.6881157+00:00</StartDate>
        <Type>sample string 4</Type>
      </QPSScheme>
    </Schemes>
    <StatusDate>2025-04-04T04:58:22.6881157+00:00</StatusDate>
  </QPS>
</ArrayOfQPS>

Response Information

Resource Description

ApiResponseMessage
NameDescriptionTypeAdditional information
ERPId

ERPID of the Requested insertion/updation

 string

None.
Message

Error Message for the indicated ERPID

 string

None.
ResponseStatus

Status of the action requested from Api

 ResponseStatus

None.
GUID

GUID of the database Entry with respect to the ERP Id Provided

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ERPId": "sample string 1",
  "Message": "sample string 2",
  "ResponseStatus": "Failure",
  "GUID": "sample string 3"
}

application/xml, text/xml

Sample: 
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <ERPId>sample string 1</ERPId>
  <GUID>sample string 3</GUID>
  <Message>sample string 2</Message>
  <ResponseStatus>Failure</ResponseStatus>
</ApiResponseMessage>