POST spa
Create SPA agreement
Request Information
URI Parameters
None.
Body Parameters
CreateAgreementRequest
CreateAgreementRequestName | Description | Type | Additional information |
---|---|---|---|
VendorNumber |
Vendor Number |
string |
None. |
DealId |
Unique deal id |
string |
None. |
PECategory |
Price Exception category // PE1 |
string |
None. |
SettleOpt | string |
None. |
|
SalesOrg |
Specifies the ScanSource business unit
|
integer |
None. |
AgreementDesc |
Description |
string |
None. |
ValidFrom |
Start Date Format: YYYY-MM-DD |
date |
None. |
ValidTo |
End Date Format: YYYY-MM-DD |
date |
None. |
EndUser | string |
None. |
|
Resellers |
Array of Customer numbers for this agreement |
Collection of string |
None. |
Materials |
Array of Materials for this agreement |
Collection of MaterialLine |
None. |
Request Formats
application/json, text/json
{ "VendorNumber": "sample string 1", "DealId": "sample string 2", "PECategory": "sample string 3", "SettleOpt": "sample string 4", "SalesOrg": 5, "AgreementDesc": "sample string 6", "ValidFrom": "2021-01-19T08:55:21.6818415-05:00", "ValidTo": "2021-01-19T08:55:21.6818415-05:00", "EndUser": "sample string 9", "Resellers": [ "sample string 1", "sample string 2" ], "Materials": [ { "Material": "sample string 1", "MaterialEntered": "sample string 2", "MagicKey": "sample string 3", "MaxQuantity": 4, "Duration": 5.0, "Rate": 6.0, "CalcType": "sample string 7", "SuggestedPrice": 8.0 }, { "Material": "sample string 1", "MaterialEntered": "sample string 2", "MagicKey": "sample string 3", "MaxQuantity": 4, "Duration": 5.0, "Rate": 6.0, "CalcType": "sample string 7", "SuggestedPrice": 8.0 } ] }
application/xml, text/xml
<CreateAgreementRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <VendorNumber>sample string 1</VendorNumber> <DealId>sample string 2</DealId> <PECategory>sample string 3</PECategory> <SettleOpt>sample string 4</SettleOpt> <SalesOrg>5</SalesOrg> <AgreementDesc>sample string 6</AgreementDesc> <ValidFrom>2021-01-19T08:55:21.6818415-05:00</ValidFrom> <ValidTo>2021-01-19T08:55:21.6818415-05:00</ValidTo> <EndUser>sample string 9</EndUser> <Resellers> <string>sample string 1</string> <string>sample string 2</string> </Resellers> <Materials> <MaterialLine> <Material>sample string 1</Material> <MaterialEntered>sample string 2</MaterialEntered> <MagicKey>sample string 3</MagicKey> <MaxQuantity>4</MaxQuantity> <Duration>5</Duration> <Rate>6</Rate> <CalcType>sample string 7</CalcType> <SuggestedPrice>8</SuggestedPrice> </MaterialLine> <MaterialLine> <Material>sample string 1</Material> <MaterialEntered>sample string 2</MaterialEntered> <MagicKey>sample string 3</MagicKey> <MaxQuantity>4</MaxQuantity> <Duration>5</Duration> <Rate>6</Rate> <CalcType>sample string 7</CalcType> <SuggestedPrice>8</SuggestedPrice> </MaterialLine> </Materials> </CreateAgreementRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CreateAgreementResponseName | Description | Type | Additional information |
---|---|---|---|
AgreementCreated |
Flag indicating if agreement created |
boolean |
None. |
AgreementNumber |
Identifier assigned to new agreement |
string |
None. |
Errors |
If there were errors processing request, list of errors |
Collection of ERPError |
None. |
Warnings |
If there were warnings processing request, list of warnings |
Collection of ERPWarning |
None. |
Response Formats
application/json, text/json
{ "AgreementCreated": true, "AgreementNumber": "sample string 2", "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
<CreateAgreementResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AgreementCreated>true</AgreementCreated> <AgreementNumber>sample string 2</AgreementNumber> <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> </CreateAgreementResponse>