GET spa/summary?customerNumber={customerNumber}&salesOrg={salesOrg}&dealId={dealId}&endUser={endUser}&mfgCode={mfgCode}&validOn={validOn}&controlNumber={controlNumber}&description={description}&agreementTypes={agreementTypes}

SPA summary

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

string

Required

salesOrg

string

None.

dealId

string

None.

endUser

string

None.

mfgCode

string

None.

validOn

date

None.

controlNumber

string

None.

description

string

None.

agreementTypes

string

None.

Body Parameters

None.

Response Information

Resource Description

AgreementSummaryResponse
NameDescriptionTypeAdditional information
CustomerNumber

string

None.

SalesOrg

string

None.

DealId

string

None.

EndUser

string

None.

ValidOn

date

None.

MfgCode

string

None.

ControlNumber

string

None.

Description

string

None.

AgreementTypes

Collection of string

None.

Agreements

Collection of Agreement

None.

Errors

Collection of ERPError

None.

Warnings

Collection of ERPWarning

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerNumber": "sample string 1",
  "SalesOrg": "sample string 2",
  "DealId": "sample string 3",
  "EndUser": "sample string 4",
  "ValidOn": "2021-01-15T08:48:05.4299896-05:00",
  "MfgCode": "sample string 6",
  "ControlNumber": "sample string 7",
  "Description": "sample string 8",
  "AgreementTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Agreements": [
    {
      "AgreementNumber": "sample string 1",
      "Description": "sample string 2",
      "EndUser": "sample string 3",
      "SalesOrg": "sample string 4",
      "DealId": "sample string 5",
      "ExpirationDate": "2021-01-15T08:48:05.4299896-05:00",
      "Status": "sample string 7",
      "MfgCode": "sample string 8",
      "ControlNumber": "sample string 9",
      "AgreementType": "sample string 10"
    },
    {
      "AgreementNumber": "sample string 1",
      "Description": "sample string 2",
      "EndUser": "sample string 3",
      "SalesOrg": "sample string 4",
      "DealId": "sample string 5",
      "ExpirationDate": "2021-01-15T08:48:05.4299896-05:00",
      "Status": "sample string 7",
      "MfgCode": "sample string 8",
      "ControlNumber": "sample string 9",
      "AgreementType": "sample string 10"
    }
  ],
  "Errors": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "Warnings": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<AgreementSummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerNumber>sample string 1</CustomerNumber>
  <SalesOrg>sample string 2</SalesOrg>
  <DealId>sample string 3</DealId>
  <EndUser>sample string 4</EndUser>
  <ValidOn>2021-01-15T08:48:05.4299896-05:00</ValidOn>
  <MfgCode>sample string 6</MfgCode>
  <ControlNumber>sample string 7</ControlNumber>
  <Description>sample string 8</Description>
  <AgreementTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </AgreementTypes>
  <Agreements>
    <Agreement>
      <AgreementNumber>sample string 1</AgreementNumber>
      <Description>sample string 2</Description>
      <EndUser>sample string 3</EndUser>
      <SalesOrg>sample string 4</SalesOrg>
      <DealId>sample string 5</DealId>
      <ExpirationDate>2021-01-15T08:48:05.4299896-05:00</ExpirationDate>
      <Status>sample string 7</Status>
      <MfgCode>sample string 8</MfgCode>
      <ControlNumber>sample string 9</ControlNumber>
      <AgreementType>sample string 10</AgreementType>
    </Agreement>
    <Agreement>
      <AgreementNumber>sample string 1</AgreementNumber>
      <Description>sample string 2</Description>
      <EndUser>sample string 3</EndUser>
      <SalesOrg>sample string 4</SalesOrg>
      <DealId>sample string 5</DealId>
      <ExpirationDate>2021-01-15T08:48:05.4299896-05:00</ExpirationDate>
      <Status>sample string 7</Status>
      <MfgCode>sample string 8</MfgCode>
      <ControlNumber>sample string 9</ControlNumber>
      <AgreementType>sample string 10</AgreementType>
    </Agreement>
  </Agreements>
  <Errors>
    <ERPError>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </ERPError>
    <ERPError>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </ERPError>
  </Errors>
  <Warnings>
    <ERPWarning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </ERPWarning>
    <ERPWarning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </ERPWarning>
  </Warnings>
</AgreementSummaryResponse>