POST PurchaseContract/PostMigrateStlmPurchaseContract

Migrates a purchase contract

Request Information

URI Parameters

Body Parameters

The request object used to migrate a purchase contract with

ClsMigrateStlmContractFromApi
NameDescriptionTypeAdditional Information
ContractToMigrateGUID

The GUID of the original contract to migrate units from

globally unique identifier

Required

NewContractModel

The model of the new contract that will be created and have the delivered units

ClsNewMigrateContract

Required

MigrationComsumptionContractGUID

The GUID of the contract to consume the pricing information from - overriding values provided in NewContractModel

globally unique identifier
ScaleTicketSplitGuidsEligibleToMigrate

List of STLM Scale ticket split GUIDs that have the current contract assigned to them to migrate to the newly created contract

Collection of globally unique identifier
MigrationAmendmentRecord

IF Amendments are endabled, the record that allows this migration to occur

ClsNewMigrateContractAmendment

Request Formats

application/json, text/json

Sample:
{
  "ContractToMigrateGUID": "0c9a85f1-b2cb-4a23-aae9-d3882b5f3cc7",
  "NewContractModel": {
    "MigratedQuantity": 1.1,
    "ContractType": 1,
    "CashPrice": 1.1,
    "FuturesPrice": 1.1,
    "BasisPrice": 1.1,
    "FuturesMonthID": "sample string 2",
    "ContractFormat": "sample string 3",
    "ContractID": "sample string 4",
    "DateEstablished": "sample string 5",
    "ExpireDate": "sample string 6",
    "PriceByDate": "sample string 7",
    "MigratedContractIsNewCropStatus": true,
    "ContractSigned": true,
    "SellerSignatureDateSignedToPrint": "sample string 10",
    "FarmID": "sample string 11",
    "SalespersonID": "sample string 12",
    "BidCriteriaID": "sample string 13",
    "ShippingDestinationID": "sample string 14",
    "FreightOnBoard": true,
    "DirectShipped": true,
    "PricingNote": "sample string 17",
    "MOTGuid": "3781fe47-e794-4bfe-b905-8adbcbc90063",
    "AgvanceUserIDToAssignBuyerSignatureFrom": "sample string 18",
    "BuyerSignatureDateSignedToPrint": "sample string 19",
    "BuyerSignatureDateTimeSignedUTC": "2026-02-27T04:46:53.7108746+00:00",
    "DeliveryDates": [
      {
        "StartDate": "sample string 1",
        "CompleteDate": "sample string 2",
        "Quantity": 3.1
      },
      {
        "StartDate": "sample string 1",
        "CompleteDate": "sample string 2",
        "Quantity": 3.1
      }
    ],
    "Schedules": [
      {
        "GradeFactorID": "sample string 1",
        "ScheduleID": "sample string 2"
      },
      {
        "GradeFactorID": "sample string 1",
        "ScheduleID": "sample string 2"
      }
    ],
    "Comments": [
      {
        "Comment": "sample string 1"
      },
      {
        "Comment": "sample string 1"
      }
    ]
  },
  "MigrationComsumptionContractGUID": "d22915e0-9217-43fa-88e6-025708a03f17",
  "ScaleTicketSplitGuidsEligibleToMigrate": [
    "ea604072-5dab-4f86-beac-e11b42749fc1",
    "40533836-b83b-4ae4-9fd4-910bf307c3e8"
  ],
  "MigrationAmendmentRecord": {
    "AmendmentDate": "sample string 1",
    "AmendmentSigned": true,
    "TypeString": "",
    "SettlementDeductionGuid": "75c40133-22f7-4887-8fad-554702cf033c",
    "Rate": 1.1,
    "QuantitySource": "",
    "Quantity": 1.1,
    "Description": "sample string 3",
    "Comment": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<ClsMigrateStlmContractFromApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Grain">
  <ContractToMigrateGUID>0c9a85f1-b2cb-4a23-aae9-d3882b5f3cc7</ContractToMigrateGUID>
  <MigrationAmendmentRecord xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
    <d2p1:AmendmentDate>sample string 1</d2p1:AmendmentDate>
    <d2p1:AmendmentSigned>true</d2p1:AmendmentSigned>
    <d2p1:Comment>sample string 4</d2p1:Comment>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Quantity>1.1</d2p1:Quantity>
    <d2p1:QuantitySource>NotSelected</d2p1:QuantitySource>
    <d2p1:Rate>1.1</d2p1:Rate>
    <d2p1:SettlementDeductionGuid>75c40133-22f7-4887-8fad-554702cf033c</d2p1:SettlementDeductionGuid>
    <d2p1:TypeString>NotSelected</d2p1:TypeString>
  </MigrationAmendmentRecord>
  <MigrationComsumptionContractGUID>d22915e0-9217-43fa-88e6-025708a03f17</MigrationComsumptionContractGUID>
  <NewContractModel xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
    <d2p1:AgvanceUserIDToAssignBuyerSignatureFrom>sample string 18</d2p1:AgvanceUserIDToAssignBuyerSignatureFrom>
    <d2p1:BasisPrice>1.1</d2p1:BasisPrice>
    <d2p1:BidCriteriaID>sample string 13</d2p1:BidCriteriaID>
    <d2p1:BuyerSignatureDateSignedToPrint>sample string 19</d2p1:BuyerSignatureDateSignedToPrint>
    <d2p1:BuyerSignatureDateTimeSignedUTC>2026-02-27T04:46:53.7108746+00:00</d2p1:BuyerSignatureDateTimeSignedUTC>
    <d2p1:CashPrice>1.1</d2p1:CashPrice>
    <d2p1:Comments>
      <d2p1:ClsGrPurCon.ClsNewMigrateContractComment>
        <d2p1:Comment>sample string 1</d2p1:Comment>
      </d2p1:ClsGrPurCon.ClsNewMigrateContractComment>
      <d2p1:ClsGrPurCon.ClsNewMigrateContractComment>
        <d2p1:Comment>sample string 1</d2p1:Comment>
      </d2p1:ClsGrPurCon.ClsNewMigrateContractComment>
    </d2p1:Comments>
    <d2p1:ContractFormat>sample string 3</d2p1:ContractFormat>
    <d2p1:ContractID>sample string 4</d2p1:ContractID>
    <d2p1:ContractSigned>true</d2p1:ContractSigned>
    <d2p1:ContractType>Priced</d2p1:ContractType>
    <d2p1:DateEstablished>sample string 5</d2p1:DateEstablished>
    <d2p1:DeliveryDates>
      <d2p1:ClsGrPurCon.ClsNewMigrateContractDeliveryDate>
        <d2p1:CompleteDate>sample string 2</d2p1:CompleteDate>
        <d2p1:Quantity>3.1</d2p1:Quantity>
        <d2p1:StartDate>sample string 1</d2p1:StartDate>
      </d2p1:ClsGrPurCon.ClsNewMigrateContractDeliveryDate>
      <d2p1:ClsGrPurCon.ClsNewMigrateContractDeliveryDate>
        <d2p1:CompleteDate>sample string 2</d2p1:CompleteDate>
        <d2p1:Quantity>3.1</d2p1:Quantity>
        <d2p1:StartDate>sample string 1</d2p1:StartDate>
      </d2p1:ClsGrPurCon.ClsNewMigrateContractDeliveryDate>
    </d2p1:DeliveryDates>
    <d2p1:DirectShipped>true</d2p1:DirectShipped>
    <d2p1:ExpireDate>sample string 6</d2p1:ExpireDate>
    <d2p1:FarmID>sample string 11</d2p1:FarmID>
    <d2p1:FreightOnBoard>true</d2p1:FreightOnBoard>
    <d2p1:FuturesMonthID>sample string 2</d2p1:FuturesMonthID>
    <d2p1:FuturesPrice>1.1</d2p1:FuturesPrice>
    <d2p1:MOTGuid>3781fe47-e794-4bfe-b905-8adbcbc90063</d2p1:MOTGuid>
    <d2p1:MigratedContractIsNewCropStatus>true</d2p1:MigratedContractIsNewCropStatus>
    <d2p1:MigratedQuantity>1.1</d2p1:MigratedQuantity>
    <d2p1:PriceByDate>sample string 7</d2p1:PriceByDate>
    <d2p1:PricingNote>sample string 17</d2p1:PricingNote>
    <d2p1:SalespersonID>sample string 12</d2p1:SalespersonID>
    <d2p1:Schedules>
      <d2p1:ClsGrPurCon.ClsNewMigrateContractSchedule>
        <d2p1:GradeFactorID>sample string 1</d2p1:GradeFactorID>
        <d2p1:ScheduleID>sample string 2</d2p1:ScheduleID>
      </d2p1:ClsGrPurCon.ClsNewMigrateContractSchedule>
      <d2p1:ClsGrPurCon.ClsNewMigrateContractSchedule>
        <d2p1:GradeFactorID>sample string 1</d2p1:GradeFactorID>
        <d2p1:ScheduleID>sample string 2</d2p1:ScheduleID>
      </d2p1:ClsGrPurCon.ClsNewMigrateContractSchedule>
    </d2p1:Schedules>
    <d2p1:SellerSignatureDateSignedToPrint>sample string 10</d2p1:SellerSignatureDateSignedToPrint>
    <d2p1:ShippingDestinationID>sample string 14</d2p1:ShippingDestinationID>
  </NewContractModel>
  <ScaleTicketSplitGuidsEligibleToMigrate xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>ea604072-5dab-4f86-beac-e11b42749fc1</d2p1:guid>
    <d2p1:guid>40533836-b83b-4ae4-9fd4-910bf307c3e8</d2p1:guid>
  </ScaleTicketSplitGuidsEligibleToMigrate>
</ClsMigrateStlmContractFromApi>

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 'ClsMigrateStlmContractFromApi'.

Response Information

Resource Description

Migrates a purchase contract

AgvPurchaseContractDetailsWithErrorLists
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
ErrorList

List of error messages by the API call

Collection of string
WarningList

List of warning messages by the API call

Collection of 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",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "1",
  "PurchaseContract": {
    "Contract": "sample string 1",
    "CustID": "sample string 2",
    "Location": "sample string 5",
    "Commodity": "sample string 6",
    "Dateest": "sample string 7",
    "ExpireDate": "sample string 8",
    "ContractStatus": "sample string 9",
    "ContractType": "sample string 10",
    "CashPrice": 11.1,
    "ContractQuantity": 12.1,
    "QuantityRecvd": 13.1,
    "Basisprice": 14.1,
    "FuturesMonth": "sample string 15",
    "Exchange": "sample string 17",
    "StrikePrice": 18.1,
    "Futuresprice": 19.1,
    "ContractSigned": true,
    "BidCriteria": "sample string 21",
    "ShipDestination": "sample string 22",
    "OriginContract": "sample string 23",
    "OriginLocation": "sample string 24",
    "SalesmanID": "sample string 25",
    "PricingNotes": "sample string 26",
    "IsSpot": true,
    "originalContractQuantity": 28.1,
    "PurchaseContractGuid": "5be253fb-55b5-45b1-9331-b56bb7f6bce1",
    "SellerSignatureDateSignedToPrint": "2026-02-27T04:46:53.760189+00:00",
    "ContractFormat": "sample string 37",
    "DirectShipped": true,
    "LastModifiedUTC": "2026-02-27T04:46:53.760189+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'.