POST PurchaseContract/CreatePurchaseContractAmendment

Create a purchase contract amendment

Request Information

URI Parameters

Body Parameters

A new contract amendment shape

ClsGrPurConAmendAdd
NameDescriptionTypeAdditional Information
PurchaseContractGUID

Guid of the contract - will be used to look up the contract

globally unique identifier

Required

AmendmentDate

string

Required

Data type: DateTime

Format must be MM/dd/yyyy

ContractSigned

boolean
AgvanceUserForBuyerSignature

The User ID that the signature will be pulled from

string
BuyerSignatureDateTimeSignedUtc

The date and time the buyer's signature was captured in UTC (Only used with a valid AgvanceUserIdToAssignBuyerSignatureFrom set)

date
BuyerSignatureDateSignedToPrint

The date the buyer's signature was applied to the contract (Only used with a valid AgvanceUserIdToAssignBuyerSignatureFrom set)

date
GrPurConAmendDt

Deduction and change information object

Collection of ClsGrPurConAmendDtAdd

Required

List cannot be empty

Request Formats

application/json, text/json

Sample:
{
  "PurchaseContractGUID": "27a670e7-93e7-4d1f-b51c-b1762723387c",
  "AmendmentDate": "sample string 1",
  "ContractSigned": true,
  "AgvanceUserForBuyerSignature": "sample string 3",
  "BuyerSignatureDateTimeSignedUtc": "2025-05-15T14:00:50.9560336+00:00",
  "BuyerSignatureDateSignedToPrint": "2025-05-15T14:00:50.9560336+00:00",
  "GrPurConAmendDt": [
    {
      "TypeString": "",
      "SettDedsGuid": "a66ba8df-1978-4e59-8b83-bd690943d99c",
      "Rate": "sample string 1",
      "Description": "sample string 2",
      "Comment": "sample string 3",
      "Value": "sample string 4",
      "ChangeType": "",
      "Quantity": 1.1,
      "QuantitySource": "",
      "SourceGuid": "4b58e41e-4c46-4af3-98a8-0de78fd15899"
    },
    {
      "TypeString": "",
      "SettDedsGuid": "a66ba8df-1978-4e59-8b83-bd690943d99c",
      "Rate": "sample string 1",
      "Description": "sample string 2",
      "Comment": "sample string 3",
      "Value": "sample string 4",
      "ChangeType": "",
      "Quantity": 1.1,
      "QuantitySource": "",
      "SourceGuid": "4b58e41e-4c46-4af3-98a8-0de78fd15899"
    }
  ]
}

application/xml, text/xml

Sample:
<ClsGrPurCon.ClsGrPurConAmendAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
  <AgvanceUserForBuyerSignature>sample string 3</AgvanceUserForBuyerSignature>
  <AmendmentDate>sample string 1</AmendmentDate>
  <BuyerSignatureDateSignedToPrint>2025-05-15T14:00:50.9560336+00:00</BuyerSignatureDateSignedToPrint>
  <BuyerSignatureDateTimeSignedUtc>2025-05-15T14:00:50.9560336+00:00</BuyerSignatureDateTimeSignedUtc>
  <ContractSigned>true</ContractSigned>
  <GrPurConAmendDt>
    <ClsGrPurCon.ClsGrPurConAmendDtAdd>
      <ChangeType>NotSelected</ChangeType>
      <Comment>sample string 3</Comment>
      <Description>sample string 2</Description>
      <Quantity>1.1</Quantity>
      <QuantitySource>NotSelected</QuantitySource>
      <Rate>sample string 1</Rate>
      <SettDedsGuid>a66ba8df-1978-4e59-8b83-bd690943d99c</SettDedsGuid>
      <SourceGuid>4b58e41e-4c46-4af3-98a8-0de78fd15899</SourceGuid>
      <TypeString>NotSelected</TypeString>
      <Value>sample string 4</Value>
    </ClsGrPurCon.ClsGrPurConAmendDtAdd>
    <ClsGrPurCon.ClsGrPurConAmendDtAdd>
      <ChangeType>NotSelected</ChangeType>
      <Comment>sample string 3</Comment>
      <Description>sample string 2</Description>
      <Quantity>1.1</Quantity>
      <QuantitySource>NotSelected</QuantitySource>
      <Rate>sample string 1</Rate>
      <SettDedsGuid>a66ba8df-1978-4e59-8b83-bd690943d99c</SettDedsGuid>
      <SourceGuid>4b58e41e-4c46-4af3-98a8-0de78fd15899</SourceGuid>
      <TypeString>NotSelected</TypeString>
      <Value>sample string 4</Value>
    </ClsGrPurCon.ClsGrPurConAmendDtAdd>
  </GrPurConAmendDt>
  <PurchaseContractGUID>27a670e7-93e7-4d1f-b51c-b1762723387c</PurchaseContractGUID>
