POST ScaleInterface/PostInboundGrainScaleInterfaceTicket
Creates an inbound grain scale interface record
Request Information
URI Parameters
Body Parameters
The request object used to create the database entry.
ClsGrainScaleInterfaceApiName | Description | Type | Additional Information |
---|---|---|---|
TicketGUID |
The GUID of the Scale Interface Tranaction. |
globally unique identifier | |
TicketNum |
The ticket number that displayed throughout Agvance |
string |
Required Max length: 10 |
AssemblyNum |
Read Only Assembly Number of the transaction |
string | |
LocationId |
The Location ID of the transaction |
string |
Required Max length: 6 |
CommodityId |
The Commodity ID of the transaction |
string |
Required Max length: 6 |
TicketDate |
The date of the scale ticket transaction (Date portion only) |
date |
Required |
CashPrice |
Spot cash price for the ticket |
decimal number |
Cannot be negative Max of 4 decimal places |
GrossWeight |
Gross Weight |
integer |
Required Cannot be negative |
GrossWeightCaptureDateTime |
The local date and time that the Gross Weight was captured |
date | |
TareWeight |
Tare Weight |
integer |
Required Cannot be negative |
TareWeightCaptureDateTime |
The local date and time that the Tare Weight was captured |
date | |
NetWeight |
Net Weight |
integer |
Required Cannot be negative |
DockPercent |
Read Only Dockage Percent |
decimal number | |
ShrinkPercent |
Read Only Shrink Percent |
decimal number | |
GrossUnits |
Gross amount in commodity units |
decimal number |
Required Cannot be negative Max of 4 decimal places |
DockUnits |
Dockage amount in commodity units |
decimal number |
Required Cannot be negative Max of 4 decimal places |
ShrinkUnits |
Shrink amount in commodity units |
decimal number |
Required Cannot be negative Max of 4 decimal places |
NetUnits |
Net amount in commodity units |
decimal number |
Required Cannot be negative Max of 4 decimal places |
Comment |
Comments for the ticket |
string |
Max length: 60 |
BinId |
The ID of the bin for the ticket |
string |
Max length: 10 |
DriverOn |
Indication of the driver being on the scale when it was weighed |
boolean |
Must be 0, 1, True, or False |
TransferredFlag |
Read Only Indication of the imported state into Grain |
boolean |
Must be 0, 1, True, or False |
VehicleDescription |
The description of the vehicle that is delivering the commodity |
string |
Max length: 30 |
Axles |
The number of axles of the vehicle delivering the commodity |
integer |
Cannot be negative |
WeighMaster |
Weighmaster of the ticket |
string |
Max length: 20 |
WeighMasterLicenseNumber |
The license number of the Weighmaster |
string |
Max length: 10 |
FarmUniqueId |
The farm unique id for the transaction |
integer |
Cannot be negative |
FarmName |
Read Only user friendly name of the farm referenced on this ticket |
string | |
GrowerId |
The Grower ID of the field - will only be used if the FieldId is populated |
string |
Max length: 6 |
FieldId |
The ID for the field to be saved with the ticket - requires the GrowerId to also be populated. IF the FarmUniqueId is populated, this field must be from that farm. |
string |
Max length: 8 |
FreightVendorId |
The ID of the Freight Vendor |
string |
Max length: 10 |
FreightVendorName |
The Name of the Freight Vendor - Allowed to exist without the FreightVendorId populated |
string |
Max length: 50 |
BillOfLadingNumber |
BOL Number |
string |
Max length: 15 |
ReadyForTransfer |
Ready for Transfer |
boolean |
Must be 0, 1, True, or False |
Voided |
Indicates if the ticket is Voided or not. To VOID a ticket in Agvance, set this to 'true' and call the PUT method. |
boolean |
Must be 0, 1, True, or False |
MoistureTesterCalibrationNumber |
Moisture tester calibration number |
string |
Max length: 20 |
IsApproximatedTestWeight |
Indication of if the test weight value is an approximate test weight or not |
boolean |
Must be 0, 1, True, or False |
CommodityVariety |
The commodity variety of the commodity |
string |
Max length: 50 |
BolTruckLicenseNum |
BOL Truck Plate # |
string |
Max length: 20 |
BolTrailerLicenseNum |
BOL Trailer Plate # |
string |
Max length: 20 |
BolLastHauledCommodityName |
BOL Last Hauled Commodity |
string |
Max length: 50 |
BolLastCleanoutDate |
BOL Cleanout Date (Date portion only) |
date | |
LastModifiedUTC |
Read Only date and time the transaction was last modified in UTC format |
date | |
Splits |
List of customers for the ticket |
Collection of ClsGrainScaleInterfaceSplitApi |
Required List cannot be empty |
GradeFactors |
List of grade factors for the ticket |
Collection of ClsGrainScaleInterfaceGradeFactorApi | |
FreightCharges |
List of freight charges for the ticket |
Collection of ClsGrainScaleInterfaceFrtChargeApi |
Request Formats
application/json, text/json
{ "TicketGUID": "831a7dad-bb46-4519-b55f-62e625964abd", "TicketNum": "sample string 5", "AssemblyNum": "sample string 6", "LocationId": "sample string 7", "CommodityId": "sample string 8", "TicketDate": "2024-11-21T09:55:13.3525272+00:00", "CashPrice": 9.1, "GrossWeight": 10, "GrossWeightCaptureDateTime": "2024-11-21T09:55:13.3525272+00:00", "TareWeight": 12, "TareWeightCaptureDateTime": "2024-11-21T09:55:13.3525272+00:00", "NetWeight": 14, "DockPercent": 15.1, "ShrinkPercent": 16.1, "GrossUnits": 17.1, "DockUnits": 18.1, "ShrinkUnits": 19.1, "NetUnits": 20.1, "Comment": "sample string 22", "BinId": "sample string 23", "DriverOn": true, "TransferredFlag": true, "VehicleDescription": "sample string 38", "Axles": 39, "WeighMaster": "sample string 40", "WeighMasterLicenseNumber": "sample string 41", "FarmUniqueId": 1, "FarmName": "sample string 43", "GrowerId": "sample string 44", "FieldId": "sample string 45", "FreightVendorId": "sample string 47", "FreightVendorName": "sample string 48", "BillOfLadingNumber": "sample string 49", "ReadyForTransfer": true, "Voided": true, "MoistureTesterCalibrationNumber": "sample string 79", "IsApproximatedTestWeight": true, "CommodityVariety": "sample string 86", "BolTruckLicenseNum": "sample string 87", "BolTrailerLicenseNum": "sample string 88", "BolLastHauledCommodityName": "sample string 89", "BolLastCleanoutDate": "2024-11-21T09:55:13.3545267+00:00", "LastModifiedUTC": "2024-11-21T09:55:13.3545267+00:00", "Splits": [ { "UniqueId": 1, "CustomerId": "sample string 3", "CustomerName": "sample string 4", "SharePercent": 5.1, "ContractNumber": "sample string 6", "Disposition": "sample string 8", "OnHold": true }, { "UniqueId": 1, "CustomerId": "sample string 3", "CustomerName": "sample string 4", "SharePercent": 5.1, "ContractNumber": "sample string 6", "Disposition": "sample string 8", "OnHold": true } ], "GradeFactors": [ { "GradeFactorId": "sample string 2", "Value": 1.1 }, { "GradeFactorId": "sample string 2", "Value": 1.1 } ], "FreightCharges": [ { "FreightVendorId": "sample string 2", "FreightVendorName": "sample string 3", "Rate": 1.1, "UseGrossUnits": true }, { "FreightVendorId": "sample string 2", "FreightVendorName": "sample string 3", "Rate": 1.1, "UseGrossUnits": true } ] }
application/xml
text/xml
application/x-www-form-urlencoded
Response Information
Resource Description
Creates an inbound grain scale interface record
AgvScaleInterfaceName | Description | Type | Additional 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 of the API call. |
Collection of string | |
WarningList |
List of warning messages of the API call. |
Collection of string | |
Count |
Number of results returned. |
string | |
Data |
List of Properties and Values returned for each grain scale interface record that matches the request. |
Collection of ClsGrainScaleInterfaceApi |
Response Formats
application/json, text/json
{ "Status": "sample string 1", "Message": "sample string 2", "ErrorList": [ "sample string 1", "sample string 2" ], "WarningList": [ "sample string 1", "sample string 2" ], "Count": "2", "Data": [ { "TicketGUID": "483fb208-eba2-405a-820c-0e4575ebe97a", "TicketNum": "sample string 5", "AssemblyNum": "sample string 6", "LocationId": "sample string 7", "CommodityId": "sample string 8", "TicketDate": "2024-11-21T09:55:13.3955267+00:00", "CashPrice": 9.1, "GrossWeight": 10, "GrossWeightCaptureDateTime": "2024-11-21T09:55:13.3955267+00:00", "TareWeight": 12, "TareWeightCaptureDateTime": "2024-11-21T09:55:13.3955267+00:00", "NetWeight": 14, "DockPercent": 15.1, "ShrinkPercent": 16.1, "GrossUnits": 17.1, "DockUnits": 18.1, "ShrinkUnits": 19.1, "NetUnits": 20.1, "Comment": "sample string 22", "BinId": "sample string 23", "DriverOn": true, "TransferredFlag": true, "VehicleDescription": "sample string 38", "Axles": 39, "WeighMaster": "sample string 40", "WeighMasterLicenseNumber": "sample string 41", "FarmUniqueId": 1, "FarmName": "sample string 43", "GrowerId": "sample string 44", "FieldId": "sample string 45", "FreightVendorId": "sample string 47", "FreightVendorName": "sample string 48", "BillOfLadingNumber": "sample string 49", "ReadyForTransfer": true, "Voided": true, "MoistureTesterCalibrationNumber": "sample string 79", "IsApproximatedTestWeight": true, "CommodityVariety": "sample string 86", "BolTruckLicenseNum": "sample string 87", "BolTrailerLicenseNum": "sample string 88", "BolLastHauledCommodityName": "sample string 89", "BolLastCleanoutDate": "2024-11-21T09:55:13.3955267+00:00", "LastModifiedUTC": "2024-11-21T09:55:13.3955267+00:00", "Splits": [ { "UniqueId": 1, "CustomerId": "sample string 3", "CustomerName": "sample string 4", "SharePercent": 5.1, "ContractNumber": "sample string 6", "Disposition": "sample string 8", "OnHold": true }, { "UniqueId": 1, "CustomerId": "sample string 3", "CustomerName": "sample string 4", "SharePercent": 5.1, "ContractNumber": "sample string 6", "Disposition": "sample string 8", "OnHold": true } ], "GradeFactors": [ { "GradeFactorId": "sample string 2", "Value": 1.1 }, { "GradeFactorId": "sample string 2", "Value": 1.1 } ], "FreightCharges": [ { "FreightVendorId": "sample string 2", "FreightVendorName": "sample string 3", "Rate": 1.1, "UseGrossUnits": true }, { "FreightVendorId": "sample string 2", "FreightVendorName": "sample string 3", "Rate": 1.1, "UseGrossUnits": true } ] }, { "TicketGUID": "483fb208-eba2-405a-820c-0e4575ebe97a", "TicketNum": "sample string 5", "AssemblyNum": "sample string 6", "LocationId": "sample string 7", "CommodityId": "sample string 8", "TicketDate": "2024-11-21T09:55:13.3955267+00:00", "CashPrice": 9.1, "GrossWeight": 10, "GrossWeightCaptureDateTime": "2024-11-21T09:55:13.3955267+00:00", "TareWeight": 12, "TareWeightCaptureDateTime": "2024-11-21T09:55:13.3955267+00:00", "NetWeight": 14, "DockPercent": 15.1, "ShrinkPercent": 16.1, "GrossUnits": 17.1, "DockUnits": 18.1, "ShrinkUnits": 19.1, "NetUnits": 20.1, "Comment": "sample string 22", "BinId": "sample string 23", "DriverOn": true, "TransferredFlag": true, "VehicleDescription": "sample string 38", "Axles": 39, "WeighMaster": "sample string 40", "WeighMasterLicenseNumber": "sample string 41", "FarmUniqueId": 1, "FarmName": "sample string 43", "GrowerId": "sample string 44", "FieldId": "sample string 45", "FreightVendorId": "sample string 47", "FreightVendorName": "sample string 48", "BillOfLadingNumber": "sample string 49", "ReadyForTransfer": true, "Voided": true, "MoistureTesterCalibrationNumber": "sample string 79", "IsApproximatedTestWeight": true, "CommodityVariety": "sample string 86", "BolTruckLicenseNum": "sample string 87", "BolTrailerLicenseNum": "sample string 88", "BolLastHauledCommodityName": "sample string 89", "BolLastCleanoutDate": "2024-11-21T09:55:13.3955267+00:00", "LastModifiedUTC": "2024-11-21T09:55:13.3955267+00:00", "Splits": [ { "UniqueId": 1, "CustomerId": "sample string 3", "CustomerName": "sample string 4", "SharePercent": 5.1, "ContractNumber": "sample string 6", "Disposition": "sample string 8", "OnHold": true }, { "UniqueId": 1, "CustomerId": "sample string 3", "CustomerName": "sample string 4", "SharePercent": 5.1, "ContractNumber": "sample string 6", "Disposition": "sample string 8", "OnHold": true } ], "GradeFactors": [ { "GradeFactorId": "sample string 2", "Value": 1.1 }, { "GradeFactorId": "sample string 2", "Value": 1.1 } ], "FreightCharges": [ { "FreightVendorId": "sample string 2", "FreightVendorName": "sample string 3", "Rate": 1.1, "UseGrossUnits": true }, { "FreightVendorId": "sample string 2", "FreightVendorName": "sample string 3", "Rate": 1.1, "UseGrossUnits": true } ] } ] }