GET CommodityCustomerBalance/GetCommodityGrainBalance?CustID={CustID}&SplitOpenStorageOnHold={SplitOpenStorageOnHold}
Returns a list of Commodity Grain Balances.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| CustID |
CustID for the grain balances being requested. |
string |
Required |
| SplitOpenStorageOnHold |
Splitout the open storage units from units that are on Hold |
boolean |
Default value is False |
Body Parameters
Response Information
Resource Description
Returns a list of Commodity Grain Balances.
AgvCommodityCustomerBalance| Name | Description | Type | Additional Information |
|---|---|---|---|
| Status |
Status of the API call. |
string | |
| Message |
Message of the API call. |
string | |
| Count |
Count of how many Commodity JSON dictionaries. |
string | |
| CustomerCommodityBalanceList |
JSON dictionary of Commodity balances. |
Collection of CommodityDispositionBalance |
Response Formats
application/json, text/json
Sample:
{
"Status": "sample string 1",
"Message": "sample string 2",
"Count": "sample string 3",
"CustomerCommodityBalanceList": [
{
"ColumnHeader": "sample string 1",
"UnPaidPricedUnits": "sample string 2",
"OpenStorage": "sample string 3",
"PricedLater": "sample string 4",
"GrainBank": "sample string 5",
"WarehouseReceipt": "sample string 6",
"FutureBased": "sample string 7",
"InstallmentSales": "sample string 8",
"DeferredPayment": "sample string 9",
"Hold": "sample string 10",
"AdditionalUnitBalances": [
{
"UnitType": "sample string 1",
"Units": "sample string 2",
"UserDefinedLabel": "sample string 3"
},
{
"UnitType": "sample string 1",
"Units": "sample string 2",
"UserDefinedLabel": "sample string 3"
}
]
},
{
"ColumnHeader": "sample string 1",
"UnPaidPricedUnits": "sample string 2",
"OpenStorage": "sample string 3",
"PricedLater": "sample string 4",
"GrainBank": "sample string 5",
"WarehouseReceipt": "sample string 6",
"FutureBased": "sample string 7",
"InstallmentSales": "sample string 8",
"DeferredPayment": "sample string 9",
"Hold": "sample string 10",
"AdditionalUnitBalances": [
{
"UnitType": "sample string 1",
"Units": "sample string 2",
"UserDefinedLabel": "sample string 3"
},
{
"UnitType": "sample string 1",
"Units": "sample string 2",
"UserDefinedLabel": "sample string 3"
}
]
}
]
}
application/xml, text/xml
Sample:
<AgvCommodityCustomerBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Commodity">
<Count>sample string 3</Count>
<CustomerCommodityBalanceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
<d2p1:ClsCommodityBalance.CommodityDispositionBalance>
<d2p1:AdditionalUnitBalances>
<d2p1:ClsCommodityBalance.AdditionalUnitTypes>
<d2p1:UnitType>sample string 1</d2p1:UnitType>
<d2p1:Units>sample string 2</d2p1:Units>
<d2p1:UserDefinedLabel>sample string 3</d2p1:UserDefinedLabel>
</d2p1:ClsCommodityBalance.AdditionalUnitTypes>
<d2p1:ClsCommodityBalance.AdditionalUnitTypes>
<d2p1:UnitType>sample string 1</d2p1:UnitType>
<d2p1:Units>sample string 2</d2p1:Units>
<d2p1:UserDefinedLabel>sample string 3</d2p1:UserDefinedLabel>
</d2p1:ClsCommodityBalance.AdditionalUnitTypes>
</d2p1:AdditionalUnitBalances>
<d2p1:ColumnHeader>sample string 1</d2p1:ColumnHeader>
<d2p1:DeferredPayment>sample string 9</d2p1:DeferredPayment>
<d2p1:FutureBased>sample string 7</d2p1:FutureBased>
<d2p1:GrainBank>sample string 5</d2p1:GrainBank>
<d2p1:Hold>sample string 10</d2p1:Hold>
<d2p1:InstallmentSales>sample string 8</d2p1:InstallmentSales>
<d2p1:OpenStorage>sample string 3</d2p1:OpenStorage>
<d2p1:PricedLater>sample string 4</d2p1:PricedLater>
<d2p1:UnPaidPricedUnits>sample string 2</d2p1:UnPaidPricedUnits>
<d2p1:WarehouseReceipt>sample string 6</d2p1:WarehouseReceipt>
</d2p1:ClsCommodityBalance.CommodityDispositionBalance>
<d2p1:ClsCommodityBalance.CommodityDispositionBalance>
<d2p1:AdditionalUnitBalances>
<d2p1:ClsCommodityBalance.AdditionalUnitTypes>
<d2p1:UnitType>sample string 1</d2p1:UnitType>
<d2p1:Units>sample string 2</d2p1:Units>
<d2p1:UserDefinedLabel>sample string 3</d2p1:UserDefinedLabel>
</d2p1:ClsCommodityBalance.AdditionalUnitTypes>
<d2p1:ClsCommodityBalance.AdditionalUnitTypes>
<d2p1:UnitType>sample string 1</d2p1:UnitType>
<d2p1:Units>sample string 2</d2p1:Units>
<d2p1:UserDefinedLabel>sample string 3</d2p1:UserDefinedLabel>
</d2p1:ClsCommodityBalance.AdditionalUnitTypes>
</d2p1:AdditionalUnitBalances>
<d2p1:ColumnHeader>sample string 1</d2p1:ColumnHeader>
<d2p1:DeferredPayment>sample string 9</d2p1:DeferredPayment>
<d2p1:FutureBased>sample string 7</d2p1:FutureBased>
<d2p1:GrainBank>sample string 5</d2p1:GrainBank>
<d2p1:Hold>sample string 10</d2p1:Hold>
<d2p1:InstallmentSales>sample string 8</d2p1:InstallmentSales>
<d2p1:OpenStorage>sample string 3</d2p1:OpenStorage>
<d2p1:PricedLater>sample string 4</d2p1:PricedLater>
<d2p1:UnPaidPricedUnits>sample string 2</d2p1:UnPaidPricedUnits>
<d2p1:WarehouseReceipt>sample string 6</d2p1:WarehouseReceipt>
</d2p1:ClsCommodityBalance.CommodityDispositionBalance>
</CustomerCommodityBalanceList>
<Message>sample string 2</Message>
<Status>sample string 1</Status>
</AgvCommodityCustomerBalance>