</ClsGrPurCon.ClsGrPurConAmendAdd>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsGrPurConAmendAdd'.

Response Information

Resource Description

Create a purchase contract amendment

AgvPurchaseContractDetails
NameDescriptionTypeAdditional Information
Status

0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful

string
Message

Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know

string
Count

The number of results returned.

string
PurchaseContract

ClsGrPurCon

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "1",
  "PurchaseContract": {
    "Contract": "sample string 1",
    "CustID": "sample string 2",
    "Location": "sample string 3",
    "Commodity": "sample string 4",
    "Dateest": "sample string 5",
    "ExpireDate": "sample string 6",
    "ContractStatus": "sample string 7",
    "ContractType": "sample string 8",
    "CashPrice": 9.1,
    "ContractQuantity": 10.1,
    "QuantityRecvd": 11.1,
    "Basisprice": 12.1,
    "FuturesMonth": "sample string 13",
    "Exchange": "sample string 15",
    "StrikePrice": 16.1,
    "Futuresprice": 17.1,
    "ContractSigned": true,
    "BidCriteria": "sample string 19",
    "ShipDestination": "sample string 20",
    "OriginContract": "sample string 21",
    "OriginLocation": "sample string 22",
    "SalesmanID": "sample string 23",
    "PricingNotes": "sample string 24",
    "IsSpot": true,
    "originalContractQuantity": 26.1,
    "PurchaseContractGuid": "9d7190a3-84e8-44d3-8d6f-a0889d0f4041",
    "SellerSignatureDateSignedToPrint": "2025-05-15T14:00:50.976195+00:00",
    "ContractFormat": "sample string 35",
    "DirectShipped": true,
    "LastModifiedUTC": "2025-05-15T14:00:50.976195+00:00",
    "PurchaseContractDeliveryDates": [
      {
        "Contract": "sample string 1",
        "Location": "sample string 2",
        "Lineitem": "3",
        "StartDate": "sample string 4",
        "Quantity": "5.1",
        "CompleteDate": "sample string 6"
      },
      {
        "Contract": "sample string 1",
        "Location": "sample string 2",
        "Lineitem": "3",
        "StartDate": "sample string 4",
        "Quantity": "5.1",
        "CompleteDate": "sample string 6"
      }
    ],
    "PurchaseContractGradeFactors": [
      {
        "Contract": "sample string 1",
        "Location": "sample string 2",
        "Lineitem": "3",
        "GradFact": "sample string 4",
        "Schedule": "sample string 5",
        "Commodity": "sample string 6"
      },
      {
        "Contract": "sample string 1",
        "Location": "sample string 2",
        "Lineitem": "3",
        "GradFact": "sample string 4",
        "Schedule": "sample string 5",
        "Commodity": "sample string 6"
      }
    ],
    "PurchaseContractComments": [
      {
        "CommentDate": "sample string 4",
        "Comment": "sample string 5"
      },
      {
        "CommentDate": "sample string 4",
        "Comment": "sample string 5"
      }
    ]
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'QuantityAsStringForApi' in type 'SKY.Core.Grain.ClsGrPurCon+ClsGrPurConDd'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'QuantityAsStringForApi' in type 'SKY.Core.Grain.ClsGrPurCon+ClsGrPurConDd'.